SimGrid  3.13
Versatile Simulation of Distributed Systems
lib.h File Reference
#include <xbt/dict.h>

Classes

struct  s_xbt_lib
 Container for all the objects of a given type. More...
 

Macros

#define xbt_lib_cursor_t   xbt_dict_cursor_t
 
#define xbt_lib_length(lib)   xbt_dict_length((lib)->dict)
 
#define xbt_lib_foreach(lib, cursor, key, data)
 

Typedefs

typedef struct s_xbt_lib s_xbt_lib_t
 Container for all the objects of a given type. More...
 
typedef struct s_xbt_libxbt_lib_t
 

Functions

xbt_lib_t xbt_lib_new (void)
 
void xbt_lib_free (xbt_lib_t *lib)
 
int xbt_lib_add_level (xbt_lib_t lib, void_f_pvoid_t free_f)
 
void xbt_lib_set (xbt_lib_t lib, const char *name, int level, void *obj)
 
void xbt_lib_unset (xbt_lib_t lib, const char *key, int level, int invoke_callback)
 
voidxbt_lib_get_or_null (xbt_lib_t lib, const char *name, int level)
 
xbt_dictelm_t xbt_lib_get_elm_or_null (xbt_lib_t lib, const char *key)
 
voidxbt_lib_get_level (xbt_dictelm_t elm, int level)
 
void xbt_lib_remove (xbt_lib_t lib, const char *key)
 

Macro Definition Documentation

#define xbt_lib_cursor_t   xbt_dict_cursor_t
#define xbt_lib_length (   lib)    xbt_dict_length((lib)->dict)
#define xbt_lib_foreach (   lib,
  cursor,
  key,
  data 
)

Typedef Documentation

typedef struct s_xbt_lib s_xbt_lib_t

Container for all the objects of a given type.

  • each item is identified by a string name/identifier;
  • the lib itself is a dictionary from the element id to the element;
  • the element itself is represented aby the xbt_dictelm_t;
  • the element can store any number of associated facets/data structures (corresponding to the different layers of SimGrid or its extensions) in ((void**)dictelt->content)[level];
  • each level is allocated in the lib with xbt_lib_add_level.
// Define a collection for the foo objects and two associated facets:
typedef xbt_dictelm_t foo_t;
xbt_lib_t foo_lib = xbt_lib_new();
int BAR_FOO_LEVEL  = xbt_lib_add_level(foo_lib, free_bar);
int AUTH_FOO_LEVEL = xbt_lib_add_level(foo_lib, free_auth);
// Store a bar:
bar_t bar = bar_new();
char* id = bar_name(bar);
xbt_lib_set(id, id, BAR_FOO_LEVEL, bar);
// Find the corresponding foo and the facet again:
foo_t foo = xbt_lib_get_elm_or_null(foo_lib, id);
bar_t bar2 = (bar_t) xbt_lib_get_level(foo, BAR_FOO_LEVEL);
assert(bar == bar2);
// Add authentication facet for the previous object:
auth_t auth = auth_new();
xbt_lib_set(foo_lib, id, AUTH_FOO_LEVEL, auth);
typedef struct s_xbt_lib * xbt_lib_t

Function Documentation

xbt_lib_t xbt_lib_new ( void  )
void xbt_lib_free ( xbt_lib_t lib)
int xbt_lib_add_level ( xbt_lib_t  lib,
void_f_pvoid_t  free_f 
)
void xbt_lib_set ( xbt_lib_t  lib,
const char *  name,
int  level,
void obj 
)
void xbt_lib_unset ( xbt_lib_t  lib,
const char *  key,
int  level,
int  invoke_callback 
)
void* xbt_lib_get_or_null ( xbt_lib_t  lib,
const char *  name,
int  level 
)
xbt_dictelm_t xbt_lib_get_elm_or_null ( xbt_lib_t  lib,
const char *  key 
)
void* xbt_lib_get_level ( xbt_dictelm_t  elm,
int  level 
)
void xbt_lib_remove ( xbt_lib_t  lib,
const char *  key 
)