runtime.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <[email protected]>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <https://www.gnu.org/licenses/>.
 */
 
// This header file suppose to be a simple way for client programs
// to include the runtime
#pragma once
 
#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>
 
// -----------------------------------------------------------------------------
// Bootstrapping helpers
// -----------------------------------------------------------------------------
/**
 * 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.
 */
#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 plus a `sched` variable bound to the engine's
 * scheduler, which every run and fiber call wants at hand.
 */
#define SERENE_RUNTIME_INIT_WITH_SCHED(engine, sched, config) \
  SERENE_RUNTIME_INIT(engine, config);                        \
  srn_scheduler_t *sched = (engine)->scheduler;               \
  PANIC_IF_NULL(sched)
 
/**
 * 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.
 */
#define SERENE_RUNTIME_SHUTDOWN(engine)  \
  do {                                   \
    srn_mm_t *serene_mm_ = (engine)->mm; \
    srn_engine_shutdown(engine);         \
    srn_mm_shutdown(serene_mm_);         \
  } while (0)