agt_cfg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2022, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_agt_cfg
#define _H_agt_cfg

/*  FILE: agt_cfg.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************

date         init     comment
----------------------------------------------------------------------
22dec11      abb      begun; split out from ncx/rpc ...

*/

#include <time.h>

#ifndef _H_agt
#include "agt.h"
#endif

#ifndef _H_cfg
#include "cfg.h"
#endif

#ifndef _H_dlq
#include "dlq.h"
#endif

#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif

#ifndef _H_op
#include "op.h"
#endif

#ifndef _H_status
#include "status.h"
#endif

#ifndef _H_val
#include "val.h"
#endif

#ifndef _H_xpath
#include "xpath.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/

/* header only */

#define AGT_CFG_SET_VALIDATE_DEF(C) (C)->is_validate_def = TRUE

#define AGT_CFG_GET_VALIDATE_DEF(C) (C)->is_validate_def

#define AGT_CFG_SET_SKIP_SIL(C) (C)->skip_sil = TRUE

#define AGT_CFG_GET_SKIP_SIL(C) (C)->skip_sil

#define AGT_CFG_SET_SKIP_SIL_PARTIAL(C) (C)->skip_sil_partial = TRUE

#define AGT_CFG_GET_SKIP_SIL_PARTIAL(C) (C)->skip_sil_partial

#define AGT_CFG_SET_SKIP_SAVE(C) (C)->skip_save = TRUE

#define AGT_CFG_GET_SKIP_SAVE(C) (C)->skip_save

#define AGT_CFG_GET_COMMENT(C) (C)->comment

#define AGT_CFG_SET_COMMENT(C,S) (C)->comment = S

#define AGT_CFG_GET_TXCB(M) (M)->rpc_txcb

#define AGT_CFG_SET_CUR_SILCALL(C,S) (C)->cur_silcall = S

#define AGT_CFG_GET_CUR_SILCALL(C) (C)->cur_silcall

#define AGT_CFG_SET_TOP_REPLACE(C) (C)->top_replace = TRUE

#define AGT_CFG_IS_TOP_REPLACE(C) (C)->top_replace


/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/


typedef enum agt_cfg_edit_action_t_ {
    AGT_CFG_EDIT_ACTION_NONE,

    AGT_CFG_EDIT_ACTION_ADD,

    AGT_CFG_EDIT_ACTION_SET,

    AGT_CFG_EDIT_ACTION_MOVE,

    AGT_CFG_EDIT_ACTION_REPLACE,

    AGT_CFG_EDIT_ACTION_DELETE,

    AGT_CFG_EDIT_ACTION_DELETE_DEFAULT
} agt_cfg_edit_action_t;


typedef enum agt_cfg_edit_type_t_ {
    AGT_CFG_EDIT_TYPE_NONE,   
    AGT_CFG_EDIT_TYPE_FULL,   
    AGT_CFG_EDIT_TYPE_PARTIAL 
} agt_cfg_edit_type_t;


typedef struct agt_cfg_transaction_t_ {
    dlq_hdr_t            qhdr;

    ncx_transaction_id_t txid;

    xmlChar             *txid_str;

    time_t               timestamp;

    agt_cfg_edit_type_t  edit_type;

    ncx_cfg_t            cfg_id;

    status_t             apply_res;

    status_t             commit_res;

    status_t             rollback_res;

    op_testop_t          test_option;

    boolean              start_bad;

    boolean              rootcheck;

    boolean              rootcheck_done;

    boolean              commitcheck;

    boolean              is_validate;

    boolean              is_validate_def;

    boolean              is_commit;

    boolean              is_rollback;

    boolean              is_unload;

    boolean              is_commit_completeness;

    boolean              is_load;

    boolean              is_transhook;

    boolean              top_replace;

    boolean              force_full_root_check;

    boolean              fill_candidate_failed;

    boolean              skip_sil;

    boolean              skip_sil_partial;

    boolean              skip_save;

    boolean              sethook_mode;

    boolean              post_sethook_mode;

    boolean              skip_cb;

    boolean              hook_merge;

    boolean              check_duplicate_silcall;

    boolean              root_check_first;

    boolean              root_check_first_done;

    boolean              silcall_setup_done;

    boolean              silcall_invoke_only_sethook;

    boolean              silcall_sethook_done;

    const xmlChar       *comment;

    dlq_hdr_t            undoQ;       /* Q of agt_cfg_undo_rec_t */

    dlq_hdr_t            auditQ;      /* Q of agt_cfg_audit_rec_t */

    dlq_hdr_t            deadnodeQ;   /* Q of ncx_backptr to val_value_t */

    /* not used anymore. See def_reg implementation instead for
     * must visit checks
     */
    // dlq_hdr_t            xpath_visitQ;   // backptr to agt_cfg_xpath_visit_t

    struct agt_cfg_nested_silcall_t_ *cur_silcall;

    dlq_hdr_t            transhookQ;

#ifdef WITH_YCONTROL

    dlq_hdr_t           silcallQ;

    dlq_hdr_t           silcall_undoQ;

    boolean             silcall_undo_mode;

    boolean             silcall_done;

    boolean             skip_silsa_hooks;

    boolean             subsys_add_edit_mode;

    dlq_hdr_t           added_silcallQ;
#endif  // WITH_YCONTROL

} YPACK agt_cfg_transaction_t;


typedef struct agt_cfg_nested_silcall_t_ {
    dlq_hdr_t       qhdr;

    op_editop_t     editop;

    status_t        validate_res;

    status_t        apply_res;

    status_t        commit_res;

    status_t        rollback_res;

    /* the newval is a backptr into the subtree
     * that is really rooted in the undo record that is at
     * the root of this edit.
     */
    val_value_t    *newval;

    /* the curval is a backptr into the subtree
     * that is really rooted in the undo record that is at
     * the root of this edit.
     */
    val_value_t    *curval;

    obj_template_t *callback_obj;

    dlq_hdr_t       nested_silcallQ;

    struct agt_cfg_nested_silcall_t_ *parent;

    val_value_t    *curval_clone;

} YPACK agt_cfg_nested_silcall_t;


typedef struct agt_cfg_undo_rec_t_ {
    dlq_hdr_t       qhdr;

    boolean         free_curnode;

    boolean         is_sil_force_replay;

    boolean         edit2_merge;

    boolean         in_reverse_edit;

    boolean         when_force_delete;

    boolean         skip_sil_partial;

    boolean         parent_is_edit2_merge;

    boolean         added_edit;

    boolean         skip_cb;

    boolean         is_insert;

    op_editop_t     editop;

    op_editop_t     cvtop;

    agt_cfg_edit_action_t edit_action;

    val_value_t    *newnode;

    val_value_t    *newnode_marker;

    val_value_t    *newnode_parent;

    val_value_t    *curnode;

    val_value_t    *curnode_marker;

    val_value_t    *curnode_clone;

    val_value_t    *child_undo_curnode_clone;

    val_value_t    *parentnode;

    agt_cfg_nested_silcall_t *cur_silcall;

    val_editvars_t *newnode_editvars;

    xmlChar        *save_path;

    dlq_hdr_t       extra_deleteQ;   
    dlq_hdr_t       nested_silcallQ;   
    dlq_hdr_t       child_undoQ;   
    status_t        validate_res;

    status_t        apply_res;

    status_t        sil_apply_res;

    status_t        commit_res;

    status_t        rollback_res;

#ifdef WITH_YCONTROL

    boolean         subsys_add_edit;
#endif  // WITH_YCONTROL

    struct agt_cfg_undo_rec_t_ *orig_rev_undo;

} YPACK agt_cfg_undo_rec_t;


#ifdef WITH_YCONTROL

typedef struct agt_cfg_child_silcall_t_ {
    dlq_hdr_t          qhdr;

    op_editop_t        editop;

    val_value_t       *newval;

    val_value_t       *curval;

} YPACK agt_cfg_child_silcall_t;


typedef struct agt_cfg_silcall_t_ {
    dlq_hdr_t          qhdr;

    op_editop_t        editop;

    val_value_t       *newval;

    val_value_t       *curval;

    dlq_hdr_t         *subsysQ;

    dlq_hdr_t          keyptrQ;

    boolean            hook_edit;

    agt_hook_type_t    hook_type;

    dlq_hdr_t          child_editQ;

} YPACK agt_cfg_silcall_t;
#endif  // WITH_YCONTROL


typedef struct agt_cfg_audit_rec_t_ {
    dlq_hdr_t       qhdr;

    xmlChar        *target;

    op_editop_t     editop;

    const val_value_t *newval;

    const val_value_t *curval;

} YPACK agt_cfg_audit_rec_t;


typedef struct agt_cfg_commit_test_t_ {
    dlq_hdr_t          qhdr;

    obj_template_t    *obj;

    xpath_pcb_t       *objpcb;

    xpath_result_t    *result;

    ncx_transaction_id_t result_txid;

    ncx_btype_t        btyp;

    uint32             testflags;
} YPACK agt_cfg_commit_test_t;


typedef struct agt_cfg_xpath_visit_t_ {
    dlq_hdr_t          qhdr;

    xpath_pcb_t       *xpath;

    val_value_t       *valnode;
} YPACK agt_cfg_xpath_visit_t;


typedef struct agt_cfg_trans_hook_t_ {
    dlq_hdr_t         qhdr;

    obj_template_t   *target_obj;

    val_value_t      *newval;

    val_value_t      *curval;

    op_editop_t       editop;

    boolean           subtree_mode;
} YPACK agt_cfg_trans_hook_t;


/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/

extern agt_cfg_transaction_t *
    agt_cfg_new_transaction (ncx_cfg_t cfgid,
                             agt_cfg_edit_type_t edit_type,
                             boolean rootcheck,
                             boolean is_validate,
                             boolean is_rollback,
                             status_t *res);


extern agt_cfg_transaction_t *
    agt_cfg_new_transaction_ex (ncx_cfg_t cfgid,
                                agt_cfg_edit_type_t edit_type,
                                boolean rootcheck,
                                boolean is_validate,
                                boolean is_rollback,
                                boolean no_cb,
                                status_t *res);


agt_cfg_transaction_t *
    agt_cfg_new_transaction_ex2 (ncx_cfg_t cfgid,
                                 agt_cfg_edit_type_t edit_type,
                                 boolean rootcheck,
                                 boolean is_validate,
                                 boolean is_rollback,
                                 boolean no_cb,
                                 ses_cb_t *scb,
                                 status_t *res);


extern status_t
    agt_cfg_finish_new_transaction (ses_cb_t *scb,
                                    agt_cfg_transaction_t *txcb);


extern agt_cfg_transaction_t *
    agt_cfg_new_transaction_ex3 (ncx_cfg_t cfgid,
                                 agt_cfg_edit_type_t edit_type,
                                 boolean rootcheck,
                                 boolean is_validate,
                                 boolean is_rollback,
                                 boolean no_cb,
                                 boolean no_silsa_cb,
                                 ses_cb_t *scb,
                                 status_t *res);


extern agt_cfg_transaction_t *
    agt_cfg_rerun_transaction (ncx_cfg_t cfgid,
                               agt_cfg_edit_type_t edit_type,
                               boolean rootcheck,
                               boolean is_validate,
                               boolean is_rollback,
                               boolean no_silsa_cb,
                               ncx_transaction_id_t txid,
                               ses_cb_t *scb,
                               status_t *res);


extern void
    agt_cfg_free_transaction (agt_cfg_transaction_t *txcb);


extern status_t
    agt_cfg_init_transactions (const xmlChar *txidfile,
                               boolean foundfile);


extern void
    agt_cfg_cleanup_transactions (const xmlChar *txidfile);


extern ncx_transaction_id_t
    agt_cfg_txid_in_progress (ncx_cfg_t cfgid);


extern agt_cfg_undo_rec_t *
    agt_cfg_new_undorec (void);


extern void
    agt_cfg_init_undorec (agt_cfg_undo_rec_t *undo);


extern void
    agt_cfg_free_undorec (agt_cfg_undo_rec_t *undo);


extern void
    agt_cfg_clean_undorec (agt_cfg_undo_rec_t *undo);


extern agt_cfg_audit_rec_t *
    agt_cfg_new_auditrec (const xmlChar *target,
                          op_editop_t editop);


extern void
    agt_cfg_free_auditrec (agt_cfg_audit_rec_t *auditrec);


extern agt_cfg_commit_test_t *
    agt_cfg_new_commit_test (void);


extern void
    agt_cfg_free_commit_test (agt_cfg_commit_test_t *commit_test);


extern void
    agt_cfg_set_transaction_commit (agt_cfg_transaction_t *txcb);


extern void
    agt_cfg_set_transaction_unload (agt_cfg_transaction_t *txcb);


extern boolean
    agt_cfg_transaction_is_unload (agt_cfg_transaction_t *txcb);


extern void
    agt_cfg_force_full_root_check (agt_cfg_transaction_t *txcb);


extern void
    agt_cfg_remove_module_commit_tests (ncx_module_t *mod);


#ifdef WITH_YCONTROL

extern agt_cfg_silcall_t *
    agt_cfg_new_silcall (op_editop_t editop,
                         val_value_t *newval,
                         val_value_t *curval,
                         dlq_hdr_t *subsysQ);


extern void
    agt_cfg_free_silcall (agt_cfg_silcall_t *silcall);


extern status_t
    agt_cfg_add_hook_silcall (agt_cfg_transaction_t *txcb,
                              op_editop_t editop,
                              val_value_t *newval,
                              val_value_t *curval,
                              dlq_hdr_t *subsysQ,
                              val_value_t *callval,
                              agt_hook_type_t hook_type);


extern status_t
    agt_cfg_add_silcall (agt_cfg_transaction_t *txcb,
                         op_editop_t editop,
                         val_value_t *newval,
                         val_value_t *curval,
                         dlq_hdr_t *subsysQ,
                         val_value_t *callval);


extern status_t
    agt_cfg_add_edit2_silcall (agt_cfg_transaction_t *txcb,
                               op_editop_t editop,
                               val_value_t *newval,
                               val_value_t *curval,
                               dlq_hdr_t *subsysQ,
                               val_value_t *callval);

#endif   // WITH_YCONTROL


extern status_t
    agt_cfg_add_nested_silcall (agt_cfg_transaction_t *txcb,
                                agt_cfg_undo_rec_t *undo,
                                op_editop_t editop,
                                val_value_t *newval,
                                val_value_t *curval,
                                obj_template_t *callback_obj,
                                boolean indelete,
                                boolean in_reverse_delete,
                                agt_cfg_nested_silcall_t **result);


extern agt_cfg_undo_rec_t *
    agt_cfg_find_undo_node (agt_cfg_transaction_t *txcb,
                            val_value_t *newnode,
                            val_value_t *curnode);


extern agt_cfg_undo_rec_t *
    agt_cfg_first_child_edit (agt_cfg_transaction_t *txcb,
                              val_value_t *newnode,
                              val_value_t *curnode);


extern agt_cfg_undo_rec_t *
    agt_cfg_next_child_edit (agt_cfg_undo_rec_t *curedit);


extern void
    agt_cfg_child_edit_fields (agt_cfg_undo_rec_t *child_undo,
                               op_editop_t *editop,
                               val_value_t **newval,
                               val_value_t **curval);


extern void
    agt_cfg_dump_undo (agt_cfg_undo_rec_t *undo);


extern void
    agt_cfg_restore_newnode (agt_cfg_undo_rec_t *undo);


extern boolean
    agt_cfg_use_child_undo (agt_cfg_undo_rec_t *undo,
                            agt_cfg_undo_rec_t *child_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_first_undo (agt_cfg_transaction_t *txcb);


extern agt_cfg_undo_rec_t *
    agt_cfg_next_undo (agt_cfg_transaction_t *txcb,
                       agt_cfg_undo_rec_t *cur_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_last_undo (agt_cfg_transaction_t *txcb);


extern agt_cfg_undo_rec_t *
    agt_cfg_prev_undo (agt_cfg_transaction_t *txcb,
                       agt_cfg_undo_rec_t *cur_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_first_child_undo (agt_cfg_undo_rec_t *undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_next_child_undo (agt_cfg_undo_rec_t *cur_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_find_child_undo_node (agt_cfg_undo_rec_t *parent_undo,
                                  val_value_t *newnode,
                                  val_value_t *curnode);


extern boolean
    agt_cfg_ascendant_lists_check (val_value_t *test_val,
                                   val_value_t *next_parent);


extern agt_cfg_undo_rec_t *
    agt_cfg_find_undo_node_slow (agt_cfg_transaction_t *txcb,
                                 val_value_t *newnode,
                                 val_value_t *curnode);


extern boolean
    agt_cfg_find_duplicate_silcall (agt_cfg_transaction_t *txcb,
                                    val_value_t *newnode,
                                    val_value_t *curnode);


extern boolean
    agt_cfg_check_parent_edits (agt_cfg_transaction_t *txcb,
                                val_value_t *newnode);


extern agt_cfg_trans_hook_t *
    agt_cfg_new_trans_hook (obj_template_t *target_obj,
                            val_value_t *newval,
                            val_value_t *curval,
                            op_editop_t editop);


extern void
    agt_cfg_free_trans_hook (agt_cfg_trans_hook_t *hook);


extern agt_cfg_trans_hook_t *
    agt_cfg_first_trans_hook (agt_cfg_transaction_t *txcb);


extern agt_cfg_trans_hook_t *
    agt_cfg_next_trans_hook (agt_cfg_trans_hook_t *cur_hook);


extern agt_cfg_trans_hook_t *
    agt_cfg_last_trans_hook (agt_cfg_transaction_t *txcb);


extern agt_cfg_trans_hook_t *
    agt_cfg_prev_trans_hook (agt_cfg_trans_hook_t *cur_hook);


extern boolean
    agt_cfg_check_hook_created (agt_cfg_transaction_t *txcb,
                                val_value_t *newval,
                                val_value_t *curval);


extern agt_cfg_undo_rec_t *
    agt_cfg_first_active_undo (agt_cfg_transaction_t *txcb);


extern agt_cfg_undo_rec_t *
    agt_cfg_next_active_undo (agt_cfg_transaction_t *txcb,
                              agt_cfg_undo_rec_t *cur_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_last_active_undo (agt_cfg_transaction_t *txcb);


extern agt_cfg_undo_rec_t *
    agt_cfg_prev_active_undo (agt_cfg_transaction_t *txcb,
                              agt_cfg_undo_rec_t *cur_undo);


extern void
    agt_cfg_clear_config_txid (agt_cfg_transaction_t *txcb,
                               cfg_template_t *cfg);


extern agt_cfg_undo_rec_t *
    agt_cfg_last_active_child_undo (agt_cfg_transaction_t *txcb,
                                    agt_cfg_undo_rec_t *parent_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_prev_active_child_undo (agt_cfg_transaction_t *txcb,
                                    agt_cfg_undo_rec_t *cur_undo);


extern agt_cfg_undo_rec_t *
    agt_cfg_find_undo_node_ascendant (agt_cfg_transaction_t *txcb,
                                      val_value_t *newnode,
                                      val_value_t *curnode);


extern agt_cfg_nested_silcall_t *
    agt_cfg_find_nested_silcall (agt_cfg_undo_rec_t *undo,
                                 val_value_t *newnode,
                                 val_value_t *curnode);


extern boolean
    agt_cfg_has_added_edits (agt_cfg_transaction_t *txcb);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif      /* _H_agt_cfg */