environment.h

Go to the documentation of this file.

#ifndef ENVIRONMENT_H
#define ENVIRONMENT_H
 
#include "lf_types.h"
#include "low_level_platform.h"
#include "tracepoint.h"
 
// Forward declarations so that a pointers can appear in the environment struct.
typedef struct lf_scheduler_t lf_scheduler_t;
typedef struct mode_environment_t mode_environment_t;
typedef struct enclave_info_t enclave_info_t;
typedef struct watchdog_t watchdog_t;

#define GLOBAL_ENVIRONMENT NULL

typedef struct environment_t {
  bool initialized;
  bool execution_started; // Events at the start tag have been pulled from the event queue.
  char* name;
  int id;
  tag_t current_tag;
  tag_t stop_tag;
  pqueue_tag_t* event_q;
  pqueue_tag_t* recycle_q;
  bool** is_present_fields;
  int is_present_fields_size;
  bool** is_present_fields_abbreviated;
  int is_present_fields_abbreviated_size;
  vector_t sparse_io_record_sizes;
  trigger_handle_t _lf_handle;
  trigger_t** timer_triggers;
  int timer_triggers_size;
  reaction_t** startup_reactions;
  int startup_reactions_size;
  reaction_t** shutdown_reactions;
  int shutdown_reactions_size;
  reaction_t** reset_reactions;
  int reset_reactions_size;
  mode_environment_t* modes;
  int watchdogs_size;
  watchdog_t** watchdogs;
  int worker_thread_count;
#if defined(LF_SINGLE_THREADED)
  pqueue_t* reaction_q;
#else
  int num_workers;
  lf_thread_t* thread_ids;
  lf_mutex_t mutex;
  lf_cond_t event_q_changed;
  lf_scheduler_t* scheduler;
  _lf_tag_advancement_barrier barrier;
  lf_cond_t global_tag_barrier_requestors_reached_zero;
#endif // LF_SINGLE_THREADED
#if defined(FEDERATED)
  tag_t** _lf_intended_tag_fields;
  int _lf_intended_tag_fields_size;
  bool need_to_send_LTC;
#endif             // FEDERATED
#ifdef LF_ENCLAVES // TODO: Consider dropping #ifdef
  enclave_info_t* enclave_info;
#endif
} environment_t;
 
#if defined(MODAL_REACTORS)
struct mode_environment_t {
  uint8_t triggered_reactions_request;
  reactor_mode_state_t** modal_reactor_states;
  int modal_reactor_states_size;
  mode_state_variable_reset_data_t* state_resets;
  int state_resets_size;
};
#endif

int environment_init(environment_t* env, const char* name, int id, int num_workers, int num_timers,
                     int num_startup_reactions, int num_shutdown_reactions, int num_reset_reactions,
                     int num_is_present_fields, int num_modes, int num_state_resets, int num_watchdogs,
                     const char* trace_file_name);

void environment_verify(environment_t* env);

void environment_free(environment_t* env);

void environment_init_tags(environment_t* env, instant_t start_time, interval_t duration);

int _lf_get_environments(environment_t** envs);
 
#endif