Merge pull request #5942 from victormlg/body_file_control_evalorder

CFE-4598: Added evaluation order in body file control

Author: olehermanse

cf-agent/cf-agent.c

@@ -1601,7 +1601,7 @@ static void AllClassesReport(const EvalContext *ctx)
 PromiseResult ScheduleAgentOperations(EvalContext *ctx, const Bundle *bp)
 // NB - this function can be called recursively through "methods"
 {
-    if (EvalContextIsClassicOrder(ctx))
+    if (EvalContextIsClassicOrder(ctx, bp))
     {
         return ScheduleAgentOperationsNormalOrder(ctx, bp);
     }

cf-agent/files_editline.c

@@ -182,7 +182,7 @@ Bundle *MakeTemporaryBundleFromTemplate(EvalContext *ctx, Policy *policy, const
         char bundlename[CF_MAXVARSIZE];
         snprintf(bundlename, CF_MAXVARSIZE, "temp_cf_bundle_%s", CanonifyName(a->edit_template));
 
-        bp = PolicyAppendBundle(policy, "default", bundlename, "edit_line", NULL, NULL);
+        bp = PolicyAppendBundle(policy, "default", bundlename, "edit_line", NULL, NULL, EVAL_ORDER_UNDEFINED);
     }
     assert(bp);
 

cf-monitord/env_monitor.c

@@ -272,7 +272,7 @@ void MonitorStartServer(EvalContext *ctx, const Policy *policy)
     Policy *monitor_cfengine_policy = PolicyNew();
     Promise *pp = NULL;
     {
-        Bundle *bp = PolicyAppendBundle(monitor_cfengine_policy, NamespaceDefault(), "monitor_cfengine_bundle", "agent", NULL, NULL);
+        Bundle *bp = PolicyAppendBundle(monitor_cfengine_policy, NamespaceDefault(), "monitor_cfengine_bundle", "agent", NULL, NULL, EVAL_ORDER_UNDEFINED);
         BundleSection *sp = BundleAppendSection(bp, "monitor_cfengine");
 
         pp = BundleSectionAppendPromise(sp, "the monitor daemon", (Rval) { NULL, RVAL_TYPE_NOPROMISEE }, NULL, NULL);

cf-monitord/history.c

@@ -400,7 +400,7 @@ void HistoryUpdate(EvalContext *ctx, const Averages *const newvals)
     Policy *history_db_policy = PolicyNew();
     Promise *pp = NULL;
     {
-        Bundle *bp = PolicyAppendBundle(history_db_policy, NamespaceDefault(), "history_db_bundle", "agent", NULL, NULL);
+        Bundle *bp = PolicyAppendBundle(history_db_policy, NamespaceDefault(), "history_db_bundle", "agent", NULL, NULL, EVAL_ORDER_UNDEFINED);
         BundleSection *sp = BundleAppendSection(bp, "history_db");
 
         pp = BundleSectionAppendPromise(sp, "the long term memory", (Rval) { NULL, RVAL_TYPE_NOPROMISEE }, NULL, NULL);

cf-serverd/cf-serverd-functions.c

@@ -543,7 +543,7 @@ static CfLock AcquireServerLock(EvalContext *ctx,
     {
         Bundle *bp = PolicyAppendBundle(server_policy, NamespaceDefault(),
                                         "server_cfengine_bundle", "agent",
-                                        NULL, NULL);
+                                        NULL, NULL, EVAL_ORDER_UNDEFINED);
         BundleSection *sp = BundleAppendSection(bp, "server_cfengine");
 
         pp = BundleSectionAppendPromise(sp, config->input_file,

libpromises/cf3.defs.h

@@ -690,6 +690,13 @@ typedef struct
     SyntaxStatus status;
 } PromiseTypeSyntax;
 
+typedef enum
+{
+    EVAL_ORDER_UNDEFINED = 0,
+    EVAL_ORDER_CLASSIC,
+    EVAL_ORDER_TOP_DOWN
+} EvalOrder;
+
 /*************************************************************************/
 
 typedef struct Constraint_ Constraint;

libpromises/cf3parse_logic.h

@@ -1011,6 +1011,24 @@ static inline void ParserHandleBlockAttributeRval()
                 P.current_namespace = xstrdup(P.rval.item);
             }
         }
+        if (StringEqual(P.lval, "evaluation_order"))
+        {
+            if (P.rval.type != RVAL_TYPE_SCALAR)
+            {
+                yyerror("evaluation_order must be a constant scalar string");
+            }
+            else
+            {
+                if (StringEqual(P.rval.item, "classic"))
+                {
+                    P.current_evaluation_order = EVAL_ORDER_CLASSIC;
+                }
+                else if (StringEqual(P.rval.item, "top_down"))
+                {
+                    P.current_evaluation_order = EVAL_ORDER_TOP_DOWN;
+                }
+            }
+        }
     }
 
     RvalDestroy(P.rval);
@@ -1038,7 +1056,8 @@ static inline void ParserBeginBundleBody()
             P.blockid,
             P.blocktype,
             P.useargs,
-            P.filename);
+            P.filename,
+            P.current_evaluation_order);
         P.currentbundle->offset.line = CURRENT_BLOCKID_LINE;
         P.currentbundle->offset.start = P.offsets.last_block_id;
     }

libpromises/eval_context.c

@@ -207,8 +207,8 @@ struct EvalContext_
         Seq *events;
     } profiler;
 
-    EvalContextEvalOrder common_eval_order;
-    EvalContextEvalOrder agent_eval_order;
+    EvalOrder common_eval_order;
+    EvalOrder agent_eval_order;
 };
 
 void EvalContextSetConfig(EvalContext *ctx, const GenericAgentConfig *config)
@@ -4062,21 +4062,54 @@ void EvalContextProfilingEnd(EvalContext *ctx, const Policy *policy)
 
 // ##############################################################
 
-void EvalContextSetCommonEvalOrder(EvalContext *ctx, EvalContextEvalOrder eval_order)
+void EvalContextSetCommonEvalOrder(EvalContext *ctx, EvalOrder eval_order)
 {
     assert(ctx != NULL);
     ctx->common_eval_order = eval_order;
 }
 
-void EvalContextSetAgentEvalOrder(EvalContext *ctx, EvalContextEvalOrder eval_order)
+void EvalContextSetAgentEvalOrder(EvalContext *ctx, EvalOrder eval_order)
 {
     assert(ctx != NULL);
     ctx->agent_eval_order = eval_order;
 }
 
-bool EvalContextIsClassicOrder(EvalContext *ctx)
+const char *EvalContextEvaluationOrderToString(EvalOrder evaluation_order)
+{
+    if (evaluation_order == EVAL_ORDER_CLASSIC)
+    {
+        return "classic";
+    }
+    if (evaluation_order == EVAL_ORDER_TOP_DOWN)
+    {
+        return "top_down";
+    }
+    return "undefined";
+}
+
+EvalOrder EvalContextEvaluationOrderFromString(const char *evaluation_order_string)
+{
+    if (StringEqual(evaluation_order_string, "classic"))
+    {
+        return EVAL_ORDER_CLASSIC;
+    }
+    if (StringEqual(evaluation_order_string, "top_down"))
+    {
+        return EVAL_ORDER_TOP_DOWN;
+    }
+    return EVAL_ORDER_UNDEFINED;
+}
+
+bool EvalContextIsClassicOrder(EvalContext *ctx, const Bundle *bp)
 {
     assert(ctx != NULL);
+    assert(bp != NULL);
+
+    if (bp->evaluation_order != EVAL_ORDER_UNDEFINED)
+    {
+        // bundle evaluation order overrides common or agent control
+        return bp->evaluation_order == EVAL_ORDER_CLASSIC;
+    }
 
     if (ctx->config->agent_type != AGENT_TYPE_AGENT)
     {

libpromises/eval_context.h

@@ -124,13 +124,6 @@ typedef enum
     EVAL_OPTION_FULL = 0xFFFFFFFF
 } EvalContextOption;
 
-typedef enum
-{
-    EVAL_ORDER_UNDEFINED = 0,
-    EVAL_ORDER_CLASSIC,
-    EVAL_ORDER_TOP_DOWN
-} EvalContextEvalOrder;
-
 EvalContext *EvalContextNew(void);
 void EvalContextDestroy(EvalContext *ctx);
 
@@ -459,8 +452,10 @@ void EvalContextSetProfiling(EvalContext *ctx, bool profiling);
 void EvalContextProfilingStart(EvalContext *ctx);
 void EvalContextProfilingEnd(EvalContext *ctx, const Policy *policy);
 
-void EvalContextSetCommonEvalOrder(EvalContext *ctx, EvalContextEvalOrder eval_order);
-void EvalContextSetAgentEvalOrder(EvalContext *ctx, EvalContextEvalOrder eval_order);
-bool EvalContextIsClassicOrder(EvalContext *ctx);
+void EvalContextSetCommonEvalOrder(EvalContext *ctx, EvalOrder eval_order);
+void EvalContextSetAgentEvalOrder(EvalContext *ctx, EvalOrder eval_order);
+const char *EvalContextEvaluationOrderToString(EvalOrder evaluation_order);
+EvalOrder EvalContextEvaluationOrderFromString(const char *evaluation_order_string);
+bool EvalContextIsClassicOrder(EvalContext *ctx, const Bundle *bp);
 
 #endif

libpromises/evalfunction.c

@@ -4883,7 +4883,7 @@ static FnCallResult FnCallSelectServers(EvalContext *ctx,
     Policy *select_server_policy = PolicyNew();
     {
         Bundle *bp = PolicyAppendBundle(select_server_policy, NamespaceDefault(),
-                                        "select_server_bundle", "agent", NULL, NULL);
+                                        "select_server_bundle", "agent", NULL, NULL, EVAL_ORDER_UNDEFINED);
         BundleSection *sp = BundleAppendSection(bp, "select_server");
 
         BundleSectionAppendPromise(sp, "function", (Rval) { NULL, RVAL_TYPE_NOPROMISEE }, NULL, NULL);