Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
de198c33fbbdad93f11ef25728f7f4d593ec7b4e
[simgrid.git] / src / smpi / smpi_shared.cpp
1 /* Copyright (c) 2007, 2009-2017. The SimGrid Team. All rights reserved.    */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 /* Shared allocations are handled through shared memory segments.
7  * Associated data and metadata are used as follows:
8  *
9  *                                                                    mmap #1
10  *    `allocs' dict                                                     ---- -.
11  *    ----------      shared_data_t               shared_metadata_t   / |  |  |
12  * .->| <name> | ---> -------------------- <--.   -----------------   | |  |  |
13  * |  ----------      | fd of <name>     |    |   | size of mmap  | --| |  |  |
14  * |                  | count (2)        |    |-- | data          |   \ |  |  |
15  * `----------------- | <name>           |    |   -----------------     ----  |
16  *                    --------------------    |   ^                           |
17  *                                            |   |                           |
18  *                                            |   |   `allocs_metadata' dict  |
19  *                                            |   |   ----------------------  |
20  *                                            |   `-- | <addr of mmap #1>  |<-'
21  *                                            |   .-- | <addr of mmap #2>  |<-.
22  *                                            |   |   ----------------------  |
23  *                                            |   |                           |
24  *                                            |   |                           |
25  *                                            |   |                           |
26  *                                            |   |                   mmap #2 |
27  *                                            |   v                     ---- -'
28  *                                            |   shared_metadata_t   / |  |
29  *                                            |   -----------------   | |  |
30  *                                            |   | size of mmap  | --| |  |
31  *                                            `-- | data          |   | |  |
32  *                                                -----------------   | |  |
33  *                                                                    \ |  |
34  *                                                                      ----
35  */
36 #include <unordered_map>
37
38 #include "private.h"
39 #include "private.hpp"
40 #include "xbt/dict.h"
41 #include <errno.h>
42
43 #include <sys/types.h>
44 #ifndef WIN32
45 #include <sys/mman.h>
46 #endif
47 #include <sys/stat.h>
48 #include <fcntl.h>
49 #include <string.h>
50 #include <stdio.h>
51
52 #ifndef MAP_ANONYMOUS
53 #define MAP_ANONYMOUS MAP_ANON
54 #endif
55
56 #ifndef MAP_POPULATE
57 #define MAP_POPULATE 0
58 #endif
59
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_shared, smpi, "Logging specific to SMPI (shared memory macros)");
61
62 #define PTR_STRLEN (2 + 2 * sizeof(void*) + 1)
63
64 namespace{
65 /** Some location in the source code
66  *
67  *  This information is used by SMPI_SHARED_MALLOC to allocate  some shared memory for all simulated processes.
68  */
69
70 class smpi_source_location {
71 public:
72   smpi_source_location(const char* filename, int line)
73       : filename(xbt_strdup(filename)), filename_length(strlen(filename)), line(line)
74   {
75   }
76
77   /** Pointer to a static string containing the file name */
78   char* filename      = nullptr;
79   int filename_length = 0;
80   int line            = 0;
81
82   bool operator==(smpi_source_location const& that) const
83   {
84     return filename_length == that.filename_length && line == that.line &&
85            std::memcmp(filename, that.filename, filename_length) == 0;
86   }
87   bool operator!=(smpi_source_location const& that) const { return !(*this == that); }
88 };
89 }
90
91 namespace std {
92
93 template <> class hash<smpi_source_location> {
94 public:
95   typedef smpi_source_location argument_type;
96   typedef std::size_t result_type;
97   result_type operator()(smpi_source_location const& loc) const
98   {
99     return xbt_str_hash_ext(loc.filename, loc.filename_length) ^
100            xbt_str_hash_ext((const char*)&loc.line, sizeof(loc.line));
101   }
102 };
103 }
104
105 namespace{
106
107 typedef struct {
108   int fd    = -1;
109   int count = 0;
110 } shared_data_t;
111
112 std::unordered_map<smpi_source_location, shared_data_t> allocs;
113 typedef std::unordered_map<smpi_source_location, shared_data_t>::value_type shared_data_key_type;
114
115 typedef struct {
116   size_t size;
117   shared_data_key_type* data;
118 } shared_metadata_t;
119
120 std::unordered_map<void*, shared_metadata_t> allocs_metadata;
121 xbt_dict_t calls = nullptr;           /* Allocated on first use */
122 #ifndef WIN32
123 static int smpi_shared_malloc_bogusfile           = -1;
124 static unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
125 #endif
126 }
127
128
129 void smpi_shared_destroy()
130 {
131   allocs.clear();
132   allocs_metadata.clear();
133   xbt_dict_free(&calls);
134 }
135
136 static size_t shm_size(int fd) {
137   struct stat st;
138
139   if(fstat(fd, &st) < 0) {
140     xbt_die("Could not stat fd %d: %s", fd, strerror(errno));
141   }
142   return static_cast<size_t>(st.st_size);
143 }
144
145 #ifndef WIN32
146 static void* shm_map(int fd, size_t size, shared_data_key_type* data) {
147   char loc[PTR_STRLEN];
148   shared_metadata_t meta;
149
150   if(size > shm_size(fd) && (ftruncate(fd, static_cast<off_t>(size)) < 0)) {
151     xbt_die("Could not truncate fd %d to %zu: %s", fd, size, strerror(errno));
152   }
153
154   void* mem = mmap(nullptr, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
155   if(mem == MAP_FAILED) {
156     xbt_die(
157         "Failed to map fd %d with size %zu: %s\n"
158         "If you are running a lot of ranks, you may be exceeding the amount of mappings allowed per process.\n"
159         "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
160         "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
161         fd, size, strerror(errno));
162   }
163   snprintf(loc, PTR_STRLEN, "%p", mem);
164   meta.size = size;
165   meta.data = data;
166   allocs_metadata[mem] = meta;
167   XBT_DEBUG("MMAP %zu to %p", size, mem);
168   return mem;
169 }
170
171 void *smpi_shared_malloc(size_t size, const char *file, int line)
172 {
173   void* mem;
174   if (size > 0 && smpi_cfg_shared_malloc == shmalloc_local) {
175     smpi_source_location loc(file, line);
176     auto res = allocs.insert(std::make_pair(loc, shared_data_t()));
177     auto data = res.first;
178     if (res.second) {
179       // The insertion did not take place.
180       // Generate a shared memory name from the address of the shared_data:
181       char shmname[32]; // cannot be longer than PSHMNAMLEN = 31 on Mac OS X (shm_open raises ENAMETOOLONG otherwise)
182       snprintf(shmname, 31, "/shmalloc%p", &*data);
183       int fd = shm_open(shmname, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
184       if (fd < 0) {
185         if (errno == EEXIST)
186           xbt_die("Please cleanup /dev/shm/%s", shmname);
187         else
188           xbt_die("An unhandled error occurred while opening %s. shm_open: %s", shmname, strerror(errno));
189       }
190       data->second.fd = fd;
191       data->second.count = 1;
192       mem = shm_map(fd, size, &*data);
193       if (shm_unlink(shmname) < 0) {
194         XBT_WARN("Could not early unlink %s. shm_unlink: %s", shmname, strerror(errno));
195       }
196       XBT_DEBUG("Mapping %s at %p through %d", shmname, mem, fd);
197     } else {
198       mem = shm_map(data->second.fd, size, &*data);
199       data->second.count++;
200     }
201     XBT_DEBUG("Shared malloc %zu in %p (metadata at %p)", size, mem, &*data);
202
203   } else if (smpi_cfg_shared_malloc == shmalloc_global) {
204     /* First reserve memory area */
205     mem = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
206
207     xbt_assert(mem != MAP_FAILED, "Failed to allocate %luMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
208                                   "to allow big allocations.\n",
209                (unsigned long)(size >> 20));
210
211     /* Create bogus file if not done already */
212     if (smpi_shared_malloc_bogusfile == -1) {
213       /* Create a fd to a new file on disk, make it smpi_shared_malloc_blocksize big, and unlink it.
214        * It still exists in memory but not in the file system (thus it cannot be leaked). */
215       smpi_shared_malloc_blocksize = static_cast<unsigned long>(xbt_cfg_get_double("smpi/shared-malloc-blocksize"));
216       XBT_DEBUG("global shared allocation. Blocksize %lu", smpi_shared_malloc_blocksize);
217       char* name                   = xbt_strdup("/tmp/simgrid-shmalloc-XXXXXX");
218       smpi_shared_malloc_bogusfile = mkstemp(name);
219       unlink(name);
220       xbt_free(name);
221       char* dumb = (char*)calloc(1, smpi_shared_malloc_blocksize);
222       ssize_t err = write(smpi_shared_malloc_bogusfile, dumb, smpi_shared_malloc_blocksize);
223       if(err<0)
224         xbt_die("Could not write bogus file for shared malloc");
225       xbt_free(dumb);
226     }
227
228     /* Map the bogus file in place of the anonymous memory */
229     unsigned int i;
230     for (i = 0; i < size / smpi_shared_malloc_blocksize; i++) {
231       void* pos = (void*)((unsigned long)mem + i * smpi_shared_malloc_blocksize);
232       void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED | MAP_POPULATE,
233                        smpi_shared_malloc_bogusfile, 0);
234       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
235                              "size of the mapped file using --cfg=smpi/shared-malloc-blocksize=newvalue (default 1048576) ?"
236                              "You can also try using  the sysctl vm.max_map_count",
237                  strerror(errno));
238     }
239     if (size % smpi_shared_malloc_blocksize) {
240       void* pos = (void*)((unsigned long)mem + i * smpi_shared_malloc_blocksize);
241       void* res = mmap(pos, size % smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE,
242                        MAP_FIXED | MAP_SHARED | MAP_POPULATE, smpi_shared_malloc_bogusfile, 0);
243       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
244                              "size of the mapped file using --cfg=smpi/shared-malloc-blocksize=newvalue (default 1048576) ?"
245                              "You can also try using  the sysctl vm.max_map_count",
246                  strerror(errno));
247     }
248
249     shared_metadata_t newmeta;
250     //register metadata for memcpy avoidance
251     shared_data_key_type* data = (shared_data_key_type*)xbt_malloc(sizeof(shared_data_key_type));
252     data->second.fd = -1;
253     data->second.count = 1;
254     newmeta.size = size;
255     newmeta.data = data;
256     allocs_metadata[mem] = newmeta;
257   } else {
258     mem = xbt_malloc(size);
259     XBT_DEBUG("Classic malloc %zu in %p", size, mem);
260   }
261
262   return mem;
263 }
264
265 int smpi_is_shared(void*ptr){
266   if (allocs_metadata.empty())
267     return 0;
268   if ( smpi_cfg_shared_malloc == shmalloc_local || smpi_cfg_shared_malloc == shmalloc_global) {
269     if (allocs_metadata.count(ptr) != 0) 
270      return 1;
271     for(auto it : allocs_metadata){
272       if (ptr >= it.first && ptr < (char*)it.first + it.second.size)
273         return 1;
274     }
275       return 0;
276   } else {
277     return 0;
278   }
279 }
280
281 void smpi_shared_free(void *ptr)
282 {
283   if (smpi_cfg_shared_malloc == shmalloc_local) {
284     char loc[PTR_STRLEN];
285     snprintf(loc, PTR_STRLEN, "%p", ptr);
286     auto meta = allocs_metadata.find(ptr);
287     if (meta == allocs_metadata.end()) {
288       XBT_WARN("Cannot free: %p was not shared-allocated by SMPI - maybe its size was 0?", ptr);
289       return;
290     }
291     shared_data_t* data = &meta->second.data->second;
292     if (munmap(ptr, meta->second.size) < 0) {
293       XBT_WARN("Unmapping of fd %d failed: %s", data->fd, strerror(errno));
294     }
295     data->count--;
296     if (data->count <= 0) {
297       close(data->fd);
298       allocs.erase(allocs.find(meta->second.data->first));
299       allocs_metadata.erase(ptr);
300       XBT_DEBUG("Shared free - with removal - of %p", ptr);
301     } else {
302       XBT_DEBUG("Shared free - no removal - of %p, count = %d", ptr, data->count);
303     }
304
305   } else if (smpi_cfg_shared_malloc == shmalloc_global) {
306     auto meta = allocs_metadata.find(ptr);
307     if (meta != allocs_metadata.end()){
308       meta->second.data->second.count--;
309       if(meta->second.data->second.count==0)
310         xbt_free(meta->second.data);
311     }
312
313     munmap(ptr, 0); // the POSIX says that I should not give 0 as a length, but it seems to work OK
314   } else {
315     XBT_DEBUG("Classic free of %p", ptr);
316     xbt_free(ptr);
317   }
318 }
319 #endif
320
321 int smpi_shared_known_call(const char* func, const char* input)
322 {
323   char* loc = bprintf("%s:%s", func, input);
324   int known = 0;
325
326   if (calls==nullptr) {
327     calls = xbt_dict_new_homogeneous(nullptr);
328   }
329   try {
330     xbt_dict_get(calls, loc); /* Succeed or throw */
331     known = 1;
332     xbt_free(loc);
333   }
334   catch (xbt_ex& ex) {
335     xbt_free(loc);
336     if (ex.category != not_found_error)
337       throw;
338   }
339   catch(...) {
340     xbt_free(loc);
341     throw;
342   }
343   return known;
344 }
345
346 void* smpi_shared_get_call(const char* func, const char* input) {
347   char* loc = bprintf("%s:%s", func, input);
348
349   if (calls == nullptr)
350     calls    = xbt_dict_new_homogeneous(nullptr);
351   void* data = xbt_dict_get(calls, loc);
352   xbt_free(loc);
353   return data;
354 }
355
356 void* smpi_shared_set_call(const char* func, const char* input, void* data) {
357   char* loc = bprintf("%s:%s", func, input);
358
359   if (calls == nullptr)
360     calls = xbt_dict_new_homogeneous(nullptr);
361   xbt_dict_set(calls, loc, data, nullptr);
362   xbt_free(loc);
363   return data;
364 }
365