Migrate from index to references when pointing to a script route

The idx are hard to work with in the context of script reload, as they cannot be upated or checked (if still valid).
So, instead of pointing to the route by its idx, use an intermediary structure that holds: name of the route, the idx of the route, the version of the script.

Now, such intermediary structs (or route refs) may operate in 2 ways:
* they are per process, in pkg; all such refs are linked in a single list and automatically updated (their idx) upon reload.
* they are shared (like attached to data structs in shm), in shm; if so, before using it, the version is checked, and if old, the idx is updated on spot.

Author: bogdan-iancu

action.c

@@ -1058,13 +1058,13 @@ int do_action(struct action* a, struct sip_msg* msg)
 			break;
 		case ASYNC_T:
 			/* first param - an ACTIONS_ST containing an ACMD_ST
-			 * second param - a NUMBER_ST pointing to resume route
+			 * second param - a ROUTE_REF_ST pointing to resume route
 			 * third param - an optional NUMBER_ST with a timeout */
 			aitem = (struct action *)(a->elem[0].u.data);
 			acmd = (const acmd_export_t *)aitem->elem[0].u.data_const;
 
 			if (async_script_start_f==NULL || a->elem[0].type!=ACTIONS_ST ||
-			a->elem[1].type!=NUMBER_ST || aitem->type!=AMODULE_T) {
+			a->elem[1].type!=ROUTE_REF_ST || aitem->type!=AMODULE_T) {
 				LM_ALERT("BUG in async expression "
 				         "(is the 'tm' module loaded?)\n");
 			} else {
@@ -1077,7 +1077,8 @@ int do_action(struct action* a, struct sip_msg* msg)
 					break;
 				}
 
-				ret = async_script_start_f(msg, aitem, a->elem[1].u.number,
+				ret = async_script_start_f(msg, aitem,
+					(struct script_route_ref*)a->elem[1].u.data,
 					(unsigned int)a->elem[2].u.number, cmdp);
 				if (ret>=0)
 					action_flags |= ACT_FL_TBCONT;
@@ -1092,17 +1093,17 @@ int do_action(struct action* a, struct sip_msg* msg)
 			break;
 		case LAUNCH_T:
 			/* first param - an ACTIONS_ST containing an ACMD_ST
-			 * second param - an optional NUMBER_ST pointing to an end route */
+			 * second param - an optional ROUTE_REF_ST pointing to an end route */
 			aitem = (struct action *)(a->elem[0].u.data);
 			acmd = (const acmd_export_t *)aitem->elem[0].u.data_const;
 
 			if (async_script_start_f==NULL || a->elem[0].type!=ACTIONS_ST ||
-			a->elem[1].type!=NUMBER_ST || aitem->type!=AMODULE_T) {
+			a->elem[1].type!=ROUTE_REF_ST || aitem->type!=AMODULE_T) {
 				LM_ALERT("BUG in launch expression\n");
 			} else {
 				script_trace("launch", acmd->name, msg, a->file, a->line);
-				/* NOTE that the routeID (a->elem[1].u.number) is set to 
-				 * -1 if no reporting route is set */
+				/* NOTE that the routeID (a->elem[1].u.data) is set to 
+				 * NULL if no reporting route is set */
 
 				if ((ret = get_cmd_fixups(msg, acmd->params, aitem->elem,
 					cmdp, tmp_vals)) < 0) {
@@ -1117,10 +1118,12 @@ int do_action(struct action* a, struct sip_msg* msg)
 						break;
 					}
 
-					ret = async_script_launch( msg, aitem, a->elem[1].u.number,
+					ret = async_script_launch( msg, aitem,
+						(struct script_route_ref*)a->elem[1].u.data,
 						&sval, cmdp);
 				} else {
-					ret = async_script_launch( msg, aitem, a->elem[1].u.number,
+					ret = async_script_launch( msg, aitem,
+						(struct script_route_ref*)a->elem[1].u.data,
 						NULL, cmdp);
 				}
 

async.c

@@ -45,8 +45,8 @@ async_script_resume_function *async_script_resume_f = NULL;
 typedef struct _async_launch_ctx {
 	/* generic async context - MUST BE FIRST */
 	async_ctx  async;
-	/* the ID of the report script route (-1 if none) */
-	int report_route;
+	/* ref to the report script route (NULL if none) */
+	struct script_route_ref *report_route;
 	str report_route_param;
 } async_launch_ctx;
 
@@ -240,18 +240,18 @@ int async_launch_resume(int fd, void *param)
 	if (async_status == ASYNC_DONE_CLOSE_FD)
 		close(fd);
 
-	if (ctx->report_route!=-1) {
+	if (ref_script_route_check_and_update(ctx->report_route)) {
 		LM_DBG("runinng report route for a launch job,"
 			" route <%s>, param [%.*s]\n",
-			sroutes->request[ctx->report_route].name, 
+			ctx->report_route->name.s,
 			ctx->report_route_param.len, ctx->report_route_param.s);
 		if (ctx->report_route_param.s)
 			route_params_push_level(
-				sroutes->request[ctx->report_route].name, 
+				sroutes->request[ctx->report_route->idx].name, 
 				&ctx->report_route_param, NULL,
 				launch_route_param_get);
 		swap_route_type( bk_rt, REQUEST_ROUTE);
-		run_top_route( sroutes->request[ctx->report_route], req);
+		run_top_route( sroutes->request[ctx->report_route->idx], req);
 		set_route_type( bk_rt );
 		if (ctx->report_route_param.s)
 			route_params_pop_level();
@@ -261,6 +261,8 @@ int async_launch_resume(int fd, void *param)
 	}
 
 	/* no need for the context anymore */
+	if (ctx->report_route)
+		shm_free(ctx->report_route);
 	shm_free(ctx);
 	LM_DBG("done with a launch job\n");
 
@@ -273,7 +275,8 @@ int async_launch_resume(int fd, void *param)
 
 
 int async_script_launch(struct sip_msg *msg, struct action* a,
-					int report_route, str *report_route_param, void **params)
+								struct script_route_ref *report_route,
+								str *report_route_param, void **params)
 {
 	struct sip_msg *req;
 	struct usr_avp *report_avps = NULL, **bak_avps = NULL;
@@ -331,7 +334,12 @@ int async_script_launch(struct sip_msg *msg, struct action* a,
 	}
 
 	/* ctx is to be used from this point further */
-	ctx->report_route = report_route;
+
+	ctx->report_route = dup_ref_script_route_in_shm( report_route, 0);
+	if (!ref_script_route_is_valid(ctx->report_route)) {
+		LM_ERR("failed dup resume route -> act in sync mode\n");
+		goto sync;
+	}
 
 	if (report_route_param) {
 		ctx->report_route_param.s = (char *)(ctx+1);
@@ -366,8 +374,10 @@ int async_script_launch(struct sip_msg *msg, struct action* a,
 	} while(async_status==ASYNC_CONTINUE||async_status==ASYNC_CHANGE_FD);
 	/* the IO completed, so report now */
 report:
+	if (ctx->report_route)
+		shm_free(ctx->report_route);
 	shm_free(ctx);
-	if (report_route==-1)
+	if (report_route==NULL)
 		return 1;
 
 	/* run the report route inline */
@@ -380,7 +390,7 @@ int async_script_launch(struct sip_msg *msg, struct action* a,
 	bak_avps = set_avp_list(&report_avps);
 	swap_route_type( bk_rt, REQUEST_ROUTE);
 
-	run_top_route( sroutes->request[report_route], req);
+	run_top_route( sroutes->request[report_route->idx], req);
 
 	set_route_type( bk_rt );
 	destroy_avp_list(&report_avps);

async.h

@@ -27,6 +27,7 @@
 #ifndef _ASYNC_H_
 #define _ASYNC_H_
 
+#include "route.h"
 #include "route_struct.h"
 #include "parser/msg_parser.h"
 
@@ -74,7 +75,8 @@ extern int async_status;
           -1 some error happened and the async call did not happened.
  */
 typedef int (async_script_start_function)
-	(struct sip_msg *msg, struct action* a , int resume_route,
+	(struct sip_msg *msg, struct action* a,
+	struct script_route_ref *resume_route,
 	unsigned int timeout, void **params);
 
 /* Handles periodic progress (data arrival) on behalf of the contained,
@@ -140,7 +142,8 @@ int async_fd_resume(int fd, void *param);
 /******** functions related to async launch *******/
 
 int async_script_launch(struct sip_msg *msg, struct action* a,
-		int report_route, str *report_route_param, void **params);
+		struct script_route_ref *report_route,
+		str *report_route_param, void **params);
 
 /* @fd is always valid */
 int async_launch_resume(int fd, void *param);

cfg.y

@@ -141,6 +141,7 @@ static pv_spec_t *spec;
 static pv_elem_t *elem;
 static struct bl_rule *bl_head = 0;
 static struct bl_rule *bl_tail = 0;
+static struct script_route_ref *rt_ref = NULL;
 
 action_elem_t elems[MAX_ACTION_ELEMS];
 static action_elem_t route_elems[MAX_ACTION_ELEMS];
@@ -2474,32 +2475,36 @@ cmd:	 ASSERT LPAREN exp COMMA STRING RPAREN	 {
 		| XLOG LPAREN STRING COMMA folded_string RPAREN {
 				mk_action2($$, XLOG_T, STR_ST, STR_ST, $3, $5); }
 		| ASYNC_TOKEN LPAREN async_func COMMA route_name RPAREN {
-				i_tmp = get_script_route_idx( $5, sroutes->request, RT_NO, 0);
-				if (i_tmp==-1) yyerror("too many script routes");
-				mk_action2($$, ASYNC_T, ACTIONS_ST, NUMBER_ST,
-						$3, (void*)(long)i_tmp);
+				rt_ref = ref_script_route_by_name( $5, sroutes->request,
+					RT_NO, REQUEST_ROUTE, 0);
+				if (rt_ref==NULL) yyerror("fail to create route reference");
+				mk_action2($$, ASYNC_T, ACTIONS_ST, ROUTE_REF_ST,
+						$3, (void*)rt_ref);
 				}
 		| ASYNC_TOKEN LPAREN async_func COMMA route_name COMMA NUMBER RPAREN {
-				i_tmp = get_script_route_idx( $5, sroutes->request, RT_NO, 0);
-				if (i_tmp==-1) yyerror("too many script routes");
-				mk_action3($$, ASYNC_T, ACTIONS_ST, NUMBER_ST, NUMBER_ST,
-						$3, (void*)(long)i_tmp, (void*)(long)$7);
+				rt_ref = ref_script_route_by_name( $5, sroutes->request,
+					RT_NO, REQUEST_ROUTE, 0);
+				if (rt_ref==NULL) yyerror("fail to create route reference");
+				mk_action3($$, ASYNC_T, ACTIONS_ST, ROUTE_REF_ST, NUMBER_ST,
+						$3, (void*)rt_ref, (void*)(long)$7);
 				}
 		| LAUNCH_TOKEN LPAREN async_func COMMA route_name COMMA STRING RPAREN {
-				i_tmp = get_script_route_idx( $5, sroutes->request, RT_NO, 0);
-				if (i_tmp==-1) yyerror("too many script routes");
-				mk_action3($$, LAUNCH_T, ACTIONS_ST, NUMBER_ST, STRING_ST,
-						$3, (void*)(long)i_tmp, $7);
+				rt_ref = ref_script_route_by_name( $5, sroutes->request,
+					RT_NO, REQUEST_ROUTE, 0);
+				if (rt_ref==NULL) yyerror("fail to create route reference");
+				mk_action3($$, LAUNCH_T, ACTIONS_ST, ROUTE_REF_ST, STRING_ST,
+						$3, (void*)rt_ref, $7);
 				}
 		| LAUNCH_TOKEN LPAREN async_func COMMA route_name RPAREN {
-				i_tmp = get_script_route_idx( $5, sroutes->request, RT_NO, 0);
-				if (i_tmp==-1) yyerror("too many script routes");
-				mk_action2($$, LAUNCH_T, ACTIONS_ST, NUMBER_ST,
-						$3, (void*)(long)i_tmp);
+				rt_ref = ref_script_route_by_name( $5, sroutes->request,
+					RT_NO, REQUEST_ROUTE, 0);
+				if (rt_ref==NULL) yyerror("fail to create route reference");
+				mk_action2($$, LAUNCH_T, ACTIONS_ST, ROUTE_REF_ST,
+						$3, (void*)rt_ref);
 				}
 		| LAUNCH_TOKEN LPAREN async_func RPAREN {
-				mk_action2($$, LAUNCH_T, ACTIONS_ST, NUMBER_ST,
-						$3, (void*)(long)-1);
+				mk_action2($$, LAUNCH_T, ACTIONS_ST, ROUTE_REF_ST,
+						$3, (void*)NULL);
 				}
 	;
 

cfg_reload.c

@@ -154,117 +154,6 @@ static inline void reset_script_reload_ctx(void)
 }
 
 
-static int reindex_new_sroutes(struct script_route *new_sr,
-						struct script_route *old_sr, int size, int has_zero)
-{
-	static char *deleted_route_name = "_X_deleted_Y_";
-	struct script_route *my_sr;
-	int i, n, adding_idx;
-
-	/* devel only
-	for(i=0+(has_zero?0:1) ; i<size && old_sr[i].name ; i++)
-		LM_DBG("OLD [%d] is [%s]\n",i,old_sr[i].name);
-	for(i=0+(has_zero?0:1) ; i<size && new_sr[i].name ; i++)
-		LM_DBG("NEW [%d] is [%s]\n",i,new_sr[i].name);*/
-
-	my_sr = (struct script_route*)pkg_malloc(size*sizeof(struct script_route));
-	if (my_sr==NULL) {
-		LM_ERR("failed to allocate pkg mem (needing %zu)\n",
-			size*sizeof(struct script_route));
-		return -1;
-	}
-	memset( my_sr, 0, size*sizeof(struct script_route));
-	/* iterate the old set of route and try to correlate the entries with the
-	 * new set of routes - the idea is to try to preserv the indexes */
-	if (has_zero) {
-		my_sr[0] = new_sr[0];
-		new_sr[0].name = NULL;
-		new_sr[0].a = NULL;
-	}
-	for ( i=1 ; i<size && old_sr[i].name ; i++) {
-		if (old_sr[i].name == deleted_route_name) {
-			/* simply preserve the index of old deleted routes */
-			my_sr[i] = old_sr[i];
-		} else {
-			n = get_script_route_ID_by_name( old_sr[i].name, new_sr, size);
-			if (n==-1) {
-				/* route was removed in the new set , set the dummy one here */
-				my_sr[i].name = deleted_route_name;
-				my_sr[i].a = pkg_malloc( sizeof(struct action) );
-				if (my_sr[i].a==NULL) {
-					LM_ERR("failed to allocate dummy EXIT action\n");
-					pkg_free(my_sr);
-					return -1;
-				}
-				my_sr[i].a->type = EXIT_T;
-			} else {
-				/* copy new route definition over the original index*/
-				my_sr[i] = new_sr[n];
-				new_sr[n].name = deleted_route_name;
-				new_sr[n].a = NULL;
-			}
-		}
-	}
-	adding_idx = i;
-
-	/* now see what is left in new set and not re-mapped to the old set 
-	 * (basically the newly defined routes */
-	for ( i=1 ; i<size ; i++) {
-		if (new_sr[i].name==deleted_route_name || new_sr[i].name==NULL)
-			continue;
-		if (adding_idx==size) {
-			LM_ERR("too many routes, cannot re-index newly defined routes "
-				"after reload\n");
-			pkg_free(my_sr);
-			return -1;
-		}
-		my_sr[adding_idx++] = new_sr[i];
-	}
-
-	/* copy the re-indexed set of routes as the new set of routes */
-	memcpy( new_sr, my_sr, size*sizeof(struct script_route));
-	pkg_free(my_sr);
-	/* devel only
-	for(i=0+(has_zero?0:1) ; i<size && new_sr[i].name ; i++)
-		LM_DBG("END NEW [%d] is [%s]\n",i,new_sr[i].name);
-	*/
-	return 0;
-}
-
-
-static int reindex_all_new_sroutes(struct os_script_routes *new_srs,
-											struct os_script_routes *old_srs)
-{
-	if (reindex_new_sroutes( new_srs->request, old_srs->request,
-	RT_NO, 1)<0) {
-		LM_ERR("failed to re-index the request routes\n");
-		return -1;
-	}
-	if (reindex_new_sroutes( new_srs->onreply, old_srs->onreply,
-	ONREPLY_RT_NO, 1)<0) {
-		LM_ERR("failed to re-index the on_reply routes\n");
-		return -1;
-	}
-	if (reindex_new_sroutes( new_srs->failure, old_srs->failure,
-	FAILURE_RT_NO, 0)<0) {
-		LM_ERR("failed to re-index the on_failure routes\n");
-		return -1;
-	}
-	if (reindex_new_sroutes( new_srs->branch, old_srs->branch,
-	BRANCH_RT_NO, 0)<0) {
-		LM_ERR("failed to re-index the branch routes\n");
-		return -1;
-	}
-	if (reindex_new_sroutes( new_srs->event, old_srs->event,
-	EVENT_RT_NO, 0)<0) {
-		LM_ERR("failed to re-index the branch routes\n");
-		return -1;
-	}
-
-	return 0;
-}
-
-
 static inline void send_cmd_to_all_procs(ipc_rpc_f *rpc)
 {
 	int i;
@@ -392,11 +281,6 @@ static void routes_reload_per_proc(int sender, void *param)
 	fclose(cfg);
 	cfg_parse_only_routes = 0;
 
-	if (reindex_all_new_sroutes( sroutes, sr_bk)<0) {
-		LM_ERR("re-indexing routes failed, abording\n");
-		goto error;
-	}
-
 	if (fix_rls()<0) {
 		LM_ERR("fixing routes failed, abording\n");
 		goto error;
@@ -462,6 +346,10 @@ static void routes_switch_per_proc(int sender, void *param)
 	/* swap the old route set with the new parsed set */
 	sroutes = parsed_sr;
 	parsed_sr = NULL;
+
+	/* update all the ref to script routes */
+	update_all_script_route_refs();
+	print_script_route_refs();
 }