ntsimulator/ntsim-ng/core/framework.h

   1 /*************************************************************************
   2 *
   3 * Copyright 2020 highstreet technologies GmbH and others
   4 *
   5 * Licensed under the Apache License, Version 2.0 (the "License");
   6 * you may not use this file except in compliance with the License.
   7 * You may obtain a copy of the License at
   8 *
   9 *     http://www.apache.org/licenses/LICENSE-2.0
  10 *
  11 * Unless required by applicable law or agreed to in writing, software
  12 * distributed under the License is distributed on an "AS IS" BASIS,
  13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 * See the License for the specific language governing permissions and
  15 * limitations under the License.
  16 ***************************************************************************/
  17
  18 #pragma once
  19
  20 #include <argp.h>
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include <unistd.h>
  24 #include <signal.h>
  25
  26 #define NTS_VERSION_FALLBACK                            "1.2.0"
  27
  28 #define ENV_VAR_NTS_MANUAL                              "NTS_MANUAL"
  29 #define ENV_VAR_NTS_BUILD_VERSION                       "NTS_BUILD_VERSION"
  30 #define ENV_VAR_NTS_BUILD_TIME                          "NTS_BUILD_DATE"
  31 #define ENV_VAR_NTS_FUNCTION_TYPE                       "NTS_FUNCTION_TYPE"
  32 #define ENV_VAR_NTS_NF_STANDALONE_START_FEATURES        "NTS_NF_STANDALONE_START_FEATURES"
  33 #define ENV_VAR_NTS_NF_MOUNT_POINT_ADDRESSING_METHOD    "NTS_NF_MOUNT_POINT_ADDRESSING_METHOD"
  34
  35 #define ENV_VAR_DOCKER_REPOSITORY                       "DOCKER_REPOSITORY"
  36 #define ENV_VAR_DOCKER_ENGINE_VERSION                   "DOCKER_ENGINE_VERSION"
  37 #define ENV_VAR_HOSTNAME                                "HOSTNAME"
  38 #define ENV_VAR_IPV6ENABLED                             "IPv6_ENABLED"
  39 #define ENV_VAR_SSH_CONNECTIONS                         "SSH_CONNECTIONS"
  40 #define ENV_VAR_TLS_CONNECTIONS                         "TLS_CONNECTIONS"
  41
  42 #define ENV_VAR_HOST_IP                                 "NTS_HOST_IP"
  43 #define ENV_VAR_HOST_BASE_PORT                          "NTS_HOST_BASE_PORT"
  44 #define ENV_VAR_HOST_NETCONF_SSH_BASE_PORT              "NTS_HOST_NETCONF_SSH_BASE_PORT"
  45 #define ENV_VAR_HOST_NETCONF_TLS_BASE_PORT              "NTS_HOST_NETCONF_TLS_BASE_PORT"
  46 #define ENV_VAR_HOST_TRANSFER_FTP_BASE_PORT             "NTS_HOST_TRANSFER_FTP_BASE_PORT"
  47 #define ENV_VAR_HOST_TRANSFER_SFTP_BASE_PORT            "NTS_HOST_TRANSFER_SFTP_BASE_PORT"
  48
  49 #define ENV_VAR_SDN_CONTROLLER_PROTOCOL                 "SDN_CONTROLLER_PROTOCOL"
  50 #define ENV_VAR_SDN_CONTROLLER_IP                       "SDN_CONTROLLER_IP"
  51 #define ENV_VAR_SDN_CONTROLLER_PORT                     "SDN_CONTROLLER_PORT"
  52 #define ENV_VAR_SDN_CONTROLLER_CALLHOME_PORT            "SDN_CONTROLLER_CALLHOME_PORT"
  53 #define ENV_VAR_SDN_CONTROLLER_USERNAME                 "SDN_CONTROLLER_USERNAME"
  54 #define ENV_VAR_SDN_CONTROLLER_PASSWORD                 "SDN_CONTROLLER_PASSWORD"
  55
  56 #define ENV_VAR_VES_COMMON_HEADER_VERSION               "VES_COMMON_HEADER_VERSION"
  57 #define ENV_VAR_VES_ENDPOINT_PROTOCOL                   "VES_ENDPOINT_PROTOCOL"
  58 #define ENV_VAR_VES_ENDPOINT_IP                         "VES_ENDPOINT_IP"
  59 #define ENV_VAR_VES_ENDPOINT_PORT                       "VES_ENDPOINT_PORT"
  60 #define ENV_VAR_VES_ENDPOINT_AUTH_METHOD                "VES_ENDPOINT_AUTH_METHOD"
  61 #define ENV_VAR_VES_ENDPOINT_USERNAME                   "VES_ENDPOINT_USERNAME"
  62 #define ENV_VAR_VES_ENDPOINT_PASSWORD                   "VES_ENDPOINT_PASSWORD"
  63 #define ENV_VAR_VES_ENDPOINT_CERTIFICATE                "VES_ENDPOINT_CERTIFICATE"
  64
  65 typedef enum {
  66     NTS_MODE_DEFAULT = 0,
  67     NTS_MODE_CONTAINER_INIT,
  68     NTS_MODE_SUPERVISOR,
  69     NTS_MODE_MANAGER,
  70     NTS_MODE_NETWORK_FUNCTION,
  71     NTS_MODE_GENERATE_DATA,
  72     NTS_MODE_TEST,
  73 } nts_mode_t;
  74
  75 typedef struct {
  76     nts_mode_t nts_mode;
  77
  78     int argc;
  79     char **argv;    //no-copy
  80
  81     bool no_rand;
  82     unsigned int fixed_seed;
  83     int verbosity_level;
  84
  85     bool print_root_paths;
  86     char *print_structure_xpath;
  87 } framework_arguments_t;
  88
  89 typedef struct {
  90     struct  {
  91         bool manual;
  92         char *version;
  93         char *build_time;
  94         char *function_type;
  95         char *nf_standalone_start_features;
  96         char *nf_mount_point_addressing_method;
  97     } nts;
  98
  99     struct {
 100         char *docker_repository;
 101         char *docker_engine_version;
 102
 103         char *hostname;
 104         char *ip_v4;
 105         char *ip_v6;
 106         bool ip_v6_enabled;
 107         uint16_t ssh_connections;
 108         uint16_t tls_connections;
 109         uint16_t ftp_connections;
 110         uint16_t sftp_connections;
 111     } settings;
 112
 113     struct {
 114         char *ip;
 115         uint16_t base_port;
 116         uint16_t ssh_base_port;
 117         uint16_t tls_base_port;
 118         uint16_t ftp_base_port;
 119         uint16_t sftp_base_port;
 120     } host;
 121
 122     struct {
 123         char *protocol;
 124         char *ip;
 125         uint16_t port;
 126         uint16_t callhome_port;
 127         char *username;
 128         char *password;
 129     } sdn_controller;
 130
 131     struct {
 132         char *common_header_version;
 133
 134         char *protocol;
 135         char *ip;
 136         uint16_t port;
 137         char *auth_method;
 138         char *username;
 139         char *password;
 140         char *certificate;
 141     } ves_endpoint;
 142 } framework_environment_t;
 143
 144 typedef struct {
 145     char *name;
 146     char *path;
 147     char **args;
 148     int args_count;
 149     bool nomanual;
 150     bool autorestart;
 151     char *stdout_path;
 152     char *stderr_path;
 153 } supervisor_rules_t;
 154
 155 typedef struct {
 156     char *path;
 157     int count;
 158 } custom_list_instances_t;
 159
 160 typedef struct {
 161     char *path;
 162     int values_count;
 163     char **values;
 164     int index;
 165 } restrict_schema_t;
 166
 167 typedef struct {
 168     struct {
 169         int excluded_modules_count;
 170         char **excluded_modules;
 171
 172         int excluded_features_count;
 173         char **excluded_features;
 174     } docker;
 175
 176     struct {
 177         int rules_count;
 178         supervisor_rules_t *rules;
 179     } supervisor;
 180
 181     struct {
 182         int debug_max_string_size;
 183
 184         int excluded_modules_count;
 185         char **excluded_modules;
 186
 187         int default_list_instances;
 188
 189         int custom_list_instances_count;
 190         custom_list_instances_t *custom_list_instances;
 191
 192         int restrict_schema_count;
 193         restrict_schema_t *restrict_schema;
 194     } datastore_generate;
 195
 196     struct {
 197         bool random_generation_enabled;
 198
 199         int preg_operational_count;
 200         char **preg_operational;
 201
 202         int preg_running_count;
 203         char **preg_running;
 204     } datastore_populate;
 205 } framework_config_t;
 206
 207 extern framework_arguments_t framework_arguments;
 208 extern framework_environment_t framework_environment;
 209 extern framework_config_t framework_config;
 210
 211 volatile sig_atomic_t framework_sigint;
 212
 213 int framework_init(int argc, char **argv);
 214 void framework_free(void);