ROOT-Sim.h

Go to the documentation of this file.

 
#pragma once
 
#include <limits.h>
#include <float.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
 
typedef double simtime_t;
 
#define SIMTIME_MAX DBL_MAX
 
typedef uint64_t lp_id_t;
 
typedef void (*ProcessEvent_t)(lp_id_t me, simtime_t now, unsigned event_type, const void *event_content,
    unsigned event_size, void *st);
 
typedef bool (*CanEnd_t)(lp_id_t me, const void *snapshot);
 
enum rootsim_event {LP_INIT = 65534, LP_FINI};
 
extern void ScheduleNewEvent(lp_id_t receiver, simtime_t timestamp, unsigned event_type, const void *event_content,
    unsigned event_size);
 
extern void SetState(void *new_state);
 
extern void *rs_malloc(size_t req_size);
extern void *rs_calloc(size_t nmemb, size_t size);
extern void rs_free(void *ptr);
extern void *rs_realloc(void *ptr, size_t req_size);
 
extern double Random(void);
extern uint64_t RandomU64(void);
extern double Poisson(void);
#define Expent(mean) ((mean) * Poisson())
extern double Normal(void);
extern int RandomRange(int min, int max);
extern int RandomRangeNonUniform(int x, int min, int max);
extern double Gamma(unsigned ia);
extern unsigned Zipf(double skew, unsigned limit);
 
 
enum log_level {
    LOG_TRACE,  
    LOG_DEBUG,  
    LOG_INFO,   
    LOG_WARN,   
    LOG_ERROR,  
    LOG_FATAL,   
    LOG_SILENT 
};
 
/********* TOPOLOGY LIBRARY ************/
struct topology;
 
enum topology_geometry {
    TOPOLOGY_HEXAGON = 1,   
    TOPOLOGY_SQUARE,    
    TOPOLOGY_TORUS,     
    TOPOLOGY_RING,      
    TOPOLOGY_BIDRING,   
    TOPOLOGY_STAR,      
    TOPOLOGY_FCMESH,    
    TOPOLOGY_GRAPH,     
};
 
enum topology_direction {
    DIRECTION_E,    
    DIRECTION_W,    
    DIRECTION_N,    
    DIRECTION_S,    
    DIRECTION_NE,   
    DIRECTION_SW,   
    DIRECTION_NW,   
    DIRECTION_SE,   
 
    DIRECTION_RANDOM, 
};
 
#define INVALID_DIRECTION UINT64_MAX
 
extern lp_id_t CountRegions(struct topology *topology);
extern lp_id_t CountDirections(lp_id_t from, struct topology *topology);
extern lp_id_t GetReceiver(lp_id_t from, struct topology *topology, enum topology_direction direction);
 
extern void ReleaseTopology(struct topology *topology);
extern bool AddTopologyLink(struct topology *topology, lp_id_t from, lp_id_t to, double probability);
extern bool IsNeighbor(lp_id_t from, lp_id_t to, struct topology *topology);
 
 
// The following trick belongs to Laurent Deniau at CERN.
// https://groups.google.com/g/comp.std.c/c/d-6Mj5Lko_s?pli=1
 
#define PP_NARG(...) \
         PP_NARG_(__VA_ARGS__,PP_RSEQ_N())
#define PP_NARG_(...) \
         PP_128TH_ARG(__VA_ARGS__)
#define PP_128TH_ARG( \
          _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
         _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
         _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
         _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
         _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
         _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
         _61,_62,_63,_64,_65,_66,_67,_68,_69,_70, \
         _71,_72,_73,_74,_75,_76,_77,_78,_79,_80, \
         _81,_82,_83,_84,_85,_86,_87,_88,_89,_90, \
         _91,_92,_93,_94,_95,_96,_97,_98,_99,_100, \
         _101,_102,_103,_104,_105,_106,_107,_108,_109,_110, \
         _111,_112,_113,_114,_115,_116,_117,_118,_119,_120, \
         _121,_122,_123,_124,_125,_126,_127,N,...) N
#define PP_RSEQ_N() \
         127,126,125,124,123,122,121,120, \
         119,118,117,116,115,114,113,112,111,110, \
         109,108,107,106,105,104,103,102,101,100, \
         99,98,97,96,95,94,93,92,91,90, \
         89,88,87,86,85,84,83,82,81,80, \
         79,78,77,76,75,74,73,72,71,70, \
         69,68,67,66,65,64,63,62,61,60, \
         59,58,57,56,55,54,53,52,51,50, \
         49,48,47,46,45,44,43,42,41,40, \
         39,38,37,36,35,34,33,32,31,30, \
         29,28,27,26,25,24,23,22,21,20, \
         19,18,17,16,15,14,13,12,11,10, \
         9,8,7,6,5,4,3,2,1,0
 
extern struct topology *vInitializeTopology(enum topology_geometry geometry, int argc, ...);
 
 
#define InitializeTopology(geometry, ...) vInitializeTopology(geometry, PP_NARG(__VA_ARGS__), __VA_ARGS__)
/********* TOPOLOGY LIBRARY ************/
 
struct simulation_configuration {
    lp_id_t lps;
    unsigned n_threads;
    simtime_t termination_time;
    unsigned gvt_period;
    enum log_level log_level;
    FILE *logfile;
    const char *stats_file;
    unsigned ckpt_interval;
    uint64_t prng_seed;
    bool core_binding;
    bool serial;
    ProcessEvent_t dispatcher;
    CanEnd_t committed;
};
 
extern int RootsimInit(const struct simulation_configuration *conf);
extern int RootsimRun(void);
extern void RootsimStop(void);