xml_msg.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_xml_msg
#define _H_xml_msg
/*  FILE: xml_msg.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
14-jan-07    abb      Begun; split from agt_rpc.h
28-feb-13    abb      Add JSON, <get2>, and YANG-API support
*/
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifndef _H_xml_util
#include "xml_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
#define XML_MSG_FL_PREFIX     bit0
 
#define XML_MSG_FL_ETAGS      bit1
 
#define XML_MSG_FL_ETAGS_TEST  bit2
 
#define XML_MSG_FL_TSTAMPS    bit3
 
#define XML_MSG_FL_TSTAMPS_TEST  bit4
 
#define XML_MSG_FL_KEYS       bit5
 
#define XML_MSG_FL_PASSED bit6
 
#define XML_MSG_FL_DELTA bit7
 
#define XML_MSG_FL_OWNERS bit8
 
#define XML_MSG_FL_GET2 bit9
 
#define XML_MSG_FL_MODTAGS bit10
 
#define XML_MSG_FL_MODTAGS_EMPTY bit11
 
#define XML_MSG_FL_ANYXML_TRACK bit12
 
 
#define XML_MSG_USE_PREFIX(M)   ((M)->flags & XML_MSG_FL_PREFIX)
 
#define XML_MSG_NO_PREFIX(M)    ((M)->flags &= ~XML_MSG_FL_PREFIX)
 
 
/* ETAGS */
 
#define XML_MSG_WITH_ETAGS(M)   ((M)->flags & XML_MSG_FL_ETAGS)
 
#define XML_MSG_WITH_ETAGS_TEST(M)   ((M)->flags & XML_MSG_FL_ETAGS_TEST)
 
#define XML_MSG_SET_WITH_ETAGS(M) (M)->flags |= XML_MSG_FL_ETAGS
 
#define XML_MSG_SET_WITH_ETAGS_TEST(M) (M)->flags |= XML_MSG_FL_ETAGS_TEST
 
#define XML_MSG_CLR_WITH_ETAGS_TEST(M) (M)->flags &= ~XML_MSG_FL_ETAGS_TEST
 
 
/* TIMESTAMPS */
 
#define XML_MSG_WITH_TSTAMPS(M) ((M)->flags & XML_MSG_FL_TSTAMPS)
 
#define XML_MSG_WITH_TSTAMPS_TEST(M) ((M)->flags & XML_MSG_FL_TSTAMPS_TEST)
 
#define XML_MSG_SET_WITH_TSTAMPS(M) (M)->flags |= XML_MSG_FL_TSTAMPS
 
#define XML_MSG_SET_WITH_TSTAMPS_TEST(M) (M)->flags |= XML_MSG_FL_TSTAMPS_TEST
 
#define XML_MSG_CLR_WITH_TSTAMPS_TEST(M) (M)->flags &= ~XML_MSG_FL_TSTAMPS_TEST
 
#define XML_MSG_TSTAMPS_PASSED(M) ((M)->flags & XML_MSG_FL_PASSED)
 
#define XML_MSG_SET_TSTAMPS_PASSED(M) (M)->flags |= XML_MSG_FL_PASSED
 
#define XML_MSG_DELTA(M) ((M)->flags & XML_MSG_FL_DELTA)
 
#define XML_MSG_SET_DELTA(M) (M)->flags |= XML_MSG_FL_DELTA
 
 
#define XML_MSG_KEYS_ONLY(M)    ((M)->flags & XML_MSG_FL_KEYS)
 
#define XML_MSG_SET_KEYS_ONLY(M)  (M)->flags |= XML_MSG_FL_KEYS
 
/* WITH-OWNERS */
 
#define XML_MSG_WITH_OWNERS(M)   ((M)->flags & XML_MSG_FL_OWNERS)
 
#define XML_MSG_SET_WITH_OWNERS(M) (M)->flags |= XML_MSG_FL_OWNERS
 
#define XML_MSG_CLR_WITH_OWNERS(M) (M)->flags &= ~XML_MSG_FL_OWNERS
 
 
/* GET2 */
 
#define XML_MSG_WITH_GET2(M)   ((M)->flags & XML_MSG_FL_GET2) ? TRUE : FALSE
 
#define XML_MSG_SET_WITH_GET2(M) (M)->flags |= XML_MSG_FL_GET2
 
#define XML_MSG_CLR_WITH_GET2(M) (M)->flags &= ~XML_MSG_FL_GET2
 
#define XML_MSG_SET_LOOKUPQ(M,Q) (M)->lookupQ = Q
 
#define XML_MSG_SET_MATCHQ(M,Q) (M)->matchQ = Q
 
#define XML_MSG_SET_SELECTQ(M,Q) (M)->selectQ = Q
 
 
/* ANYXML-TRACKING */
 
#define XML_MSG_ANYXML_TRACK(M)   ((M)->flags & XML_MSG_FL_ANYXML_TRACK)
 
#define XML_MSG_SET_ANYXML_TRACK(M) (M)->flags |= XML_MSG_FL_ANYXML_TRACK
 
#define XML_MSG_CLR_ANYXML_TRACK(M) (M)->flags &= ~XML_MSG_FL_ANYXML_TRACK
 
#define XML_MSG_ANYXML_OBJ(M) (M)->anyxml_obj
 
#define XML_MSG_GET_ERROR_DATAQ(M) &(M)->error_dataQ
 
#define XML_MSG_ACTIONVAL(M)   (M)->actionval
 
#define XML_MSG_GETBULK(M) (M)->getbulk_cb
 
#define XML_MSG_GET2_TARGET(M) (M)->get2_target
 
#define XML_MSG_GET2CB(M) (M)->get2cb
 
/* MODTAGS */
 
#define XML_MSG_WITH_MODTAGS(M)   ((M)->flags & XML_MSG_FL_MODTAGS)
 
#define XML_MSG_SET_WITH_MODTAGS(M) (M)->flags |= XML_MSG_FL_MODTAGS
 
#define XML_MSG_WITH_MODTAGS_EMPTY(M)  \
    ((M)->flags & XML_MSG_FL_MODTAGS_EMPTY)
 
#define XML_MSG_SET_WITH_MODTAGS_EMPTY(M) \
    (M)->flags |= XML_MSG_FL_MODTAGS_EMPTY
 
#define XML_MSG_YPGNMI_GETCB(M) (M)->gnmi_getcb
 
#define XML_MSG_YPGNMI_EDITCB(M) (M)->gnmi_editcb
 
#define XML_MSG_PRUNE_BAD_DATA(M) (M)->prune_bad_data
 
#define XML_MSG_XGET_REQ(M) (M)->xget_request
 
#define XML_MSG_ALLINONE_MODE(M) (M)->all_in_one_mode
 
#define XML_MSG_LAST_GET2_FILPTR(M) (M)->get2_filptr
 
#define XML_MSG_GET2CB_ALLINONE(M) (M)->get2cb
 
 
#define XML_MSG_NMDA_PARAMS(M) (M)->nmda_params
 
#define XML_MSG_WITH_ORIGIN(M) \
    ((M)->nmda_params && (M)->nmda_params->with_origin)
 
#define XML_MSG_EDIT_CONFIG_ROOT(M) (M)->edit_config_root
 
#define XML_MSG_DEPTH_TARGET(M) (M)->depth_target
 
 
#define XML_MSG_NMDA_OPERATIONAL(M) \
    ((M)->nmda_params && \
     ((M)->nmda_params->nmda_ds == NCX_NMDA_DS_OPERATIONAL))
 
#define XML_MSG_SM_MPID(M) (M)->sm_mpid
 
#define XML_MSG_SID_LOWER(M) (M)->sid_lower
 
 
#define XML_MSG_SID_UPPER(M) (M)->sid_upper
 
#define XML_MSG_SID_SKIP(M)  (M)->sid_skip
 
#define XML_MSG_PARENT_SID(M)  (M)->parent_sid
 
 
#define XML_MSG_ACTION_PARENT(M)  (M)->action_parent
 
 
#define XML_MSG_ACTION_PARENT_MODE(M)  (M)->action_parent_mode
 
#define XML_MSG_SKIP_EMPTY_NPCON(M)   (M)->skip_empty_npcon
 
 
#define XML_MSG_PRE_PROCESS_MODE(M)  (M)->pre_process_mode
 
 
#define XML_MSG_JSON_PARSE_NOTIF(M)  (M)->json_parse_notif
 
 
#define XML_MSG_JSON_WR_FIXTOP(M) (M)->json_wr_fixtop
 
 
/********************************************************************
*                                                                   *
*                         T Y P E S                                 *
*                                                                   *
*********************************************************************/
 
 
typedef struct xml_msg_hdr_t_ {
 
    uint16             flags;
 
    ncx_withdefaults_t withdef;           
    dlq_hdr_t          prefixQ;             
    dlq_hdr_t          errQ;                
    dlq_hdr_t          filptr_cleanupQ;     
    dlq_hdr_t       error_dataQ;     
    dlq_hdr_t      *lookupQ;         
    dlq_hdr_t      *matchQ;          
    dlq_hdr_t      *selectQ;         
    struct agt_acm_cache_t_ *acm_cache;
 
    uint32             msgid;
 
    ncx_cfg_t          cfgid;
 
    boolean            cfgid_valid;
 
    void              *acm_cbfn;
 
    uint32             max_depth;    
    uint32             start_depth;    
    uint32             cur_depth;       
    time_t             match_tstamp;
 
    ncx_etag_t         match_etag;
 
    ncx_display_mode_t input_encoding;
 
    ncx_display_mode_t output_encoding;
 
    struct tk_chain_t_ *tkc;
 
    void *val_error_fn;
 
    void *val_errinfo_fn;
 
    void *obj_error_fn;
 
    void *record_error;
 
    void *record_error_errinfo;
 
    void *record_attr_error;
 
    val_value_t     *actionval;  /* backptr into rpc_input tree */
 
    struct getbulk_cb_t_ *getbulk_cb;
 
    struct obj_template_t_ *get2_target;
 
    struct getcb_get2_t_   *get2cb;
 
    dlq_hdr_t              modtagQ;
 
    struct ypgnmi_get_cb_t_ *gnmi_getcb;
 
    struct ypgnmi_edit_cb_t_ *gnmi_editcb;
 
    boolean                   prune_bad_data;
 
    boolean                   xget_request;
 
    boolean                   all_in_one_mode;
 
    struct ncx_filptr_t_     *get2_filptr;
 
    ncx_nmda_params_t        *nmda_params;
 
    dlq_hdr_t                *aiocbQ; // Q of xpath_aio_cb_t
 
    struct obj_template_t_  *anyxml_obj;
 
    val_value_t *edit_config_root;
 
    struct obj_template_t_ *depth_target;
 
    ncx_sm_mpid_t *sm_mpid;
 
    ncx_sid_t sid_lower;
 
    ncx_sid_t sid_upper;
 
    boolean sid_skip;
 
 
    ncx_sid_t parent_sid;
 
    /* YPW-2006: need to GET the parent of an action invocation
     *  This is used for NMDA to verify the action can be called
     *  It is required for YANG 1.1 XPath in case a must or when
     *  statement in the input parameters reaches up into the
     *  config or state data above the action node
     */
    struct xpath_pcb_t_ *action_parent;
 
    /* YPW-2060: need to flag the special get action parent mode
     * so validation properly handled for AIO and missing NP containers
     */
    boolean action_parent_mode;
 
    boolean skip_empty_npcon;
 
    dlq_hdr_t revcount_revQ;     
    /* YPW-2273: need to flag the special subtree pre-process mode so the
     * callback has that information and can act accordingly.
     */
    boolean pre_process_mode;
 
    boolean json_parse_notif;
 
    boolean json_wr_fixtop;
 
} xml_msg_hdr_t;
 
 
typedef void
    (*xml_msg_val_error_fn_t) (ses_cb_t *scb,
                               xml_msg_hdr_t *mhdr,
                               status_t res,
                               val_value_t *errnode,
                               const xmlChar *badval);
 
 
 
typedef void
    (*xml_msg_val_errinfo_fn_t) (ses_cb_t *scb,
                                xml_msg_hdr_t *mhdr,
                                status_t res,
                                val_value_t *errnode,
                                const xmlChar *badval,
                                const ncx_errinfo_t *errinfo);
 
 
 
typedef void
    (*xml_msg_obj_error_fn_t) (ses_cb_t *scb,
                               xml_msg_hdr_t *mhdr,
                               status_t res,
                               struct obj_template_t_ *errobj,
                               const xmlChar *badval);
 
 
typedef boolean (*xml_msg_authfn_t) (xml_msg_hdr_t *msg,
                                     const xmlChar *username,
                                     const val_value_t *val);
 
 
typedef void
    (*xml_msg_record_error_fn_t) (ses_cb_t *scb,
                                  xml_msg_hdr_t *mhdr,
                                  ncx_layer_t layer,
                                  status_t res,
                                  const xml_node_t *xmlnode,
                                  ncx_node_t parmtyp,
                                  const void *error_info,
                                  ncx_node_t nodetyp,
                                  void *error_path);
 
 
typedef void
    (*xml_msg_record_error_errinfo_fn_t) (ses_cb_t *scb,
                                          xml_msg_hdr_t *msghdr,
                                          ncx_layer_t layer,
                                          status_t  res,
                                          const xml_node_t *xmlnode,
                                          ncx_node_t parmtyp,
                                          const void *error_info,
                                          ncx_node_t nodetyp,
                                          void *error_path,
                                          const ncx_errinfo_t *errinfo);
 
 
typedef void
    (*xml_msg_record_attr_error_fn_t) (ses_cb_t *scb,
                                       xml_msg_hdr_t *msghdr,
                                       ncx_layer_t layer,
                                       status_t  res,
                                       const xml_attr_t *xmlattr,
                                       const xml_node_t *xmlnode,
                                       const xmlChar *badns,
                                       ncx_node_t nodetyp,
                                       void *errnode);
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern void
    xml_msg_init_hdr (xml_msg_hdr_t *msg);
 
 
extern void
    xml_msg_clean_hdr (xml_msg_hdr_t *msg);
 
 
extern const xmlChar *
    xml_msg_get_prefix (xml_msg_hdr_t *msg,
                        xmlns_id_t parent_nsid,
                        xmlns_id_t nsid,
                        val_value_t *curelem,
                        boolean  *xneeded);
 
 
extern const xmlChar *
    xml_msg_get_prefix_xpath (xml_msg_hdr_t *msg,
                              xmlns_id_t nsid);
 
 
extern const xmlChar *
    xml_msg_get_prefix_start_tag (xml_msg_hdr_t *msg,
                                  xmlns_id_t nsid);
 
 
extern status_t
    xml_msg_gen_new_prefix (xml_msg_hdr_t *msg,
                            xmlns_id_t  nsid,
                            xmlChar **retbuff,
                            uint32 buffsize);
 
 
extern status_t
    xml_msg_build_prefix_map (xml_msg_hdr_t *msg,
                              xml_attrs_t *attrs,
                              boolean addncid,
                              boolean addncxid);
 
 
extern status_t
    xml_msg_finish_prefix_map (xml_msg_hdr_t *msg,
                               xml_attrs_t *attrs);
 
 
extern status_t
    xml_msg_check_xmlns_attr (xml_msg_hdr_t *msg,
                              xmlns_id_t nsid,
                              const xmlChar *badns,
                              xml_attrs_t  *attrs);
 
 
extern status_t
    xml_msg_gen_xmlns_attrs (xml_msg_hdr_t *msg,
                             xml_attrs_t *attrs,
                             boolean addncx);
 
 
extern status_t
    xml_msg_clean_defns_attr (xml_attrs_t *attrs);
 
 
extern status_t
    xml_msg_add_ncid_to_prefix_map (xml_msg_hdr_t* msg,
                                    xml_attrs_t* attrs,
                                    xmlns_id_t ncid);
 
 
 
extern void xml_msg_init (void);
 
 
extern void xml_msg_cleanup (void);
 
 
extern void xml_msg_set_cfgid (xml_msg_hdr_t *msg,
                               ncx_cfg_t cfgid);
 
 
extern ncx_cfg_t
    xml_msg_get_cfgid (xml_msg_hdr_t *msg,
                       boolean *isvalid);
 
 
extern uint32
    xml_msg_get_msgid (xml_msg_hdr_t *msg);
 
 
extern ncx_withdefaults_t
    xml_msg_get_withdef (xml_msg_hdr_t *msg);
 
 
 
extern void
    xml_msg_set_withdef (xml_msg_hdr_t *msg,
                         ncx_withdefaults_t withdef);
 
 
extern uint32
    xml_msg_get_max_depth (xml_msg_hdr_t *msg);
 
 
extern void
    xml_msg_set_max_depth (xml_msg_hdr_t *msg,
                          uint32 max_depth);
 
 
extern uint32
    xml_msg_get_start_depth (xml_msg_hdr_t *msg);
 
 
extern void
    xml_msg_set_start_depth (xml_msg_hdr_t *msg,
                             uint32 start_depth);
 
 
extern uint32
    xml_msg_get_cur_depth (xml_msg_hdr_t *msg);
 
 
extern void
    xml_msg_set_cur_depth (xml_msg_hdr_t *msg,
                          uint32 cur_depth);
 
 
extern ncx_display_mode_t
    xml_msg_get_encoding (xml_msg_hdr_t *msg,
                          boolean is_output);
 
 
extern void
    xml_msg_set_encoding (xml_msg_hdr_t *msg,
                          boolean is_output,
                          ncx_display_mode_t encoding);
 
 
extern ncx_etag_t
    xml_msg_get_etag (xml_msg_hdr_t *msg,
                      boolean *test);
 
 
extern void
    xml_msg_set_etag (xml_msg_hdr_t *msg,
                      ncx_etag_t etag,
                      boolean test_sense);
 
 
extern time_t
    xml_msg_get_tstamp (xml_msg_hdr_t *msg,
                        boolean *test);
 
 
extern void
    xml_msg_set_tstamp (xml_msg_hdr_t *msg,
                        time_t tstamp,
                        boolean test_sense);
 
 
extern dlq_hdr_t *
    xml_msg_get_lookupQ (xml_msg_hdr_t *msg);
 
 
extern dlq_hdr_t *
    xml_msg_get_matchQ (xml_msg_hdr_t *msg);
 
 
extern dlq_hdr_t *
    xml_msg_get_selectQ (xml_msg_hdr_t *msg);
 
 
extern void
    xml_msg_inc_cur_depth (xml_msg_hdr_t *mhdr);
 
 
extern void
    xml_msg_dec_cur_depth (xml_msg_hdr_t *mhdr);
 
 
extern boolean
    xml_msg_test_max_depth (xml_msg_hdr_t *mhdr,
                            const struct obj_template_t_ *obj);
 
 
extern void
    xml_msg_save_filptr (xml_msg_hdr_t *msg,
                         ncx_filptr_t *filptr);
 
 
extern status_t
    xml_msg_set_with_origin (xml_msg_hdr_t *mhdr);
 
 
/*
* @brief Check the revisions
*
* Check if the revisions are the same in the queue. If they all the same
* return 1, that means that get-schema can be used with out revision
* specified. Otherwise, use the original count value which will produce
* an "duplicate" error reply.
*
* @param msg xml_msg_hdr_t to use
* @param orig_count count of duplicates
*
* @return count of duplicate revisions
*/
extern uint32
    xml_msg_check_dup_revs (xml_msg_hdr_t *msg,
                            uint32 orig_count);
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_xml_msg */