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 static void *pinned_mem;
  16
  17 void fio_unpin_memory(void)
  18 {
  19         if (pinned_mem) {
  20                 dprint(FD_MEM, "unpinning %llu bytes\n", mlock_size);
  21                 if (munlock(pinned_mem, mlock_size) < 0)
  22                         perror("munlock");
  23                 munmap(pinned_mem, mlock_size);
  24                 pinned_mem = NULL;
  25         }
  26 }
  27
  28 int fio_pin_memory(void)
  29 {
  30         unsigned long long phys_mem;
  31
  32         if (!mlock_size)
  33                 return 0;
  34
  35         dprint(FD_MEM, "pinning %llu bytes\n", mlock_size);
  36
  37         /*
  38          * Don't allow mlock of more than real_mem-128MB
  39          */
  40         phys_mem = os_phys_mem();
  41         if (phys_mem) {
  42                 if ((mlock_size + 128 * 1024 * 1024) > phys_mem) {
  43                         mlock_size = phys_mem - 128 * 1024 * 1024;
  44                         log_info("fio: limiting mlocked memory to %lluMB\n",
  45                                                         mlock_size >> 20);
  46                 }
  47         }
  48
  49         pinned_mem = mmap(NULL, mlock_size, PROT_READ | PROT_WRITE,
  50                                 MAP_PRIVATE | OS_MAP_ANON, -1, 0);
  51         if (pinned_mem == MAP_FAILED) {
  52                 perror("malloc locked mem");
  53                 pinned_mem = NULL;
  54                 return 1;
  55         }
  56         if (mlock(pinned_mem, mlock_size) < 0) {
  57                 perror("mlock");
  58                 munmap(pinned_mem, mlock_size);
  59                 pinned_mem = NULL;
  60                 return 1;
  61         }
  62
  63         return 0;
  64 }
  65
  66 static int alloc_mem_shm(struct thread_data *td, unsigned int total_mem)
  67 {
  68         int flags = IPC_CREAT | S_IRUSR | S_IWUSR;
  69
  70         if (td->o.mem_type == MEM_SHMHUGE) {
  71                 unsigned long mask = td->o.hugepage_size - 1;
  72
  73                 flags |= SHM_HUGETLB;
  74                 total_mem = (total_mem + mask) & ~mask;
  75         }
  76
  77         td->shm_id = shmget(IPC_PRIVATE, total_mem, flags);
  78         dprint(FD_MEM, "shmget %u, %d\n", total_mem, td->shm_id);
  79         if (td->shm_id < 0) {
  80                 td_verror(td, errno, "shmget");
  81                 if (geteuid() != 0 && (errno == ENOMEM || errno == EPERM))
  82                         log_err("fio: you may need to run this job as root\n");
  83                 if (td->o.mem_type == MEM_SHMHUGE) {
  84                         if (errno == EINVAL) {
  85                                 log_err("fio: check that you have free huge"
  86                                         " pages and that hugepage-size is"
  87                                         " correct.\n");
  88                         } else if (errno == ENOSYS) {
  89                                 log_err("fio: your system does not appear to"
  90                                         " support huge pages.\n");
  91                         } else if (errno == ENOMEM) {
  92                                 log_err("fio: no huge pages available, do you"
  93                                         " need to alocate some? See HOWTO.\n");
  94                         }
  95                 }
  96
  97                 return 1;
  98         }
  99
 100         td->orig_buffer = shmat(td->shm_id, NULL, 0);
 101         dprint(FD_MEM, "shmat %d, %p\n", td->shm_id, td->orig_buffer);
 102         if (td->orig_buffer == (void *) -1) {
 103                 td_verror(td, errno, "shmat");
 104                 td->orig_buffer = NULL;
 105                 return 1;
 106         }
 107
 108         return 0;
 109 }
 110
 111 static void free_mem_shm(struct thread_data *td)
 112 {
 113         struct shmid_ds sbuf;
 114
 115         dprint(FD_MEM, "shmdt/ctl %d %p\n", td->shm_id, td->orig_buffer);
 116         shmdt(td->orig_buffer);
 117         shmctl(td->shm_id, IPC_RMID, &sbuf);
 118 }
 119
 120 static int alloc_mem_mmap(struct thread_data *td, size_t total_mem)
 121 {
 122         int flags = 0;
 123
 124         td->mmapfd = 1;
 125
 126         if (td->o.mem_type == MEM_MMAPHUGE) {
 127                 unsigned long mask = td->o.hugepage_size - 1;
 128
 129                 /* TODO: make sure the file is a real hugetlbfs file */
 130                 if (!td->mmapfile)
 131                         flags |= MAP_HUGETLB;
 132                 total_mem = (total_mem + mask) & ~mask;
 133         }
 134
 135         if (td->mmapfile) {
 136                 td->mmapfd = open(td->mmapfile, O_RDWR|O_CREAT, 0644);
 137
 138                 if (td->mmapfd < 0) {
 139                         td_verror(td, errno, "open mmap file");
 140                         td->orig_buffer = NULL;
 141                         return 1;
 142                 }
 143                 if (td->o.mem_type != MEM_MMAPHUGE &&
 144                     ftruncate(td->mmapfd, total_mem) < 0) {
 145                         td_verror(td, errno, "truncate mmap file");
 146                         td->orig_buffer = NULL;
 147                         return 1;
 148                 }
 149                 if (td->o.mem_type == MEM_MMAPHUGE)
 150                         flags |= MAP_SHARED;
 151                 else
 152                         flags |= MAP_PRIVATE;
 153         } else
 154                 flags |= OS_MAP_ANON | MAP_PRIVATE;
 155
 156         td->orig_buffer = mmap(NULL, total_mem, PROT_READ | PROT_WRITE, flags,
 157                                 td->mmapfd, 0);
 158         dprint(FD_MEM, "mmap %llu/%d %p\n", (unsigned long long) total_mem,
 159                                                 td->mmapfd, td->orig_buffer);
 160         if (td->orig_buffer == MAP_FAILED) {
 161                 td_verror(td, errno, "mmap");
 162                 td->orig_buffer = NULL;
 163                 if (td->mmapfd) {
 164                         close(td->mmapfd);
 165                         unlink(td->mmapfile);
 166                 }
 167
 168                 return 1;
 169         }
 170
 171         return 0;
 172 }
 173
 174 static void free_mem_mmap(struct thread_data *td, size_t total_mem)
 175 {
 176         dprint(FD_MEM, "munmap %llu %p\n", (unsigned long long) total_mem,
 177                                                 td->orig_buffer);
 178         munmap(td->orig_buffer, td->orig_buffer_size);
 179         if (td->mmapfile) {
 180                 close(td->mmapfd);
 181                 unlink(td->mmapfile);
 182                 free(td->mmapfile);
 183         }
 184 }
 185
 186 static int alloc_mem_malloc(struct thread_data *td, size_t total_mem)
 187 {
 188         td->orig_buffer = malloc(total_mem);
 189         dprint(FD_MEM, "malloc %llu %p\n", (unsigned long long) total_mem,
 190                                                         td->orig_buffer);
 191
 192         return td->orig_buffer == NULL;
 193 }
 194
 195 static void free_mem_malloc(struct thread_data *td)
 196 {
 197         dprint(FD_MEM, "free malloc mem %p\n", td->orig_buffer);
 198         free(td->orig_buffer);
 199 }
 200
 201 /*
 202  * Set up the buffer area we need for io.
 203  */
 204 int allocate_io_mem(struct thread_data *td)
 205 {
 206         size_t total_mem;
 207         int ret = 0;
 208
 209         if (td->io_ops->flags & FIO_NOIO)
 210                 return 0;
 211
 212         total_mem = td->orig_buffer_size;
 213
 214         if (td->o.odirect || td->o.mem_align ||
 215             (td->io_ops->flags & FIO_MEMALIGN)) {
 216                 total_mem += page_mask;
 217                 if (td->o.mem_align && td->o.mem_align > page_size)
 218                         total_mem += td->o.mem_align - page_size;
 219         }
 220
 221         dprint(FD_MEM, "Alloc %llu for buffers\n", (unsigned long long) total_mem);
 222
 223         if (td->o.mem_type == MEM_MALLOC)
 224                 ret = alloc_mem_malloc(td, total_mem);
 225         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
 226                 ret = alloc_mem_shm(td, total_mem);
 227         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
 228                 ret = alloc_mem_mmap(td, total_mem);
 229         else {
 230                 log_err("fio: bad mem type: %d\n", td->o.mem_type);
 231                 ret = 1;
 232         }
 233
 234         if (ret)
 235                 td_verror(td, ENOMEM, "iomem allocation");
 236
 237         return ret;
 238 }
 239
 240 void free_io_mem(struct thread_data *td)
 241 {
 242         unsigned int total_mem;
 243
 244         total_mem = td->orig_buffer_size;
 245         if (td->o.odirect)
 246                 total_mem += page_mask;
 247
 248         if (td->o.mem_type == MEM_MALLOC)
 249                 free_mem_malloc(td);
 250         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
 251                 free_mem_shm(td);
 252         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
 253                 free_mem_mmap(td, total_mem);
 254         else
 255                 log_err("Bad memory type %u\n", td->o.mem_type);
 256
 257         td->orig_buffer = NULL;
 258         td->orig_buffer_size = 0;
 259 }