runtime.h File Reference

#include <serene/rt/context.h>
#include <serene/rt/engine.h>
#include <serene/rt/fiber.h>
#include <serene/rt/mm/interface.h>
#include <serene/utils.h>

Include dependency graph for runtime.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SERENE_RUNTIME_INIT(engine, config)
	Declare engine and bring the runtime up, the memory manager first, then the engine over it, both reading config (a const srn_configuration_t *; null means the defaults).
#define	SERENE_RUNTIME_INIT_WITH_SCHED(engine, sched, config)
	SERENE_RUNTIME_INIT plus a sched variable bound to the engine's scheduler, which every run and fiber call wants at hand.
#define	SERENE_RUNTIME_SHUTDOWN(engine)
	Tear down what SERENE_RUNTIME_INIT brought up, in reverse order, the engine (reactor, scheduler, jit) and then the memory manager it lives in.
#define	SERENE_MAIN(f)

Typedefs
typedef int(*	srn_main_t) (srn_context_t *ctx, int argc, char *argv[])

Functions
int	srn_run_fiber_main (srn_main_t m, int argc, char *argv[])

Macro Definition Documentation

SERENE_MAIN

#define SERENE_MAIN

(

f

)

Value:

int main(int argc, char *argv[]) { return srn_run_fiber_main(&(f), argc, argv); }

Definition at line 65 of file runtime.h.

#define SERENE_MAIN(f) \
  int main(int argc, char *argv[]) { return srn_run_fiber_main(&(f), argc, argv); }

SERENE_RUNTIME_INIT

#define SERENE_RUNTIME_INIT	(		engine,
			config )

Value:

srn_engine_t *engine = srn_engine_make(srn_mm_init(config), (config)); \
PANIC_IF_NULL(engine)

Declare engine and bring the runtime up, the memory manager first, then the engine over it, both reading config (a const srn_configuration_t *; null means the defaults).

config is evaluated more than once, so pass a plain pointer, not an expression with effects. Panics on failure.

Definition at line 38 of file runtime.h.

#define SERENE_RUNTIME_INIT(engine, config)                              \
  srn_engine_t *engine = srn_engine_make(srn_mm_init(config), (config)); \
  PANIC_IF_NULL(engine)

SERENE_RUNTIME_INIT_WITH_SCHED

#define SERENE_RUNTIME_INIT_WITH_SCHED	(		engine,
			sched,
			config )

Value:

SERENE_RUNTIME_INIT(engine, config);                        \
srn_scheduler_t *sched = (engine)->scheduler;               \
PANIC_IF_NULL(sched)

SERENE_RUNTIME_INIT plus a sched variable bound to the engine's scheduler, which every run and fiber call wants at hand.

Definition at line 46 of file runtime.h.

#define SERENE_RUNTIME_INIT_WITH_SCHED(engine, sched, config) \
  SERENE_RUNTIME_INIT(engine, config);                        \
  srn_scheduler_t *sched = (engine)->scheduler;               \
  PANIC_IF_NULL(sched)

SERENE_RUNTIME_SHUTDOWN

#define SERENE_RUNTIME_SHUTDOWN

(

engine

)

Value:

do {                                   \
  srn_mm_t *serene_mm_ = (engine)->mm; \
  srn_engine_shutdown(engine);         \
  srn_mm_shutdown(serene_mm_);         \
} while (0)

Tear down what SERENE_RUNTIME_INIT brought up, in reverse order, the engine (reactor, scheduler, jit) and then the memory manager it lives in.

Contexts need no separate release beforehand; the manager reclaims every chain. Release a context earlier only to reclaim its memory early, and only when no unreaped fiber lives in it.

Definition at line 58 of file runtime.h.

#define SERENE_RUNTIME_SHUTDOWN(engine)  \
  do {                                   \
    srn_mm_t *serene_mm_ = (engine)->mm; \
    srn_engine_shutdown(engine);         \
    srn_mm_shutdown(serene_mm_);         \
  } while (0)

Typedef Documentation

srn_main_t

typedef int(* srn_main_t) (srn_context_t *ctx, int argc, char *argv[])

Definition at line 68 of file runtime.h.

Function Documentation

srn_run_fiber_main()

int srn_run_fiber_main	(	srn_main_t	m,
		int	argc,
		char *	argv[] )

Definition at line 35 of file runtime.c.

                                                             {
  SERENE_RUNTIME_INIT_WITH_SCHED(engine, sched, nullptr);
  srn_context_t *ctx = srn_context_make(engine);
 
  srn_main_args_t args = {
    .main_f = m,
    .out    = 0,
    .argc   = argc,
    .argv   = argv,
 
  };
 
  SRN_TRACEPOINT(serene_main_start);
  (void)srn_fiber_spawn(ctx, main_fiber_wrapper, &args);
  srn_sched_run(sched, 0);
  SRN_TRACEPOINT(serene_main_end);
 
  srn_context_release(ctx);
  SERENE_RUNTIME_SHUTDOWN(engine);
  return args.out;
}

Here is the call graph for this function: