configuration.c

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/>.
 */
 
#include "serene/rt/configuration.h"
 
#include <stdint.h>
 
#include "serene/rt/mm/interface.h"
#include "serene/utils.h"
 
void srn_config_validate(const srn_configuration_t *config) {
  PANIC_IF_NULL(config);
 
  // Pages are powers of two on every platform in practice, which makes a
  // covering power of two a whole number of pages. The modulo still checks
  // it, in case a platform reports an unusual page size. The upper bound
  // keeps the shift defined and the block size sane.
  PANIC_IF(
    config->mm.block_size_magnitude > 30 ||
      ((size_t)1 << config->mm.block_size_magnitude) < srn_mm_get_os_page_size() ||
      ((size_t)1 << config->mm.block_size_magnitude) % srn_mm_get_os_page_size() != 0,
    "config: mm.block_size_magnitude must yield a whole number of OS pages, within 30"
  );
 
  PANIC_IF(
    config->fiber.stack_size < FALLBACK_PAGE_SIZE || config->fiber.stack_size > SIZE_MAX / 2,
    "config: fiber.stack_size must be within one page..SIZE_MAX/2"
  );
 
  // A workers count of zero is valid, it delegates to the CPU count at run
  // time.
  PANIC_IF(
    config->fiber.max_workers < 1 || config->fiber.max_workers > SRN_MAX_WORKERS,
    "config: fiber.max_workers must be within 1..SRN_MAX_WORKERS"
  );
 
  PANIC_IF(
    config->fiber.workers > config->fiber.max_workers,
    "config: fiber.workers must not exceed fiber.max_workers"
  );
 
  // The ring magnitude bounds every ring, the admission cap, and the backend
  // op pool; the reap batch is a stack buffer size on the workers.
  PANIC_IF(
    config->reactor.ring_magnitude < 1 || config->reactor.ring_magnitude > 16,
    "config: reactor.ring_magnitude must be within 1..16"
  );
  PANIC_IF(
    config->reactor.reap_batch < 1 ||
      config->reactor.reap_batch > ((size_t)1 << config->reactor.ring_magnitude),
    "config: reactor.reap_batch must be within 1..ring capacity"
  );
 
  // A zero limit rejects everything, including the runtime's own interned
  // names, which is never what a configuration means.
  PANIC_IF(config->limits.string_max_len < 1, "config: limits.string_max_len must be at least 1");
  PANIC_IF(config->limits.ns_name_max_len < 1, "config: limits.ns_name_max_len must be at least 1");
}