-/* Copyright (c) 2008-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2008-2023. 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 <array>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <sys/types.h>
#if defined __APPLE__
+# include <dlfcn.h>
# 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
# include <libprocstat.h>
#endif
-#include <xbt/sysdep.h>
-#include <xbt/base.h>
-#include <xbt/log.h>
+#include <cinttypes>
#include "memory_map.hpp"
-extern "C" {
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt, "Logging specific to algorithms for memory_map");
-}
+// abort with a message if `expr' is false
+#define CHECK(expr) \
+ if (not(expr)) { \
+ fprintf(stderr, "CHECK FAILED: %s:%d: %s\n", __FILE__, __LINE__, #expr); \
+ abort(); \
+ } else \
+ ((void)0)
+
+#define DEBUG_PRINT(...) \
+ if (false) { \
+ fprintf(stderr, __VA_ARGS__); \
+ } else \
+ ((void)0)
-namespace simgrid {
-namespace xbt {
+namespace simgrid::xbt {
/**
* \todo This function contains many cases that do not allow for a
- * recovery. Currently, xbt_abort() is called but we should
+ * recovery. Currently, 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)
+std::vector<VmMap> get_memory_map(pid_t pid)
{
std::vector<VmMap> ret;
#if defined __APPLE__
/* 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");
+ std::fprintf(stderr, "Cannot request authorization for kernel information access\n");
+ abort();
}
/*
* Darwin do not give us the number of mappings, so we read entries until
- * we get an KERN_INVALID_ADDRESS return.
+ * we get a KERN_INVALID_ADDRESS return.
*/
mach_vm_address_t address = VM_MIN_ADDRESS;
while (true) {
mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT;
#endif
- kr =
- mach_vm_region(
- map,
- &address,
- &size,
- flavor,
- (vm_region_info_t)&info,
- &info_count,
- &object);
+ 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) {
+
+ } else if (kr != KERN_SUCCESS) {
+ const char* name = nullptr;
+ switch (kr) { // https://github.com/apple/darwin-xnu/blob/main/bsd/kern/stackshot.c#L42
+ case KERN_SUCCESS:
+ name = "kr=KERN_SUCCESS";
+ break;
+ case KERN_RESOURCE_SHORTAGE:
+ name = "kr=KERN_RESOURCE_SHORTAGE (ENOMEM)";
+ break;
+ case KERN_INSUFFICIENT_BUFFER_SIZE:
+ name = "kr=KERN_INSUFFICIENT_BUFFER_SIZE (ENOSPC)";
+ break;
+ case KERN_NO_SPACE:
+ name = "kr=KERN_NO_SPACE (ENOSPC)";
+ break;
+ case KERN_NO_ACCESS:
+ name = "kr=KERN_NO_ACCESS (EPERM)";
+ break;
+ case KERN_MEMORY_PRESENT:
+ name = "kr=KERN_MEMORY_PRESENT (EEXIST)";
+ break;
+ case KERN_NOT_SUPPORTED:
+ name = "kr=KERN_NOT_SUPPORTED (ENOTSUP)";
+ break;
+ case KERN_NOT_IN_SET:
+ name = "kr=KERN_NOT_IN_SET (ENOENT)";
+ break;
+ case KERN_ABORTED:
+ name = "kr=KERN_ABORTED (EINTR)";
+ break;
+ case KERN_FAILURE:
+ name = "kr=KERN_FAILURE (EBUSY)";
+ break;
+ case KERN_OPERATION_TIMED_OUT:
+ name = "kr=KERN_OPERATION_TIMED_OUT (ETIMEDOUT)";
+ break;
+ default:
+ name = "kr=default case (EINVAL)";
+ }
std::perror("mach_vm_region failed");
- xbt_die("Cannot request authorization for kernel information access");
+ std::fprintf(stderr, "Cannot request authorization for kernel information access (kr=%d ; %s)\n", (int)kr, name);
+ abort();
}
VmMap memreg;
memreg.inode = 0;
/* Path */
- char path[MAXPATHLEN];
- int pathlen;
- pathlen = proc_regionfilename(pid, address, path, sizeof(path));
- path[pathlen] = '\0';
- memreg.pathname = path;
-
-#if 0 /* Display mappings for debug */
- fprintf(stderr,
- "%#014llx - %#014llx | %c%c%c | %s\n",
- 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());
-#endif
+ Dl_info dlinfo;
+ if (dladdr(reinterpret_cast<void*>(address), &dlinfo))
+ memreg.pathname = dlinfo.dli_fname;
+
+ DEBUG_PRINT("Region: %016" PRIx64 "-%016" PRIx64 " | %c%c%c | %s\n", 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;
#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::string path = "/proc/" + std::to_string(pid) + "/maps";
std::ifstream fp;
- fp.rdbuf()->pubsetbuf(0, 0);
+ fp.rdbuf()->pubsetbuf(nullptr, 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());
+ std::fprintf(stderr, "Cannot open %s to investigate the memory map of the process.\n", path.c_str());
+ abort();
}
/* Read one line at the time, parse it and add it to the memory map to be returned */
/* 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];
+ std::array<char*, 6> lfields;
lfields[0] = strtok_r(line, " ", &saveptr);
int i;
}
/* Check to see if we got the expected amount of columns */
- if (i < 6)
- xbt_die("The memory map apparently only supplied less than 6 columns. Recovery impossible.");
+ if (i < 6) {
+ std::fprintf(stderr, "The memory map apparently only supplied less than 6 columns. Recovery impossible.\n");
+ abort();
+ }
/* 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 = 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.");
+ const char* tok = strtok_r(lfields[0], "-", &saveptr);
+ if (tok == nullptr) {
+ std::fprintf(stderr,
+ "Start and end address of the map are not concatenated by a hyphen (-). Recovery impossible.\n");
+ abort();
+ }
VmMap memreg;
char *endptr;
memreg.start_addr = std::strtoull(tok, &endptr, 16);
/* Make sure that the entire string was an hex number */
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
tok = strtok_r(nullptr, "-", &saveptr);
- if (tok == nullptr)
- xbt_abort();
+ CHECK(tok != nullptr);
memreg.end_addr = std::strtoull(tok, &endptr, 16);
/* Make sure that the entire string was an hex number */
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
/* Get the permissions flags */
- if (std::strlen(lfields[1]) < 4)
- xbt_abort();
+ CHECK(std::strlen(lfields[1]) >= 4);
memreg.prot = 0;
for (i = 0; i < 3; i++){
} 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);
+ fprintf(stderr,
+ "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);
/* Make sure that the entire string was an hex number */
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
/* Get the device major:minor bytes */
tok = strtok_r(lfields[3], ":", &saveptr);
- if (tok == nullptr)
- xbt_abort();
+ CHECK(tok != nullptr);
memreg.dev_major = (char) strtoul(tok, &endptr, 16);
/* Make sure that the entire string was an hex number */
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
tok = strtok_r(nullptr, ":", &saveptr);
- if (tok == nullptr)
- xbt_abort();
+ CHECK(tok != nullptr);
memreg.dev_minor = (char) std::strtoul(tok, &endptr, 16);
/* Make sure that the entire string was an hex number */
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
/* Get the inode number and make sure that the entire string was a long int */
memreg.inode = strtoul(lfields[4], &endptr, 10);
- if (*endptr != '\0')
- xbt_abort();
+ CHECK(*endptr == '\0');
/* And finally get the pathname */
if (lfields[5])
/* 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", not memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
+ DEBUG_PRINT("Found region for \"%s\"\n", memreg.pathname.c_str());
ret.push_back(std::move(memreg));
}
if ((prstat = procstat_open_sysctl()) == NULL) {
std::perror("procstat_open_sysctl failed");
- xbt_die("Cannot access kernel state information");
+ std::fprintf(stderr, "Cannot access kernel state information\n");
+ abort();
}
if ((proc = procstat_getprocs(prstat, KERN_PROC_PID, pid, &cnt)) == NULL) {
std::perror("procstat_open_sysctl failed");
- xbt_die("Cannot access process information");
+ std::fprintf(stderr, "Cannot access process information\n");
+ abort();
}
if ((vmentries = procstat_getvmmap(prstat, proc, &cnt)) == NULL) {
std::perror("procstat_getvmmap failed");
- xbt_die("Cannot access process memory mappings");
+ std::fprintf(stderr, "Cannot access process memory mappings\n");
+ abort();
}
for (unsigned int i = 0; i < cnt; i++) {
VmMap memreg;
procstat_freeprocs(prstat, proc);
procstat_close(prstat);
#else
- xbt_die("Could not get memory map from process %lli", (long long int) pid);
+ std::fprintf(stderr, "Could not get memory map from process %lli\n", (long long int)pid);
+ abort();
#endif
return ret;
}
-}
-}
+} // namespace simgrid::xbt
