Added new status/report framework.

The purpose of this framework is to allow Modules (or parts of the core) to register identifiers in order to publish their status (readiness) and reports (logs).
There statuses/reports may be checked from scripts or listed via MI. This allow the script to check the readiness status of various components of OpenSIPS, or, an external entity may monitor (check, list, get events) of the status / readiness of OpenSIPS (or parts of it). Also reports (some important logs poduced by OpenSIPS/modules) may be listed via MI, in order to have some history of what happened inside OpenSIPS/modules.

Available cfg commnds (core provided):
	sr_check_status( group, [identifier])

Available MI commands (core providede):
	sr_get_status group identifier
	sr_list_status [group]
	sr_list_reports [group] [identifier]

Available events (core provided):
	E_SR_STATUS_CHANGED ( group, identifier, new_status, new_details, old_status)

The old "general" OpenSIPS status was ported to this new framework as group "core", identifier "main", publishing the core status (startup, running, terminating).

Author: bogdan-iancu

core_cmds.c

@@ -36,6 +36,7 @@
 #include "flags.h"
 #include "serialize.h"
 #include "blacklists.h"
+#include "status_report.h"
 #include "cachedb/cachedb.h"
 #include "msg_translator.h"
 /* needed by tcpconn_add_alias() */
@@ -299,6 +300,11 @@ static cmd_export_t core_cmds[]={
 		{CMD_PARAM_STR, 0, 0},
 		{CMD_PARAM_INT|CMD_PARAM_OPT, 0, 0}, {0,0,0}},
 		ALL_ROUTES},
+	{"sr_check_status", (cmd_function)w_sr_check_status, {
+		{CMD_PARAM_STR, fixup_sr_group, 0},
+		{CMD_PARAM_STR|CMD_PARAM_OPT, 0, 0}, {0,0,0}},
+		ALL_ROUTES},
+
 	{0,0,{{0,0,0}},0}
 };
 

daemonize.c

@@ -67,8 +67,6 @@ char *startup_wdir = NULL;
 
 static int status_pipe[2];
 
-static enum opensips_states *osips_state = NULL;
-
 /* creates the status pipe which will be used for
  * proper status code returning
  *
@@ -567,26 +565,3 @@ int set_core_dump(int enable, unsigned int size)
 	return -1;
 }
 
-
-/* first setting must be done before any forking, so all processes will
- * inherite the same pointer to the global state variable */
-void set_osips_state(enum opensips_states state)
-{
-	if (osips_state==NULL) {
-		osips_state = shm_malloc( sizeof(enum opensips_states) );
-		if (osips_state==NULL) {
-			LM_ERR("failed to allocate opensips state variable in shm\n");
-			return;
-		}
-	}
-
-	*osips_state = state;
-}
-
-
-enum opensips_states get_osips_state(void)
-{
-	return osips_state ? *osips_state : STATE_NONE;
-}
-
-

daemonize.h

@@ -41,12 +41,6 @@ int create_status_pipe(void);
 int wait_for_one_child(void);
 int wait_for_all_children(void);
 
-enum opensips_states {STATE_NONE, STATE_STARTING,
-	STATE_RUNNING, STATE_TERMINATING};
-
-void set_osips_state(enum opensips_states);
-enum opensips_states get_osips_state(void);
-
 #define report_failure_status() \
 	do { \
 		if (send_status_code(-1) < 0) \

main.c

@@ -131,6 +131,7 @@
 #include "ut.h"
 #include "serialize.h"
 #include "statistics.h"
+#include "status_report.h"
 #include "core_stats.h"
 #include "pvar.h"
 #include "signals.h"
@@ -256,7 +257,8 @@ static int main_loop(void)
 		shm_free(startup_done);
 	}
 
-	set_osips_state( STATE_RUNNING );
+	sr_set_core_status( STATE_RUNNING, MI_SSTR("running"));
+	sr_add_core_report( MI_SSTR("initialization completed, ready now") );
 
 	/* main process left */
 	is_main=1;
@@ -632,7 +634,13 @@ int main(int argc, char** argv)
 		goto error;
 	}
 
-	set_osips_state( STATE_STARTING );
+	if (init_status_report() < 0) {
+		LM_ERR("failed to initialize status-report support\n");
+		goto error;
+	}
+
+	sr_set_core_status( STATE_INITIALIZING, MI_SSTR("initializing"));
+	sr_add_core_report( MI_SSTR("initializing") );
 
 	if ((!testing_framework || strcmp(testing_module, "core"))
 	        && parse_opensips_cfg(cfg_file, preproc, NULL) < 0) {

mi/mi_core.c

@@ -49,6 +49,7 @@
 #include "../ipc.h"
 #include "../xlog.h"
 #include "../cfg_reload.h"
+#include "../status_report.h"
 #include "mi.h"
 #include "mi_trace.h"
 
@@ -897,6 +898,28 @@ static mi_export_t mi_core_cmds[] = {
 		{EMPTY_MI_RECIPE}
 		}
 	},
+	{ "sr_get_status", "gets the status (only) of a 'status-report' "
+	"group/identifier", 0, 0, {
+		{mi_sr_get_status, {"group",0}},
+		{mi_sr_get_status, {"group","identifier",0}},
+		{EMPTY_MI_RECIPE}
+		}
+	},
+	{ "sr_list_status", "list the status of all the identifiers in OpenSIPS"
+	" or from a certain 'status-report' group", 0, 0, {
+		{mi_sr_list_status, {0}},
+		{mi_sr_list_status, {"group",0}},
+		{EMPTY_MI_RECIPE}
+		}
+	},
+	{ "sr_list_reports", "list the reports produced by some 'status-report' "
+	"identifiers / groups" , 0, 0, {
+		{mi_sr_list_reports, {0}},
+		{mi_sr_list_reports, {"group",0}},
+		{mi_sr_list_reports, {"group","identifier",0}},
+		{EMPTY_MI_RECIPE}
+		}
+	},
 	{ "help", "prints information about MI commands usage", 0, 0, {
 		{w_mi_help, {0}},
 		{w_mi_help_1, {"mi_cmd", 0}},

modules/dispatcher/dispatch.c

@@ -29,7 +29,7 @@
 
 #include "../../ut.h"
 #include "../../trim.h"
-#include "../../daemonize.h"
+#include "../../status_report.h"
 #include "../../dprint.h"
 #include "../../action.h"
 #include "../../route.h"
@@ -909,7 +909,8 @@ void ds_flusher_routine(unsigned int ticks, void* param)
 	ds_set_p list;
 	int j;
 
-	if (ticks > 0 && get_osips_state() > STATE_RUNNING)
+	/* do not run this routine if not in running mode */
+	if (ticks > 0 && sr_get_core_status() < STATE_RUNNING)
 		return;
 
 	ds_partition_t *partition;
@@ -2682,7 +2683,8 @@ void ds_update_weights(unsigned int ticks, void *param)
 	ds_partition_t *part;
 	ds_set_p sp;
 
-	if (get_osips_state() > STATE_RUNNING)
+	/* do not run this routine if not in running mode */
+	if (sr_get_core_status() < STATE_RUNNING)
 		return;
 
 	for (part = partitions; part; part = part->next) {

modules/mid_registrar/save.c

@@ -42,7 +42,7 @@
 #include "../../dset.h"
 
 #include "../../parser/parse_from.h"
-#include "../../daemonize.h"
+#include "../../status_report.h"
 #include "../../mod_fix.h"
 #include "../../data_lump.h"
 #include "../../data_lump_rpl.h"
@@ -1865,7 +1865,7 @@ void mid_reg_tmcb_deleted(struct cell *_, int __, struct tmcb_params *params)
 
 	/* no response from downstream - clear up any lingering refs! */
 	if (mri->pending_replies && (reg_mode != MID_REG_THROTTLE_AOR) &&
-	        get_osips_state() < STATE_TERMINATING) {
+	        sr_get_core_status() == STATE_RUNNING) {
 		ul.lock_udomain(mri->dom, &mri->aor);
 		ul.get_urecord(mri->dom, &mri->aor, &r);
 		if (!r) {

modules/usrloc/dlist.c

@@ -40,7 +40,7 @@
 #include "../../ut.h"
 #include "../../db/db_ut.h"
 #include "../../mem/shm_mem.h"
-#include "../../daemonize.h"
+#include "../../status_report.h"
 #include "../../dprint.h"
 #include "../../ip_addr.h"
 #include "../../socket_info.h"
@@ -895,7 +895,7 @@ static inline int new_dlist(str* _n, dlist_t** _d)
 {
 	dlist_t* ptr;
 
-	if (get_osips_state()>STATE_STARTING) {
+	if (sr_get_core_status()!=STATE_INITIALIZING) {
 		LM_ERR("cannot register new domain during runtime\n");
 		return -1;
 	}

shutdown.c

@@ -34,6 +34,7 @@
 #include "route.h"
 #include "script_cb.h"
 #include "blacklists.h"
+#include "status_report.h"
 #include "mem/shm_mem.h"
 #include "db/db_insertq.h"
 #include "net/net_udp.h"
@@ -189,7 +190,7 @@ void shutdown_opensips( int status )
 	int i, n, p;
 	int chld_status;
 
-	set_osips_state( STATE_TERMINATING );
+	sr_set_core_status( STATE_TERMINATING, MI_SSTR("shutting down"));
 
 	/* terminate all processes */
 

signals.c

@@ -27,6 +27,7 @@
 #include "dprint.h"
 #include "daemonize.h"
 #include "pt.h"
+#include "status_report.h"
 #include "shutdown.h"
 #include "signals.h"
 
@@ -175,7 +176,7 @@ static void sig_usr(int signo)
 			case SIGTERM:
 					/* ignore any SIGTERM if not in shutdown sequance (this 
 					 * is marked by the attendent process) */
-					if (get_osips_state()!=STATE_TERMINATING)
+					if (sr_get_core_status()!=STATE_TERMINATING)
 						return;
 					/* if some shutdown already in progress, ignore this one */
 					if (sig_flag==0) sig_flag=signo;