context.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <lxsameer@lxsameer.com>
 *
 * 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/>.
 */
 
// IMPORTANT NOTES:
// - When allocating memory via a context it, we're targeting a normal block in
// the memory manager, and eventually the block will be released, so don't rely
// on the data in the block to stick around. If you need immortal data, just
// explicitly allocate it using the memory manager.
 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef struct srn_engine_t srn_engine_t;
 
#ifdef SRN_WITH_SERENE
typedef struct srn_error_t srn_error_t;
typedef struct srn_namespace_t srn_namespace_t;
#endif
 
typedef size_t srn_block_id_t;
typedef uintptr_t object_id_t;
 
#define SRN_HASH_TYPE uint32_t
#define SRN_SEED_TYPE uint32_t
 
typedef SRN_HASH_TYPE srn_hash_t;
typedef SRN_SEED_TYPE srn_seed_t;
 
typedef struct srn_context_t {
  /// Long term state of the compiler
  srn_engine_t *engine;
 
  struct srn_context_t *parent;
  /// Where to allocate memory from.
  srn_block_id_t block_id;
} srn_context_t;
 
// -----------------------------------------------------------------------------
// LifeCycle
// -----------------------------------------------------------------------------
 
/// Make an empty context, by allocating a new memory block. The returning
/// context is a root context (no parent).
[[gnu::nonnull(1)]]
srn_context_t *srn_context_make(srn_engine_t *engine);
/* [[gnu::nonnull(1)]] srn_context_t * */
/* srn_context_make_subcontext(srn_context_t *parent, srn_block_id_t block_id);
 */
 
[[gnu::nonnull(1)]]
int srn_context_release(srn_context_t *ctx);
 
// -----------------------------------------------------------------------------
// Memory Management
// By default the context will carry around a memory block id and uses that
// block to allocate memory. If in any case we need another block to allocate
// memory in, then we need to provide the block id separately.
// -----------------------------------------------------------------------------
 
/**
 * Allocate `size` bytes aligned to `alignment` from the context's memory block.
 * Returns a pointer to the allocated region, or NULL on failure.
 */
[[gnu::nonnull(1)]]
void *srn_allocate(const srn_context_t *ctx, size_t size, size_t alignment);
 
/**
 * Allocate `size` bytes aligned to `alignment` from the context's memory block.
 * Panics if the allocation fails. Never returns NULL.
 */
[[gnu::nonnull(1)]]
void *srn_allocate_or_panic(const srn_context_t *ctx, size_t size, size_t alignment);
 
[[gnu::nonnull(1, 2)]]
void srn_release(const srn_context_t *ctx, void *ptr);
 
#define ALLOC(ctx, T)     (T *)srn_allocate(ctx, sizeof(T), alignof(T))
#define ALLOCN(ctx, T, N) (T *)srn_allocate(ctx, sizeof(T) * (N), alignof(T))
 
#define ALLOC_OR_PANIC(ctx, T)     (T *)srn_allocate_or_panic(ctx, sizeof(T), alignof(T))
#define ALLOCN_OR_PANIC(ctx, T, N) (T *)srn_allocate_or_panic(ctx, sizeof(T) * (N), alignof(T))
 
#ifdef SRN_WITH_SERENE
// -----------------------------------------------------------------------------
// Namespace operations
// -----------------------------------------------------------------------------
/// Look up a previously registered namespace by its name (a C string).
/// Returns the namespace or nullptr if none is registered under `name`.
[[gnu::nonnull(1, 2)]]
srn_namespace_t *srn_context_find_namespace(srn_context_t *ctx, const char *name);
#endif