yangapi.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_yangapi
#define _H_yangapi
/*  FILE: yangapi.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
11-apr-12    abb      Begun.
*/
 
/* used by the agent for the xmlTextReader interface */
#include <xmlreader.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_op
#include "op.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xpath
#include "xpath.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* Header only */
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
#define YANGAPI_RET_OK   200
 
#define YANGAPI_RET_CREATE_OK 201
 
#define YANGAPI_RET_BAD_METHOD  405
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
typedef enum yangapi_method_t_ {
    YANGAPI_METHOD_NONE,     
    YANGAPI_METHOD_OPTIONS,  
    YANGAPI_METHOD_HEAD,     
    YANGAPI_METHOD_GET,      
    YANGAPI_METHOD_POST,     
    YANGAPI_METHOD_PUT,      
    YANGAPI_METHOD_PATCH,    
    YANGAPI_METHOD_DELETE    
} yangapi_method_t;
 
 
typedef enum yangapi_launchpt_t_ {
    YANGAPI_LAUNCHPT_NONE,
 
    YANGAPI_LAUNCHPT_TOP,
 
    YANGAPI_LAUNCHPT_DATASTORE,
 
    YANGAPI_LAUNCHPT_DATA,
 
    YANGAPI_LAUNCHPT_NEW_DATA,
 
    YANGAPI_LAUNCHPT_MODULES,
 
    YANGAPI_LAUNCHPT_MODULE,
 
    YANGAPI_LAUNCHPT_OPERATIONS,
 
    YANGAPI_LAUNCHPT_OPERATION,
 
    YANGAPI_LAUNCHPT_YANG,
 
    YANGAPI_LAUNCHPT_YANG_PLAIN,
 
    YANGAPI_LAUNCHPT_VERSION,
 
    YANGAPI_LAUNCHPT_STREAMS,
 
    YANGAPI_LAUNCHPT_STREAM,
 
    YANGAPI_LAUNCHPT_EVENTS,
 
    YANGAPI_LAUNCHPT_YANGLIB_VERSION,
 
    YANGAPI_LAUNCHPT_ACTION,
 
    YANGAPI_LAUNCHPT_SUBSCRIPTIONS
 
} yangapi_launchpt_t;
 
 
typedef struct yangapi_param_t_ {
    dlq_hdr_t     qhdr;
 
    xmlChar      *name;
 
    xmlChar      *value;
} yangapi_param_t;
 
 
typedef struct yangapi_accept_t_ {
    dlq_hdr_t     qhdr;
 
    xmlChar      *media_type;
 
    xmlChar      *submedia_type;
 
    xmlChar      *format;
 
    xmlChar      *qvalue_str;
} yangapi_accept_t;
 
 
typedef enum restconf_content_t_ {
    RESTCONF_CONTENT_NONE,  
    RESTCONF_CONTENT_CONFIG,  
    RESTCONF_CONTENT_NONCONFIG, 
    RESTCONF_CONTENT_ALL  
} restconf_content_t;
 
typedef enum restconf_qparam_t_ {
    RESTCONF_QPARAM_CONTENT,
    RESTCONF_QPARAM_DEPTH,
    RESTCONF_QPARAM_FIELDS,
    RESTCONF_QPARAM_FILTER,
    RESTCONF_QPARAM_INSERT,
    RESTCONF_QPARAM_POINT,
    RESTCONF_QPARAM_START_TIME,
    RESTCONF_QPARAM_STOP_TIME,
    RESTCONF_QPARAM_WITH_DEFAULTS,
    RESTCONF_QPARAM_WITH_ORIGIN, 
    RESTCONF_QPARAM_EXTENSION,  
    RESTCONF_QPARAM_UNKNOWN  
} restconf_qparam_t;
 
 
 
 
 
 
#if defined(WITH_SNMP) && defined(WITH_RESTCONF)
 
typedef struct yangapi_snmp_cb_t_ {
 
    netsnmp_variable_list *variables;
 
    uint8            snmp_pdu_code;
 
    obj_template_t  *snmp_target_obj;
 
    obj_oid_t       *snmp_target_oid;
 
    boolean          snmp_key_walk;
 
    boolean          snmp_return_value_set;
 
/*********************  SNMP Index entries   *****************************/
 
    obj_oid_t       *snmp_target_index_oid;
 
    dlq_hdr_t        snmp_getnext_listQ;
 
    dlq_hdr_t        snmp_target_keyvalQ;
 
    val_value_t     *snmp_target_list;
 
    uint32           snmp_index_length;
 
    obj_template_t  *snmp_table_obj;
 
/*********************  SNMP GET2 entries   *****************************/
 
    boolean          snmpget2_index_match;
 
    val_value_t     *snmpget2_match_list;
}  yangapi_snmp_cb_t;
#endif   // WITH_SNMP and WITH_RESTCONF
 
 
typedef struct yangapi_cb_t_ {
 
/************************* COMMON RCB entries *****************************/
 
    dlq_hdr_t     qhdr;
 
    dlq_hdr_t     paramQ;
 
    dlq_hdr_t     keyvalQ;
 
    dlq_hdr_t     acceptQ;
 
    dlq_hdr_t     sorted_acceptQ;
 
    xmlChar      *accept;
 
    xmlChar      *request_method;
 
    xmlChar      *request_uri;
 
    xmlChar      *request_patch_path;
 
    boolean       request_force_patch_root;
 
    boolean       netconf_getbulk;
 
    xpath_pcb_t  *request_xpath;
 
    xpath_result_t *request_xpath_result;
 
    uint32         request_xpath_result_count;
 
    boolean        request_xpath_result_flat;
 
    val_value_t   *request_target;
 
    val_value_t   *request_sm_mpival;
 
    obj_template_t *req_target_reply_obj;
 
    xmlChar       *request_target_name;
 
    obj_template_t *request_target_obj;
 
    obj_template_t *request_target_obj_term;
 
    yangapi_launchpt_t request_launchpt;
 
    uint32 request_subscription_id;
 
    val_value_t  *request_launch;
 
    val_value_t  *request_top_data;
 
    val_value_t  *request_terminal;
 
    boolean       query_config;
 
    boolean       query_config_set;
 
    uint16        query_depth;
 
    ncx_display_mode_t query_format;
 
    op_insertop_t  query_insert;
 
    xmlChar      *query_point;
 
    xmlChar      *query_select;
 
    xpath_pcb_t  *query_select_xpath;
 
    xpath_result_t *query_select_xpath_result;
 
    uint32        query_select_xpath_result_count;
 
    xmlChar      *query_start;
 
    time_t        query_tstamp;
 
    ncx_etag_t    query_etag;
 
    xmlChar      *query_test;
 
    xpath_pcb_t  *query_test_xpath;
 
    xpath_result_t *query_test_xpath_result;
 
    uint32        query_test_xpath_result_count;
 
    xmlChar      *query_persist;
 
    xmlChar      *query_persist_id;
 
    uint32        query_confirm_timeout;
 
    boolean       query_confirmed;
 
    xmlChar      *content_type;
 
    xmlChar      *content_length;
 
    xmlChar      *if_modified_since;
 
    xmlChar      *if_unmodified_since;
 
    xmlChar      *if_match;
 
    xmlChar      *if_none_match;
 
    int           content_len;
 
    yangapi_method_t method;
 
    xmlChar      *fragment;
 
    uint32        pathlen;
 
    boolean       db_api_patch;
 
    boolean       get2_read;
 
    dlq_hdr_t     get2_lookupQ;
 
    dlq_hdr_t     get2_selectQ;
 
    uint32        return_code;
 
    op_editop_t   editop;
 
    val_value_t  *curnode;
 
    boolean       skip_read;
 
    boolean       empty_read;
 
    boolean       is_delta;
 
    boolean       target_is_config;
 
/********************** Accept header entries ***************************/
 
    ncx_display_mode_t accept_format;
 
    boolean         norm_header;
 
/************************* RESTCONF entries *****************************/
 
    boolean         is_restconf;
 
    restconf_content_t  query_content;
 
    val_value_t     *valfilter;
 
    xmlChar         *query_filter;
 
    xmlChar         *query_starttime;
 
    xmlChar         *starttime_utc;
 
    xmlChar         *query_stoptime;
 
    xmlChar         *stoptime_utc;
 
    boolean          futurestop;
 
    ncx_withdefaults_t  query_withdef;
 
    const xmlChar   *query_fields;
 
    xmlChar         *fields_buff;
 
    val_value_t     *fields_filter;
 
    xmlChar         *index_string;
 
    boolean         empty_edit;
 
    boolean         is_action;
 
    val_value_t     *action_root;
 
    val_value_t     *action_val;
 
    boolean         is_replace_datastore;
 
    xmlChar        *event_stream_name;
 
    val_value_t     *configval;
 
    xmlChar         *message_id;
 
/*********************  YANG-PATCH entries   *****************************/
 
    boolean         yang_patch;
 
    xmlChar        *patch_id;
 
    xmlChar        *edit_id;
 
/*********************  YP-COAP entries   *****************************/
 
    boolean         is_ypcoap;
 
    uint16          http_status;      
    uint8           coap_accept_type; 
    uint8           coap_content_type;
    uint16          coap_etag_len;    
    xmlChar        *coap_etag;        
    xmlChar        *http_location;    
    xmlChar        *http_etag;        
    xmlChar        *coap_data;        
    size_t          coap_datalen;     
    boolean         coap_save;        
    boolean         coap_is_block1;   
    uint8           coap_block_szx;   
    boolean         coap_block_m;     
    uint16          coap_block_num;   
 
/*********************  SNMP entries   *****************************/
 
    boolean       is_snmp;
 
    /*** NOTE: ALL SIL AND SIL-SA CODE MUST BE BUILT WITH THE CORRECT
     *** MATCHING MAKE FLAGS BECAUSE THIS STRUCT HAS CONDITIONAL MEMBERS
     ***/
 
#if defined(WITH_SNMP) && defined(WITH_RESTCONF)
    yangapi_snmp_cb_t *snmp_cb;
#else
    void *snmp_cb_dummy;   // dummy, not used
#endif
 
 
/*********************  GNMI entries   *****************************/
 
    boolean          is_gnmi;
 
    status_t         res;
 
    boolean          lock_done;
 
    boolean          gnmi_patch;
 
 
/*********************  NMDA Support entries   *****************************/
 
    ncx_nmda_ds_t             nmda_ds;
 
    boolean                   nmda_req;
 
    boolean                   nmda_ds_parsed;
 
    ncx_cfg_t                 nmda_cfg_ds;
 
    struct cfg_template_t_   *nmda_source_cfg;
 
    boolean                   with_origin;
 
    boolean                   oper_edit;
 
    boolean                   restconf_format;
 
} yangapi_cb_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
extern yangapi_param_t *
    yangapi_new_param (const xmlChar *parmname,
                       uint32 parmnamelen,
                       const xmlChar *parmval,
                       uint32 parmvallen);
 
 
extern void
    yangapi_free_param (yangapi_param_t *param);
 
 
extern yangapi_accept_t *
    yangapi_new_accept (const xmlChar *mediatype,
                       uint32 media_type_len,
                       const xmlChar *submediatype,
                       uint32 submediatype_len,
                       const xmlChar *acc_format,
                       uint32 acc_format_len,
                       const xmlChar *qvalue,
                       uint32 qvalue_len);
 
 
extern void
    yangapi_free_accept (yangapi_accept_t *accept_entry);
 
 
extern void
    yangapi_clean_keyvalQ (yangapi_cb_t *rcb);
 
 
extern void
    yangapi_clean_getnext_listQ (yangapi_cb_t *rcb,
                                 ses_cb_t *scb);
 
 
extern void
    yangapi_clean_target_keyvalQ (yangapi_cb_t *rcb);
 
 
extern yangapi_cb_t *
    yangapi_new_rcb (void);
 
 
extern void
    yangapi_free_rcb (yangapi_cb_t *rcb);
 
 
extern void
    yangapi_clean_rcb (yangapi_cb_t *rcb);
 
 
extern const xmlChar *
    yangapi_get_method_name (yangapi_method_t method_enum);
 
 
extern uint8
    yangapi_cvt_method_coap (yangapi_method_t method_enum);
 
 
extern restconf_content_t
    yangapi_get_content_enum (const xmlChar *content);
 
 
extern const xmlChar *
    yangapi_get_content_name (restconf_content_t content);
 
extern restconf_qparam_t
    yangapi_get_restconf_qparam_enum (const xmlChar *param);
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_yangapi */