mimalloc-sys 0.1.4

/* ----------------------------------------------------------------------------
Copyright (c) 2018, Microsoft Research, Daan Leijen
This is free software; you can redistribute it and/or modify it under the
terms of the MIT license. A copy of the license can be found in the file
"LICENSE" at the root of this distribution.
-----------------------------------------------------------------------------*/
#include "mimalloc.h"
#include "mimalloc-internal.h"
#include "mimalloc-atomic.h"

#include <string.h> // memset


/* -----------------------------------------------------------
  Merge thread statistics with the main one.
----------------------------------------------------------- */

static void mi_stats_add(mi_stats_t* stats, const mi_stats_t* src);

void _mi_stats_done(mi_stats_t* stats) {
  if (stats == &_mi_stats_main) return;
  mi_stats_add(&_mi_stats_main, stats);
  memset(stats,0,sizeof(*stats));
}


/* -----------------------------------------------------------
  Statistics operations
----------------------------------------------------------- */

static void mi_stat_update(mi_stat_count_t* stat, int64_t amount) {
  if (amount == 0) return;
  bool in_main = ((uint8_t*)stat >= (uint8_t*)&_mi_stats_main
                  && (uint8_t*)stat < ((uint8_t*)&_mi_stats_main + sizeof(mi_stats_t)));
  if (in_main)
  {
    // add atomically (for abandoned pages)
    int64_t current = mi_atomic_add(&stat->current,amount);
    if (current > stat->peak) stat->peak = stat->current;  // racing.. it's ok
    if (amount > 0) {
      mi_atomic_add(&stat->allocated,amount);
    }
    else {
      mi_atomic_add(&stat->freed, -amount);
    }
  }
  else {
    // add thread local
    stat->current += amount;
    if (stat->current > stat->peak) stat->peak = stat->current;
    if (amount > 0) {
      stat->allocated += amount;
    }
    else {
      stat->freed += -amount;
    }
  }
}

void _mi_stat_counter_increase(mi_stat_counter_t* stat, size_t amount) {  
  mi_atomic_add( &stat->count, 1 );
  mi_atomic_add( &stat->total, (int64_t)amount );
}


void _mi_stat_increase(mi_stat_count_t* stat, size_t amount) {
  mi_stat_update(stat, (int64_t)amount);
}

void _mi_stat_decrease(mi_stat_count_t* stat, size_t amount) {
  mi_stat_update(stat, -((int64_t)amount));
}

// must be thread safe as it is called from stats_merge
static void mi_stat_add(mi_stat_count_t* stat, const mi_stat_count_t* src, int64_t unit) {
  if (stat==src) return;
  mi_atomic_add( &stat->allocated, src->allocated * unit);
  mi_atomic_add( &stat->current, src->current * unit);
  mi_atomic_add( &stat->freed, src->freed * unit);
  mi_atomic_add( &stat->peak, src->peak * unit);
}

static void mi_stat_counter_add(mi_stat_counter_t* stat, const mi_stat_counter_t* src, int64_t unit) {
  if (stat==src) return;
  mi_atomic_add( &stat->total, src->total * unit);
  mi_atomic_add( &stat->count, src->count * unit);
}

// must be thread safe as it is called from stats_merge
static void mi_stats_add(mi_stats_t* stats, const mi_stats_t* src) {
  if (stats==src) return;
  mi_stat_add(&stats->segments, &src->segments,1);
  mi_stat_add(&stats->pages, &src->pages,1);
  mi_stat_add(&stats->reserved, &src->reserved, 1);
  mi_stat_add(&stats->committed, &src->committed, 1);
  mi_stat_add(&stats->reset, &src->reset, 1);

  mi_stat_add(&stats->pages_abandoned, &src->pages_abandoned, 1);
  mi_stat_add(&stats->segments_abandoned, &src->segments_abandoned, 1);
  mi_stat_add(&stats->mmap_calls, &src->mmap_calls, 1);
  mi_stat_add(&stats->mmap_ensure_aligned, &src->mmap_ensure_aligned, 1);
  mi_stat_add(&stats->mmap_right_align, &src->mmap_right_align, 1);
  mi_stat_add(&stats->threads, &src->threads, 1);
  mi_stat_add(&stats->pages_extended, &src->pages_extended, 1);

  mi_stat_add(&stats->malloc, &src->malloc, 1);
  mi_stat_add(&stats->huge, &src->huge, 1);
  mi_stat_counter_add(&stats->searches, &src->searches, 1);
#if MI_STAT>1
  for (size_t i = 0; i <= MI_BIN_HUGE; i++) {
    if (src->normal[i].allocated > 0 || src->normal[i].freed > 0) {
      mi_stat_add(&stats->normal[i], &src->normal[i], 1);
    }
  }
#endif
}

/* -----------------------------------------------------------
  Display statistics
----------------------------------------------------------- */

static void mi_printf_amount(int64_t n, int64_t unit, FILE* out, const char* fmt) {
  char buf[32];
  int  len = 32;
  const char* suffix = (unit <= 0 ? " " : "b");
  double base = (unit == 0 ? 1000.0 : 1024.0);
  if (unit>0) n *= unit;

  double pos = (double)(n < 0 ? -n : n);
  if (pos < base)
    snprintf(buf,len, "%d %s ", (int)n, suffix);
  else if (pos < base*base)
    snprintf(buf, len, "%.1f k%s", (double)n / base, suffix);
  else if (pos < base*base*base)
    snprintf(buf, len, "%.1f m%s", (double)n / (base*base), suffix);
  else
    snprintf(buf, len, "%.1f g%s", (double)n / (base*base*base), suffix);

  _mi_fprintf(out, (fmt==NULL ? "%11s" : fmt), buf);
}

#if MI_STAT>0
static void mi_print_amount(int64_t n, int64_t unit, FILE* out) {
  mi_printf_amount(n,unit,out,NULL);
}

static void mi_print_count(int64_t n, int64_t unit, FILE* out) {
  if (unit==1) _mi_fprintf(out,"%11s"," ");
          else mi_print_amount(n,0,out);
}

static void mi_stat_print(const mi_stat_count_t* stat, const char* msg, int64_t unit, FILE* out ) {
  _mi_fprintf(out,"%10s:", msg);
  mi_print_amount(stat->peak, unit, out);
  if (unit!=0) {
    mi_print_amount(stat->allocated, unit, out);
    mi_print_amount(stat->freed, unit, out);
  }
  if (unit>0) {
    mi_print_amount(unit, (unit==0 ? 0 : 1), out);
    mi_print_count(stat->allocated, unit, out);
    if (stat->allocated > stat->freed)
      _mi_fprintf(out, "  not all freed!\n");
    else
      _mi_fprintf(out, "  ok\n");
  }
  else {
    _mi_fprintf(out, "\n");
  }
}

static void mi_stat_counter_print(const mi_stat_counter_t* stat, const char* msg, FILE* out ) {
  double avg = (stat->count == 0 ? 0.0 : (double)stat->total / (double)stat->count);
  _mi_fprintf(out,"%10s: %7.1f avg\n", msg, avg);
}
#endif

static void mi_print_header( FILE* out ) {
  _mi_fprintf(out,"%10s: %10s %10s %10s %10s %10s\n", "heap stats", "peak  ", "total  ", "freed  ", "unit  ", "count  ");
}

#if MI_STAT>1
static void mi_stats_print_bins(mi_stat_count_t* all, const mi_stat_count_t* bins, size_t max, const char* fmt, FILE* out) {
  bool found = false;
  char buf[64];
  for (size_t i = 0; i <= max; i++) {
    if (bins[i].allocated > 0) {
      found = true;
      int64_t unit = _mi_bin_size((uint8_t)i);
      snprintf(buf, 64, "%s %3zu", fmt, i);
      mi_stat_add(all, &bins[i], unit);
      mi_stat_print(&bins[i], buf, unit, out);
    }
  }
  //snprintf(buf, 64, "%s all", fmt);
  //mi_stat_print(all, buf, 1);
  if (found) {
    _mi_fprintf(out, "\n");
    mi_print_header(out);
  }
}
#endif


static void mi_process_info(double* utime, double* stime, size_t* peak_rss, size_t* page_faults, size_t* page_reclaim);

static void _mi_stats_print(mi_stats_t* stats, double secs, FILE* out) mi_attr_noexcept {
  if (out == NULL) out = stderr;
  mi_print_header(out);
#if !defined(MI_STAT) || (MI_STAT==0)
  UNUSED(stats);
  //_mi_fprintf(out,"(mimalloc built without statistics)\n");
#else
  #if MI_STAT>1
  mi_stat_count_t normal = { 0,0,0,0 };
  mi_stats_print_bins(&normal, stats->normal, MI_BIN_HUGE, "normal",out);
  mi_stat_print(&normal, "normal", 1, out);
  #endif
  mi_stat_print(&stats->huge, "huge", 1, out);
  #if MI_STAT>1
  mi_stat_count_t total = { 0,0,0,0 };
  mi_stat_add(&total, &normal, 1);
  mi_stat_add(&total, &stats->huge, 1);
  mi_stat_print(&total, "total", 1, out);
  #endif
  _mi_fprintf(out, "malloc requested:     ");
  mi_print_amount(stats->malloc.allocated, 1, out);
  _mi_fprintf(out, "\n\n");
  mi_stat_print(&stats->committed, "committed", 1, out);
  mi_stat_print(&stats->reserved, "reserved", 1, out);
  mi_stat_print(&stats->reset, "reset", -1, out);
  mi_stat_print(&stats->segments, "segments", -1, out);
  mi_stat_print(&stats->segments_abandoned, "-abandoned", -1, out);
  mi_stat_print(&stats->pages, "pages", -1, out);
  mi_stat_print(&stats->pages_abandoned, "-abandoned", -1, out);
  mi_stat_print(&stats->pages_extended, "-extended", 0, out);
  mi_stat_print(&stats->mmap_calls, "mmaps", 0, out);
  mi_stat_print(&stats->mmap_right_align, "mmap fast", 0, out);
  mi_stat_print(&stats->mmap_ensure_aligned, "mmap slow", 0, out);
  mi_stat_print(&stats->threads, "threads", 0, out);
  mi_stat_counter_print(&stats->searches, "searches", out);
#endif

  if (secs >= 0.0) _mi_fprintf(out, "%10s: %9.3f s\n", "elapsed", secs);

  double user_time;
  double sys_time;
  size_t peak_rss;
  size_t page_faults;
  size_t page_reclaim;
  mi_process_info(&user_time, &sys_time, &peak_rss, &page_faults, &page_reclaim);
  _mi_fprintf(out,"%10s: user: %.3f s, system: %.3f s, faults: %lu, reclaims: %lu, rss: ", "process", user_time, sys_time, (unsigned long)page_faults, (unsigned long)page_reclaim );
  mi_printf_amount((int64_t)peak_rss, 1, out, "%s");
  _mi_fprintf(out,"\n");
}

static double mi_clock_end(double start);
static double mi_clock_start(void);
static double mi_time_start = 0.0;

static mi_stats_t* mi_stats_get_default(void) {
  mi_heap_t* heap = mi_heap_get_default();
  return &heap->tld->stats;
}

void mi_stats_reset(void) mi_attr_noexcept {
  mi_stats_t* stats = mi_stats_get_default();
  if (stats != &_mi_stats_main) { memset(stats, 0, sizeof(mi_stats_t)); }
  memset(&_mi_stats_main, 0, sizeof(mi_stats_t));
  mi_time_start = mi_clock_start();
}

static void mi_stats_print_ex(mi_stats_t* stats, double secs, FILE* out) {
  if (stats != &_mi_stats_main) {
    mi_stats_add(&_mi_stats_main,stats);
    memset(stats,0,sizeof(mi_stats_t));
  }
  _mi_stats_print(&_mi_stats_main, secs, out);
}

void mi_stats_print(FILE* out) mi_attr_noexcept {
  mi_stats_print_ex(mi_stats_get_default(),mi_clock_end(mi_time_start),out);
}

void mi_thread_stats_print(FILE* out) mi_attr_noexcept {
  _mi_stats_print(mi_stats_get_default(), mi_clock_end(mi_time_start), out);
}



// --------------------------------------------------------
// Basic timer for convenience
// --------------------------------------------------------

#ifdef _WIN32
#include <windows.h>
static double mi_to_seconds(LARGE_INTEGER t) {
  static double freq = 0.0;
  if (freq <= 0.0) {
    LARGE_INTEGER f;
    QueryPerformanceFrequency(&f);
    freq = (double)(f.QuadPart);
  }
  return ((double)(t.QuadPart) / freq);
}

static double mi_clock_now(void) {
  LARGE_INTEGER t;
  QueryPerformanceCounter(&t);
  return mi_to_seconds(t);
}
#else
#include <time.h>
#ifdef CLOCK_REALTIME
static double mi_clock_now(void) {
  struct timespec t;
  clock_gettime(CLOCK_REALTIME, &t);
  return (double)t.tv_sec + (1.0e-9 * (double)t.tv_nsec);
}
#else
// low resolution timer
static double mi_clock_now(void) {
  return ((double)clock() / (double)CLOCKS_PER_SEC);
}
#endif
#endif


static double mi_clock_diff = 0.0;

static double mi_clock_start(void) {
  if (mi_clock_diff == 0.0) {
    double t0 = mi_clock_now();
    mi_clock_diff = mi_clock_now() - t0;
  }
  return mi_clock_now();
}

static double mi_clock_end(double start) {
  double end = mi_clock_now();
  return (end - start - mi_clock_diff);
}


// --------------------------------------------------------
// Basic process statistics
// --------------------------------------------------------

#if defined(_WIN32)
#include <windows.h>
#include <psapi.h>
#pragma comment(lib,"psapi.lib")

static double filetime_secs(const FILETIME* ftime) {
  ULARGE_INTEGER i;
  i.LowPart = ftime->dwLowDateTime;
  i.HighPart = ftime->dwHighDateTime;
  double secs = (double)(i.QuadPart) * 1.0e-7; // FILETIME is in 100 nano seconds
  return secs;
}
static void mi_process_info(double* utime, double* stime, size_t* peak_rss, size_t* page_faults, size_t* page_reclaim) {
  FILETIME ct;
  FILETIME ut;
  FILETIME st;
  FILETIME et;
  GetProcessTimes(GetCurrentProcess(), &ct, &et, &st, &ut);
  *utime = filetime_secs(&ut);
  *stime = filetime_secs(&st);

  PROCESS_MEMORY_COUNTERS info;
  GetProcessMemoryInfo(GetCurrentProcess(), &info, sizeof(info));
  *peak_rss = (size_t)info.PeakWorkingSetSize;
  *page_faults = (size_t)info.PageFaultCount;
  *page_reclaim = 0;
}

#elif defined(__unix__) || defined(__unix) || defined(unix) || (defined(__APPLE__) && defined(__MACH__))
#include <stdio.h>
#include <unistd.h>
#include <sys/resource.h>

#if defined(__APPLE__) && defined(__MACH__)
#include <mach/mach.h>
#endif

static double timeval_secs(const struct timeval* tv) {
  return (double)tv->tv_sec + ((double)tv->tv_usec * 1.0e-6);
}

static void mi_process_info(double* utime, double* stime, size_t* peak_rss, size_t* page_faults, size_t* page_reclaim) {
  struct rusage rusage;
  getrusage(RUSAGE_SELF, &rusage);
#if defined(__APPLE__) && defined(__MACH__)
  *peak_rss = rusage.ru_maxrss;
#else
  *peak_rss = rusage.ru_maxrss * 1024;
#endif
  *page_faults = rusage.ru_majflt;
  *page_reclaim = rusage.ru_minflt;
  *utime = timeval_secs(&rusage.ru_utime);
  *stime = timeval_secs(&rusage.ru_stime);
}

#else
#pragma message("define a way to get process info")
static void mi_process_info(double* utime, double* stime, size_t* peak_rss, size_t* page_faults, size_t* page_reclaim) {
  *peak_rss = 0;
  *page_faults = 0;
  *page_reclaim = 0;
  *utime = 0.0;
  *stime = 0.0;
}
#endif