aramid.h

Go to the documentation of this file.

#ifndef ARAMID_ARAMID_H
#define ARAMID_ARAMID_H

#ifdef __cplusplus
#include <cstddef>
#include <cstdint>
#else
#include <stddef.h>
#include <stdint.h>
#endif

#ifdef __cplusplus
#define ARMD_EXTERN_C extern "C"
#else
#define ARMD_EXTERN_C
#endif

typedef size_t ARMD_Size;
typedef int ARMD_Bool;
typedef double ARMD_Real;
typedef uint64_t ARMD_Handle;

typedef struct TAG_ARMD_Job ARMD_Job;
typedef struct TAG_ARMD_Procedure ARMD_Procedure;

typedef void *(*ARMD_MemoryAllocatorAllocateFunc)(void *context,
                                                  ARMD_Size size);
typedef void (*ARMD_MemoryAllocatorFreeFunc)(void *context, void *buf);

typedef struct TAG_ARMD_MemoryAllocator {
    void *context;
    ARMD_MemoryAllocatorAllocateFunc allocate;
    ARMD_MemoryAllocatorFreeFunc free;
} ARMD_MemoryAllocator;

ARMD_EXTERN_C void *
armd_memory_allocator_allocate(const ARMD_MemoryAllocator *allocator,
                               ARMD_Size size);
ARMD_EXTERN_C void
armd_memory_allocator_free(const ARMD_MemoryAllocator *allocator, void *buf);

ARMD_EXTERN_C void
armd_memory_allocator_init_default(ARMD_MemoryAllocator *memory_allocator);

typedef struct TAG_ARMD_MemoryRegion ARMD_MemoryRegion;

ARMD_EXTERN_C ARMD_MemoryRegion *
armd_memory_region_create(const ARMD_MemoryAllocator *memory_allocator);
ARMD_EXTERN_C ARMD_Size
armd_memory_region_destroy(ARMD_MemoryRegion *memory_region);

ARMD_EXTERN_C void *
armd_memory_region_allocate(ARMD_MemoryRegion *memory_region, ARMD_Size size);

ARMD_EXTERN_C void armd_memory_region_free(ARMD_MemoryRegion *memory_region,
                                           void *buf);

ARMD_EXTERN_C char *armd_memory_region_strdup(ARMD_MemoryRegion *memory_region,
                                              const char *str);

typedef struct TAG_ARMD_Context ARMD_Context;

ARMD_EXTERN_C ARMD_Context *
armd_context_create(const ARMD_MemoryAllocator *memory_allocator,
                    ARMD_Size num_executors);
ARMD_EXTERN_C int armd_context_destroy(ARMD_Context *context);

ARMD_EXTERN_C ARMD_Handle armd_invoke(ARMD_Context *context,
                                      ARMD_Procedure *procedure, void *args,
                                      ARMD_Size num_dependencies,
                                      const ARMD_Handle *dependencies);
ARMD_EXTERN_C int armd_await(ARMD_Context *context, ARMD_Handle handle);

ARMD_EXTERN_C int armd_detach(ARMD_Context *context, ARMD_Handle handle);

ARMD_EXTERN_C int armd_await_all(ARMD_Context *context);

typedef void (*ARMD_PromiseCallbackFunc)(ARMD_Handle handle,
                                         void *callback_context, int has_error);
ARMD_EXTERN_C
int armd_add_promise_callback(ARMD_Context *context, ARMD_Handle handle,
                              void *callback_context,
                              ARMD_PromiseCallbackFunc callback_func);

ARMD_EXTERN_C ARMD_Size armd_job_get_num_executors(ARMD_Job *job);
ARMD_EXTERN_C ARMD_Size armd_job_get_executor_id(ARMD_Job *job);

ARMD_EXTERN_C int armd_fork(ARMD_Job *parent_job, ARMD_Procedure *procedure,
                            void *args);
ARMD_EXTERN_C int armd_fork_with_id(ARMD_Size executor_id, ARMD_Job *parent_job,
                                    ARMD_Procedure *procedure, void *args);

typedef enum TAG_ARMD_ContinuationResult {
    ARMD_ContinuationResult_Error,
    ARMD_ContinuationResult_Ended,
    ARMD_ContinuationResult_Repeat,
} ARMD_ContinuationResult;

typedef ARMD_ContinuationResult (*ARMD_ContinuationFunc)(
    ARMD_Job *job, const void *constants, void *args, void *frame,
    const void *continuation_constants, void *continuation_frame);

typedef ARMD_ContinuationResult (*ARMD_ErrorTrapFunc)(
    ARMD_Job *job, const void *constants, void *args, void *frame,
    const void *continuation_constants, void *continuation_frame);

typedef void (*ARMD_ContinuationConstantsDestroyer)(
    ARMD_MemoryAllocator *memory_region, void *continuation_constants);

typedef void *(*ARMD_ContinuationFrameCreator)(
    ARMD_MemoryRegion *memory_region);
typedef void (*ARMD_ContinuationFrameDestroyer)(
    ARMD_MemoryRegion *memory_region, void *continuation_frame);

typedef int (*ARMD_SingleContinuationFunc)(ARMD_Job *job, const void *constants,
                                           void *args, void *frame);

typedef ARMD_Size (*ARMD_SequentialForCountFunc)(void *args, void *frame);
typedef int (*ARMD_SequentialForContinuationFunc)(ARMD_Job *job,
                                                  const void *constants,
                                                  void *args, void *frame,
                                                  ARMD_Size index);

typedef ARMD_Size (*ARMD_ParallelForCountFunc)(void *args, void *frame);
typedef int (*ARMD_ParallelForContinuationFunc)(ARMD_Job *job,
                                                const void *constants,
                                                void *args, void *frame,
                                                ARMD_Size index);

typedef ARMD_Bool (*ARMD_SetupFunc)(ARMD_Job *job, const void *constants,
                                    void *args, void *frame,
                                    int dependency_has_error);

typedef void (*ARMD_UnwindFunc)(ARMD_Job *job, const void *constants,
                                void *args, void *frame);

typedef struct TAG_ARMD_ProcedureBuilder ARMD_ProcedureBuilder;

ARMD_EXTERN_C ARMD_ProcedureBuilder *
armd_procedure_builder_create(const ARMD_MemoryAllocator *memory_allocator,
                              ARMD_Size constant_size, ARMD_Size frame_size);
ARMD_EXTERN_C int
armd_procedure_builder_destroy(ARMD_ProcedureBuilder *procedure_builder);
ARMD_EXTERN_C ARMD_Procedure *armd_procedure_builder_build_and_destroy(
    ARMD_ProcedureBuilder *procedure_builder);
ARMD_EXTERN_C void *
armd_procedure_builder_get_constants(ARMD_ProcedureBuilder *procedure_builder);
ARMD_EXTERN_C ARMD_MemoryAllocator armd_procedure_builder_get_memory_allocator(
    ARMD_ProcedureBuilder *procedure_builder);

ARMD_EXTERN_C int
armd_then(ARMD_ProcedureBuilder *procedure_builder,
          ARMD_ContinuationFunc continuation_func, void *continuation_constants,
          ARMD_ContinuationConstantsDestroyer continuation_constants_destroyer,
          ARMD_ErrorTrapFunc error_trap_func,
          ARMD_ContinuationFrameCreator continuation_frame_creator,
          ARMD_ContinuationFrameDestroyer continuation_frame_destroyer);

ARMD_EXTERN_C int
armd_then_single(ARMD_ProcedureBuilder *procedure_builder,
                 ARMD_SingleContinuationFunc single_continuation_func);

ARMD_EXTERN_C int armd_then_sequential_for(
    ARMD_ProcedureBuilder *procedure_builder,
    ARMD_SequentialForCountFunc sequential_for_count_func,
    ARMD_SequentialForContinuationFunc sequential_for_continuation_func);

ARMD_EXTERN_C int armd_then_parallel_for(
    ARMD_ProcedureBuilder *procedure_builder,
    ARMD_ParallelForCountFunc parallel_for_count_func,
    ARMD_ParallelForContinuationFunc parallel_for_continuation_func);

int armd_setup(ARMD_ProcedureBuilder *builder, ARMD_SetupFunc setup_func);

ARMD_EXTERN_C int armd_unwind(ARMD_ProcedureBuilder *procedure_builder,
                              ARMD_UnwindFunc unwind_func);

ARMD_EXTERN_C int armd_procedure_destroy(ARMD_Procedure *procedure);

ARMD_EXTERN_C void *armd_procedure_get_constants(ARMD_Procedure *procedure);

/* Time */

typedef struct TAG_ARMD_Timespec {
    int64_t seconds;
    int64_t nanoseconds;
} ARMD_Timespec;

ARMD_EXTERN_C int armd_get_time(ARMD_Timespec *result);
ARMD_EXTERN_C char *armd_format_time_iso8601(ARMD_MemoryRegion *memory_region,
                                             const ARMD_Timespec *timespec);

/* Logger */

typedef enum TAG_ARMD_LogLevel {
    ARMD_LogLevel_Fatal,
    ARMD_LogLevel_Error,
    ARMD_LogLevel_Warn,
    ARMD_LogLevel_Info,
    ARMD_LogLevel_Debug,
    ARMD_LogLevel_Trace,
} ARMD_LogLevel;

typedef struct TAG_ARMD_Logger ARMD_Logger;

typedef struct TAG_ARMD_LogElement {
    ARMD_Timespec timespec;
    ARMD_LogLevel level;
    const char *filename;
    ARMD_Size lineno;
    char *message;
} ARMD_LogElement;

typedef void (*ARMD_LoggerCallbackFunc)(void *context, ARMD_Logger *logger);

ARMD_EXTERN_C ARMD_Logger *armd_logger_create(ARMD_MemoryRegion *memory_region,
                                              ARMD_LogLevel level);
ARMD_EXTERN_C void armd_logger_increment_reference_count(ARMD_Logger *logger);
ARMD_EXTERN_C ARMD_Bool
armd_logger_decrement_reference_count(ARMD_Logger *logger);

ARMD_EXTERN_C void
armd_logger_set_callback(ARMD_Logger *logger,
                         ARMD_LoggerCallbackFunc callback_func,
                         void *callback_context);
ARMD_EXTERN_C void armd_logger_set_stdout_callback(ARMD_Logger *logger);
ARMD_EXTERN_C void armd_logger_set_stderr_callback(ARMD_Logger *logger);

ARMD_EXTERN_C ARMD_MemoryRegion *
armd_logger_get_memory_region(ARMD_Logger *logger);
ARMD_EXTERN_C int armd_logger_get_log_element(ARMD_Logger *logger,
                                              ARMD_LogElement **log_element);
ARMD_EXTERN_C void
armd_logger_destroy_log_element(ARMD_Logger *logger,
                                ARMD_LogElement *log_element);

ARMD_EXTERN_C
void armd_logger_log_string(ARMD_Logger *logger, ARMD_LogLevel level,
                            const char *filename, ARMD_Size lineno,
                            char *message);

#if defined(__GNUC__) || defined(__clang__)
#define ARMD_LOGGER_LOG_FORMAT_ATTRIBUTE __attribute__((format(printf, 5, 6)))
#else
#define ARMD_LOGGER_LOG_FORMAT_ATTRIBUTE
#endif

ARMD_EXTERN_C
void armd_logger_log_format(ARMD_Logger *logger, ARMD_LogLevel level,
                            const char *filename, ARMD_Size lineno,
                            const char *format,
                            ...) ARMD_LOGGER_LOG_FORMAT_ATTRIBUTE;

#undef ARMD_LOGGER_LOG_FORMAT_ATTRIBUTE

#define armd_log_fatal(logger, format, ...)                                    \
    armd_logger_log_format(logger, ARMD_LogLevel_Fatal, __FILE__, __LINE__,    \
                           format, __VA_ARGS__)

#define armd_log_error(logger, format, ...)                                    \
    armd_logger_log_format(logger, ARMD_LogLevel_Error, __FILE__, __LINE__,    \
                           format, __VA_ARGS__)

#define armd_log_warn(logger, format, ...)                                     \
    armd_logger_log_format(logger, ARMD_LogLevel_Warn, __FILE__, __LINE__,     \
                           format, __VA_ARGS__)

#define armd_log_info(logger, format, ...)                                     \
    armd_logger_log_format(logger, ARMD_LogLevel_Info, __FILE__, __LINE__,     \
                           format, __VA_ARGS__)

#define armd_log_debug(logger, format, ...)                                    \
    armd_logger_log_format(logger, ARMD_LogLevel_Debug, __FILE__, __LINE__,    \
                           format, __VA_ARGS__)

#define armd_log_trace(logger, format, ...)                                    \
    armd_logger_log_format(logger, ARMD_LogLevel_Trace, __FILE__, __LINE__,    \
                           format, __VA_ARGS__)

#endif