131243da4d892e4c4ee613781fa2f932036aa5bc
[sim/o1-interface.git] / ntsimulator / ntsim-ng / core / framework.c
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 #define _GNU_SOURCE
19
20 #include "framework.h"
21 #include <string.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <unistd.h>
25 #include <limits.h>
26 #include <assert.h>
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <cjson/cJSON.h>
30
31 #include "utils/sys_utils.h"
32 #include "utils/log_utils.h"
33 #include "utils/rand_utils.h"
34
35 framework_arguments_t framework_arguments;
36 framework_environment_t framework_environment;
37 framework_config_t framework_config;
38
39 const char *argp_program_version = 0;    //is set later
40 const char *argp_program_bug_address = "<alexandru.stancu@highstreet-technologies.com> / <adrian.lita@highstreet-technologies.com>";
41 static char doc[] = "ntsim - new generation";
42
43 static struct argp_option options[] = {
44     { "container-init", 'i', 0, 0, "Runs initialization tasks for the Docker container that's being built. Do not run manually." },
45     { "supervisor", 's', 0, 0, "Run as supervisor; manager/network-function is chosen via config.json"},
46     { "manager", 'm', 0, 0, "Run the daemon as manager." },
47     { "network-function", 'f', 0, 0, "Run the daemon as network function." },
48     { "blank", 'b', 0, 0, "Run the deamon as a blank network function." },
49     { "generate", 'g', 0, 0, "Generate population data without commiting." },
50     { "test-mode", 't', 0, 0, "Test mode." },
51     
52     // tools
53     { "ls", '1', 0, 0, "Print all available root paths." },
54     { "schema", '2', "XPATH", 0, "Print schema for XPATH." },
55     
56     { "fixed-rand", 'r', "SEED", 0, "Initialize RAND seed to a fixed value (for debugging purposes)." },
57     { "verbose", 'v', "LEVEL", 0, "Verbosity level for printing to stdout (logs will still save everything). LEVEL is: 0=errors only, 1=requested info(default), 2=info" },
58     { "workspace", 'w', "PATH", 0, "Initialize workspace to a different one than the current working directory." },
59     { 0 } 
60 };
61
62 volatile sig_atomic_t framework_sigint;
63
64 static int framework_env_init(void);
65 static int framework_config_init(void);
66
67 static void framework_signal_handler(int signo);
68 static error_t parse_opt(int key, char *arg, struct argp_state *state);
69
70 int framework_init(int argc, char **argv) {
71     //environment vars
72     framework_environment.nts.version = (getenv(ENV_VAR_NTS_BUILD_VERSION) && strlen(getenv(ENV_VAR_NTS_BUILD_VERSION))) ? strdup(getenv(ENV_VAR_NTS_BUILD_VERSION)) : strdup(NTS_VERSION_FALLBACK"!");
73     if(getenv(ENV_VAR_NTS_BUILD_TIME) && strlen(getenv(ENV_VAR_NTS_BUILD_TIME))) {
74         framework_environment.nts.build_time = strdup(getenv(ENV_VAR_NTS_BUILD_TIME));
75     }
76     else {
77         if(__DATE__[0] == '?') {
78             framework_environment.nts.build_time = strdup("1970-01-01T00:00:00Z");
79         }
80         else {
81             //01234567890
82             //May  4 2021
83             int year = 0;
84             int month = 1;
85             int day = 0;
86             
87             year = (__DATE__[10] - '0') + (__DATE__[9] - '0')*10 + (__DATE__[8] - '0')*100 + (__DATE__[7] - '0')*1000;
88             day = (__DATE__[5] - '0');
89             if(__DATE__[4] != ' ') {
90                 day += (__DATE__[4] - '0')*10;
91             }
92             
93             switch(__DATE__[0]) {
94                 case 'J':
95                     switch(__DATE__[1]) {
96                         case 'a':
97                             month = 1;
98                             break;
99                         
100                         case 'u':
101                             if(__DATE__[2] == 'n') {
102                                 month = 6;
103                             }
104                             else {
105                                 month = 7;
106                             }
107                             break;
108                     }
109                     break;
110                     
111                 case 'F':
112                     month = 2;
113                     break;
114                     
115                 case 'M':
116                     switch(__DATE__[2]) {
117                         case 'r':
118                             month = 3;
119                             break;
120                             
121                         case 'y':
122                             month = 5;
123                             break;
124                     }
125                     break;
126                 
127                 case 'A':
128                     switch(__DATE__[1]) {
129                         case 'p':
130                             month = 4;
131                             break;
132                             
133                         case 'u':
134                             month = 8;
135                             break;
136                     }
137                     break;
138                     
139                 case 'S':
140                     month = 9;
141                     break;
142                     
143                 case 'O':
144                     month = 10;
145                     break;
146                     
147                 case 'N':
148                     month = 11;
149                     break;
150                     
151                 case 'D':
152                     month = 12;
153                     break;
154             }
155             
156             asprintf(&framework_environment.nts.build_time, "%04d-%02d-%02dT%sZ", year, month, day, __TIME__);
157         }
158     }
159
160     //set argp_version
161     char *version = 0;
162     asprintf(&version, "ntsim-ng v%s build %s", framework_environment.nts.version, framework_environment.nts.build_time);
163     argp_program_version = version;
164
165     //initialize app arguments
166     framework_arguments.nts_mode = NTS_MODE_DEFAULT;
167
168     framework_arguments.argc = argc;
169     framework_arguments.argv = argv;
170
171     framework_arguments.no_rand = false;
172     framework_arguments.fixed_seed = 0;
173     framework_arguments.verbosity_level = 1;
174
175     framework_arguments.print_root_paths = false;
176     framework_arguments.print_structure_xpath = 0;
177
178     //parse provided command line arguments
179     struct argp argp = { options, parse_opt, 0, doc, 0, 0, 0 };
180     argp_parse(&argp, argc, argv, 0, 0, &framework_arguments);
181
182     //manage signals
183     framework_sigint = 0;
184     signal(SIGINT, framework_signal_handler);
185     signal(SIGTERM, framework_signal_handler);
186     signal(SIGQUIT, framework_signal_handler);
187
188     //disable buffering for stdout
189     setbuf(stdout, NULL);
190
191     //init logging subsystem
192     char *log_file = 0;
193     char *stderr_file = 0;
194
195     if(!dir_exists("log")) {
196         mkdir("log", 0777);
197     }
198
199     switch(framework_arguments.nts_mode) {
200         case NTS_MODE_CONTAINER_INIT:
201             log_file = "log/log-install.txt";
202             stderr_file = "log/stderr-install.txt";
203             break;
204
205         case NTS_MODE_BLANK:
206             log_file = "log/log-blank.txt";
207             stderr_file = "log/stderr-blank.txt";
208             break;
209
210         case NTS_MODE_SUPERVISOR:
211             log_file = "log/log-supervisor.txt";
212             stderr_file = "log/stderr-supervisor.txt";
213             break;
214
215         case NTS_MODE_GENERATE_DATA:
216             log_file = "log/log-generate.txt";
217             stderr_file = "log/stderr-generate.txt";
218             break;
219
220         default:
221             log_file = "log/log.txt";
222             stderr_file = "log/stderr.txt";
223             break;
224     }
225
226     log_init(log_file);
227     log_redirect_stderr(stderr_file);
228
229     char cwd[PATH_MAX];
230     getcwd(cwd, sizeof(cwd));
231     log_add_verbose(2, "[framework] current working dir is: %s\n", cwd);
232
233     //init rand generator if needed
234     if(framework_arguments.no_rand == false) {
235         rand_init();
236     }
237     else {
238         rand_init_fixed(framework_arguments.fixed_seed);
239     }
240
241     log_add_verbose(2, "[framework] app was called: ");
242     for(int i = 0; i < argc; i++) {
243         log_add(2, "%s ", argv[i]);
244     }
245     log_add(2, "\n");
246
247     if(framework_env_init() != NTS_ERR_OK) {
248         log_error("[framework] framework_env_init() failed\n");
249         return NTS_ERR_FAILED;
250     }
251
252     if(framework_config_init() != NTS_ERR_OK) {
253         log_error("[framework] framework_config_init() failed\n");
254         return NTS_ERR_FAILED;
255     }
256
257     log_add_verbose(2, "[framework] init complete\n");
258     return NTS_ERR_OK;
259 }
260
261 static int framework_env_init(void) {
262     log_add_verbose(2, "[framework-env] started\n");
263
264     /*
265     The following env vars are taken care of by framework_init()
266         framework_environment.nts.version
267         framework_environment.nts.build_time
268     */
269
270     framework_environment.nts.manual = getenv(ENV_VAR_NTS_MANUAL) ? true : false;
271     framework_environment.nts.function_type = getenv(ENV_VAR_NTS_FUNCTION_TYPE) ? strdup(getenv(ENV_VAR_NTS_FUNCTION_TYPE)) : strdup("");
272     framework_environment.nts.nf_standalone_start_features = getenv(ENV_VAR_NTS_NF_STANDALONE_START_FEATURES) ? strdup(getenv(ENV_VAR_NTS_NF_STANDALONE_START_FEATURES)) : strdup("");
273     framework_environment.nts.nf_mount_point_addressing_method = getenv(ENV_VAR_NTS_NF_MOUNT_POINT_ADDRESSING_METHOD) ? strdup(getenv(ENV_VAR_NTS_NF_MOUNT_POINT_ADDRESSING_METHOD)) : strdup("docker-mapping");
274
275     framework_environment.settings.docker_repository = getenv(ENV_VAR_DOCKER_REPOSITORY) ? strdup(getenv(ENV_VAR_DOCKER_REPOSITORY)) : strdup("");
276     if(strlen(framework_environment.settings.docker_repository)) {
277         if(framework_environment.settings.docker_repository[strlen(framework_environment.settings.docker_repository) - 1] == '/') {
278             framework_environment.settings.docker_repository[strlen(framework_environment.settings.docker_repository) - 1] = 0;
279         }
280     }
281     framework_environment.settings.docker_engine_version = getenv(ENV_VAR_DOCKER_ENGINE_VERSION) ? strdup(getenv(ENV_VAR_DOCKER_ENGINE_VERSION)) : strdup("1.40");
282     framework_environment.settings.hostname = getenv(ENV_VAR_HOSTNAME) ? strdup(getenv(ENV_VAR_HOSTNAME)) : strdup("localhost");
283
284     bool ip_ok = get_local_ips("eth0", &framework_environment.settings.ip_v4, &framework_environment.settings.ip_v6);
285     if(!ip_ok) {
286         log_error("[framework-env] could not get local IP addresses\n");
287     }
288
289     char *ipv6_env_var = getenv(ENV_VAR_IPV6ENABLED);
290     if(ipv6_env_var == 0) {
291         log_error("[framework-env] could not get the IPv6 Enabled env variable\n");
292     }
293     framework_environment.settings.ip_v6_enabled = (strcmp(ipv6_env_var, "true") == 0) ? true : false;
294     framework_environment.settings.ssh_connections = get_int_from_string_with_default(getenv(ENV_VAR_SSH_CONNECTIONS), 1);
295     framework_environment.settings.tls_connections = get_int_from_string_with_default(getenv(ENV_VAR_TLS_CONNECTIONS), 0);
296     framework_environment.settings.ftp_connections = 1;
297     framework_environment.settings.sftp_connections = 1;
298
299     //build version and build time are set in the begining of the function
300     framework_environment.host.ip = getenv(ENV_VAR_HOST_IP) ? strdup(getenv(ENV_VAR_HOST_IP)) : strdup("127.0.0.1");
301     framework_environment.host.base_port = get_int_from_string_with_default(getenv(ENV_VAR_HOST_BASE_PORT), 1000);
302     framework_environment.host.ssh_base_port = get_int_from_string_with_default(getenv(ENV_VAR_HOST_NETCONF_SSH_BASE_PORT), 0);
303     framework_environment.host.tls_base_port = get_int_from_string_with_default(getenv(ENV_VAR_HOST_NETCONF_TLS_BASE_PORT), 0);
304     framework_environment.host.ftp_base_port = get_int_from_string_with_default(getenv(ENV_VAR_HOST_TRANSFER_FTP_BASE_PORT), 0);
305     framework_environment.host.sftp_base_port = get_int_from_string_with_default(getenv(ENV_VAR_HOST_TRANSFER_SFTP_BASE_PORT), 0);
306     
307     framework_environment.sdn_controller.protocol = getenv(ENV_VAR_SDN_CONTROLLER_IP) ? strdup(getenv(ENV_VAR_SDN_CONTROLLER_PROTOCOL)) : strdup("https");
308     framework_environment.sdn_controller.ip = getenv(ENV_VAR_SDN_CONTROLLER_IP) ? strdup(getenv(ENV_VAR_SDN_CONTROLLER_IP)) : strdup("127.0.0.1");
309     framework_environment.sdn_controller.port = get_int_from_string_with_default(getenv(ENV_VAR_SDN_CONTROLLER_PORT), 8181);
310     framework_environment.sdn_controller.callhome_port = get_int_from_string_with_default(getenv(ENV_VAR_SDN_CONTROLLER_CALLHOME_PORT), 6666);
311     framework_environment.sdn_controller.username = getenv(ENV_VAR_SDN_CONTROLLER_USERNAME) ? strdup(getenv(ENV_VAR_SDN_CONTROLLER_USERNAME)) : strdup("admin");
312     framework_environment.sdn_controller.password = getenv(ENV_VAR_SDN_CONTROLLER_PASSWORD) ? strdup(getenv(ENV_VAR_SDN_CONTROLLER_PASSWORD)) : strdup("admin");
313     framework_environment.sdn_controller.port_absent = (getenv(ENV_VAR_SDN_CONTROLLER_PORT) == 0) ? true : false;
314
315     framework_environment.ves_endpoint.common_header_version = getenv(ENV_VAR_VES_COMMON_HEADER_VERSION) ? strdup(getenv(ENV_VAR_VES_COMMON_HEADER_VERSION)) : strdup("7.2");
316     framework_environment.ves_endpoint.protocol = getenv(ENV_VAR_VES_ENDPOINT_PROTOCOL) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_PROTOCOL)) : strdup("https");
317     framework_environment.ves_endpoint.ip = getenv(ENV_VAR_VES_ENDPOINT_IP) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_IP)) : strdup("127.0.0.1");
318     framework_environment.ves_endpoint.port = get_int_from_string_with_default(getenv(ENV_VAR_VES_ENDPOINT_PORT), 1234);
319     framework_environment.ves_endpoint.auth_method = getenv(ENV_VAR_VES_ENDPOINT_AUTH_METHOD) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_AUTH_METHOD)) : strdup("no-auth");
320     framework_environment.ves_endpoint.username = getenv(ENV_VAR_VES_ENDPOINT_USERNAME) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_USERNAME)) : strdup("admin");
321     framework_environment.ves_endpoint.password = getenv(ENV_VAR_VES_ENDPOINT_PASSWORD) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_PASSWORD)) : strdup("admin");
322     framework_environment.ves_endpoint.certificate = getenv(ENV_VAR_VES_ENDPOINT_CERTIFICATE) ? strdup(getenv(ENV_VAR_VES_ENDPOINT_CERTIFICATE)) : strdup("");
323     framework_environment.ves_endpoint.port_absent = (getenv(ENV_VAR_VES_ENDPOINT_PORT) == 0) ? true : false;
324
325     log_add_verbose(2, "[framework-env] nts.manual = %d\n", framework_environment.nts.manual);
326     log_add_verbose(2, "[framework-env] nts.version = %s\n", framework_environment.nts.version);
327     log_add_verbose(2, "[framework-env] nts.build_time = %s\n", framework_environment.nts.build_time);
328     log_add_verbose(2, "[framework-env] nts.function_type = %s\n", framework_environment.nts.function_type);
329     log_add_verbose(2, "[framework-env] nts.nf_standalone_start_features = %s\n", framework_environment.nts.nf_standalone_start_features);
330     log_add_verbose(2, "[framework-env] nts.nf_mount_point_addressing_method = %s\n", framework_environment.nts.nf_mount_point_addressing_method);
331
332     log_add_verbose(2, "[framework-env] settings.docker_engine_version = %s\n", framework_environment.settings.docker_engine_version);
333     log_add_verbose(2, "[framework-env] settings.docker_repository = %s\n", framework_environment.settings.docker_repository);
334     log_add_verbose(2, "[framework-env] settings.hostname = %s\n", framework_environment.settings.hostname);
335     log_add_verbose(2, "[framework-env] settings.ip_v4 = %s\n", framework_environment.settings.ip_v4);
336     log_add_verbose(2, "[framework-env] settings.ip_v6 = %s\n", framework_environment.settings.ip_v6);
337     log_add_verbose(2, "[framework-env] settings.ip_v6_enabled = %s\n", framework_environment.settings.ip_v6_enabled ? "true" : "false");
338     log_add_verbose(2, "[framework-env] settings.ssh_connections = %d\n", framework_environment.settings.ssh_connections);
339     log_add_verbose(2, "[framework-env] settings.tls_connections = %d\n", framework_environment.settings.tls_connections);
340     log_add_verbose(2, "[framework-env] settings.ftp_connections = %d\n", framework_environment.settings.ftp_connections);
341     log_add_verbose(2, "[framework-env] settings.sftp_connections = %d\n", framework_environment.settings.sftp_connections);
342
343     //check ports
344     if(framework_environment.host.base_port < 1000) {
345         log_add_verbose(2, "[framework-env] host.base_port < 1000 -> disabling\n");
346         framework_environment.host.base_port = 0;
347     }
348
349     if(framework_environment.host.ssh_base_port < 1000) {
350         log_add_verbose(2, "[framework-env] host.ssh_base_port < 1000 -> using base_port\n");
351         framework_environment.host.ssh_base_port = framework_environment.host.base_port;
352     }
353
354     if(framework_environment.host.tls_base_port < 1000) {
355         log_add_verbose(2, "[framework-env] host.tls_base_port < 1000 -> using base_port\n");
356         framework_environment.host.tls_base_port = framework_environment.host.base_port;
357     }
358
359     if(framework_environment.host.ftp_base_port < 1000) {
360         log_add_verbose(2, "[framework-env] host.ftp_base_port < 1000 -> using base_port\n");
361         framework_environment.host.ftp_base_port = framework_environment.host.base_port;
362     }
363
364     if(framework_environment.host.sftp_base_port < 1000) {
365         log_add_verbose(2, "[framework-env] host.sftp_base_port < 1000 -> using base_port\n");
366         framework_environment.host.sftp_base_port = framework_environment.host.base_port;
367     }
368
369     if(framework_environment.host.base_port == 0) {
370         if(framework_environment.host.ssh_base_port == 0) {
371             log_error("[framework-env] host.ssh_base_port unknown\n");
372             return NTS_ERR_FAILED;
373         }
374
375         if(framework_environment.host.tls_base_port == 0) {
376             log_error("[framework-env] host.tls_base_port unknown\n");
377             return NTS_ERR_FAILED;
378         }
379
380         if(framework_environment.host.ftp_base_port == 0) {
381             log_error("[framework-env] host.ftp_base_port unknown\n");
382             return NTS_ERR_FAILED;
383         }
384
385         if(framework_environment.host.sftp_base_port == 0) {
386             log_error("[framework-env] host.sftp_base_port unknown\n");
387             return NTS_ERR_FAILED;
388         }
389     }
390     
391     log_add_verbose(2, "[framework-env] host.ip = %s\n", framework_environment.host.ip);
392     if(framework_environment.settings.ip_v6_enabled) {
393         if(strstr(framework_environment.host.ip, ".")) {
394             log_error("[framework-env] host.ip is an invalid IP v6\n");
395             return NTS_ERR_FAILED;
396         }
397     }
398     else {
399         if(strstr(framework_environment.host.ip, ":")) {
400             log_error("[framework-env] host.ip is an invalid IP v4\n");
401             return NTS_ERR_FAILED;
402         }
403     }
404
405     log_add_verbose(2, "[framework-env] host.base_port = %d\n", framework_environment.host.base_port);
406     log_add_verbose(2, "[framework-env] host.ssh_base_port = %d\n", framework_environment.host.ssh_base_port);
407     log_add_verbose(2, "[framework-env] host.tls_base_port = %d\n", framework_environment.host.tls_base_port);
408     log_add_verbose(2, "[framework-env] host.ftp_base_port = %d\n", framework_environment.host.ftp_base_port);
409     log_add_verbose(2, "[framework-env] host.sftp_base_port = %d\n", framework_environment.host.sftp_base_port);
410     
411     log_add_verbose(2, "[framework-env] sdn_controller.protocol = %s\n", framework_environment.sdn_controller.protocol);
412     log_add_verbose(2, "[framework-env] sdn_controller.ip = %s\n", framework_environment.sdn_controller.ip);
413     log_add_verbose(2, "[framework-env] sdn_controller.port = %d\n", framework_environment.sdn_controller.port);
414     log_add_verbose(2, "[framework-env] sdn_controller.callhome_port = %d\n", framework_environment.sdn_controller.callhome_port);
415     log_add_verbose(2, "[framework-env] sdn_controller.username = %s\n", framework_environment.sdn_controller.username);
416     log_add_verbose(2, "[framework-env] sdn_controller.password = %s\n", framework_environment.sdn_controller.password);
417     log_add_verbose(2, "[framework-env] sdn_controller.port_absent = %d\n", framework_environment.sdn_controller.port_absent);
418
419     log_add_verbose(2, "[framework-env] ves_endpoint.common_header_version = %s\n", framework_environment.ves_endpoint.common_header_version);
420     log_add_verbose(2, "[framework-env] ves_endpoint.protocol = %s\n", framework_environment.ves_endpoint.protocol);
421     log_add_verbose(2, "[framework-env] ves_endpoint.ip = %s\n", framework_environment.ves_endpoint.ip);
422     log_add_verbose(2, "[framework-env] ves_endpoint.port = %d\n", framework_environment.ves_endpoint.port);
423     log_add_verbose(2, "[framework-env] ves_endpoint.auth_method = %s\n", framework_environment.ves_endpoint.auth_method);
424     log_add_verbose(2, "[framework-env] ves_endpoint.username = %s\n", framework_environment.ves_endpoint.username);
425     log_add_verbose(2, "[framework-env] ves_endpoint.password = %s\n", framework_environment.ves_endpoint.password);
426     log_add_verbose(2, "[framework-env] ves_endpoint.certificate = %s\n", framework_environment.ves_endpoint.certificate);
427     log_add_verbose(2, "[framework-env] ves_endpoint.port_absent = %d\n", framework_environment.ves_endpoint.port_absent);
428
429     log_add_verbose(2, "[framework-env] finished\n");
430     return NTS_ERR_OK;
431 }
432
433 static int framework_config_init(void) {
434     log_add_verbose(2, "[framework-config] started\n");
435
436     //init app config
437     framework_config.docker.excluded_modules = 0;
438     framework_config.docker.excluded_modules_count = 0;
439     framework_config.docker.excluded_features = 0;
440     framework_config.docker.excluded_features_count = 0;
441
442     framework_config.supervisor.rules_count = 0;
443     framework_config.supervisor.rules = 0;
444
445     framework_config.datastore_generate.debug_max_string_size = 0;
446     framework_config.datastore_generate.excluded_modules = 0;
447     framework_config.datastore_generate.excluded_modules_count = 0;
448     framework_config.datastore_generate.default_list_instances = 1;
449     framework_config.datastore_generate.custom_list_instances_count = 0;
450     framework_config.datastore_generate.custom_list_instances = 0;
451     framework_config.datastore_generate.restrict_schema_count = 0;
452     framework_config.datastore_generate.restrict_schema = 0;
453
454     framework_config.datastore_populate.random_generation_enabled = 1;
455     framework_config.datastore_populate.preg_operational_count = 0;
456     framework_config.datastore_populate.preg_operational = 0;
457     framework_config.datastore_populate.preg_running_count = 0;
458     framework_config.datastore_populate.preg_running = 0;
459
460     //config init
461     char *config_file = "config/config.json";
462     if(file_exists("/opt/dev/config/config.json")) {
463         config_file = "/opt/dev/config/config.json";
464         log_add_verbose(1, LOG_COLOR_BOLD_MAGENTA"config.json is loaded from external volume!\n"LOG_COLOR_RESET);
465     }
466     else {
467         if(!dir_exists("config")) {
468             log_add_verbose(2, "[framework-config] config/ folder wasn't found; created.\n");
469             mkdir("config", 0777);
470         }
471
472         if(!file_exists("config/config.json")) {
473             log_add_verbose(2, "[framework-config] config.json file missing; created.\n");
474             file_touch("config/config.json", "{}");
475         }
476     }
477
478     log_add_verbose(2, "[framework-config] parsing config.json from %s\n", config_file);
479     char *config_contents = file_read_content(config_file);
480     cJSON *json = cJSON_Parse(config_contents);
481     free(config_contents);
482     if(!json) {
483         log_error("[framework-config] config.json error: %s\n", cJSON_GetErrorPtr());
484     }
485     else {
486         cJSON *main_node;
487         cJSON *node;
488
489         if(framework_arguments.nts_mode == NTS_MODE_CONTAINER_INIT) {
490             main_node = cJSON_GetObjectItem(json, "container-rules");
491             if(main_node) {
492                 node = cJSON_GetObjectItem(main_node, "excluded-modules");
493                 if(node) {
494                     if(cJSON_IsArray(node)) {
495                         cJSON *element;
496                         cJSON_ArrayForEach(element, node) {
497                             if(cJSON_IsString(element)) {
498                                 log_add_verbose(2, "[framework-config] adding container-rules/exclude-modules: %s\n", element->valuestring);
499                                 framework_config.docker.excluded_modules = (char **)realloc(framework_config.docker.excluded_modules, sizeof(char*) * (framework_config.docker.excluded_modules_count + 1));
500                                 if(!framework_config.docker.excluded_modules) {
501                                     log_error("[framework-config] bad realloc\n");
502                                 }
503                                 framework_config.docker.excluded_modules[framework_config.docker.excluded_modules_count] = (char *)malloc(sizeof(char) * (strlen(element->valuestring) + 1));
504                                 if(!framework_config.docker.excluded_modules[framework_config.docker.excluded_modules_count]) {
505                                     log_error("[framework-config] bad malloc\n");
506                                 }
507                                 strcpy(framework_config.docker.excluded_modules[framework_config.docker.excluded_modules_count], element->valuestring);
508                                 framework_config.docker.excluded_modules_count++;
509                             }
510                         }
511                     }
512                 }
513
514                 node = cJSON_GetObjectItem(main_node, "excluded-features");
515                 if(node) {
516                     if(cJSON_IsArray(node)) {
517                         cJSON *element;
518                         cJSON_ArrayForEach(element, node) {
519                             if(cJSON_IsString(element)) {
520                                 log_add_verbose(2, "[framework-config] adding container-rules/excluded-features: %s\n", element->valuestring);
521                                 framework_config.docker.excluded_features = (char **)realloc(framework_config.docker.excluded_features, sizeof(char*) * (framework_config.docker.excluded_features_count + 1));
522                                 if(!framework_config.docker.excluded_features) {
523                                     log_error("[framework-config] bad realloc\n");
524                                 }
525                                 framework_config.docker.excluded_features[framework_config.docker.excluded_features_count] = (char *)malloc(sizeof(char) * (strlen(element->valuestring) + 1));
526                                 if(!framework_config.docker.excluded_features[framework_config.docker.excluded_features_count]) {
527                                     log_error("[framework-config] bad malloc\n");
528                                 }
529                                 strcpy(framework_config.docker.excluded_features[framework_config.docker.excluded_features_count], element->valuestring);
530                                 framework_config.docker.excluded_features_count++;
531                             }
532                         }
533                     }
534                 }
535             }
536         }
537         else if(framework_arguments.nts_mode == NTS_MODE_SUPERVISOR) {
538             main_node = cJSON_GetObjectItem(json, "supervisor-rules");
539             if(main_node) {
540                 cJSON *app;
541                 cJSON_ArrayForEach(app, main_node) {
542                     if(cJSON_IsObject(app)) {
543                         cJSON *object = cJSON_GetObjectItem(app, "path");
544                         if(object) {
545                             framework_config.supervisor.rules = (supervisor_rules_t *)realloc(framework_config.supervisor.rules, sizeof(supervisor_rules_t) * (framework_config.supervisor.rules_count + 1));
546                             if(!framework_config.supervisor.rules) {
547                                 log_error("[framework-config] bad realloc\n");
548                             }
549                             
550                             char *path = strdup(object->valuestring);
551                             bool autorestart = false;
552                             bool nomanual = false;
553                             char *stdout_path = 0;
554                             char *stderr_path = 0;
555
556                             int args_count = 0;
557                             char **args = 0;
558                             cJSON *args_json = cJSON_GetObjectItem(app, "args");
559                             if(args_json) {
560                                 args_count = cJSON_GetArraySize(args_json);
561                                 if(args_count) {
562                                     args = malloc(sizeof(char *) * args_count);
563                                     int i = 0;
564                                     cJSON *arg;
565                                     cJSON_ArrayForEach(arg, args_json) {
566                                         args[i] = strdup(arg->valuestring);
567                                         i++;
568                                     }
569                                 }
570                             }
571
572                             object = cJSON_GetObjectItem(app, "autorestart");
573                             if(object) {
574                                 autorestart = object->valueint;
575                             }
576
577                             object = cJSON_GetObjectItem(app, "nomanual");
578                             if(object) {
579                                 nomanual = object->valueint;
580                             }
581
582                             object = cJSON_GetObjectItem(app, "stdout");
583                             if(object) {
584                                 stdout_path = strdup(object->valuestring);
585                             }
586
587                             object = cJSON_GetObjectItem(app, "stderr");
588                             if(object) {
589                                 stderr_path = strdup(object->valuestring);
590                             }
591
592                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].name = strdup(app->string);
593                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].path = path;
594                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].args = args;
595                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].args_count = args_count;
596                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].autorestart = autorestart;
597                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].nomanual = nomanual;
598                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].stdout_path = stdout_path;
599                             framework_config.supervisor.rules[framework_config.supervisor.rules_count].stderr_path = stderr_path;
600
601                             log_add_verbose(2, "[framework-config] adding supervisor command: %s with autorestart: %d\n", path, autorestart);
602                             framework_config.supervisor.rules_count++;
603                         }
604                     }
605                 }
606             }
607         }
608         else {
609             main_node = cJSON_GetObjectItem(json, "datastore-random-generation-rules");
610             if(main_node) {
611                 node = cJSON_GetObjectItem(main_node, "excluded-modules");
612                 if(node) {
613                     if(cJSON_IsArray(node)) {
614                         cJSON *element;
615                         cJSON_ArrayForEach(element, node) {
616                             if(cJSON_IsString(element)) {
617                                 log_add_verbose(2, "[framework-config] adding datastore-random-generation-rules/excluded-modules: %s\n", element->valuestring);
618                                 framework_config.datastore_generate.excluded_modules = (char **)realloc(framework_config.datastore_generate.excluded_modules, sizeof(char*) * (framework_config.datastore_generate.excluded_modules_count + 1));
619                                 if(!framework_config.datastore_generate.excluded_modules) {
620                                     log_error("[framework-config] bad realloc\n");
621                                 }
622                                 framework_config.datastore_generate.excluded_modules[framework_config.datastore_generate.excluded_modules_count] = (char *)malloc(sizeof(char) * (strlen(element->valuestring) + 1));
623                                 if(!framework_config.datastore_generate.excluded_modules[framework_config.datastore_generate.excluded_modules_count]) {
624                                     log_error("[framework-config] bad malloc\n");
625                                 }
626                                 strcpy(framework_config.datastore_generate.excluded_modules[framework_config.datastore_generate.excluded_modules_count], element->valuestring);
627                                 framework_config.datastore_generate.excluded_modules_count++;
628                             }
629                         }
630                     }
631                 }
632
633                 node = cJSON_GetObjectItem(main_node, "debug-max-string-size");
634                 if(node) {
635                     framework_config.datastore_generate.debug_max_string_size = node->valueint;
636                     log_add_verbose(2, "[framework-config] setting datastore-random-generation-rules/debug-max-string-size: %d\n", framework_config.datastore_generate.debug_max_string_size);
637                 }
638
639                 node = cJSON_GetObjectItem(main_node, "default-list-instances");
640                 if(node) {
641                     if(cJSON_IsNumber(node)) {
642                         framework_config.datastore_generate.default_list_instances = node->valueint;
643                         log_add_verbose(2, "[framework-config] setting datastore-random-generation-rules/default-list-instances: %d\n", framework_config.datastore_generate.default_list_instances);
644                     }
645                 }
646
647                 node = cJSON_GetObjectItem(main_node, "custom-list-instances");
648                 if(node) {
649                     if(cJSON_IsArray(node)) {
650                         cJSON *element;
651                         cJSON_ArrayForEach(element, node) {
652                             if(cJSON_IsObject(element)) {
653                                 cJSON *object;
654                                 cJSON_ArrayForEach(object, element) {
655                                     char *path = object->string;
656                                     int count = object->valueint;
657                                     log_add_verbose(2, "[framework-config] adding datastore-random-generation-rules/custom-list-instances %s - %d\n", path, count);
658                                     framework_config.datastore_generate.custom_list_instances = (custom_list_instances_t *)realloc(framework_config.datastore_generate.custom_list_instances, sizeof(custom_list_instances_t) * (framework_config.datastore_generate.custom_list_instances_count + 1));
659                                     if(!framework_config.datastore_generate.custom_list_instances) {
660                                         log_error("[framework-config] bad realloc\n");
661                                     }
662                                     
663                                     framework_config.datastore_generate.custom_list_instances[framework_config.datastore_generate.custom_list_instances_count].path = (char *)malloc(sizeof(char) * (strlen(path) + 1));
664                                     if(!framework_config.datastore_generate.custom_list_instances[framework_config.datastore_generate.custom_list_instances_count].path) {
665                                         log_error("[framework-config] bad malloc\n");
666                                     }
667                                     strcpy(framework_config.datastore_generate.custom_list_instances[framework_config.datastore_generate.custom_list_instances_count].path, path);
668                                     framework_config.datastore_generate.custom_list_instances[framework_config.datastore_generate.custom_list_instances_count].count = count;
669                                     framework_config.datastore_generate.custom_list_instances_count++;
670                                 }
671                             }
672                         }
673                     }
674                 }
675
676                 node = cJSON_GetObjectItem(main_node, "restrict-schema");
677                 if(node) {
678                     if(cJSON_IsArray(node)) {
679                         cJSON *element;
680                         cJSON_ArrayForEach(element, node) {
681                             if(cJSON_IsObject(element)) {
682                                 cJSON *object;
683                                 cJSON_ArrayForEach(object, element) {
684                                     char *path = object->string;
685
686                                     log_add_verbose(2, "[framework-config] adding datastore-random-generation-rules/restrict-schema: %s with values:", path);
687                                     framework_config.datastore_generate.restrict_schema = (restrict_schema_t *)realloc(framework_config.datastore_generate.restrict_schema, sizeof(restrict_schema_t) * (framework_config.datastore_generate.restrict_schema_count + 1));
688                                     if(!framework_config.datastore_generate.restrict_schema) {
689                                         log_error("[framework-config] bad realloc\n");
690                                     }
691                                     
692                                     framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].path = (char *)malloc(sizeof(char) * (strlen(path) + 1));
693                                     if(!framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].path) {
694                                         log_error("[framework-config] bad malloc\n");
695                                     }
696                                     strcpy(framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].path, path);
697
698
699                                     framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count = 0;
700                                     framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values = 0;
701                                     framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].index = 0;
702                                     cJSON *value;
703                                     cJSON_ArrayForEach(value, object) {
704                                         if(cJSON_IsString(value)) {
705                                             framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values = (char **)realloc(framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values, sizeof(char*) * (framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count + 1));
706                                             if(!framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values) {
707                                                 log_error("[framework-config] bad realloc\n");
708                                             }
709                                             framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values[framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count] = (char *)malloc(sizeof(char) * (strlen(value->valuestring) + 1));
710                                             if(!framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values[framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count]) {
711                                                 log_error("[framework-config] bad malloc\n");
712                                             }
713                                             strcpy(framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values[framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count], value->valuestring);
714                                             framework_config.datastore_generate.restrict_schema[framework_config.datastore_generate.restrict_schema_count].values_count++;
715
716                                             log_add(2, " %s", value->valuestring);
717                                         }
718                                     }
719                                     log_add(2, "\n");
720
721                                     framework_config.datastore_generate.restrict_schema_count++;
722                                 }
723                             }
724                         }
725                     }
726                 }
727             }
728
729             main_node = cJSON_GetObjectItem(json, "datastore-populate-rules");
730             if(main_node) {
731                 node = cJSON_GetObjectItem(main_node, "random-generation-enabled");
732                 if(node) {
733                     framework_config.datastore_populate.random_generation_enabled = node->valueint;
734                     log_add_verbose(2, "[framework-config] setting datastore-populate-rules/random-generation-enabled: %d\n", framework_config.datastore_populate.random_generation_enabled);
735                 }
736                 else {
737                     log_add_verbose(2, "[framework-config] setting datastore-populate-rules/random-generation-enabled: %d [default value]\n", framework_config.datastore_populate.random_generation_enabled);
738                 }
739                 
740                 node = cJSON_GetObjectItem(main_node, "pre-generated-operational-data");
741                 if(node) {
742                     if(cJSON_IsArray(node)) {
743                         cJSON *element;
744                         cJSON_ArrayForEach(element, node) {
745                             if(cJSON_IsString(element)) {
746                                 log_add_verbose(2, "[framework-config] adding datastore-populate-rules/pre-generated-operational-data: %s\n", element->valuestring);
747                                 framework_config.datastore_populate.preg_operational = (char **)realloc(framework_config.datastore_populate.preg_operational, sizeof(char*) * (framework_config.datastore_populate.preg_operational_count + 1));
748                                 if(!framework_config.datastore_populate.preg_operational) {
749                                     log_error("[framework-config] bad realloc\n");
750                                 }
751                                 framework_config.datastore_populate.preg_operational[framework_config.datastore_populate.preg_operational_count] = (char *)malloc(sizeof(char) * (strlen(element->valuestring) + 1));
752                                 if(!framework_config.datastore_populate.preg_operational[framework_config.datastore_populate.preg_operational_count]) {
753                                     log_error("[framework-config] bad malloc\n");
754                                 }
755                                 strcpy(framework_config.datastore_populate.preg_operational[framework_config.datastore_populate.preg_operational_count], element->valuestring);
756                                 framework_config.datastore_populate.preg_operational_count++;
757                             }
758                         }
759                     }
760                 }
761
762                 node = cJSON_GetObjectItem(main_node, "pre-generated-running-data");
763                 if(node) {
764                     if(cJSON_IsArray(node)) {
765                         cJSON *element;
766                         cJSON_ArrayForEach(element, node) {
767                             if(cJSON_IsString(element)) {
768                                 log_add_verbose(2, "[framework-config] adding datastore-populate-rules/pre-generated-running-data: %s\n", element->valuestring);
769                                 framework_config.datastore_populate.preg_running = (char **)realloc(framework_config.datastore_populate.preg_running, sizeof(char*) * (framework_config.datastore_populate.preg_running_count + 1));
770                                 if(!framework_config.datastore_populate.preg_running) {
771                                     log_error("[framework-config] bad realloc\n");
772                                 }
773                                 framework_config.datastore_populate.preg_running[framework_config.datastore_populate.preg_running_count] = (char *)malloc(sizeof(char) * (strlen(element->valuestring) + 1));
774                                 if(!framework_config.datastore_populate.preg_running[framework_config.datastore_populate.preg_running_count]) {
775                                     log_error("[framework-config] bad malloc\n");
776                                 }
777                                 strcpy(framework_config.datastore_populate.preg_running[framework_config.datastore_populate.preg_running_count], element->valuestring);
778                                 framework_config.datastore_populate.preg_running_count++;
779                             }
780                         }
781                     }
782                 }
783
784             }
785         }
786
787         cJSON_Delete(json);
788         
789     }
790     log_add_verbose(2, "[framework-config] finished parsing config.json\n");
791
792     return NTS_ERR_OK;
793 }
794
795 void framework_free(void) {
796     log_add_verbose(2, "[framework-config] framework_free()... ");
797
798     signal(SIGINT, 0);
799     signal(SIGTERM, 0);
800     signal(SIGQUIT, 0);
801
802     free((char *)argp_program_version);
803     argp_program_version = 0;
804
805     free(framework_environment.nts.version);
806     free(framework_environment.nts.build_time);
807     free(framework_environment.nts.function_type);
808     free(framework_environment.nts.nf_standalone_start_features);
809     free(framework_environment.nts.nf_mount_point_addressing_method);
810     free(framework_environment.settings.ip_v4);
811     free(framework_environment.settings.ip_v6);
812     free(framework_environment.settings.docker_engine_version);
813     free(framework_environment.settings.docker_repository);
814     free(framework_environment.settings.hostname);
815     free(framework_environment.host.ip);
816     free(framework_environment.sdn_controller.protocol);
817     free(framework_environment.sdn_controller.ip);
818     free(framework_environment.sdn_controller.username);
819     free(framework_environment.sdn_controller.password);
820     free(framework_environment.ves_endpoint.common_header_version);
821     free(framework_environment.ves_endpoint.protocol);
822     free(framework_environment.ves_endpoint.ip);
823     free(framework_environment.ves_endpoint.auth_method);
824     free(framework_environment.ves_endpoint.username);
825     free(framework_environment.ves_endpoint.password);
826     free(framework_environment.ves_endpoint.certificate);
827
828     free(framework_arguments.print_structure_xpath);
829     framework_arguments.print_structure_xpath = 0;
830
831     for(int i = 0; i < framework_config.supervisor.rules_count; i++) {
832         free(framework_config.supervisor.rules[i].name);
833         free(framework_config.supervisor.rules[i].path);
834         for(int j = 0; j < framework_config.supervisor.rules[i].args_count; j++) {
835             free(framework_config.supervisor.rules[i].args[j]);
836         }
837         free(framework_config.supervisor.rules[i].args);
838         free(framework_config.supervisor.rules[i].stdout_path);
839         free(framework_config.supervisor.rules[i].stderr_path);
840     }
841
842     free(framework_config.supervisor.rules);
843
844     for(int i = 0; i < framework_config.docker.excluded_modules_count; i++) {
845         free(framework_config.docker.excluded_modules[i]);
846     }
847     free(framework_config.docker.excluded_modules);
848
849     for(int i = 0; i < framework_config.docker.excluded_features_count; i++) {
850         free(framework_config.docker.excluded_features[i]);
851     }
852     free(framework_config.docker.excluded_features);
853     
854     for(int i = 0; i < framework_config.datastore_generate.excluded_modules_count; i++) {
855         free(framework_config.datastore_generate.excluded_modules[i]);
856     }
857     free(framework_config.datastore_generate.excluded_modules);
858
859
860     for(int i = 0; i < framework_config.datastore_generate.custom_list_instances_count; i++) {
861         free(framework_config.datastore_generate.custom_list_instances[i].path);
862         
863     }
864     free(framework_config.datastore_generate.custom_list_instances);
865
866     for(int i = 0; i < framework_config.datastore_generate.restrict_schema_count; i++) {
867         free(framework_config.datastore_generate.restrict_schema[i].path);
868         for(int j = 0; j < framework_config.datastore_generate.restrict_schema[i].values_count; j++) {
869             free(framework_config.datastore_generate.restrict_schema[i].values[j]);
870         }
871         free(framework_config.datastore_generate.restrict_schema[i].values);
872     }
873     free(framework_config.datastore_generate.restrict_schema);
874
875     for(int i = 0; i < framework_config.datastore_populate.preg_operational_count; i++) {
876         free(framework_config.datastore_populate.preg_operational[i]);
877     }
878     free(framework_config.datastore_populate.preg_operational);
879
880     for(int i = 0; i < framework_config.datastore_populate.preg_running_count; i++) {
881         free(framework_config.datastore_populate.preg_running[i]);
882     }
883     free(framework_config.datastore_populate.preg_running);
884
885
886     log_add(2, "done\n");
887     log_close();
888 }
889
890 static void framework_signal_handler(int signo) {
891     framework_sigint = 1;
892 }
893
894 static error_t parse_opt(int key, char *arg, struct argp_state *state) {
895     framework_arguments_t *iter_arguments = state->input;
896     switch (key) {
897         case 'i':
898             iter_arguments->nts_mode = NTS_MODE_CONTAINER_INIT;
899             break;
900
901         case 's':
902             iter_arguments->nts_mode = NTS_MODE_SUPERVISOR;
903             break;
904
905         case 'm':
906             iter_arguments->nts_mode = NTS_MODE_MANAGER;
907             break;
908
909         case 'f':
910             iter_arguments->nts_mode = NTS_MODE_NETWORK_FUNCTION;
911             break;
912
913         case 'b':
914             iter_arguments->nts_mode = NTS_MODE_BLANK;
915             break;
916
917         case 'g':
918             iter_arguments->nts_mode = NTS_MODE_GENERATE_DATA;
919             break;
920
921         case 't':
922             iter_arguments->nts_mode = NTS_MODE_TEST;
923             break;
924
925         case 'r':
926             iter_arguments->no_rand = true;
927             framework_arguments.fixed_seed = 0;
928             int i = 0;
929             while(arg[i]) {
930                 framework_arguments.fixed_seed *= 10;
931                 framework_arguments.fixed_seed += arg[i] - '0';
932                 i++;
933             }
934             break;
935
936         case 'v':
937             iter_arguments->verbosity_level = arg[0] - '0';
938             break;
939
940         case 'w':
941             chdir(arg);
942             break;
943
944         case '1':
945             iter_arguments->print_root_paths = true;
946             break;
947
948         case '2':
949             iter_arguments->print_structure_xpath = (char *)malloc(sizeof(char) * (strlen(arg) + 1));
950             if(!iter_arguments->print_structure_xpath) {
951                 log_error("[framework-arg] bad malloc\n");
952                 return 1;
953             }
954             strcpy(iter_arguments->print_structure_xpath, arg);
955             if(arg[strlen(arg) - 1] == '/') {
956                 iter_arguments->print_structure_xpath[strlen(arg) - 1] = 0;
957             }
958             break;
959
960         case ARGP_KEY_ARG:
961             if (state->arg_num >= 2) {
962                 argp_usage(state);
963             }
964             break;
965
966         case ARGP_KEY_END:
967
968             break;
969
970         default:
971             return ARGP_ERR_UNKNOWN;
972     }
973     
974     return 0;
975 }