-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2008-2018. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include <cstdlib>
#include <cstdio>
+#include <cstdlib>
#include <cstring>
+#include <fstream>
+#include <iostream>
+#include <string>
#include <sys/types.h>
-#ifdef __linux__
+
+#if defined __APPLE__
+# include <mach/mach_init.h>
+# include <mach/mach_traps.h>
+# include <mach/mach_port.h>
+# include <mach/mach_vm.h>
# include <sys/mman.h>
+# include <sys/param.h>
+# include <libproc.h>
+# if __MAC_OS_X_VERSION_MIN_REQUIRED < 1050
+# define mach_vm_address_t vm_address_t
+# define mach_vm_size_t vm_size_t
+# if defined __ppc64__ || defined __x86_64__
+# define mach_vm_region vm_region64
+# else
+# define mach_vm_region vm_region
+# endif
+# endif
#endif
-#include <xbt/sysdep.h>
+#if defined __linux__
+# include <sys/mman.h>
+#endif
+
+#if defined __FreeBSD__
+# include <sys/types.h>
+# include <sys/mman.h>
+# include <sys/param.h>
+# include <sys/queue.h>
+# include <sys/socket.h>
+# include <sys/sysctl.h>
+# include <sys/user.h>
+# include <libprocstat.h>
+#endif
+
+#include <cinttypes>
#include <xbt/base.h>
-#include <xbt/file.h>
#include <xbt/log.h>
+#include <xbt/sysdep.h>
#include "memory_map.hpp"
-extern "C" {
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt, "Logging specific to algorithms for memory_map");
-}
namespace simgrid {
namespace xbt {
+/**
+ * \todo This function contains many cases that do not allow for a
+ * recovery. Currently, xbt_abort() is called but we should
+ * much rather die with the specific reason so that it's easier
+ * to find out what's going on.
+ */
XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
{
-#ifdef __linux__
- /* Open the actual process's proc maps file and create the memory_map_t */
- /* to be returned. */
- char* path = bprintf("/proc/%i/maps", (int) pid);
- FILE *fp = std::fopen(path, "r");
- if (fp == nullptr) {
- std::perror("fopen failed");
- xbt_die("Cannot open %s to investigate the memory map of the process.", path);
+ std::vector<VmMap> ret;
+#if defined __APPLE__
+ vm_map_t map;
+
+ /* Request authorization to read mappings */
+ if (task_for_pid(mach_task_self(), pid, &map) != KERN_SUCCESS) {
+ std::perror("task_for_pid failed");
+ xbt_die("Cannot request authorization for kernel information access");
}
- free(path);
- setbuf(fp, nullptr);
- std::vector<VmMap> ret;
+ /*
+ * Darwin do not give us the number of mappings, so we read entries until
+ * we get an KERN_INVALID_ADDRESS return.
+ */
+ mach_vm_address_t address = VM_MIN_ADDRESS;
+ while (true) {
+ kern_return_t kr;
+ memory_object_name_t object;
+ mach_vm_size_t size;
+#if defined __ppc64__ || defined __x86_64__
+ vm_region_flavor_t flavor = VM_REGION_BASIC_INFO_64;
+ struct vm_region_basic_info_64 info;
+ mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
+#else
+ vm_region_flavor_t flavor = VM_REGION_BASIC_INFO;
+ struct vm_region_basic_info info;
+ mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT;
+#endif
- /* Read one line at the time, parse it and add it to the memory map to be returned */
- ssize_t read; /* Number of bytes readed */
- char* line = nullptr;
- std::size_t n = 0; /* Amount of bytes to read by xbt_getline */
- while ((read = xbt_getline(&line, &n, fp)) != -1) {
+ kr =
+ mach_vm_region(
+ map,
+ &address,
+ &size,
+ flavor,
+ (vm_region_info_t)&info,
+ &info_count,
+ &object);
+ if (kr == KERN_INVALID_ADDRESS) {
+ break;
+ }
+ else if (kr != KERN_SUCCESS) {
+ std::perror("mach_vm_region failed");
+ xbt_die("Cannot request authorization for kernel information access");
+ }
+
+ VmMap memreg;
+
+ /* Addresses */
+ memreg.start_addr = address;
+ memreg.end_addr = address + size;
+
+ /* Permissions */
+ memreg.prot = PROT_NONE;
+ if (info.protection & VM_PROT_READ)
+ memreg.prot |= PROT_READ;
+ if (info.protection & VM_PROT_WRITE)
+ memreg.prot |= PROT_WRITE;
+ if (info.protection & VM_PROT_EXECUTE)
+ memreg.prot |= PROT_EXEC;
+
+ /* Private (copy-on-write) or shared? */
+ memreg.flags = 0;
+ if (info.shared)
+ memreg.flags |= MAP_SHARED;
+ else
+ memreg.flags |= MAP_PRIVATE;
- //fprintf(stderr,"%s", line);
+ /* Offset */
+ memreg.offset = info.offset;
- /* Wipeout the new line character */
- line[read - 1] = '\0';
+ /* Device : not sure this can be mapped to something outside of Linux? */
+ memreg.dev_major = 0;
+ memreg.dev_minor = 0;
- /* Tokenize the line using spaces as delimiters and store each token in lfields array. We expect 5 tokens/fields */
+ /* Inode */
+ memreg.inode = 0;
+
+ /* Path */
+ char path[MAXPATHLEN];
+ int pathlen;
+ pathlen = proc_regionfilename(pid, address, path, sizeof(path));
+ path[pathlen] = '\0';
+ memreg.pathname = path;
+
+ XBT_DEBUG("Region: %016" PRIx64 "-%016" PRIx64 " | %c%c%c | %s", memreg.start_addr, memreg.end_addr,
+ (memreg.prot & PROT_READ) ? 'r' : '-', (memreg.prot & PROT_WRITE) ? 'w' : '-',
+ (memreg.prot & PROT_EXEC) ? 'x' : '-', memreg.pathname.c_str());
+
+ ret.push_back(std::move(memreg));
+ address += size;
+ }
+
+ mach_port_deallocate(mach_task_self(), map);
+#elif defined __linux__
+ /* Open the actual process's proc maps file and create the memory_map_t */
+ /* to be returned. */
+ std::string path = std::string("/proc/") + std::to_string(pid) + "/maps";
+ std::ifstream fp;
+ fp.rdbuf()->pubsetbuf(0, 0);
+ fp.open(path);
+ if (not fp) {
+ std::perror("open failed");
+ xbt_die("Cannot open %s to investigate the memory map of the process.", path.c_str());
+ }
+
+ /* Read one line at the time, parse it and add it to the memory map to be returned */
+ std::string sline;
+ while (std::getline(fp, sline)) {
+ /**
+ * The lines that we read have this format: (This is just an example)
+ * 00602000-00603000 rw-p 00002000 00:28 1837264 <complete-path-to-file>
+ */
+ char* line = &sline[0];
+
+ /* Tokenize the line using spaces as delimiters and store each token in lfields array. We expect 5 tokens for 6 fields */
+ char* saveptr = nullptr; // for strtok_r()
char* lfields[6];
- lfields[0] = strtok(line, " ");
+ lfields[0] = strtok_r(line, " ", &saveptr);
int i;
for (i = 1; i < 6 && lfields[i - 1] != nullptr; i++) {
- lfields[i] = std::strtok(nullptr, " ");
+ lfields[i] = strtok_r(nullptr, " ", &saveptr);
}
/* Check to see if we got the expected amount of columns */
/* Ok we are good enough to try to get the info we need */
/* First get the start and the end address of the map */
- char *tok = std::strtok(lfields[0], "-");
+ char* tok = strtok_r(lfields[0], "-", &saveptr);
if (tok == nullptr)
xbt_die("Start and end address of the map are not concatenated by a hyphen (-). Recovery impossible.");
if (*endptr != '\0')
xbt_abort();
- tok = std::strtok(nullptr, "-");
+ tok = strtok_r(nullptr, "-", &saveptr);
if (tok == nullptr)
xbt_abort();
xbt_abort();
memreg.prot = 0;
-
for (i = 0; i < 3; i++){
switch(lfields[1][i]){
case 'r':
if (memreg.prot == 0)
memreg.prot |= PROT_NONE;
- if (lfields[1][4] == 'p')
+ memreg.flags = 0;
+ if (lfields[1][3] == 'p') {
memreg.flags |= MAP_PRIVATE;
- else if (lfields[1][4] == 's')
+ } else {
memreg.flags |= MAP_SHARED;
+ if (lfields[1][3] != 's')
+ XBT_WARN("The protection is neither 'p' (private) nor 's' (shared) but '%s'. Let's assume shared, as on b0rken "
+ "win-ubuntu systems.\nFull line: %s\n",
+ lfields[1], line);
+ }
/* Get the offset value */
memreg.offset = std::strtoull(lfields[2], &endptr, 16);
xbt_abort();
/* Get the device major:minor bytes */
- tok = std::strtok(lfields[3], ":");
+ tok = strtok_r(lfields[3], ":", &saveptr);
if (tok == nullptr)
xbt_abort();
if (*endptr != '\0')
xbt_abort();
- tok = std::strtok(nullptr, ":");
+ tok = strtok_r(nullptr, ":", &saveptr);
if (tok == nullptr)
xbt_abort();
/* Create space for a new map region in the region's array and copy the */
/* parsed stuff from the temporal memreg variable */
- XBT_DEBUG("Found region for %s", !memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
+ XBT_DEBUG("Found region for %s", not memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
ret.push_back(std::move(memreg));
}
- std::free(line);
- std::fclose(fp);
- return ret;
+ fp.close();
+#elif defined __FreeBSD__
+ struct procstat *prstat;
+ struct kinfo_proc *proc;
+ struct kinfo_vmentry *vmentries;
+ unsigned int cnt;
+
+ if ((prstat = procstat_open_sysctl()) == NULL) {
+ std::perror("procstat_open_sysctl failed");
+ xbt_die("Cannot access kernel state information");
+ }
+ if ((proc = procstat_getprocs(prstat, KERN_PROC_PID, pid, &cnt)) == NULL) {
+ std::perror("procstat_open_sysctl failed");
+ xbt_die("Cannot access process information");
+ }
+ if ((vmentries = procstat_getvmmap(prstat, proc, &cnt)) == NULL) {
+ std::perror("procstat_getvmmap failed");
+ xbt_die("Cannot access process memory mappings");
+ }
+ for (unsigned int i = 0; i < cnt; i++) {
+ VmMap memreg;
+
+ /* Addresses */
+ memreg.start_addr = vmentries[i].kve_start;
+ memreg.end_addr = vmentries[i].kve_end;
+
+ /* Permissions */
+ memreg.prot = PROT_NONE;
+ if (vmentries[i].kve_protection & KVME_PROT_READ)
+ memreg.prot |= PROT_READ;
+ if (vmentries[i].kve_protection & KVME_PROT_WRITE)
+ memreg.prot |= PROT_WRITE;
+ if (vmentries[i].kve_protection & KVME_PROT_EXEC)
+ memreg.prot |= PROT_EXEC;
+
+ /* Private (copy-on-write) or shared? */
+ memreg.flags = 0;
+ if (vmentries[i].kve_flags & KVME_FLAG_COW)
+ memreg.flags |= MAP_PRIVATE;
+ else
+ memreg.flags |= MAP_SHARED;
+
+ /* Offset */
+ memreg.offset = vmentries[i].kve_offset;
+
+ /* Device : not sure this can be mapped to something outside of Linux? */
+ memreg.dev_major = 0;
+ memreg.dev_minor = 0;
+
+ /* Inode */
+ memreg.inode = vmentries[i].kve_vn_fileid;
+
+ /*
+ * Path. Linuxize result by giving an anonymous mapping a path from
+ * the previous mapping, provided previous is vnode and has a path,
+ * and mark the stack.
+ */
+ if (vmentries[i].kve_path[0] != '\0')
+ memreg.pathname = vmentries[i].kve_path;
+ else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT && vmentries[i - 1].kve_type == KVME_TYPE_VNODE &&
+ vmentries[i - 1].kve_path[0] != '\0')
+ memreg.pathname = vmentries[i-1].kve_path;
+ else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT
+ && vmentries[i].kve_flags & KVME_FLAG_GROWS_DOWN)
+ memreg.pathname = "[stack]";
+
+ /*
+ * One last dirty modification: remove write permission from shared
+ * libraries private clean pages. This is necessary because simgrid
+ * later identifies mappings based on the permissions that are expected
+ * when running the Linux kernel.
+ */
+ if (vmentries[i].kve_type == KVME_TYPE_VNODE && not(vmentries[i].kve_flags & KVME_FLAG_NEEDS_COPY))
+ memreg.prot &= ~PROT_WRITE;
+
+ ret.push_back(std::move(memreg));
+ }
+ procstat_freevmmap(prstat, vmentries);
+ procstat_freeprocs(prstat, proc);
+ procstat_close(prstat);
#else
- /* On FreeBSD, kinfo_getvmmap() could be used but mmap() support is disabled anyway. */
xbt_die("Could not get memory map from process %lli", (long long int) pid);
#endif
+ return ret;
}
}
