sm.h

Go to the documentation of this file.

#ifdef WITH_SCHEMA_MOUNT
/*
 * Copyright (c) 2022 - 2023, 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_sm
#define _H_sm
 
/*  FILE: sm.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
04-apr-22        am        Begun
*/
 
/* used by the agent for the xmlTextReader interface */
#include <xmlreader.h>
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* Header only */
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
 
 
typedef status_t
    (*sm_yanglib_cbfn_t) (ncx_sm_rootcb_t *rootcb);
 
 
 
typedef boolean
    (*sm_rootcb_searchfn_t) (ncx_sm_rootcb_t *rootcb,
                             void *cookie);
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
extern void sm_init (void);
 
 
extern void
    sm_cleanup (void);
 
 
extern void
    sm_dump_rootcb (ncx_sm_rootcb_t *rootcb);
 
 
extern void
    sm_show_rootcb (ncx_sm_rootcb_t *rootcb);
 
 
extern void
    sm_dump_all_rootcb (void);
 
 
extern ncx_module_t *
    sm_find_module (ncx_sm_rootcb_t *rootcb,
                    const xmlChar *modname,
                    const xmlChar *revision);
 
 
/*
* @brief Find an ncx_module_t in the rootcb->modQ by prefix
*
* rootcb->modQ These are the modules that are already loaded
* into Mount Point
*
* @param rootcb control block to use
* @param prefix name
*
* @return module pointer if found or NULL if not
*/
extern ncx_module_t *
    sm_find_module_by_prefix (ncx_sm_rootcb_t *rootcb,
                             const xmlChar *prefix);
 
 
extern ncx_module_t *
    sm_find_deviation (ncx_sm_rootcb_t *rootcb,
                       const xmlChar *modname,
                       const xmlChar *revision);
 
 
extern ncx_module_t *
    sm_find_module_allroots (const xmlChar *modname,
                             const xmlChar *revision,
                             boolean withdev);
 
 
/*
* @brief Find an ncx_module_t in the any rootcb
* CHECK submodules allowed
* Will return the first match or NULL if no match
* @param modname module name
* @param revision module revision date
* @param withdev TRUE to check deviation modules as well
* @param withsubmod TRUE to check submodules and modules
* @return module pointer if found or NULL if not
*/
extern ncx_module_t *
    sm_find_module_allroots2 (const xmlChar *modname,
                              const xmlChar *revision,
                              boolean withdev,
                              boolean withsubmod);
 
 
extern obj_template_t *
    sm_find_any_object (ncx_sm_rootcb_t *rootcb,
                        const xmlChar *objname);
 
 
extern obj_template_t *
    sm_first_mounted_obj (ncx_sm_rootcb_t *rootcb,
                          boolean augment_ok);
 
 
extern obj_template_t *
    sm_next_mounted_obj (obj_template_t *curobj,
                         boolean augment_ok);
 
 
extern obj_template_t *
    sm_last_mounted_obj (ncx_sm_rootcb_t *rootcb,
                         boolean augment_ok);
 
 
extern obj_template_t *
    sm_prev_mounted_obj (obj_template_t *curobj,
                         boolean augment_ok);
 
 
extern obj_template_t *
    sm_find_child_obj (obj_template_t *obj,
                       const xmlChar *modname,
                       const xmlChar *objname,
                       ncx_name_match_t match_names,
                       boolean alt_names,
                       boolean dataonly,
                       status_t *retres);
 
 
extern void
    sm_setup_cur_rootcb (ncx_sm_rootcb_t *rootcb);
 
 
extern void
    sm_init_yanglib_cb (ncx_yanglib_cb_t *cb);
 
 
extern void
    sm_clean_yanglib_cb (ncx_yanglib_cb_t *cb);
 
 
extern void
    sm_register_yanglib_cbfn (sm_yanglib_cbfn_t cbfn);
 
 
extern ncx_sm_mpid_t *
    sm_new_mpid (void);
 
 
extern void
    sm_free_mpid (ncx_sm_mpid_t *mpid);
 
 
extern status_t
    sm_setup_mpid (xml_msg_hdr_t *msg,
                   val_value_t *val,
                   obj_template_t *obj);
 
 
extern void
    sm_dump_mpid (const ncx_sm_mpid_t *mpid);
 
 
extern ncx_sm_mpid_t *
    sm_clone_mpid (const ncx_sm_mpid_t *mpid,
                   val_value_t *valroot);
 
 
extern ncx_sm_mpid_t *
    sm_get_mpid_from_msg (rpc_msg_t *msg);
 
 
extern status_t
    sm_find_mpidval_from_input (val_value_t *chval,
                                val_value_t **mpidval);
 
 
 
extern val_value_t *
    sm_get_mpi_valroot (val_value_t *val);
 
 
 
extern ncx_sm_mpid_t *
    sm_get_ancestor_mpid (val_value_t *val);
 
 
extern status_t
    sm_patch_notif_keyQ (const ncx_sm_mpid_t *mpid,
                         dlq_hdr_t *keyQ);
 
 
extern ncx_sm_mpid_t *
    sm_get_first_mpid (ncx_sm_rootcb_t *rootcb);
 
extern ncx_sm_mpid_t *
    sm_get_next_mpid (ncx_sm_mpid_t *curmpid);
 
 
extern status_t
    sm_activate_mpid (ncx_sm_rootcb_t *rootcb,
                      ncx_sm_mpid_t *mpid);
 
 
 
extern ncx_sm_rootcb_t *
    sm_search_rootcbs (dlq_hdr_t *searchQ,
                       sm_rootcb_searchfn_t searchfn,
                       void *cookie);
 
extern ncx_sm_rootcb_t *
    sm_save_rootcb (obj_template_t *obj,
                    const xmlChar *label);
 
 
extern ncx_sm_rootcb_t *
    sm_find_rootcb (const xmlChar *label,
                    const xmlChar *modname);
 
 
extern void
    sm_free_rootcb (ncx_sm_rootcb_t *rootcb);
 
 
extern ncx_module_t *
    sm_get_first_module (ncx_sm_rootcb_t *rootcb);
 
 
extern ncx_module_t *
    sm_get_last_module (ncx_sm_rootcb_t *rootcb);
 
 
/*
* @brief Get the specific Mount Point Label
*
* @param mod module that is inside this Mount Point
*/
extern const xmlChar *
    sm_get_current_mp_label (ncx_module_t *mod);
 
 
extern void
    sm_clear_all_rootcbs (dlq_hdr_t *saveQ);
 
 
extern ncx_sm_mpid_t *
    sm_val_to_mpid (val_value_t *mpidval,
                    boolean preserve,
                    status_t *res);
 
 
extern val_value_t *
    sm_mpid_to_val (ncx_sm_mpid_t *mpid,
                    obj_template_t *mpidobj,
                    boolean preserve,
                    status_t *res);
 
 
extern val_value_t *
    sm_get_first_anckey (const ncx_sm_mpid_t *mpid);
 
 
 
extern val_value_t *
    sm_get_next_anckey (const val_value_t *curkey);
 
 
 
extern ncx_sm_rootcb_t *
    sm_get_rootcb_for_mpid (ncx_sm_mpid_t *mpid);
 
 
extern uint32
    sm_mod_revision_count (xml_msg_hdr_t *msg,
                           ncx_sm_rootcb_t *rootcb,
                           const xmlChar *modname);
 
 
 
extern uint32
    sm_mod_revision_count_allroots (xml_msg_hdr_t *msg,
                                    const xmlChar *modname);
 
 
extern status_t
    sm_setup_yanglib (ncx_sm_rootcb_t *rootcb);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_sm */
 
#else
 
#define sm_dump_rootcb(R)
 
#define sm_show_rootcb(R)
 
#define sm_dump_all_rootcb()
 
#define sm_find_module(A,B,C) NULL
 
#define sm_find_deviation(A,B,C) NULL
 
#define sm_find_module_allroots(A,B,C) NULL
 
#define sm_find_any_object(A,B) NULL
 
#define sm_first_mounted_obj(R,B) NULL
 
#define sm_next_mounted_obj(C,B) NULL
 
#define sm_last_mounted_obj(C,B) NULL
 
#define sm_prev_mounted_obj(C,B) NULL
 
#define sm_setup_cur_rootcb(P)
 
#define sm_free_mpid(A)
 
#define sm_dump_mpid(M)
 
#define sm_clone_mpid(M,V) NULL
 
#define sm_get_mpid_from_msg(M) NULL
 
#define sm_get_mpi_valroot(P) NULL
 
#define sm_get_ancestor_mpid(P) NULL
 
#define sm_clear_all_rootcbs(P)
 
#define sm_get_first_module(R) NULL
 
#define sm_get_rootcb_for_mpid(P) NULL
 
#define sm_setup_yanglib(R) ERR_NCX_OPERATION_NOT_SUPPORTED
 
#define sm_get_first_anckey(M) NULL
 
#define sm_get_next_anckey(M) NULL
 
#endif  // WITH_SCHEMA_MOUNT