fe657225a2739bf878b2ddfb0909771ccb6e21ad
[fio.git] / memory.c
1 /*
2  * Memory helpers
3  */
4 #include <sys/types.h>
5 #include <sys/stat.h>
6 #include <fcntl.h>
7 #include <unistd.h>
8 #include <sys/mman.h>
9
10 #include "fio.h"
11 #ifndef FIO_NO_HAVE_SHM_H
12 #include <sys/shm.h>
13 #endif
14
15 void fio_unpin_memory(struct thread_data *td)
16 {
17         if (td->pinned_mem) {
18                 dprint(FD_MEM, "unpinning %llu bytes\n", td->o.lockmem);
19                 if (munlock(td->pinned_mem, td->o.lockmem) < 0)
20                         perror("munlock");
21                 munmap(td->pinned_mem, td->o.lockmem);
22                 td->pinned_mem = NULL;
23         }
24 }
25
26 int fio_pin_memory(struct thread_data *td)
27 {
28         unsigned long long phys_mem;
29
30         if (!td->o.lockmem)
31                 return 0;
32
33         dprint(FD_MEM, "pinning %llu bytes\n", td->o.lockmem);
34
35         /*
36          * Don't allow mlock of more than real_mem-128MiB
37          */
38         phys_mem = os_phys_mem();
39         if (phys_mem) {
40                 if ((td->o.lockmem + 128 * 1024 * 1024) > phys_mem) {
41                         td->o.lockmem = phys_mem - 128 * 1024 * 1024;
42                         log_info("fio: limiting mlocked memory to %lluMiB\n",
43                                                         td->o.lockmem >> 20);
44                 }
45         }
46
47         td->pinned_mem = mmap(NULL, td->o.lockmem, PROT_READ | PROT_WRITE,
48                                 MAP_PRIVATE | OS_MAP_ANON, -1, 0);
49         if (td->pinned_mem == MAP_FAILED) {
50                 perror("malloc locked mem");
51                 td->pinned_mem = NULL;
52                 return 1;
53         }
54         if (mlock(td->pinned_mem, td->o.lockmem) < 0) {
55                 perror("mlock");
56                 munmap(td->pinned_mem, td->o.lockmem);
57                 td->pinned_mem = NULL;
58                 return 1;
59         }
60
61         return 0;
62 }
63
64 static int alloc_mem_shm(struct thread_data *td, unsigned int total_mem)
65 {
66 #ifndef CONFIG_NO_SHM
67         int flags = IPC_CREAT | S_IRUSR | S_IWUSR;
68
69         if (td->o.mem_type == MEM_SHMHUGE) {
70                 unsigned long mask = td->o.hugepage_size - 1;
71
72                 flags |= SHM_HUGETLB;
73                 total_mem = (total_mem + mask) & ~mask;
74         }
75
76         td->shm_id = shmget(IPC_PRIVATE, total_mem, flags);
77         dprint(FD_MEM, "shmget %u, %d\n", total_mem, td->shm_id);
78         if (td->shm_id < 0) {
79                 td_verror(td, errno, "shmget");
80                 if (geteuid() != 0 && (errno == ENOMEM || errno == EPERM))
81                         log_err("fio: you may need to run this job as root\n");
82                 if (td->o.mem_type == MEM_SHMHUGE) {
83                         if (errno == EINVAL) {
84                                 log_err("fio: check that you have free huge"
85                                         " pages and that hugepage-size is"
86                                         " correct.\n");
87                         } else if (errno == ENOSYS) {
88                                 log_err("fio: your system does not appear to"
89                                         " support huge pages.\n");
90                         } else if (errno == ENOMEM) {
91                                 log_err("fio: no huge pages available, do you"
92                                         " need to allocate some? See HOWTO.\n");
93                         }
94                 }
95
96                 return 1;
97         }
98
99         td->orig_buffer = shmat(td->shm_id, NULL, 0);
100         dprint(FD_MEM, "shmat %d, %p\n", td->shm_id, td->orig_buffer);
101         if (td->orig_buffer == (void *) -1) {
102                 td_verror(td, errno, "shmat");
103                 td->orig_buffer = NULL;
104                 return 1;
105         }
106
107         return 0;
108 #else
109         log_err("fio: shm not supported\n");
110         return 1;
111 #endif
112 }
113
114 static void free_mem_shm(struct thread_data *td)
115 {
116 #ifndef CONFIG_NO_SHM
117         struct shmid_ds sbuf;
118
119         dprint(FD_MEM, "shmdt/ctl %d %p\n", td->shm_id, td->orig_buffer);
120         shmdt(td->orig_buffer);
121         shmctl(td->shm_id, IPC_RMID, &sbuf);
122 #endif
123 }
124
125 static int alloc_mem_mmap(struct thread_data *td, size_t total_mem)
126 {
127         int flags = 0;
128
129         td->mmapfd = -1;
130
131         if (td->o.mem_type == MEM_MMAPHUGE) {
132                 unsigned long mask = td->o.hugepage_size - 1;
133
134                 /* TODO: make sure the file is a real hugetlbfs file */
135                 if (!td->o.mmapfile)
136                         flags |= MAP_HUGETLB;
137                 total_mem = (total_mem + mask) & ~mask;
138         }
139
140         if (td->o.mmapfile) {
141                 td->mmapfd = open(td->o.mmapfile, O_RDWR|O_CREAT, 0644);
142
143                 if (td->mmapfd < 0) {
144                         td_verror(td, errno, "open mmap file");
145                         td->orig_buffer = NULL;
146                         return 1;
147                 }
148                 if (td->o.mem_type != MEM_MMAPHUGE &&
149                     td->o.mem_type != MEM_MMAPSHARED &&
150                     ftruncate(td->mmapfd, total_mem) < 0) {
151                         td_verror(td, errno, "truncate mmap file");
152                         td->orig_buffer = NULL;
153                         return 1;
154                 }
155                 if (td->o.mem_type == MEM_MMAPHUGE ||
156                     td->o.mem_type == MEM_MMAPSHARED)
157                         flags |= MAP_SHARED;
158                 else
159                         flags |= MAP_PRIVATE;
160         } else
161                 flags |= OS_MAP_ANON | MAP_PRIVATE;
162
163         td->orig_buffer = mmap(NULL, total_mem, PROT_READ | PROT_WRITE, flags,
164                                 td->mmapfd, 0);
165         dprint(FD_MEM, "mmap %llu/%d %p\n", (unsigned long long) total_mem,
166                                                 td->mmapfd, td->orig_buffer);
167         if (td->orig_buffer == MAP_FAILED) {
168                 td_verror(td, errno, "mmap");
169                 td->orig_buffer = NULL;
170                 if (td->mmapfd != 1 && td->mmapfd != -1) {
171                         close(td->mmapfd);
172                         if (td->o.mmapfile)
173                                 unlink(td->o.mmapfile);
174                 }
175
176                 return 1;
177         }
178
179         return 0;
180 }
181
182 static void free_mem_mmap(struct thread_data *td, size_t total_mem)
183 {
184         dprint(FD_MEM, "munmap %llu %p\n", (unsigned long long) total_mem,
185                                                 td->orig_buffer);
186         munmap(td->orig_buffer, td->orig_buffer_size);
187         if (td->o.mmapfile) {
188                 if (td->mmapfd != -1)
189                         close(td->mmapfd);
190                 unlink(td->o.mmapfile);
191                 free(td->o.mmapfile);
192         }
193 }
194
195 static int alloc_mem_malloc(struct thread_data *td, size_t total_mem)
196 {
197         td->orig_buffer = malloc(total_mem);
198         dprint(FD_MEM, "malloc %llu %p\n", (unsigned long long) total_mem,
199                                                         td->orig_buffer);
200
201         return td->orig_buffer == NULL;
202 }
203
204 static void free_mem_malloc(struct thread_data *td)
205 {
206         dprint(FD_MEM, "free malloc mem %p\n", td->orig_buffer);
207         free(td->orig_buffer);
208 }
209
210 #ifdef CONFIG_CUDA
211
212 static int alloc_mem_cudamalloc(struct thread_data *td, size_t total_mem)
213 {
214         CUresult ret;
215         char name[128];
216
217         ret = cuInit(0);
218         if (ret != CUDA_SUCCESS) {
219                 log_err("fio: failed initialize cuda driver api\n");
220                 return 1;
221         }
222
223         ret = cuDeviceGetCount(&td->gpu_dev_cnt);
224         if (ret != CUDA_SUCCESS) {
225                 log_err("fio: failed get device count\n");
226                 return 1;
227         }
228         dprint(FD_MEM, "found %d GPU devices\n", td->gpu_dev_cnt);
229
230         if (td->gpu_dev_cnt == 0) {
231                 log_err("fio: no GPU device found. "
232                         "Can not perform GPUDirect RDMA.\n");
233                 return 1;
234         }
235
236         td->gpu_dev_id = td->o.gpu_dev_id;
237         ret = cuDeviceGet(&td->cu_dev, td->gpu_dev_id);
238         if (ret != CUDA_SUCCESS) {
239                 log_err("fio: failed get GPU device\n");
240                 return 1;
241         }
242
243         ret = cuDeviceGetName(name, sizeof(name), td->gpu_dev_id);
244         if (ret != CUDA_SUCCESS) {
245                 log_err("fio: failed get device name\n");
246                 return 1;
247         }
248         dprint(FD_MEM, "dev_id = [%d], device name = [%s]\n", \
249                td->gpu_dev_id, name);
250
251         ret = cuCtxCreate(&td->cu_ctx, CU_CTX_MAP_HOST, td->cu_dev);
252         if (ret != CUDA_SUCCESS) {
253                 log_err("fio: failed to create cuda context: %d\n", ret);
254                 return 1;
255         }
256
257         ret = cuMemAlloc(&td->dev_mem_ptr, total_mem);
258         if (ret != CUDA_SUCCESS) {
259                 log_err("fio: cuMemAlloc %zu bytes failed\n", total_mem);
260                 return 1;
261         }
262         td->orig_buffer = (void *) td->dev_mem_ptr;
263
264         dprint(FD_MEM, "cudaMalloc %llu %p\n",                          \
265                (unsigned long long) total_mem, td->orig_buffer);
266         return 0;
267 }
268
269 static void free_mem_cudamalloc(struct thread_data *td)
270 {
271         if ((void *) td->dev_mem_ptr != NULL)
272                 cuMemFree(td->dev_mem_ptr);
273
274         if (cuCtxDestroy(td->cu_ctx) != CUDA_SUCCESS)
275                 log_err("fio: failed to destroy cuda context\n");
276 }
277 #endif
278
279 /*
280  * Set up the buffer area we need for io.
281  */
282 int allocate_io_mem(struct thread_data *td)
283 {
284         size_t total_mem;
285         int ret = 0;
286
287         if (td_ioengine_flagged(td, FIO_NOIO))
288                 return 0;
289
290         total_mem = td->orig_buffer_size;
291
292         if (td->o.odirect || td->o.mem_align || td->o.oatomic ||
293             td_ioengine_flagged(td, FIO_MEMALIGN)) {
294                 total_mem += page_mask;
295                 if (td->o.mem_align && td->o.mem_align > page_size)
296                         total_mem += td->o.mem_align - page_size;
297         }
298
299         dprint(FD_MEM, "Alloc %llu for buffers\n", (unsigned long long) total_mem);
300
301         /*
302          * If the IO engine has hooks to allocate/free memory, use those. But
303          * error out if the user explicitly asked for something else.
304          */
305         if (td->io_ops->iomem_alloc) {
306                 if (fio_option_is_set(&td->o, mem_type)) {
307                         log_err("fio: option 'mem/iomem' conflicts with specified IO engine\n");
308                         ret = 1;
309                 } else
310                         ret = td->io_ops->iomem_alloc(td, total_mem);
311         } else if (td->o.mem_type == MEM_MALLOC)
312                 ret = alloc_mem_malloc(td, total_mem);
313         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
314                 ret = alloc_mem_shm(td, total_mem);
315         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE ||
316                  td->o.mem_type == MEM_MMAPSHARED)
317                 ret = alloc_mem_mmap(td, total_mem);
318 #ifdef CONFIG_CUDA
319         else if (td->o.mem_type == MEM_CUDA_MALLOC)
320                 ret = alloc_mem_cudamalloc(td, total_mem);
321 #endif
322         else {
323                 log_err("fio: bad mem type: %d\n", td->o.mem_type);
324                 ret = 1;
325         }
326
327         if (ret)
328                 td_verror(td, ENOMEM, "iomem allocation");
329
330         return ret;
331 }
332
333 void free_io_mem(struct thread_data *td)
334 {
335         unsigned int total_mem;
336
337         total_mem = td->orig_buffer_size;
338         if (td->o.odirect || td->o.oatomic)
339                 total_mem += page_mask;
340
341         if (td->io_ops->iomem_alloc) {
342                 if (td->io_ops->iomem_free)
343                         td->io_ops->iomem_free(td);
344         } else if (td->o.mem_type == MEM_MALLOC)
345                 free_mem_malloc(td);
346         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
347                 free_mem_shm(td);
348         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE ||
349                  td->o.mem_type == MEM_MMAPSHARED)
350                 free_mem_mmap(td, total_mem);
351 #ifdef CONFIG_CUDA
352         else if (td->o.mem_type == MEM_CUDA_MALLOC)
353                 free_mem_cudamalloc(td);
354 #endif
355         else
356                 log_err("Bad memory type %u\n", td->o.mem_type);
357
358         td->orig_buffer = NULL;
359         td->orig_buffer_size = 0;
360 }