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 #ifndef FIO_NO_HAVE_SHM_H
   9 #include <sys/shm.h>
  10 #endif
  11 #include <sys/mman.h>
  12
  13 #include "fio.h"
  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-128MB
  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 %lluMB\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         int flags = IPC_CREAT | S_IRUSR | S_IWUSR;
  67
  68         if (td->o.mem_type == MEM_SHMHUGE) {
  69                 unsigned long mask = td->o.hugepage_size - 1;
  70
  71                 flags |= SHM_HUGETLB;
  72                 total_mem = (total_mem + mask) & ~mask;
  73         }
  74
  75         td->shm_id = shmget(IPC_PRIVATE, total_mem, flags);
  76         dprint(FD_MEM, "shmget %u, %d\n", total_mem, td->shm_id);
  77         if (td->shm_id < 0) {
  78                 td_verror(td, errno, "shmget");
  79                 if (geteuid() != 0 && (errno == ENOMEM || errno == EPERM))
  80                         log_err("fio: you may need to run this job as root\n");
  81                 if (td->o.mem_type == MEM_SHMHUGE) {
  82                         if (errno == EINVAL) {
  83                                 log_err("fio: check that you have free huge"
  84                                         " pages and that hugepage-size is"
  85                                         " correct.\n");
  86                         } else if (errno == ENOSYS) {
  87                                 log_err("fio: your system does not appear to"
  88                                         " support huge pages.\n");
  89                         } else if (errno == ENOMEM) {
  90                                 log_err("fio: no huge pages available, do you"
  91                                         " need to alocate some? See HOWTO.\n");
  92                         }
  93                 }
  94
  95                 return 1;
  96         }
  97
  98         td->orig_buffer = shmat(td->shm_id, NULL, 0);
  99         dprint(FD_MEM, "shmat %d, %p\n", td->shm_id, td->orig_buffer);
 100         if (td->orig_buffer == (void *) -1) {
 101                 td_verror(td, errno, "shmat");
 102                 td->orig_buffer = NULL;
 103                 return 1;
 104         }
 105
 106         return 0;
 107 }
 108
 109 static void free_mem_shm(struct thread_data *td)
 110 {
 111         struct shmid_ds sbuf;
 112
 113         dprint(FD_MEM, "shmdt/ctl %d %p\n", td->shm_id, td->orig_buffer);
 114         shmdt(td->orig_buffer);
 115         shmctl(td->shm_id, IPC_RMID, &sbuf);
 116 }
 117
 118 static int alloc_mem_mmap(struct thread_data *td, size_t total_mem)
 119 {
 120         int flags = MAP_PRIVATE;
 121
 122         td->mmapfd = 1;
 123
 124         if (td->o.mem_type == MEM_MMAPHUGE) {
 125                 unsigned long mask = td->o.hugepage_size - 1;
 126
 127                 flags |= MAP_HUGETLB;
 128                 total_mem = (total_mem + mask) & ~mask;
 129         }
 130
 131         if (td->o.mmapfile) {
 132                 td->mmapfd = open(td->o.mmapfile, O_RDWR|O_CREAT, 0644);
 133
 134                 if (td->mmapfd < 0) {
 135                         td_verror(td, errno, "open mmap file");
 136                         td->orig_buffer = NULL;
 137                         return 1;
 138                 }
 139                 if (ftruncate(td->mmapfd, total_mem) < 0) {
 140                         td_verror(td, errno, "truncate mmap file");
 141                         td->orig_buffer = NULL;
 142                         return 1;
 143                 }
 144         } else
 145                 flags |= OS_MAP_ANON;
 146
 147         td->orig_buffer = mmap(NULL, total_mem, PROT_READ | PROT_WRITE, flags,
 148                                 td->mmapfd, 0);
 149         dprint(FD_MEM, "mmap %u/%d %p\n", total_mem, td->mmapfd,
 150                                                 td->orig_buffer);
 151         if (td->orig_buffer == MAP_FAILED) {
 152                 td_verror(td, errno, "mmap");
 153                 td->orig_buffer = NULL;
 154                 if (td->mmapfd) {
 155                         close(td->mmapfd);
 156                         unlink(td->o.mmapfile);
 157                 }
 158
 159                 return 1;
 160         }
 161
 162         return 0;
 163 }
 164
 165 static void free_mem_mmap(struct thread_data *td, size_t total_mem)
 166 {
 167         dprint(FD_MEM, "munmap %u %p\n", total_mem, td->orig_buffer);
 168         munmap(td->orig_buffer, td->orig_buffer_size);
 169         if (td->o.mmapfile) {
 170                 close(td->mmapfd);
 171                 unlink(td->o.mmapfile);
 172                 free(td->o.mmapfile);
 173         }
 174 }
 175
 176 static int alloc_mem_malloc(struct thread_data *td, size_t total_mem)
 177 {
 178         td->orig_buffer = malloc(total_mem);
 179         dprint(FD_MEM, "malloc %u %p\n", total_mem, td->orig_buffer);
 180
 181         return td->orig_buffer == NULL;
 182 }
 183
 184 static void free_mem_malloc(struct thread_data *td)
 185 {
 186         dprint(FD_MEM, "free malloc mem %p\n", td->orig_buffer);
 187         free(td->orig_buffer);
 188 }
 189
 190 /*
 191  * Set up the buffer area we need for io.
 192  */
 193 int allocate_io_mem(struct thread_data *td)
 194 {
 195         size_t total_mem;
 196         int ret = 0;
 197
 198         if (td->io_ops->flags & FIO_NOIO)
 199                 return 0;
 200
 201         total_mem = td->orig_buffer_size;
 202
 203         if (td->o.odirect || td->o.mem_align ||
 204             (td->io_ops->flags & FIO_MEMALIGN)) {
 205                 total_mem += page_mask;
 206                 if (td->o.mem_align && td->o.mem_align > page_size)
 207                         total_mem += td->o.mem_align - page_size;
 208         }
 209
 210         dprint(FD_MEM, "Alloc %lu for buffers\n", (size_t) total_mem);
 211
 212         if (td->o.mem_type == MEM_MALLOC)
 213                 ret = alloc_mem_malloc(td, total_mem);
 214         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
 215                 ret = alloc_mem_shm(td, total_mem);
 216         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
 217                 ret = alloc_mem_mmap(td, total_mem);
 218         else {
 219                 log_err("fio: bad mem type: %d\n", td->o.mem_type);
 220                 ret = 1;
 221         }
 222
 223         if (ret)
 224                 td_verror(td, ENOMEM, "iomem allocation");
 225
 226         return ret;
 227 }
 228
 229 void free_io_mem(struct thread_data *td)
 230 {
 231         unsigned int total_mem;
 232
 233         total_mem = td->orig_buffer_size;
 234         if (td->o.odirect)
 235                 total_mem += page_mask;
 236
 237         if (td->o.mem_type == MEM_MALLOC)
 238                 free_mem_malloc(td);
 239         else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
 240                 free_mem_shm(td);
 241         else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
 242                 free_mem_mmap(td, total_mem);
 243         else
 244                 log_err("Bad memory type %u\n", td->o.mem_type);
 245
 246         td->orig_buffer = NULL;
 247         td->orig_buffer_size = 0;
 248 }