Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / smpi / internals / smpi_shared.cpp
index 6cc7757..a34d667 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-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 <map>
+#include <array>
 #include <cstring>
+#include <map>
 
 #include "private.hpp"
 #include "xbt/config.hpp"
+#include "xbt/file.hpp"
 
 #include <cerrno>
 
 #ifndef WIN32
 #include <sys/mman.h>
 #endif
-#include <cstdio>
-#include <fcntl.h>
-#include <sys/stat.h>
-
+#include <stdlib.h>
+#include <sys/types.h>
+#include <unistd.h>
+#include "smpi_utils.hpp"
 #ifndef MAP_ANONYMOUS
 #define MAP_ANONYMOUS MAP_ANON
 #endif
@@ -79,7 +81,7 @@ struct shared_data_t {
 };
 
 std::unordered_map<smpi_source_location, shared_data_t, std::hash<std::string>> allocs;
-typedef decltype(allocs)::value_type shared_data_key_type;
+using shared_data_key_type = decltype(allocs)::value_type;
 
 struct shared_metadata_t {
   size_t size;
@@ -90,16 +92,15 @@ struct shared_metadata_t {
 };
 
 std::map<const void*, shared_metadata_t> allocs_metadata;
-std::map<std::string, void*> calls;
+std::map<std::string, void*, std::less<>> calls;
 
 #ifndef WIN32
-static int smpi_shared_malloc_bogusfile           = -1;
-static int smpi_shared_malloc_bogusfile_huge_page  = -1;
-static unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
+int smpi_shared_malloc_bogusfile           = -1;
+int smpi_shared_malloc_bogusfile_huge_page = -1;
+unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
 #endif
 }
 
-
 void smpi_shared_destroy()
 {
   allocs.clear();
@@ -125,9 +126,8 @@ static void *smpi_shared_malloc_local(size_t size, const char *file, int line)
 {
   void* mem;
   smpi_source_location loc(file, line);
-  auto res = allocs.insert(std::make_pair(loc, shared_data_t()));
-  auto data = res.first;
-  if (res.second) {
+  auto [data, inserted] = allocs.try_emplace(loc);
+  if (inserted) {
     // The new element was inserted.
     int fd             = smpi_temp_shm_get();
     data->second.fd    = fd;
@@ -142,8 +142,8 @@ static void *smpi_shared_malloc_local(size_t size, const char *file, int line)
 }
 
 // Align functions, from http://stackoverflow.com/questions/4840410/how-to-align-a-pointer-in-c
-#define ALIGN_UP(n, align) ((((int64_t)n) + ((int64_t)align)-1) & -((int64_t)align))
-#define ALIGN_DOWN(n, align) (((int64_t)n) & -((int64_t)align))
+#define ALIGN_UP(n, align) (((int64_t)(n) + (int64_t)(align) - 1) & -(int64_t)(align))
+#define ALIGN_DOWN(n, align) ((int64_t)(n) & -(int64_t)(align))
 
 constexpr unsigned PAGE_SIZE      = 0x1000;
 constexpr unsigned HUGE_PAGE_SIZE = 1U << 21;
@@ -155,7 +155,7 @@ constexpr unsigned HUGE_PAGE_SIZE = 1U << 21;
  * The others are not.
  */
 
-void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int nb_shared_blocks)
+void* smpi_shared_malloc_partial(size_t size, const size_t* shared_block_offsets, int nb_shared_blocks)
 {
   std::string huge_page_mount_point = simgrid::config::get_value<std::string>("smpi/shared-malloc-hugepage");
   bool use_huge_page                = not huge_page_mount_point.empty();
@@ -178,7 +178,7 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
 
 
   /* First reserve memory area */
-  void* allocated_ptr = mmap(NULL, allocated_size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
+  void* allocated_ptr = mmap(nullptr, allocated_size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
 
   xbt_assert(allocated_ptr != MAP_FAILED, "Failed to allocate %zuMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
                                 "to allow big allocations.\n",
@@ -208,11 +208,8 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
     smpi_shared_malloc_bogusfile = mkstemp(name);
     XBT_DEBUG("bogusfile         : %s\n", name);
     unlink(name);
-    const char* dumb = new char[smpi_shared_malloc_blocksize](); // zero initialized
-    ssize_t err = write(smpi_shared_malloc_bogusfile, dumb, smpi_shared_malloc_blocksize);
-    if(err<0)
-      xbt_die("Could not write bogus file for shared malloc");
-    delete[] dumb;
+    xbt_assert(ftruncate(smpi_shared_malloc_bogusfile, smpi_shared_malloc_blocksize) == 0,
+               "Could not write bogus file for shared malloc");
   }
 
   int mmap_base_flag = MAP_FIXED | MAP_SHARED | MAP_POPULATE;
@@ -239,7 +236,7 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
     size_t stop_block_offset = ALIGN_DOWN(stop_offset, smpi_shared_malloc_blocksize);
     for (size_t offset = start_block_offset; offset < stop_block_offset; offset += smpi_shared_malloc_blocksize) {
       XBT_DEBUG("\t\tglobal shared allocation, mmap block offset %zx", offset);
-      void* pos = (void*)((unsigned long)mem + offset);
+      void* pos       = static_cast<char*>(mem) + offset;
       const void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, mmap_flag, huge_fd, 0);
       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
                              "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ? "
@@ -252,7 +249,7 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
     size_t low_page_stop_offset = (int64_t)start_block_offset < ALIGN_DOWN(stop_offset, PAGE_SIZE) ? start_block_offset : ALIGN_DOWN(stop_offset, PAGE_SIZE);
     if(low_page_start_offset < low_page_stop_offset) {
       XBT_DEBUG("\t\tglobal shared allocation, mmap block start");
-      void* pos = (void*)((unsigned long)mem + low_page_start_offset);
+      void* pos       = static_cast<char*>(mem) + low_page_start_offset;
       const void* res = mmap(pos, low_page_stop_offset - low_page_start_offset, PROT_READ | PROT_WRITE,
                              mmap_base_flag, // not a full huge page
                              smpi_shared_malloc_bogusfile, 0);
@@ -265,7 +262,7 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
       XBT_DEBUG("\t\tglobal shared allocation, mmap block stop");
       size_t high_page_stop_offset = stop_offset == size ? size : ALIGN_DOWN(stop_offset, PAGE_SIZE);
       if(high_page_stop_offset > stop_block_offset) {
-        void* pos = (void*)((unsigned long)mem + stop_block_offset);
+        void* pos       = static_cast<char*>(mem) + stop_block_offset;
         const void* res = mmap(pos, high_page_stop_offset - stop_block_offset, PROT_READ | PROT_WRITE,
                                mmap_base_flag, // not a full huge page
                                smpi_shared_malloc_bogusfile, 0);
@@ -279,7 +276,7 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
 
   shared_metadata_t newmeta;
   //register metadata for memcpy avoidance
-  shared_data_key_type* data = new shared_data_key_type;
+  auto* data             = new shared_data_key_type;
   data->second.fd = -1;
   data->second.count = 1;
   newmeta.size = size;
@@ -287,14 +284,14 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
   newmeta.allocated_ptr = allocated_ptr;
   newmeta.allocated_size = allocated_size;
   if(shared_block_offsets[0] > 0) {
-    newmeta.private_blocks.push_back(std::make_pair(0, shared_block_offsets[0]));
+    newmeta.private_blocks.emplace_back(0, shared_block_offsets[0]);
   }
   int i_block;
   for(i_block = 0; i_block < nb_shared_blocks-1; i_block ++) {
-    newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], shared_block_offsets[2*i_block+2]));
+    newmeta.private_blocks.emplace_back(shared_block_offsets[2 * i_block + 1], shared_block_offsets[2 * i_block + 2]);
   }
   if(shared_block_offsets[2*i_block+1] < size) {
-    newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], size));
+    newmeta.private_blocks.emplace_back(shared_block_offsets[2 * i_block + 1], size);
   }
   allocs_metadata[mem] = newmeta;
 
@@ -306,20 +303,57 @@ void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int
 
 void* smpi_shared_malloc_intercept(size_t size, const char* file, int line)
 {
-  if( smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh())
-    return ::operator new(size);
-  else
+  if( smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh()){
+    void* ptr = xbt_malloc(size);
+    if(not smpi_cfg_trace_call_use_absolute_path())
+      simgrid::smpi::utils::account_malloc_size(size, simgrid::xbt::Path(file).get_base_name(), line, ptr);
+    else
+      simgrid::smpi::utils::account_malloc_size(size, file, line, ptr);
+    return ptr;
+  } else {
+    simgrid::smpi::utils::account_shared_size(size);
     return smpi_shared_malloc(size, file, line);
+  }
 }
 
 void* smpi_shared_calloc_intercept(size_t num_elm, size_t elem_size, const char* file, int line)
 {
-  if( smpi_cfg_auto_shared_malloc_thresh() == 0 || elem_size*num_elm < smpi_cfg_auto_shared_malloc_thresh()){
-    void* ptr = ::operator new(elem_size*num_elm);
-    memset(ptr, 0, elem_size*num_elm);
+  size_t size = elem_size * num_elm;
+  if (smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh()) {
+    void* ptr = xbt_malloc0(size);
+    if(not smpi_cfg_trace_call_use_absolute_path())
+      simgrid::smpi::utils::account_malloc_size(size, simgrid::xbt::Path(file).get_base_name(), line, ptr);
+    else
+      simgrid::smpi::utils::account_malloc_size(size, file, line, ptr);
     return ptr;
-  } else
-    return smpi_shared_malloc(elem_size*num_elm, file, line);
+  } else {
+    simgrid::smpi::utils::account_shared_size(size);
+    return memset(smpi_shared_malloc(size, file, line), 0, size);
+  }
+}
+
+void* smpi_shared_realloc_intercept(void* data, size_t size, const char* file, int line)
+{
+  if (size == 0) {
+    smpi_shared_free(data);
+    return nullptr;
+  }
+  if (data == nullptr)
+    return smpi_shared_malloc_intercept(size, file, line);
+
+  auto meta = allocs_metadata.find(data);
+  if (meta == allocs_metadata.end()) {
+    XBT_DEBUG("Classical realloc(%p, %zu)", data, size);
+    return xbt_realloc(data, size);
+  }
+
+  XBT_DEBUG("Shared realloc(%p, %zu) (old size: %zu)", data, size, meta->second.size);
+  void* ptr = smpi_shared_malloc_intercept(size, file, line);
+  if (ptr != data) {
+    memcpy(ptr, data, std::min(size, meta->second.size));
+    smpi_shared_free(data);
+  }
+  return ptr;
 }
 
 void* smpi_shared_malloc(size_t size, const char* file, int line)
@@ -328,11 +362,11 @@ void* smpi_shared_malloc(size_t size, const char* file, int line)
     return smpi_shared_malloc_local(size, file, line);
   } else if (smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
     int nb_shared_blocks = 1;
-    size_t shared_block_offsets[2] = {0, size};
-    return smpi_shared_malloc_partial(size, shared_block_offsets, nb_shared_blocks);
+    const std::array<size_t, 2> shared_block_offsets = {{0, size}};
+    return smpi_shared_malloc_partial(size, shared_block_offsets.data(), nb_shared_blocks);
   }
   XBT_DEBUG("Classic allocation of %zu bytes", size);
-  return ::operator new(size);
+  return xbt_malloc(size);
 }
 
 int smpi_is_shared(const void* ptr, std::vector<std::pair<size_t, size_t>> &private_blocks, size_t *offset){
@@ -365,9 +399,9 @@ std::vector<std::pair<size_t, size_t>> shift_and_frame_private_blocks(const std:
                                                                       size_t offset, size_t buff_size)
 {
   std::vector<std::pair<size_t, size_t>> result;
-  for (auto const& block : vec) {
-    auto new_block = std::make_pair(std::min(std::max((size_t)0, block.first - offset), buff_size),
-                                    std::min(std::max((size_t)0, block.second - offset), buff_size));
+  for (auto const& [block_begin, block_end] : vec) {
+    auto new_block = std::make_pair(std::clamp(block_begin - offset, (size_t)0, buff_size),
+                                    std::clamp(block_end - offset, (size_t)0, buff_size));
     if (new_block.second > 0 && new_block.first < buff_size)
       result.push_back(new_block);
   }
@@ -403,10 +437,11 @@ std::vector<std::pair<size_t, size_t>> merge_private_blocks(const std::vector<st
 
 void smpi_shared_free(void *ptr)
 {
+  simgrid::smpi::utils::account_free(ptr);
   if (smpi_cfg_shared_malloc() == SharedMallocType::LOCAL) {
     auto meta = allocs_metadata.find(ptr);
     if (meta == allocs_metadata.end()) {
-      ::operator delete(ptr);
+      xbt_free(ptr);
       return;
     }
     shared_data_t* data = &meta->second.data->second;
@@ -417,7 +452,7 @@ void smpi_shared_free(void *ptr)
     if (data->count <= 0) {
       close(data->fd);
       allocs.erase(allocs.find(meta->second.data->first));
-      allocs_metadata.erase(ptr);
+      allocs_metadata.erase(meta);
       XBT_DEBUG("Shared free - Local - with removal - of %p", ptr);
     } else {
       XBT_DEBUG("Shared free - Local - no removal - of %p, count = %d", ptr, data->count);
@@ -431,16 +466,16 @@ void smpi_shared_free(void *ptr)
       munmap(ptr, meta->second.size);
       if(meta->second.data->second.count==0){
         delete meta->second.data;
-        allocs_metadata.erase(ptr);
+        allocs_metadata.erase(meta);
       }
     }else{
-      ::operator delete(ptr);
+      xbt_free(ptr);
       return;
     }
 
   } else {
     XBT_DEBUG("Classic deallocation of %p", ptr);
-    ::operator delete(ptr);
+    xbt_free(ptr);
   }
 }
 #endif