cap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, 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_cap
#define _H_cap
/*  FILE: cap.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/

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

date             init     comment
----------------------------------------------------------------------
28-apr-05    abb      Begun.
*/
#include <xmlstring.h>

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

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

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

#ifdef __cplusplus
extern "C" {
#endif


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


#define MAX_STD_CAP_NAME_LEN  31

#define CAP_VERSION_LEN  15

#define CAP_BASE_URN ((const xmlChar *) \
              "urn:ietf:params:netconf:base:1.0")

#define CAP_BASE_URN11 ((const xmlChar *) \
                        "urn:ietf:params:netconf:base:1.1")

#define CAP_URN ((const xmlChar *)"urn:ietf:params:netconf:capability:")

#define CAP_REST_URN ((const xmlChar *)"urn:ietf:params:restconf:capability:")

#define CAP_J_URN \
    (const xmlChar *)"urn:ietf:params:xml:ns:netconf:capability:"

#define CAP_JUNOS \
    (const xmlChar *)"http://xml.juniper.net/netconf/junos/1.0"

#define CAP_SEP_CH   '/'


/************************************************************
 *                                                          *
 * The following 2 sets of definitions must be kept aligned *
 *                                                          *
 ************************************************************/

/* fast lookup -- standard capability bit ID */
#define CAP_BIT_V1            bit0
#define CAP_BIT_WR_RUN        bit1
#define CAP_BIT_CANDIDATE     bit2
#define CAP_BIT_CONF_COMMIT   bit3
#define CAP_BIT_ROLLBACK_ERR  bit4
#define CAP_BIT_VALIDATE      bit5
#define CAP_BIT_STARTUP       bit6
#define CAP_BIT_URL           bit7
#define CAP_BIT_XPATH         bit8
#define CAP_BIT_NOTIFICATION  bit9
#define CAP_BIT_INTERLEAVE    bit10
#define CAP_BIT_PARTIAL_LOCK  bit11
#define CAP_BIT_WITH_DEFAULTS bit12
#define CAP_BIT_V11           bit13
#define CAP_BIT_CONF_COMMIT11 bit14
#define CAP_BIT_VALIDATE11    bit15
#define CAP_BIT_DEPTH         bit16
#define CAP_BIT_FIELDS        bit17
#define CAP_BIT_FILTER        bit18
#define CAP_BIT_REPLAY        bit19
#define CAP_BIT_DEFAULTS      bit20
#define CAP_BIT_YANGPATCH     bit21
#define CAP_BIT_YANGLIB       bit22
#define CAP_BIT_YANGLIB11     bit23


/* put the version numbers in the capability names for now */
#define CAP_NAME_V1                 ((const xmlChar *)"base:1.0")
#define CAP_NAME_V11                ((const xmlChar *)"base:1.1")
#define CAP_NAME_CANDIDATE          ((const xmlChar *)"candidate:1.0")
#define CAP_NAME_CONF_COMMIT        ((const xmlChar *)"confirmed-commit:1.0")
#define CAP_NAME_CONF_COMMIT11      ((const xmlChar *)"confirmed-commit:1.1")
#define CAP_NAME_DEFAULTS           ((const xmlChar *)"defaults:1.0")
#define CAP_NAME_DEPTH              ((const xmlChar *)"depth:1.0")
#define CAP_NAME_FIELDS             ((const xmlChar *)"fields:1.0")
#define CAP_NAME_FILTER             ((const xmlChar *)"filter:1.0")
#define CAP_NAME_INTERLEAVE         ((const xmlChar *)"interleave:1.0")
#define CAP_NAME_NOTIFICATION       ((const xmlChar *)"notification:1.0")
#define CAP_NAME_PARTIAL_LOCK       ((const xmlChar *)"partial-lock:1.0")
#define CAP_NAME_REPLAY             ((const xmlChar *)"replay:1.0")
#define CAP_NAME_ROLLBACK_ERR       ((const xmlChar *)"rollback-on-error:1.0")
#define CAP_NAME_STARTUP            ((const xmlChar *)"startup:1.0")
#define CAP_NAME_URL                ((const xmlChar *)"url:1.0")
#define CAP_NAME_VALIDATE           ((const xmlChar *)"validate:1.0")
#define CAP_NAME_VALIDATE11         ((const xmlChar *)"validate:1.1")
#define CAP_NAME_WITH_DEFAULTS      ((const xmlChar *)"with-defaults:1.0")
#define CAP_NAME_WR_RUN             ((const xmlChar *)"writable-running:1.0")
#define CAP_NAME_XPATH              ((const xmlChar *)"xpath:1.0")
#define CAP_NAME_YANGLIB            ((const xmlChar *)"yang-library:1.0")
#define CAP_NAME_YANGLIB11          ((const xmlChar *)"yang-library:1.1")
#define CAP_NAME_YANGPATCH          ((const xmlChar *)"yang-patch:1.0")



/* some YANG capability details */
#define CAP_REVISION_EQ        (const xmlChar *)"revision="
#define CAP_MODULE_EQ          (const xmlChar *)"module="
#define CAP_FEATURES_EQ        (const xmlChar *)"features="
#define CAP_DEVIATIONS_EQ      (const xmlChar *)"deviations="
#define CAP_SCHEME_EQ          (const xmlChar *)"scheme="
#define CAP_PROTOCOL_EQ        (const xmlChar *)"protocol="
#define CAP_BASIC_EQ           (const xmlChar *)"basic-mode="
#define CAP_SUPPORTED_EQ       (const xmlChar *)"also-supported="
#define CAP_MODULESETID_EQ     (const xmlChar *)"module-set-id="
#define CAP_CONTENTID_EQ       (const xmlChar *)"content-id="

#define CAP_YANGLIB_REVISION_PARAM  (const xmlChar *)"revision=2016-06-21"
#define CAP_YANGLIB_REVISION        (const xmlChar *)"2016-06-21"

#define CAP_YANGLIB_NMDA_REVISION_PARAM  (const xmlChar *)"revision=2019-01-04"
#define CAP_YANGLIB_NMDA_REVISION        (const xmlChar *)"2019-01-04"

/* yang-library module-set-id capability base string */
#define CAP_YANGLIB_BASE_URN \
    (const xmlChar *)"urn:ietf:params:netconf:capability:yang-library:1.0"

/* NMDA yang-library content-id capability base string */
#define CAP_YANGLIB_NMDA_BASE_URN \
    (const xmlChar *)"urn:ietf:params:netconf:capability:yang-library:1.1"

#define CAP_SCHEMA_RETRIEVAL \
    (const xmlChar *)"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"


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

typedef enum cap_subjtyp_t_ {
    CAP_SUBJTYP_NONE,
    CAP_SUBJTYP_PROT,       
    CAP_SUBJTYP_DM,         
    CAP_SUBJTYP_OTHER,      
    CAP_SUBJTYP_CONFID      
} cap_subjtyp_t;


typedef enum cap_change_t_ {
    CAP_CHANGE_NONE,
    CAP_CHANGE_ADD,
    CAP_CHANGE_DELETE,
    CAP_CHANGE_MODIFY
} cap_change_t;


typedef enum cap_stdid_t_ {
    CAP_STDID_V1,

    CAP_STDID_WRITE_RUNNING,

    CAP_STDID_CANDIDATE,

    CAP_STDID_CONF_COMMIT,

    CAP_STDID_ROLLBACK_ERR,

    CAP_STDID_VALIDATE,

    CAP_STDID_STARTUP,

    CAP_STDID_URL,

    CAP_STDID_XPATH,

    CAP_STDID_NOTIFICATION,

    CAP_STDID_INTERLEAVE,

    CAP_STDID_PARTIAL_LOCK,

    CAP_STDID_WITH_DEFAULTS,

    CAP_STDID_V11,

    CAP_STDID_VALIDATE11,

    CAP_STDID_CONF_COMMIT11,

    CAP_STDID_DEPTH,

    CAP_STDID_FIELDS,

    CAP_STDID_FILTER,

    CAP_STDID_REPLAY,

    CAP_STDID_DEFAULTS,

    CAP_STDID_YANGPATCH,

    CAP_STDID_YANGLIB,    

    CAP_STDID_YANGLIB11,  

    CAP_STDID_LAST_MARKER
} cap_stdid_t;


typedef struct cap_list_t_ {
    uint32          cap_std;           
    xmlChar        *cap_schemes;       
    xmlChar        *cap_defstyle;      
    xmlChar        *cap_supported;     
    xmlChar        *cap_yanglib_rev;   
    xmlChar        *cap_yanglib_setid; 
    dlq_hdr_t       capQ;              
} cap_list_t;


typedef struct cap_rec_t_ {
    dlq_hdr_t      cap_qhdr;
    cap_subjtyp_t  cap_subject;
    xmlChar       *cap_uri;
    xmlChar       *cap_namespace;
    xmlChar       *cap_module;
    xmlChar       *cap_revision;
    ncx_list_t     cap_feature_list;
    ncx_list_t     cap_deviation_list;
} cap_rec_t;


typedef enum cap_yanglib_ver_t_ {
    CAP_YANGLIB_VER_NONE,

    CAP_YANGLIB_VER_10,

    CAP_YANGLIB_VER_11,
} cap_yanglib_ver_t;


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


extern cap_list_t *
    cap_new_caplist (void);


extern void
    cap_init_caplist (cap_list_t *caplist);


extern void
    cap_clean_caplist (cap_list_t *caplist);


extern void
    cap_free_caplist (cap_list_t *caplist);


extern status_t
    cap_add_std (cap_list_t *caplist,
                 cap_stdid_t capstd);


extern status_t
    cap_add_stdval (val_value_t *caplist,
                    cap_stdid_t capstd,
                    boolean is_restconf);


extern status_t
    cap_add_std_string (cap_list_t *caplist,
                        const xmlChar *uri,
                        boolean is_restconf);


extern boolean
    cap_is_module_string (const xmlChar *uri);


extern status_t
    cap_add_module_string (cap_list_t *caplist,
                           const xmlChar *uri);


extern status_t
    cap_add_url (cap_list_t *caplist,
         const xmlChar *scheme_list);


extern status_t
    cap_add_urlval (val_value_t *caplist,
                    const xmlChar *scheme_list,
                    boolean is_restconf);


extern status_t
    cap_add_withdef (cap_list_t *caplist,
                     const xmlChar *defstyle);


extern status_t
    cap_add_withdefval (val_value_t *caplist,
                        const xmlChar *defstyle,
                        uint8 withdef_enabled,
                        boolean is_restconf);


extern status_t
    cap_add_restdefval (val_value_t *caplist,
                        const xmlChar *defstyle);


extern status_t
    cap_add_ent (cap_list_t *caplist,
         const xmlChar *uristr);


extern status_t
    cap_add_entval (val_value_t *caplist,
                    const xmlChar *urival);


extern status_t
    cap_add_modval (val_value_t *caplist,
            ncx_module_t *mod);


extern status_t
    cap_add_mod (cap_list_t *caplist,
                 ncx_module_t *mod);


extern void
    cap_remove_mod (cap_list_t *caplist,
                    ncx_module_t *mod);


extern status_t
    cap_remove_modval (val_value_t *caplist,
                       ncx_module_t *mod);



extern status_t
    cap_add_netconf_modval (val_value_t *caplist,
                            ncx_module_t *mod);


extern status_t
    cap_add_devmodval (val_value_t *caplist,
                       ncx_save_deviations_t *savedev);


extern boolean
    cap_std_set (const cap_list_t *caplist,
         cap_stdid_t capstd);


extern boolean
    cap_set (const cap_list_t *caplist,
         const xmlChar *capuri);


extern cap_rec_t *
    cap_match (const cap_list_t *caplist,
               const xmlChar *capuri);


extern val_value_t *
    cap_match_val (val_value_t *caplist,
                   const xmlChar *capuri);


extern const xmlChar *
    cap_get_protos (cap_list_t *caplist);


extern void
    cap_dump_stdcaps (const cap_list_t *caplist,
                      log_debug_t lvl,
                      FILE *outfile);


extern void
    cap_dump_modcaps (const cap_list_t *caplist,
                      log_debug_t lvl,
                      FILE *outfile);


extern const cap_rec_t *
    cap_find_modcap (const cap_list_t *caplist,
                     const xmlChar *modname);


extern void
    cap_dump_entcaps (const cap_list_t *caplist,
                      log_debug_t lvl,
                      FILE *outfile);


extern cap_rec_t *
    cap_first_modcap (cap_list_t *caplist);


extern cap_rec_t *
    cap_next_modcap (cap_rec_t *curcap);


extern void
    cap_split_modcap (cap_rec_t *cap,
              const xmlChar **module,
              const xmlChar **revision,
              const xmlChar **namespacestr);


extern xmlChar *
    cap_make_moduri (ncx_module_t *mod);


extern status_t
    cap_add_config_id (cap_list_t *caplist);


extern status_t
    cap_add_ids_val (val_value_t *caplist,
                     boolean is_module_id,
                     cap_yanglib_ver_t yanglib_ver);


extern status_t
    cap_add_yanglib (cap_list_t *caplist,
                     cap_yanglib_ver_t yanglib_ver);


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

#endif            /* _H_cap */