api/spec/init.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2019-2024 Nokia
 */
 
#ifndef ODP_API_SPEC_INIT_H_
#define ODP_API_SPEC_INIT_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/std_types.h>
#include <odp/api/hints.h>
#include <odp/api/thread_types.h>
#include <odp/api/cpumask.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ODP_TERM_FROM_SIGH  ((uint64_t)0x1)
 
#define ODP_TERM_LAST_FLAG ODP_TERM_FROM_SIGH
 
typedef enum {
    ODP_LOG_DBG,
 
    ODP_LOG_WARN,
 
    ODP_LOG_ERR,
 
    ODP_LOG_UNIMPLEMENTED,
 
    ODP_LOG_ABORT,
 
    ODP_LOG_PRINT
 
} odp_log_level_t;
 
int odp_override_log(odp_log_level_t level, const char *fmt, ...) ODP_PRINTF_FORMAT(2, 3);
 
void odp_override_abort(void) ODP_NORETURN;
 
typedef int (*odp_log_func_t)(odp_log_level_t level, const char *fmt, ...) ODP_PRINTF_FORMAT(2, 3);
 
typedef void (*odp_abort_func_t)(void) ODP_NORETURN;
 
typedef enum {
    ODP_MEM_MODEL_THREAD = 0,
 
    ODP_MEM_MODEL_PROCESS
 
} odp_mem_model_t;
 
typedef struct odp_init_t {
    int num_worker;
 
    int num_control;
 
    const odp_cpumask_t *worker_cpus;
 
    const odp_cpumask_t *control_cpus;
 
    odp_log_func_t log_fn;
 
    odp_abort_func_t abort_fn;
 
    odp_feature_t not_used;
 
    odp_mem_model_t mem_model;
 
    struct {
        uint64_t max_memory;
    } shm;
 
} odp_init_t;
 
void odp_init_param_init(odp_init_t *param);
 
int odp_init_global(odp_instance_t *instance,
            const odp_init_t *params,
            const odp_platform_init_t *platform_params);
 
int odp_init_local(odp_instance_t instance, odp_thread_type_t thr_type);
 
int odp_term_local(void);
 
int odp_term_global(odp_instance_t instance);
 
int odp_term_abnormal(odp_instance_t instance, uint64_t flags, void *data);
 
void odp_log_thread_fn_set(odp_log_func_t func);
 
odp_log_func_t odp_log_fn_get(void);
 
odp_abort_func_t odp_abort_fn_get(void);
 
int odp_instance(odp_instance_t *instance);
 
uint64_t odp_instance_to_u64(odp_instance_t instance);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif