ncxmod.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_ncxmod
#define _H_ncxmod
 
/*  FILE: ncxmod.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
10-nov-05    abb      Begun
22-jan-08    abb      Add support for YANG import and include
                      Unlike NCX, forward references are allowed
                      so import/include loops have to be tracked
                      and prevented
16-feb-08   abb       Changed environment variables from NCX to YANG
                      Added YANG_INSTALL envvar as well.
22-jul-08   abb       Remove NCX support -- YANG only from now on
06-oct-09   abb       Change YANG_ env vars to YUMA_
*/
 
#include <xmlstring.h>
 
/* used for timestamps and time deltas */
#include <time.h>
 
#ifndef _H_cap
#include "cap.h"
#endif
 
#ifndef _H_help
#include "help.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_yang
#include "yang.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
/* max user-configurable directories for NCX and YANG modules */
#define NCXMOD_MAX_SEARCHPATH   64
 
/* maximum abolute filespec */
#define NCXMOD_MAX_FSPEC_LEN 2047
 
/* path, file separator char
 * this is used to check file paths not XPath
 * Windows allows foward and backslash so pick forward
 * since that is all Linux and Mac support
 */
#define NCXMOD_PSCHAR   '/'
 
#define NCXMOD_WIN_PSCHAR   '\\'
 
#define NCXMOD_HMCHAR   '~'
 
#define NCXMOD_ENVCHAR '$'
 
#define NCXMOD_DOTCHAR '.'
 
/* name of the NCX module containing agent boot parameters
 * loaded during startup
 */
#define NCXMOD_NETCONFD         (const xmlChar *)"netconfd-pro"
 
#define NCXMOD_NCX              (const xmlChar *)"yuma-ncx"
 
#define NCXMOD_RESTCONF         (const xmlChar *)"ietf-restconf"
 
#define NCXMOD_YANG_DATA_EXT    (const xmlChar *)"yang-data-ext"
 
#define NCXMOD_YANG_STRUCTURE  (const xmlChar *)"ietf-yang-structure-ext"
 
#define NCXMOD_YUMA_NACM        (const xmlChar *)"yuma-nacm"
 
#define NCXMOD_YUMA_TIME_FILTER (const xmlChar *)"yuma-time-filter"
 
#define NCXMOD_YUMAWORKS_ATTRS  (const xmlChar *)"yumaworks-attrs"
 
#define NCXMOD_YUMAWORKS_CERT_USERMAP          \
    (const xmlChar *)"yumaworks-cert-usermap"
 
#define NCXMOD_YUMAWORKS_CONFIG_CHANGE \
    (const xmlChar *)"yumaworks-config-change"
 
#define NCXMOD_YUMAWORKS_EVENT_FILTER           \
    (const xmlChar *)"yumaworks-event-filter"
 
#define NCXMOD_YUMAWORKS_EVENT_STREAM           \
    (const xmlChar *)"yumaworks-event-stream"
 
#define NCXMOD_YUMAWORKS_GETBULK (const xmlChar *)"yumaworks-getbulk"
 
#define NCXMOD_YUMAWORKS_IDS (const xmlChar *)"yumaworks-ids"
 
#define NCXMOD_YUMAWORKS_INTERNAL (const xmlChar *)"yumaworks-internal"
 
#define NCXMOD_YUMAWORKS_SERVER (const xmlChar *)"yumaworks-server"
 
#define NCXMOD_YUMAWORKS_SYSTEM (const xmlChar *)"yumaworks-system"
 
#define NCXMOD_YUMAWORKS_TYPES (const xmlChar *)"yumaworks-types"
 
#define NCXMOD_YUMAWORKS_APP_COMMON (const xmlChar *)"yumaworks-app-common"
 
#define NCXMOD_YUMA_APP_COMMON (const xmlChar *)"yuma-app-common"
 
#define NCXMOD_YUMA_TYPES (const xmlChar *)"yuma-types"
 
#define NCXMOD_YANGCLI          (const xmlChar *)"yangcli-pro"
 
#define NCXMOD_YANG_API         (const xmlChar *)"yumaworks-yang-api"
 
#define NCXMOD_YUMAWORKS_GRPC_STATE           \
    (const xmlChar *)"yumaworks-grpc-mon"
 
#define NCXMOD_YUMA_RESTCONF    (const xmlChar *)"yumaworks-restconf"
 
#define NCXMOD_YUMA_IDS         (const xmlChar *)"yumaworks-ids"
 
#define NCXMOD_YUMA_SUPPORT_SAVE (const xmlChar *)"yumaworks-support-save"
 
#define NCXMOD_YUMA_TERM_MSG   (const xmlChar *)"yumaworks-term-msg"
 
/* name of the NETCONF module containing NETCONF protocol definitions,
 * that is loaded by default during startup
 */
#define NCXMOD_NETCONF          (const xmlChar *)"yuma-netconf"
 
#define NCXMOD_YUMA_NETCONF     (const xmlChar *)"yuma-netconf"
 
#define NCXMOD_IETF_INTERFACES  (const xmlChar *)"ietf-interfaces"
 
#define NCXMOD_IETF_NETCONF     (const xmlChar *)"ietf-netconf"
 
#define NCXMOD_IETF_NETCONF_REV (const xmlChar *)"2011-06-01"
 
#define NCXMOD_IETF_YANG_PATCH  (const xmlChar *)"ietf-yang-patch"
 
#define NCXMOD_IETF_YANG_TYPES  (const xmlChar *)"ietf-yang-types"
 
#define NCXMOD_IETF_INET_TYPES  (const xmlChar *)"ietf-inet-types"
 
#define NCXMOD_IETF_NETCONF_STATE (const xmlChar *)"ietf-netconf-monitoring"
 
#define NCXMOD_IETF_NACM        (const xmlChar *)"ietf-netconf-acm"
 
#define NCXMOD_IETF_SID_FILE    (const xmlChar *)"ietf-sid-file"
 
#define NCXMOD_WITH_DEFAULTS    (const xmlChar *)"ietf-netconf-with-defaults"
 
#define NCXMOD_YUMAWORKS_EXTENSIONS (const xmlChar *)"yumaworks-extensions"
 
#define NCXMOD_YUMAWORKS_YANG_CBOR (const xmlChar *)"yumaworks-yang-cbor"
 
#define NCXMOD_FHS_RUNDIR       (const xmlChar *)"/var/run/netconfd-pro"
 
#define NCXMOD_FHS_LIBDIR       (const xmlChar *)"/var/lib/netconfd-pro"
 
#define NCXMOD_FHS_LOGDIR       (const xmlChar *)"/var/log/netconfd-pro"
 
#define NCXMOD_FHS_LOGSPEC \
    (const xmlChar *)"/var/log/netconfd-pro/server.log"
 
#define NCXMOD_FHS_AUDIT_LOGSPEC \
    (const xmlChar *)"/var/log/netconfd-pro/audit.log"
 
#define NCXMOD_SRID_FHS_LOGSPEC \
    (const xmlChar *)"/var/log/netconfd-pro/server.%s.log"
 
#define NCXMOD_SRID_FHS_AUDIT_LOGSPEC \
    (const xmlChar *)"/var/log/netconfd-pro/audit.%s.log"
 
 
#define NCXMOD_NETCONF_NOTIFICATIONS \
    (const xmlChar *)"ietf-netconf-notifications"
 
#define NCXMOD_PARTIAL_LOCK (const xmlChar *)"ietf-netconf-partial-lock"
 
#define NCXMOD_CRYPT_HASH   (const xmlChar *)"iana-crypt-hash"
 
/* name of the RESTCONF modules, that is loaded during startup
 * if WITH_RESTCONF flag is present
 */
#define NCXMOD_YANG_LIBRARY   (const xmlChar *)"ietf-yang-library"
#define NCXMOD_RESTMON        (const xmlChar *)"ietf-restconf-monitoring"
 
/* IETF NMDA modules */
#define NCXMOD_IETF_DATASTORES  (const xmlChar *)"ietf-datastores"
#define NCXMOD_IETF_ORIGIN   (const xmlChar *)"ietf-origin"
#define NCXMOD_IETF_NETCONF_NMDA (const xmlChar *)"ietf-netconf-nmda"
 
/* IETF Schema Mount modules */
#define NCXMOD_IETF_SM_MODULE       (const xmlChar *)"ietf-yang-schema-mount"
 
/* YumaWorks annotation to ietf-yang-schema-mount */
#define NCXMOD_IETF_SM_MODULE_ANNOT \
    (const xmlChar *)"yumaworks-schema-mount-annot"
 
/* hooks-test modules is loaded during startup
 * if WITH_HOKS_TEST flag is present
 */
#define NCXMOD_HOOKS_TEST     (const xmlChar *)"hooks-test"
 
#define NCXMOD_YUMA_SYSTEM    (const xmlChar *)"yuma-system"
 
/* Openconfig extensions module containing OpenConfig extension definitions
 * "oc-ext:openconfig-version" that is mandadory filed in gNMI
 * capability-request
 */
#define NCXMOD_OC_EXT    (const xmlChar *)"openconfig-extensions"
 
/* name of the NCX modules directory appended when YUMAPRO_HOME or HOME
 * ENV vars used to construct NCX module filespec
 */
#define NCXMOD_DIR            (const xmlChar *)"modules"
 
/* name of the data direectory when YUMAPRO_HOME or HOME
 * ENV vars used to construct an NCX filespec
 */
#define NCXMOD_DATA_DIR       (const xmlChar *)"data"
 
/* name of the scripts directory when YUMAPRO_HOME or HOME
 * ENV vars used to construct a NCX filespec
 */
#define NCXMOD_SCRIPT_DIR     (const xmlChar *)"scripts"
 
/* name of the test-suites directory */
#define NCXMOD_TEST_SUITE_DIR (const xmlChar *)"test-suites"
 
/* STD Environment Variable for user home directory */
#define NCXMOD_PWD          "PWD"
 
/* STD Environment Variable for user home directory */
#define USER_HOME           "HOME"
 
/* NCX Environment Variable for YANG/NCX user work home directory */
#define NCXMOD_HOME         "YUMAPRO_HOME"
 
/* NCX Environment Variable for tools install directory
 * The default is /usr/share/yuma
 */
#define NCXMOD_INSTALL   "YUMAPRO_INSTALL"
 
/* !! should import this from make !! */
#if defined(FREEBSD) || defined(MACOSX)
#define NCXMOD_DEFAULT_INSTALL (const xmlChar *)"/usr/local/share/yumapro"
#else
#define NCXMOD_DEFAULT_INSTALL (const xmlChar *)"/usr/share/yumapro"
#endif
 
/* !! should import this from make !! */
#define NCXMOD_DEFAULT_YUMALIB64 (const xmlChar *)"/usr/lib64/yumapro"
 
#ifdef MACOSX
#define NCXMOD_DEFAULT_YUMALIB (const xmlChar *)"/usr/local/lib/yumapro"
#else
#define NCXMOD_DEFAULT_YUMALIB (const xmlChar *)"/usr/lib/yumapro"
#endif
 
 
/* !! should import this from make !! */
#define NCXMOD_ETC_DATA (const xmlChar *)"/etc/yumapro"
 
/* NCX Environment Variable for MODULE search path */
#define NCXMOD_MODPATH      "YUMAPRO_MODPATH"
 
/* NCX Environment Variable for DATA search path */
#define NCXMOD_DATAPATH      "YUMAPRO_DATAPATH"
 
/* NCX Environment Variable for SCRIPTS search path */
#define NCXMOD_RUNPATH      "YUMAPRO_RUNPATH"
 
/* NCX Environment Variable for MODULE load path */
#define NCXMOD_LOADPATH      "YUMAPRO_LOADPATH"
 
/* per user yangcli internal data home when $HOME defined */
#define NCXMOD_YUMA_DIR (const xmlChar *)"~/.yumapro"
 
/* per user yangcli internal data home when $HOME not defined */
#define NCXMOD_TEMP_YUMA_DIR (const xmlChar *)"/tmp/yumapro"
 
/* Yuma work directory name */
#define NCXMOD_YUMA_DIRNAME    (const xmlChar *)".yumapro"
 
/* sub-directory name yangcli uses to store local per-session workdirs
 * appended to ncxmod_yumadir_path
 */
#define NCXMOD_TEMP_DIR (const xmlChar *)"/tmp"
 
/* directory uses to store rpydata per step of recorded test
 */
#define NCXMOD_UT_RECORDTEST_DIR (const xmlChar *)"/recordtest"
 
/* directory uses to store cache schemas.
 */
#define NCXMOD_YANGCLI_CACHE_DIR (const xmlChar *)"/.yangcli_cache"
 
 
#define NCXMOD_GET_SOURCE_NEEDED(s) \
    (*(s) == (xmlChar)'~' || *(s) == (xmlChar)'.' || *(s) == (xmlChar)'$')
 
#define NCXMOD_SEARCH_MODULE(R) (R)->module
 
#define NCXMOD_SEARCH_REVISION(R) (R)->revision
 
#define NCXMOD_SEARCH_SOURCE(R) (R)->source
 
#define NCXMOD_SEARCH_NAMESPACE(R) (R)->namespacestr
 
/* ncxmod_search_result_t flags */
#define NCXMOD_FL_CAPMATCH  bit0
#define NCXMOD_FL_ISMOD     bit1
#define NCXMOD_FL_BEST      bit2
 
#define NCXMOD_SET_CAPMATCH(R) (R)->flags |= NCXMOD_FL_CAPMATCH
#define NCXMOD_CLR_CAPMATCH(R) (R)->flags &= ~NCXMOD_FL_CAPMATCH
#define NCXMOD_IS_CAPMATCH(R)  ((R)->flags & NCXMOD_FL_CAPMATCH)
 
#define NCXMOD_SET_ISMOD(R)    (R)->flags |= NCXMOD_FL_ISMOD
#define NCXMOD_IS_ISMOD(R)     ((R)->flags & NCXMOD_FL_ISMOD)
 
#define NCXMOD_SET_BEST(R)     (R)->flags |= NCXMOD_FL_BEST
#define NCXMOD_IS_BEST(R)      ((R)->flags & NCXMOD_FL_BEST)
 
/********************************************************************
*                                                                   *
*                         T Y P E S                                 *
*                                                                   *
*********************************************************************/
 
/* following 3 structs used for providing temporary
 * work directories for yangcli sessions
 */
 
typedef struct ncxmod_temp_progcb_t_ {
    dlq_hdr_t    qhdr;         
    xmlChar     *source;       
    dlq_hdr_t    temp_sescbQ;  
} ncxmod_temp_progcb_t;
 
 
typedef struct ncxmod_temp_sescb_t_ {
    dlq_hdr_t    qhdr;         
    xmlChar     *source;       
    uint32       sidnum;       
    dlq_hdr_t    temp_filcbQ;  
} ncxmod_temp_sescb_t;
 
 
typedef struct ncxmod_temp_filcb_t_ {
    dlq_hdr_t       qhdr;      
    xmlChar        *source;    
    const xmlChar  *filename;  
} ncxmod_temp_filcb_t;
 
 
typedef struct ncxmod_search_result_t_ {
    dlq_hdr_t      qhdr;          
    xmlChar       *module;        
    xmlChar       *belongsto;     
    xmlChar       *revision;      
    xmlChar       *namespacestr;  
    xmlChar       *source;        
    ncx_module_t  *mod;           
    status_t       res;           
    uint32         nslen;         
    cap_rec_t     *cap;           
    uint8          flags;         
} ncxmod_search_result_t;
 
 
typedef status_t (*ncxmod_callback_fn_t) (const char *fullspec,
                                          void *cookie);
 
 
 
typedef status_t (*ncxmod_backup_cbfn_t) (const char *fullspec,
                                          const xmlChar *mtime,
                                          void *cookie);
 
 
typedef status_t
    (*ncxmod_conf_cbfn_t) (const xmlChar *fullspec,
                           void *cookie);
 
 
 
typedef void (*search_dumpfn_t) (log_debug_t level, const char *fstr, ...);
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    ncxmod_init (void);
 
 
extern void
    ncxmod_log_env (void);
 
 
extern void
    ncxmod_cleanup (void);
 
 
extern status_t
    ncxmod_load_module (const xmlChar *modname,
                        const xmlChar *revision,
                        dlq_hdr_t *savedevQ,
                        ncx_module_t **retmod);
 
 
extern status_t
    ncxmod_load_module_loadpath (const xmlChar *modname,
                                 const xmlChar *revision,
                                 dlq_hdr_t *savedevQ,
                                 boolean is_loadpath,
                                 ncx_module_t **retmod);
 
 
extern status_t
    ncxmod_autoload_module (const xmlChar *modname,
                            const xmlChar *revision,
                            dlq_hdr_t *savedevQ,
                            dlq_hdr_t *savemodQ,
                            dlq_hdr_t *topfailedQ,
                            ncx_module_t **retmod);
 
 
extern ncxmod_search_result_t *
    ncxmod_find_module (const xmlChar *modname,
                        const xmlChar *revision);
 
 
extern status_t
    ncxmod_find_all_modules (dlq_hdr_t *resultQ);
 
 
extern status_t
   ncxmod_find_all_modules_ycli_cache (dlq_hdr_t *resultQ);
 
 
 
extern status_t
    ncxmod_load_deviation (const xmlChar *deviname,
                           dlq_hdr_t *deviationQ);
 
 
extern status_t
    ncxmod_load_annotation (const xmlChar *deviname,
                            dlq_hdr_t *deviationQ);
 
 
extern status_t
    ncxmod_load_imodule (const xmlChar *modname,
                         const xmlChar *revision,
                         yang_pcb_t *pcb,
                         yang_parsetype_t ptyp,
                         ncx_module_t *parent,
                         ncx_module_t **retmod);
 
 
extern yang_pcb_t *
    ncxmod_load_module_ex (const xmlChar *modname,
                           const xmlChar *revision,
                           boolean with_submods,
                           boolean savetkc,
                           boolean keepmode,
                           boolean docmode,
                           dlq_hdr_t *savedevQ,
                           status_t  *res);
 
 
extern yang_pcb_t *
    ncxmod_load_module_diff (const xmlChar *modname,
                             const xmlChar *revision,
                             boolean with_submods,
                             const xmlChar *modpath,
                             dlq_hdr_t  *savedevQ,
                             status_t  *res);
 
 
extern xmlChar *
    ncxmod_find_data_file (const xmlChar *fname,
                           boolean generrors,
                           boolean backup_file,
                           status_t *res);
 
 
extern xmlChar *
    ncxmod_find_server_data_file (const xmlChar *fname,
                                  boolean fileloc_fhs,
                                  boolean generrors,
                                  boolean backup_file,
                                  boolean keep_result,
                                  status_t *res);
 
 
 
extern xmlChar *
    ncxmod_find_sil_file (const xmlChar *fname,
                          boolean generrors,
                          status_t *res);
 
 
extern xmlChar *
    ncxmod_make_data_filespec (const xmlChar *fname,
                               boolean backup_file,
                               status_t *res);
 
 
 
extern xmlChar *
    ncxmod_make_server_data_filespec (const xmlChar *fname,
                                      boolean fileloc_fhs,
                                      boolean backup_file,
                                      status_t *res);
 
 
extern xmlChar *
    ncxmod_make_data_filespec_from_src (const xmlChar *srcspec,
                                        const xmlChar *fname,
                                        status_t *res);
 
 
extern xmlChar *
    ncxmod_find_script_file (const xmlChar *fname,
                             status_t *res);
 
 
extern xmlChar *
    ncxmod_find_test_suite_file (const xmlChar *fname,
                                 status_t *res);
 
 
extern status_t
    ncxmod_set_home (const xmlChar *home);
 
 
extern const xmlChar *
    ncxmod_get_home (void);
 
 
extern status_t
    ncxmod_set_yuma_home (const xmlChar *yumahome);
 
 
extern const xmlChar *
    ncxmod_get_yuma_home (void);
 
 
extern const xmlChar *
    ncxmod_get_yuma_install (void);
 
 
extern void
    ncxmod_set_modpath (const xmlChar *modpath);
 
 
extern void
    ncxmod_set_loadpath (const xmlChar *loadpath);
 
 
extern void
    ncxmod_set_datapath (const xmlChar *datapath);
 
 
extern void
    ncxmod_set_runpath (const xmlChar *runpath);
 
 
extern void
    ncxmod_set_subdirs (boolean usesubdirs);
 
 
extern const xmlChar *
    ncxmod_get_yumadir (void);
 
 
extern status_t
    ncxmod_process_subtree (const char *startspec,
                            ncxmod_callback_fn_t callback,
                            void *cookie);
 
 
extern boolean
    ncxmod_test_subdir (const xmlChar *dirspec);
 
 
extern const xmlChar *
    ncxmod_get_userhome (const xmlChar *user,
                         uint32 userlen);
 
 
extern const xmlChar *
    ncxmod_get_envvar (const xmlChar *name,
                       uint32 namelen);
 
 
extern void
    ncxmod_set_altpath (const xmlChar *altpath);
 
 
extern void
    ncxmod_clear_altpath (void);
 
 
extern status_t
    ncxmod_list_data_files (help_mode_t helpmode,
                            boolean logstdout);
 
 
extern status_t
    ncxmod_list_script_files (help_mode_t helpmode,
                              boolean logstdout);
 
 
extern status_t
    ncxmod_list_yang_files (help_mode_t helpmode,
                            boolean logstdout);
 
 
extern status_t
    ncxmod_setup_yumadir (void);
 
 
extern status_t
    ncxmod_setup_yumadir_srid (const xmlChar *srid);
 
 
extern status_t
    ncxmod_setup_backup_dir (const xmlChar *backup_dir);
 
 
extern status_t
    ncxmod_setup_fhs_dirs (void);
 
 
extern status_t
    ncxmod_setup_fhs_srid_dirs (const xmlChar *server_root);
 
 
extern status_t
    ncxmod_setup_tempdir (void);
 
 
extern status_t
    ncxmod_setup_yumadir_force (const xmlChar *path);
 
 
status_t
   ncxmod_setup_recordtest_dir (void);
 
 
status_t
   ncxmod_setup_yangcli_cache_dir (const xmlChar *cache_dir);
 
 
extern ncxmod_temp_progcb_t *
    ncxmod_new_program_tempdir (status_t *res);
 
 
extern void
    ncxmod_free_program_tempdir (ncxmod_temp_progcb_t *progcb);
 
 
extern ncxmod_temp_sescb_t *
    ncxmod_new_session_tempdir (ncxmod_temp_progcb_t *progcb,
                                uint32 sidnum,
                                status_t *res);
 
 
extern void
    ncxmod_free_session_tempdir (ncxmod_temp_progcb_t *progcb,
                                 uint32 sidnum);
 
 
extern ncxmod_temp_filcb_t *
    ncxmod_new_session_tempfile (ncxmod_temp_sescb_t *sescb,
                                 const xmlChar *filename,
                                 status_t *res);
 
 
extern void
    ncxmod_free_session_tempfile (ncxmod_temp_filcb_t *filcb);
 
 
extern ncxmod_search_result_t *
    ncxmod_new_search_result (void);
 
 
extern ncxmod_search_result_t *
    ncxmod_new_search_result_ex (const ncx_module_t *mod);
 
 
extern ncxmod_search_result_t *
    ncxmod_new_search_result_str (const xmlChar *modname,
                                  const xmlChar *revision);
 
 
extern void
    ncxmod_free_search_result (ncxmod_search_result_t *searchresult);
 
 
 
extern void
    ncxmod_clean_search_result_queue (dlq_hdr_t *searchQ);
 
 
extern ncxmod_search_result_t *
    ncxmod_find_search_result (dlq_hdr_t *searchQ,
                               const xmlChar *modname,
                               const xmlChar *revision,
                               const xmlChar *nsuri);
 
 
extern ncxmod_search_result_t *
    ncxmod_clone_search_result (const ncxmod_search_result_t *sr);
 
 
extern boolean
    ncxmod_test_filespec (const xmlChar *filespec);
 
 
extern uint32
    ncxmod_get_pathlen_from_filespec (const xmlChar *filespec);
 
 
extern status_t
    ncxmod_get_file_mtime (const xmlChar *filespec,
                           time_t *timebuff);
 
 
extern status_t
    ncxmod_get_backup_files (ncxmod_backup_cbfn_t cbfn,
                             void *cookie);
 
 
extern xmlChar *
    ncxmod_get_pid_filespec (const xmlChar *progname,
                             boolean fileloc_fhs,
                             status_t *res);
 
 
extern xmlChar *
    ncxmod_get_subdir_filespec (const xmlChar *subdir,
                                boolean fileloc_fhs,
                                status_t *res);
 
 
extern status_t
    ncxmod_read_num_file (const xmlChar *numfile,
                          uint64 *curnum,
                          boolean file_error);
 
 
extern status_t
    ncxmod_write_num_file (const xmlChar *numfile,
                           uint64 curnum);
 
 
extern status_t
    ncxmod_copy_text_file (const xmlChar *src_filespec,
                           const xmlChar *dest_filespec);
 
 
 
extern status_t
    ncxmod_subsys_info_write (const xmlChar *filespec,
                              const xmlChar *ipaddr,
                              uint16 portnum);
 
 
extern void
    ncxmod_subsys_info_remove (const xmlChar *filespec);
 
 
extern status_t
    ncxmod_get_conf_files (const xmlChar *confdir,
                           boolean must_exist,
                           ncxmod_conf_cbfn_t cbfn,
                           void *cookie);
 
 
extern status_t
    ncxmod_set_bestmatch_modules (void);
 
 
extern status_t
    ncxmod_scan_loadpath (ncxmod_callback_fn_t cbfn,
                          void *cookie);
 
 
extern status_t
    ncxmod_scan_loadpath_sm (ncxmod_callback_fn_t cbfn,
                             xmlChar *load_path,
                             void *cookie);
 
 
extern boolean
    ncxmod_use_bestmatch_now (const xmlChar *revision);
 
 
extern void
    ncxmod_dump_module_search_path (search_dumpfn_t dumpfn,
                                    log_debug_t loglevel);
 
 
#ifdef WINDOWS
#define ncxmod_is_pschar(ch) \
    (((ch) == NCXMOD_PSCHAR) || ((ch) == NCXMOD_WIN_PSCHAR))
#else
#define ncxmod_is_pschar(ch) ((ch) == NCXMOD_PSCHAR)
#endif
 
 
extern const xmlChar *
    ncxmod_get_modpath (void);
 
 
extern const xmlChar *
    ncxmod_get_datapath (void);
 
 
extern const xmlChar *
    ncxmod_get_runpath (void);
 
 
extern xmlChar *
    ncxmod_find_sid_file (const xmlChar *fname,
                          boolean generrors,
                          status_t *res);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ncxmod */