agt_cb.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, 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_cb
#define _H_agt_cb
 
/*  FILE: agt_cb.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
16-apr-07    abb      Begun; split out from agt_ps.h
01-aug-08    abb      Remove NCX specific stuff; YANG only now
*/
 
#include "agt.h"
#include "agt_editcb.h"
#include "getcb.h"
#include "op.h"
#include "rpc.h"
#include "ses.h"
#include "status_enum.h"
#include "val.h"
#include "xpath.h"
 
#ifndef _H_agt_cfg
#include "agt_cfg.h"
#endif
 
#ifndef _H_agt_hook_util
#include "agt_hook_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* Header only */
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
 
#define FORALL  TRUE
 
#define FORONE  FALSE
 
#define AGT_CB_FL_EDIT             bit0
 
#define AGT_CB_FL_GET              bit1
 
#define AGT_CB_FL_EDIT2            bit2
 
#define AGT_CB_FL_PSHOOK           bit3   
#define AGT_CB_FL_SHOOK            bit4   
#define AGT_CB_FL_TXHOOK           bit5   
#define AGT_CB_FL_PUSH             bit6   
#define AGT_CB_FL_SETHOOK_TREE     bit0   
#define AGT_CB_FL_TRANSHOOK_TREE   bit1   
#define AGT_CB_FL_SKIP_SETHOOK     bit2   
#define AGT_CB_FL_SKIP_TRANSHOOK   bit3   
#define AGT_CB_FL_PSETHOOK         bit4
 
#define AGT_CB_FL_SETHOOK          bit5
 
#define AGT_CB_FL_TRANSHOOK        bit6
 
#define AGT_CB_FL_EDIT3            bit7
 
/* 3 flags for skip phase callbacks in the agt_cb_fnset_t.flags field */
#define AGT_CB_FL_SKIP_VALIDATE    bit8   
#define AGT_CB_FL_SKIP_APPLY       bit9   
#define AGT_CB_SUBSYS_HAS_EDIT(S)     ((S)->flags & AGT_CB_FL_EDIT)
 
#define AGT_CB_SUBSYS_HAS_GET(S)      ((S)->flags & AGT_CB_FL_GET)
 
#define AGT_CB_SUBSYS_HAS_EDIT2(S)    ((S)->flags & AGT_CB_FL_EDIT2)
 
#define AGT_CB_SUBSYS_HAS_PUSH(S)      ((S)->flags & AGT_CB_FL_PUSH)
 
 
#define AGT_CB_SUBSYS_HAS_EDIT3(S)    ((S)->flags & AGT_CB_FL_EDIT3)
 
 
#define AGT_CB_SUBSYS_HAS_PSHOOK(S)   ((S)->flags & AGT_CB_FL_PSHOOK)
 
#define AGT_CB_SUBSYS_HAS_SHOOK(S)    ((S)->flags & AGT_CB_FL_SHOOK)
 
#define AGT_CB_SUBSYS_HAS_TXHOOK(S)   ((S)->flags & AGT_CB_FL_TXHOOK)
 
#define AGT_CB_SUBSYS_SET_PSHOOK(S)   (S)->flags |= AGT_CB_FL_PSHOOK
 
#define AGT_CB_SUBSYS_SET_SHOOK(S)    (S)->flags |= AGT_CB_FL_SHOOK
 
#define AGT_CB_SUBSYS_SET_TXHOOK(S)   (S)->flags |= AGT_CB_FL_TXHOOK
 
 
#define AGT_CB_HAS_REMOTE_PSHOOK(C)   ((C)->flags & AGT_CB_FL_PSETHOOK)
 
#define AGT_CB_HAS_REMOTE_SHOOK(C)    ((C)->flags & AGT_CB_FL_SETHOOK)
 
#define AGT_CB_HAS_REMOTE_TXHOOK(C)   ((C)->flags & AGT_CB_FL_TRANSHOOK)
 
#define AGT_CB_SET_REMOTE_PSHOOK(C)   (C)->flags |= AGT_CB_FL_PSETHOOK
 
#define AGT_CB_SET_REMOTE_SHOOK(C)    (C)->flags |= AGT_CB_FL_SETHOOK
 
#define AGT_CB_SET_REMOTE_TXHOOK(C)   (C)->flags |= AGT_CB_FL_TRANSHOOK
 
#define AGT_CB_HAS_SKIP_VALIDATE(C)   ((C)->flags & AGT_CB_FL_SKIP_VALIDATE)
#define AGT_CB_HAS_SKIP_APPLY(C)      ((C)->flags & AGT_CB_FL_SKIP_APPLY)
 
#define AGT_CB_SET_SKIP_VALIDATE(C)   (C)->flags |= AGT_CB_FL_SKIP_VALIDATE
#define AGT_CB_SET_SKIP_APPLY(C)      (C)->flags |= AGT_CB_FL_SKIP_APPLY
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum agt_cb_calltype_t_ {
    AGT_CB_CALLTYPE_NONE,    
    AGT_CB_CALLTYPE_EDIT,    
    AGT_CB_CALLTYPE_EDIT2,   
    AGT_CB_CALLTYPE_EDIT3,   
    AGT_CB_CALLTYPE_GET,     
    AGT_CB_CALLTYPE_PUSH     
} YPACK agt_cb_calltype_t;
 
 
typedef enum agt_edit_cbtype_t_ {
    AGT_EDIT_CBTYPE_NONE = 0, 
    AGT_EDIT_CBTYPE_EDIT,     
    AGT_EDIT_CBTYPE_EDIT2,    
    AGT_EDIT_CBTYPE_EDIT3,    
} YPACK agt_edit_cbtype_t;
 
 
typedef struct agt_cb_subsys_t_ {
    dlq_hdr_t       qhdr;
 
    const xmlChar  *subsys_id;
 
    uint8           flags;
 
    status_t        res;
} YPACK agt_cb_subsys_t;
 
 
typedef status_t
    (*agt_cb_fn_t) (ses_cb_t  *scb,
                    rpc_msg_t *msg,
                    agt_cbtyp_t cbtyp,
                    op_editop_t  editop,
                    val_value_t  *newval,
                    val_value_t  *curval);
 
 
typedef status_t
    (*agt_cb_hook_t) (ses_cb_t *scb,
                      rpc_msg_t *msg,
                      agt_cfg_transaction_t *txcb,
                      op_editop_t editop,
                      val_value_t  *newval,
                      val_value_t  *curval);
 
 
 
typedef uint8
    (*agt_cb_order_hook_t) (agt_cfg_transaction_t *txcb,
                            op_editop_t editop,
                            val_value_t  *newval,
                            val_value_t  *curval,
                            status_t *res);
 
 
 
typedef status_t
    (*agt_cb_trans_start_t) (agt_cfg_transaction_t *txcb);
 
 
 
typedef status_t
    (*agt_cb_sa_trans_start_t) (const xmlChar *transaction_id,
                                boolean isvalidate,
                                boolean isrollback,
                                boolean isrunning);
 
 
 
typedef void
    (*agt_cb_trans_complete_t) (agt_cfg_transaction_t *txcb);
 
 
 
typedef void
    (*agt_cb_sa_trans_complete_t) (const xmlChar *transaction_id_val);
 
 
 
typedef status_t
    (*agt_cb_startup_hook_t) (ses_cb_t *scb,
                              rpc_msg_t *msg,
                              cfg_template_t *source_config,
                              cfg_template_t *target_config);
 
 
 
typedef status_t
    (*agt_cb_validate_complete_t) (ses_cb_t *scb,
                                   rpc_msg_t *msg,
                                   val_value_t *candidate,
                                   val_value_t *running);
 
 
 
typedef status_t
    (*agt_cb_sa_validate_complete_t) (const xmlChar *transaction_id);
 
 
 
typedef status_t
    (*agt_cb_apply_complete_t) (ses_cb_t *scb,
                                rpc_msg_t *msg,
                                val_value_t *candidate,
                                val_value_t *running);
 
 
 
typedef status_t
    (*agt_cb_sa_apply_complete_t) (const xmlChar *transaction_id);
 
 
 
typedef status_t
    (*agt_cb_rollback_complete_t) (ses_cb_t *scb,
                                   rpc_msg_t *msg,
                                   val_value_t *candidate,
                                   val_value_t *running);
 
 
 
typedef status_t
    (*agt_cb_sa_rollback_complete_t) (const xmlChar *transaction_id);
 
 
 
typedef status_t
    (*agt_cb_sa_commit_complete_t) (const xmlChar *transaction_id,
                                    agt_commit_type_t commit_type);
 
 
 
typedef status_t
    (*agt_cb_command_start_t) (ses_cb_t *scb,
                               rpc_msg_t *msg,
                               const xmlChar *command_modname,
                               const xmlChar *command_name);
 
 
 
typedef void
    (*agt_cb_command_complete_t) (ses_cb_t *scb,
                                  rpc_msg_t *msg,
                                  const xmlChar *command_modname,
                                  const xmlChar *command_name);
 
 
 
typedef void
    (*agt_cb_shutdown_t) (void);
 
 
typedef void
    (*agt_cb_session_hook_t) (ncx_ses_event_t ses_event,
                              const ses_cb_t *scb);
 
 
typedef status_t
    (*agt_cb_sa_hook_t) (ses_cb_t *scb,
                         rpc_msg_t *msg,
                         op_editop_t editop,
                         val_value_t *newval,
                         val_value_t *curval,
                         const xmlChar *transaction_id,
                         boolean isvalidate,
                         boolean isload,
                         boolean isrunning);
 
 
typedef status_t
    (*agt_cb_sa_push_t) (agt_sa_push_parms_t *sa_parms);
 
 
typedef status_t
    (*agt_cb_edit_phase_complete_t) (agt_cbtyp_t edit_phase,
                                     ses_cb_t *scb,
                                     rpc_msg_t *msg,
                                     val_value_t *source,
                                     val_value_t *target);
 
 
 
 
 
typedef status_t
    (*agt_cb_sa_edit_phase_complete_t) (agt_cbtyp_t edit_phase,
                                        const xmlChar *transaction_id);
 
 
 
typedef struct agt_cb_extra_flags_t_ {
    agt_edit_cbtype_t edit_cbtype; 
    boolean skip_validate; 
    boolean skip_apply;    
} YPACK agt_cb_extra_flags_t;
 
 
typedef struct agt_cb_fnset_t_ {
    agt_cb_fn_t          cbfn;                    
    agt_edit3_fn_t       edit3_cbfn;              
    getcb_fn2_t          get_cbfn;                
    agt_cb_order_hook_t  order_hook_cbfn;         
    agt_cb_hook_t        set_hook_cbfn;           
    agt_cb_hook_t        post_set_hook_cbfn;      
    agt_cb_hook_t        trans_hook_cbfn;         
    xpath_bool_eval_fn_t xpath_cbfn;              
    uint16               flags;                   
 
    ncx_transaction_id_t txid;
 
    /* used ony by SIL-SA */
    agt_cb_sa_hook_t     sa_set_hook_cbfn;        
    agt_cb_sa_hook_t     sa_post_set_hook_cbfn;   
    agt_cb_sa_hook_t     sa_trans_hook_cbfn;      
    agt_cb_sa_push_t     sa_push_cbfn;            
 
    dlq_hdr_t            subsysQ;  
} YPACK agt_cb_fnset_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_cb_init (void);
 
 
extern void
    agt_cb_cleanup (void);
 
 
extern status_t
    agt_cb_register_callback (const xmlChar *modname,
                              const xmlChar *defpath,
                              const xmlChar *version,
                              agt_cb_fn_t cbfn);
 
 
extern status_t
    agt_cb_register_edit2_callback (const xmlChar *modname,
                                    const xmlChar *defpath,
                                    const xmlChar *version,
                                    agt_cb_fn_t cbfn);
 
 
extern status_t
    agt_cb_register_edit3_callback (const xmlChar *modname,
                                    const xmlChar *defpath,
                                    const xmlChar *version,
                                    agt_edit3_fn_t edit3_cbfn);
 
 
extern status_t
    agt_cb_register_edit_callback_extra (const xmlChar *modname,
                                         const xmlChar *defpath,
                                         const xmlChar *version,
                                         void *cbfn,
                                         const agt_cb_extra_flags_t *extra_flags);
 
 
extern status_t
    agt_cb_register_xpath_callback (const xmlChar *modname,
                                    const xmlChar *defpath,
                                    const xmlChar *version,
                                    xpath_bool_eval_fn_t cbfn);
 
 
extern void
    agt_cb_unregister_callbacks (const xmlChar *modname,
                                 const xmlChar *defpath);
 
 
 
extern status_t
    agt_cb_register_get_callback (const xmlChar *modname,
                                  const xmlChar *defpath,
                                  const xmlChar *version,
                                  getcb_fn2_t get_cbfn);
 
 
extern status_t
    agt_cb_hook_register (const xmlChar *defpath,
                          agt_hook_fmt_t format,
                          agt_hook_type_t type,
                          agt_cb_hook_t cbfn);
 
 
extern void
    agt_cb_hook_unregister (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_order_hook_register (const xmlChar *defpath,
                                agt_cb_order_hook_t cbfn);
 
 
extern void
    agt_cb_order_hook_unregister (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_trans_start_register (agt_cb_trans_start_t cbfn);
 
 
extern status_t
    agt_cb_trans_complete_register (agt_cb_trans_complete_t cbfn);
 
 
extern void
    agt_cb_trans_start_unregister (agt_cb_trans_start_t cbfn);
 
 
extern void
    agt_cb_trans_complete_unregister (agt_cb_trans_complete_t cbfn);
 
 
extern status_t
    agt_cb_run_trans_start (ses_cb_t *scb,
                            agt_cfg_transaction_t *txcb,
                            boolean isvalidate,
                            boolean isrollback,
                            boolean isrunning,
                            boolean no_silsa_cb);
 
 
extern void
    agt_cb_run_trans_complete (agt_cfg_transaction_t *txcb);
 
 
extern status_t
    agt_cb_sa_trans_start_register (agt_cb_sa_trans_start_t cbfn);
 
 
extern status_t
    agt_cb_sa_trans_complete_register (agt_cb_sa_trans_complete_t cbfn);
 
 
extern void
    agt_cb_sa_trans_start_unregister (agt_cb_sa_trans_start_t cbfn);
 
 
extern void
    agt_cb_sa_trans_complete_unregister (agt_cb_sa_trans_complete_t cbfn);
 
 
#ifdef WITH_YCONTROL
extern status_t
    agt_cb_invoke_trans_start_cb (const xmlChar *transaction_id,
                                  boolean isvalidate,
                                  boolean isrollback,
                                  boolean isrunning);
 
 
extern void
    agt_cb_invoke_trans_complete (const xmlChar *transaction_id);
 
 
extern void
    agt_cb_sa_run_trans_complete (const xmlChar *transaction_id);
 
 
 
extern status_t
    agt_cb_register_subsys_callback (const xmlChar *modname,
                                     const xmlChar *defpath,
                                     const xmlChar *version,
                                     const xmlChar *subsys_id,
                                     agt_cb_calltype_t calltype);
 
 
 
extern void
    agt_cb_unregister_subsys_callback (const xmlChar *subsys_id,
                                       const xmlChar *modname,
                                       const xmlChar *defpath,
                                       const xmlChar *revision);
 
#endif  // WITH_YCONTROL
 
 
extern status_t
    agt_cb_make_register_msg (obj_template_t *request_obj,
                              val_value_t *request_val,
                              obj_template_t *register_obj,
                              obj_template_t *module_obj,
                              obj_template_t *revision_obj,
                              obj_template_t *path_obj,
                              obj_template_t *get_path_obj,
                              obj_template_t *rpc_name_obj,
                              obj_template_t *action_path_obj,
                              obj_template_t *post_sethook_path_obj,
                              obj_template_t *sethook_list,
                              obj_template_t *txhook_list,
                              obj_template_t *edit2_path_obj,
                              obj_template_t *push_path_obj,
                              obj_template_t *edit3_path_obj,
                              boolean *any_rw_objs);
 
 
extern boolean
    agt_cb_obj_has_edit_callback (obj_template_t *obj);
 
 
extern boolean
    agt_cb_obj_has_get_callback (obj_template_t *obj);
 
 
extern boolean
    agt_cb_obj_has_push_callback (obj_template_t *obj);
 
 
extern status_t
    agt_cb_skip_leafref_validation (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_set_sil_priority (const xmlChar *defpath,
                             uint8 sil_priority);
 
 
extern status_t
    agt_cb_validate_complete_register (agt_cb_validate_complete_t cbfn);
 
 
extern status_t
    agt_cb_startup_hook_register (agt_cb_startup_hook_t cbfn);
 
 
extern void
    agt_cb_startup_hook_unregister (agt_cb_startup_hook_t cbfn);
 
 
extern void
    agt_cb_validate_complete_unregister (agt_cb_validate_complete_t cbfn);
 
 
extern status_t
    agt_cb_apply_complete_register (agt_cb_apply_complete_t cbfn);
 
 
extern void
    agt_cb_apply_complete_unregister (agt_cb_apply_complete_t cbfn);
 
 
extern status_t
    agt_cb_rollback_complete_register (agt_cb_rollback_complete_t cbfn);
 
 
extern void
    agt_cb_rollback_complete_unregister (agt_cb_rollback_complete_t cbfn);
 
 
extern status_t
    agt_cb_run_validate_complete (ses_cb_t *scb,
                                  rpc_msg_t *msg,
                                  val_value_t *candidate,
                                  val_value_t *running,
                                  boolean epc_only);
 
 
extern status_t
    agt_cb_run_startup_hook (ses_cb_t *scb,
                             rpc_msg_t *msg,
                             cfg_template_t *source_config,
                             cfg_template_t *target_config);
 
 
extern status_t
    agt_cb_run_apply_complete (ses_cb_t *scb,
                               rpc_msg_t *msg,
                               val_value_t *candidate,
                               val_value_t *running,
                               boolean epc_only);
 
 
extern status_t
    agt_cb_run_rollback_complete (ses_cb_t *scb,
                                  rpc_msg_t *msg,
                                  val_value_t *candidate,
                                  val_value_t *running,
                                  boolean epc_only);
 
 
extern status_t
    agt_cb_command_start_register (agt_cb_command_start_t cbfn);
 
 
extern void
    agt_cb_command_start_unregister (agt_cb_command_start_t cbfn);
 
 
extern status_t
    agt_cb_run_command_start (ses_cb_t *scb,
                              rpc_msg_t *msg,
                              const xmlChar *command_modname,
                              const xmlChar *command_name);
 
 
extern status_t
    agt_cb_command_complete_register (agt_cb_command_complete_t cbfn);
 
 
extern void
    agt_cb_run_command_complete (ses_cb_t *scb,
                                 rpc_msg_t *msg,
                                 const xmlChar *command_modname,
                                 const xmlChar *command_name);
 
 
extern void
    agt_cb_command_complete_unregister (agt_cb_command_complete_t cbfn);
 
 
extern status_t
    agt_cb_shutdown_register (agt_cb_shutdown_t cbfn);
 
 
extern void
    agt_cb_shutdown_unregister (agt_cb_shutdown_t cbfn);
 
 
extern void
    agt_cb_run_shutdown (void);
 
 
extern status_t
    agt_cb_post_sethook_register (const xmlChar *defpath,
                                  agt_cb_hook_t cbfn);
 
 
extern void
    agt_cb_post_sethook_unregister (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_session_hook_register (agt_cb_session_hook_t cbfn);
 
 
extern void
    agt_cb_session_hook_unregister (agt_cb_session_hook_t cbfn);
 
 
extern void
    agt_cb_run_session_hook (ncx_ses_event_t ses_event,
                             const ses_cb_t *scb);
 
 
extern status_t
    agt_cb_def_hook_register (const xmlChar *defpath,
                              ncx_def_hook_cbfn_t cbfn);
 
 
extern void
    agt_cb_def_hook_unregister (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_sa_hook_register (const xmlChar *defpath,
                             agt_hook_fmt_t format,
                             agt_hook_type_t type,
                             agt_cb_sa_hook_t cbfn);
 
 
extern void
    agt_cb_sa_hook_unregister (const xmlChar *defpath);
 
 
extern status_t
    agt_cb_sa_post_sethook_register (const xmlChar *defpath,
                                     agt_cb_sa_hook_t cbfn);
 
 
extern void
    agt_cb_sa_post_sethook_unregister (const xmlChar *defpath);
 
 
extern void
    agt_cb_unload_module (const xmlChar *modname);
 
 
extern status_t
    agt_cb_sa_validate_complete_register (agt_cb_sa_validate_complete_t cbfn);
 
 
extern void
    agt_cb_sa_validate_complete_unregister (agt_cb_sa_validate_complete_t cbfn);
 
 
extern status_t
    agt_cb_sa_apply_complete_register (agt_cb_sa_apply_complete_t cbfn);
 
 
extern void
    agt_cb_sa_apply_complete_unregister (agt_cb_sa_apply_complete_t cbfn);
 
 
extern status_t
    agt_cb_sa_commit_complete_register (agt_cb_sa_commit_complete_t cbfn);
 
 
extern void
    agt_cb_sa_commit_complete_unregister (agt_cb_sa_commit_complete_t cbfn);
 
 
extern status_t
    agt_cb_sa_rollback_complete_register (agt_cb_sa_rollback_complete_t cbfn);
 
 
extern void
    agt_cb_sa_rollback_complete_unregister (agt_cb_sa_rollback_complete_t cbfn);
 
 
#ifdef WITH_YCONTROL
extern status_t
    agt_cb_sa_run_commit_completeness_cb (const xmlChar *transaction_id,
                                          agt_cbtyp_t cbtyp,
                                          agt_commit_type_t commit_type);
 
#endif  // WITH_YCONTROL
 
 
extern status_t
    agt_cb_edit_phase_complete_register (agt_cb_edit_phase_complete_t cbfn);
 
 
extern void
    agt_cb_edit_phase_complete_unregister (agt_cb_edit_phase_complete_t cbfn);
 
 
extern status_t
    agt_cb_sa_edit_phase_complete_register (agt_cb_sa_edit_phase_complete_t cbfn);
 
 
extern void
    agt_cb_sa_edit_phase_complete_unregister (agt_cb_sa_edit_phase_complete_t cbfn);
 
 
 
extern boolean
    agt_cb_any_edit_phase_complete (void);
 
 
extern status_t
    agt_cb_run_epc_commit_complete (ses_cb_t *scb,
                                    rpc_msg_t *msg,
                                    val_value_t *source,
                                    val_value_t *target);
 
 
extern boolean
    agt_cb_is_skip_callback (const obj_template_t *obj,
                             agt_cbtyp_t cbtyp);
 
 
extern status_t
    agt_cb_register_sa_push_callback (const xmlChar *modname,
                                      const xmlChar *defpath,
                                      const xmlChar *version,
                                      agt_cb_sa_push_t cbfn);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_cb */