Detect and print when the OS doesn't support huge pages
[fio.git] / memory.c
1 /*
2  * Memory helpers
3  */
4 #include <unistd.h>
5 #include <sys/shm.h>
6 #include <sys/mman.h>
7
8 #include "fio.h"
9
10 static void *pinned_mem;
11
12 void fio_unpin_memory(void)
13 {
14         if (pinned_mem) {
15                 if (munlock(pinned_mem, mlock_size) < 0)
16                         perror("munlock");
17                 munmap(pinned_mem, mlock_size);
18                 pinned_mem = NULL;
19         }
20 }
21
22 int fio_pin_memory(void)
23 {
24         unsigned long long phys_mem;
25
26         if (!mlock_size)
27                 return 0;
28
29         /*
30          * Don't allow mlock of more than real_mem-128MB
31          */
32         phys_mem = os_phys_mem();
33         if (phys_mem) {
34                 if ((mlock_size + 128 * 1024 * 1024) > phys_mem) {
35                         mlock_size = phys_mem - 128 * 1024 * 1024;
36                         log_info("fio: limiting mlocked memory to %lluMiB\n", mlock_size >> 20);
37                 }
38         }
39
40         pinned_mem = mmap(NULL, mlock_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | OS_MAP_ANON, 0, 0);
41         if (pinned_mem == MAP_FAILED) {
42                 perror("malloc locked mem");
43                 pinned_mem = NULL;
44                 return 1;
45         }
46         if (mlock(pinned_mem, mlock_size) < 0) {
47                 perror("mlock");
48                 munmap(pinned_mem, mlock_size);
49                 pinned_mem = NULL;
50                 return 1;
51         }
52
53         return 0;
54 }
55
56 static int alloc_mem_shm(struct thread_data *td)
57 {
58         int flags = IPC_CREAT | SHM_R | SHM_W;
59
60         if (td->o.mem_type == MEM_SHMHUGE)
61                 flags |= SHM_HUGETLB;
62
63         td->shm_id = shmget(IPC_PRIVATE, td->orig_buffer_size, flags);
64         if (td->shm_id < 0) {
65                 td_verror(td, errno, "shmget");
66                 if (geteuid() != 0 && errno == ENOMEM)
67                         log_err("fio: you may need to run this job as root\n");
68                 if (td->o.mem_type == MEM_SHMHUM) {
69                         if (errno == EINVAL)
70                                 log_err("fio: check that you have free huge pages and that hugepage-size is correct.\n");
71                         else if (errno == ENOSYS)
72                                 log_err("fio: your system does not appear to support huge pages.\n");
73                 }
74                 
75                 return 1;
76         }
77
78         td->orig_buffer = shmat(td->shm_id, NULL, 0);
79         if (td->orig_buffer == (void *) -1) {
80                 td_verror(td, errno, "shmat");
81                 td->orig_buffer = NULL;
82                 return 1;
83         }
84
85         return 0;
86 }
87
88 static int alloc_mem_mmap(struct thread_data *td)
89 {
90         int flags = MAP_PRIVATE;
91
92         td->mmapfd = 0;
93
94         if (td->mmapfile) {
95                 td->mmapfd = open(td->mmapfile, O_RDWR|O_CREAT, 0644);
96
97                 if (td->mmapfd < 0) {
98                         td_verror(td, errno, "open mmap file");
99                         td->orig_buffer = NULL;
100                         return 1;
101                 }
102                 if (ftruncate(td->mmapfd, td->orig_buffer_size) < 0) {
103                         td_verror(td, errno, "truncate mmap file");
104                         td->orig_buffer = NULL;
105                         return 1;
106                 }
107         } else
108                 flags |= OS_MAP_ANON;
109
110         td->orig_buffer = mmap(NULL, td->orig_buffer_size, PROT_READ | PROT_WRITE, flags, td->mmapfd, 0);
111         if (td->orig_buffer == MAP_FAILED) {
112                 td_verror(td, errno, "mmap");
113                 td->orig_buffer = NULL;
114                 if (td->mmapfd) {
115                         close(td->mmapfd);
116                         unlink(td->mmapfile);
117                 }
118                         
119                 return 1;
120         }
121
122         return 0;
123 }
124
125 static int alloc_mem_malloc(struct thread_data *td)
126 {
127         td->orig_buffer = malloc(td->orig_buffer_size);
128         if (td->orig_buffer)
129                 return 0;
130
131         return 1;
132 }
133
134 /*
135  * Setup the buffer area we need for io.
136  */
137 int allocate_io_mem(struct thread_data *td)
138 {
139         int ret = 0;
140
141         if (td->o.mem_type == MEM_MALLOC)
142                 ret = alloc_mem_malloc(td);
143         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
144                 ret = alloc_mem_shm(td);
145         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
146                 ret = alloc_mem_mmap(td);
147         else {
148                 log_err("fio: bad mem type: %d\n", td->o.mem_type);
149                 ret = 1;
150         }
151
152         if (ret)
153                 td_verror(td, ENOMEM, "iomem allocation");
154
155         return ret;
156 }
157
158 void free_io_mem(struct thread_data *td)
159 {
160         if (td->o.mem_type == MEM_MALLOC)
161                 free(td->orig_buffer);
162         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE) {
163                 struct shmid_ds sbuf;
164
165                 shmdt(td->orig_buffer);
166                 shmctl(td->shm_id, IPC_RMID, &sbuf);
167         } else if (td->o.mem_type == MEM_MMAP ||
168                    td->o.mem_type == MEM_MMAPHUGE) {
169                 munmap(td->orig_buffer, td->orig_buffer_size);
170                 if (td->mmapfile) {
171                         close(td->mmapfd);
172                         unlink(td->mmapfile);
173                         free(td->mmapfile);
174                 }
175         } else
176                 log_err("Bad memory type %u\n", td->o.mem_type);
177
178         td->orig_buffer = NULL;
179 }