1 /* Copyright (c) 2008-2017. The SimGrid Team. All rights reserved. */
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. */
10 #include <sys/types.h>
13 # include <mach/mach_init.h>
14 # include <mach/mach_traps.h>
15 # include <mach/mach_port.h>
16 # include <mach/mach_vm.h>
17 # include <sys/mman.h>
18 # include <sys/param.h>
20 # if __MAC_OS_X_VERSION_MIN_REQUIRED < 1050
21 # define mach_vm_address_t vm_address_t
22 # define mach_vm_size_t vm_size_t
23 # if defined __ppc64__ || defined __x86_64__
24 # define mach_vm_region vm_region64
26 # define mach_vm_region vm_region
32 # include <sys/mman.h>
35 #if defined __FreeBSD__
36 # include <sys/types.h>
37 # include <sys/mman.h>
38 # include <sys/param.h>
39 # include <sys/queue.h>
40 # include <sys/socket.h>
41 # include <sys/sysctl.h>
42 # include <sys/user.h>
43 # include <libprocstat.h>
46 #include <xbt/sysdep.h>
51 #include "memory_map.hpp"
54 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt, "Logging specific to algorithms for memory_map");
61 * \todo This function contains many cases that do not allow for a
62 * recovery. Currently, xbt_abort() is called but we should
63 * much rather die with the specific reason so that it's easier
64 * to find out what's going on.
66 XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
68 std::vector<VmMap> ret;
72 /* Request authorization to read mappings */
73 if (task_for_pid(mach_task_self(), pid, &map) != KERN_SUCCESS) {
74 std::perror("task_for_pid failed");
75 xbt_die("Cannot request authorization for kernel information access");
79 * Darwin do not give us the number of mappings, so we read entries until
80 * we get an KERN_INVALID_ADDRESS return.
82 mach_vm_address_t address = VM_MIN_ADDRESS;
85 memory_object_name_t object;
87 #if defined __ppc64__ || defined __x86_64__
88 vm_region_flavor_t flavor = VM_REGION_BASIC_INFO_64;
89 struct vm_region_basic_info_64 info;
90 mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
92 vm_region_flavor_t flavor = VM_REGION_BASIC_INFO;
93 struct vm_region_basic_info info;
94 mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT;
103 (vm_region_info_t)&info,
106 if (kr == KERN_INVALID_ADDRESS) {
109 else if (kr != KERN_SUCCESS) {
110 std::perror("mach_vm_region failed");
111 xbt_die("Cannot request authorization for kernel information access");
117 memreg.start_addr = address;
118 memreg.end_addr = address + size;
121 memreg.prot = PROT_NONE;
122 if (info.protection & VM_PROT_READ)
123 memreg.prot |= PROT_READ;
124 if (info.protection & VM_PROT_WRITE)
125 memreg.prot |= PROT_WRITE;
126 if (info.protection & VM_PROT_EXECUTE)
127 memreg.prot |= PROT_EXEC;
129 /* Private (copy-on-write) or shared? */
132 memreg.flags |= MAP_SHARED;
134 memreg.flags |= MAP_PRIVATE;
137 memreg.offset = info.offset;
139 /* Device : not sure this can be mapped to something outside of Linux? */
140 memreg.dev_major = 0;
141 memreg.dev_minor = 0;
147 char path[MAXPATHLEN];
149 pathlen = proc_regionfilename(pid, address, path, sizeof(path));
150 path[pathlen] = '\0';
151 memreg.pathname = path;
153 #if 0 /* Display mappings for debug */
155 "%#014llx - %#014llx | %c%c%c | %s\n",
156 memreg.start_addr, memreg.end_addr,
157 (memreg.prot & PROT_READ) ? 'r' : '-',
158 (memreg.prot & PROT_WRITE) ? 'w' : '-',
159 (memreg.prot & PROT_EXEC) ? 'x' : '-',
160 memreg.pathname.c_str());
163 ret.push_back(std::move(memreg));
167 mach_port_deallocate(mach_task_self(), map);
168 #elif defined __linux__
169 /* Open the actual process's proc maps file and create the memory_map_t */
170 /* to be returned. */
171 char* path = bprintf("/proc/%i/maps", (int) pid);
172 FILE *fp = std::fopen(path, "r");
174 std::perror("fopen failed");
175 xbt_die("Cannot open %s to investigate the memory map of the process.", path);
180 /* Read one line at the time, parse it and add it to the memory map to be returned */
181 ssize_t read; /* Number of bytes readed */
182 char* line = nullptr;
183 std::size_t n = 0; /* Amount of bytes to read by xbt_getline */
184 while ((read = xbt_getline(&line, &n, fp)) != -1) {
186 * The lines that we read have this format: (This is just an example)
187 * 00602000-00603000 rw-p 00002000 00:28 1837264 <complete-path-to-file>
190 //fprintf(stderr,"%s", line);
192 /* Wipeout the new line character */
193 line[read - 1] = '\0';
195 /* Tokenize the line using spaces as delimiters and store each token in lfields array. We expect 5 tokens for 6 fields */
196 char* saveptr = nullptr; // for strtok_r()
198 lfields[0] = strtok_r(line, " ", &saveptr);
201 for (i = 1; i < 6 && lfields[i - 1] != nullptr; i++) {
202 lfields[i] = strtok_r(nullptr, " ", &saveptr);
205 /* Check to see if we got the expected amount of columns */
207 xbt_die("The memory map apparently only supplied less than 6 columns. Recovery impossible.");
209 /* Ok we are good enough to try to get the info we need */
210 /* First get the start and the end address of the map */
211 char* tok = strtok_r(lfields[0], "-", &saveptr);
213 xbt_die("Start and end address of the map are not concatenated by a hyphen (-). Recovery impossible.");
217 memreg.start_addr = std::strtoull(tok, &endptr, 16);
218 /* Make sure that the entire string was an hex number */
222 tok = strtok_r(nullptr, "-", &saveptr);
226 memreg.end_addr = std::strtoull(tok, &endptr, 16);
227 /* Make sure that the entire string was an hex number */
231 /* Get the permissions flags */
232 if (std::strlen(lfields[1]) < 4)
236 for (i = 0; i < 3; i++){
237 switch(lfields[1][i]){
239 memreg.prot |= PROT_READ;
242 memreg.prot |= PROT_WRITE;
245 memreg.prot |= PROT_EXEC;
251 if (memreg.prot == 0)
252 memreg.prot |= PROT_NONE;
255 if (lfields[1][3] == 'p') {
256 memreg.flags |= MAP_PRIVATE;
258 memreg.flags |= MAP_SHARED;
259 if (lfields[1][3] != 's')
260 XBT_WARN("The protection is neither 'p' (private) nor 's' (shared) but '%s'. Let's assume shared, as on b0rken "
261 "win-ubuntu systems.\nFull line: %s\n",
265 /* Get the offset value */
266 memreg.offset = std::strtoull(lfields[2], &endptr, 16);
267 /* Make sure that the entire string was an hex number */
271 /* Get the device major:minor bytes */
272 tok = strtok_r(lfields[3], ":", &saveptr);
276 memreg.dev_major = (char) strtoul(tok, &endptr, 16);
277 /* Make sure that the entire string was an hex number */
281 tok = strtok_r(nullptr, ":", &saveptr);
285 memreg.dev_minor = (char) std::strtoul(tok, &endptr, 16);
286 /* Make sure that the entire string was an hex number */
290 /* Get the inode number and make sure that the entire string was a long int */
291 memreg.inode = strtoul(lfields[4], &endptr, 10);
295 /* And finally get the pathname */
297 memreg.pathname = lfields[5];
299 /* Create space for a new map region in the region's array and copy the */
300 /* parsed stuff from the temporal memreg variable */
301 XBT_DEBUG("Found region for %s", not memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
303 ret.push_back(std::move(memreg));
308 #elif defined __FreeBSD__
309 struct procstat *prstat;
310 struct kinfo_proc *proc;
311 struct kinfo_vmentry *vmentries;
314 if ((prstat = procstat_open_sysctl()) == NULL) {
315 std::perror("procstat_open_sysctl failed");
316 xbt_die("Cannot access kernel state information");
318 if ((proc = procstat_getprocs(prstat, KERN_PROC_PID, pid, &cnt)) == NULL) {
319 std::perror("procstat_open_sysctl failed");
320 xbt_die("Cannot access process information");
322 if ((vmentries = procstat_getvmmap(prstat, proc, &cnt)) == NULL) {
323 std::perror("procstat_getvmmap failed");
324 xbt_die("Cannot access process memory mappings");
326 for (unsigned int i = 0; i < cnt; i++) {
330 memreg.start_addr = vmentries[i].kve_start;
331 memreg.end_addr = vmentries[i].kve_end;
334 memreg.prot = PROT_NONE;
335 if (vmentries[i].kve_protection & KVME_PROT_READ)
336 memreg.prot |= PROT_READ;
337 if (vmentries[i].kve_protection & KVME_PROT_WRITE)
338 memreg.prot |= PROT_WRITE;
339 if (vmentries[i].kve_protection & KVME_PROT_EXEC)
340 memreg.prot |= PROT_EXEC;
342 /* Private (copy-on-write) or shared? */
344 if (vmentries[i].kve_flags & KVME_FLAG_COW)
345 memreg.flags |= MAP_PRIVATE;
347 memreg.flags |= MAP_SHARED;
350 memreg.offset = vmentries[i].kve_offset;
352 /* Device : not sure this can be mapped to something outside of Linux? */
353 memreg.dev_major = 0;
354 memreg.dev_minor = 0;
357 memreg.inode = vmentries[i].kve_vn_fileid;
360 * Path. Linuxize result by giving an anonymous mapping a path from
361 * the previous mapping, provided previous is vnode and has a path,
362 * and mark the stack.
364 if (vmentries[i].kve_path[0] != '\0')
365 memreg.pathname = vmentries[i].kve_path;
366 else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT && vmentries[i - 1].kve_type == KVME_TYPE_VNODE &&
367 vmentries[i - 1].kve_path[0] != '\0')
368 memreg.pathname = vmentries[i-1].kve_path;
369 else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT
370 && vmentries[i].kve_flags & KVME_FLAG_GROWS_DOWN)
371 memreg.pathname = "[stack]";
374 * One last dirty modification: remove write permission from shared
375 * libraries private clean pages. This is necessary because simgrid
376 * later identifies mappings based on the permissions that are expected
377 * when running the Linux kernel.
379 if (vmentries[i].kve_type == KVME_TYPE_VNODE && not(vmentries[i].kve_flags & KVME_FLAG_NEEDS_COPY))
380 memreg.prot &= ~PROT_WRITE;
382 ret.push_back(std::move(memreg));
384 procstat_freevmmap(prstat, vmentries);
385 procstat_freeprocs(prstat, proc);
386 procstat_close(prstat);
388 xbt_die("Could not get memory map from process %lli", (long long int) pid);