MallocOpts.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     Utilities
// Class  :     MallocOpts
//
// Original Author:  Jim Kowalkowski
//
// ------------------ resetting malloc options -----------------------

#include "FWCore/Utilities/interface/MallocOpts.h"

#if !defined(__APPLE__)
#include <malloc.h>
#endif
#include <sstream>
#include <iostream>
#include <cstdlib>
#include <cstring>

namespace edm {

  std::ostream& operator<<(std::ostream& ost, const MallocOpts& opts) {
    ost << "mmap_max=" << opts.mmap_max_ << " trim_threshold=" << opts.trim_thr_ << " top_padding=" << opts.top_pad_
        << " mmap_threshold=" << opts.mmap_thr_;
    return ost;
  }

  namespace {
    typedef enum { UNKNOWN_CPU = 0, AMD_CPU = 1, INTEL_CPU = 2 } cpu_type;

    cpu_type get_cpu_type() {
      // issue: these need to be static.  The asm instruction combined
      // with optimization on the 64 bit platform moves the stack data
      // member around in such a way that the =m directive misses the
      // the location.   Of course this means that this routine is not
      // multithread safe.
      static volatile int ans[4];
#if defined(__i386__) || defined(__x86_64__)
      static volatile int op = 0, a;
#endif

// Still some problem on x86_64, so only i386 for now
#if defined(__x86_64__)

      __asm__ __volatile__(
          "pushq %%rdx;\
 pushq %%rcx;                \
 pushq %%rsi;                \
 pushq %%rbx;                \
 cpuid;                  \
 movq  %%rbx,%%rsi;          \
 popq  %%rbx;                \
 movl  %%ecx,%0;             \
 movl  %%edx,%1;             \
 movl  %%esi,%2;             \
 movl  %%eax,%3;             \
 popq  %%rsi;                \
 popq  %%rcx;                \
 popq  %%rdx;"
          : "=m"(ans[2]), "=m"(ans[1]), "=m"(ans[0]), "=m"(a)
          : "a"(op));

#elif defined(__i386__)

      __asm__ __volatile__(
          "pushl %%edx;\
 pushl %%ecx;                \
 pushl %%esi;                \
 pushl %%ebx;                \
 cpuid;                  \
 movl  %%ebx,%%esi;          \
 popl  %%ebx;                \
 movl  %%ecx,%0;             \
 movl  %%edx,%1;             \
 movl  %%esi,%2;             \
 movl  %%eax,%3;             \
 popl  %%esi;                \
 popl  %%ecx;                \
 popl  %%edx;"
          : "=m"(ans[2]), "=m"(ans[1]), "=m"(ans[0]), "=m"(a)
          : "a"(op));

#else
      const char* unknown_str = "Unknown";
      // int unknown_sz = strlen(unknown_str);
      strcpy((char*)&ans[0], unknown_str);
#endif

      const char* amd_str = "AuthenticAMD";
      int amd_sz = strlen(amd_str);
      const char* intel_str = "GenuineIntel";
      int intel_sz = strlen(intel_str);

      char* str = (char*)&ans[0];
      ans[3] = 0;

      return strncmp(str, amd_str, amd_sz) == 0       ? AMD_CPU
             : strncmp(str, intel_str, intel_sz) == 0 ? INTEL_CPU
                                                      : UNKNOWN_CPU;
    }

    // values determined experimentally for each architecture
    const MallocOpts intel_opts(262144, 524288, 5242880, 131072);
    const MallocOpts amd_opts(0, 8388608, 131072, 10485760);

  }  // namespace

  bool MallocOptionSetter::retrieveFromCpuType() {
    bool rc = true;

    switch (get_cpu_type()) {
      case AMD_CPU: {
        values_ = amd_opts;
        changed_ = true;
        break;
      }
      case INTEL_CPU: {
        values_ = intel_opts;
        changed_ = true;
        break;
      }
      case UNKNOWN_CPU:
      default:
        rc = false;
    }

    return rc;
  }

  MallocOptionSetter::MallocOptionSetter() : changed_(false) {
    if (retrieveFromEnv() || retrieveFromCpuType()) {
      adjustMallocParams();
      if (hasErrors()) {
        std::cerr << "ERROR: Reset of malloc options has fails:\n" << error_message_ << "\n";
      }
    }
  }

  void MallocOptionSetter::adjustMallocParams() {
    if (changed_ == false)
      return;  // only adjust if they changed
    error_message_.clear();
    changed_ = false;

#ifndef __SANITIZE_ADDRESS__
#ifdef M_MMAP_MAX
    if (mallopt(M_MMAP_MAX, values_.mmap_max_) < 0)
      error_message_ += "Could not set M_MMAP_MAX\n";
#endif
#ifdef M_TRIM_THRESHOLD
    if (mallopt(M_TRIM_THRESHOLD, values_.trim_thr_) < 0)
      error_message_ += "Could not set M_TRIM_THRESHOLD\n";
#endif
#ifdef M_TOP_PAD
    if (mallopt(M_TOP_PAD, values_.top_pad_) < 0)
      error_message_ += "ERROR: Could not set M_TOP_PAD\n";
#endif
#ifdef M_MMAP_THRESHOLD
    if (mallopt(M_MMAP_THRESHOLD, values_.mmap_thr_) < 0)
      error_message_ += "ERROR: Could not set M_MMAP_THRESHOLD\n";
#endif
#endif
  }

  bool MallocOptionSetter::retrieveFromEnv() {
    const char* par = std::getenv("CMSRUN_MALLOC_RESET");
    if (par == nullptr)
      return false;  // leave quickly here
    std::string spar(par);
    bool rc = false;

    // CMSRUN_MALLOC_RESET = "mmap_max trim_thres top_pad mmap_thres"

    if (spar.size() > 1) {
      std::istringstream ist(spar);
      ist >> values_.mmap_max_ >> values_.trim_thr_ >> values_.top_pad_ >> values_.mmap_thr_;

      if (ist.bad()) {
        std::cerr << "bad malloc options in CMSRUN_MALLOC_RESET: " << spar << "\n"
                  << "format is: "
                  << "CMSRUN_MALLOC_RESET=\"mmap_max trim_thres top_pad mmap_thres\"\n";
      } else {
        std::cout << "MALLOC_OPTIONS> Reset options: "
                  << "CMSRUN_MALLOC_RESET=" << par << "\n";
      }
      rc = true;
      changed_ = true;
    }

    return rc;
  }

  MallocOptionSetter global_malloc_options;

  MallocOptionSetter& getGlobalOptionSetter() { return global_malloc_options; }

  // ----------------------------------------------------------------
}  // namespace edm