yang_db_runtime.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Texas Instruments Incorporated
 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
 *
 * All rights reserved not granted herein.
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free,
 * non-exclusive license under copyrights and patents it now or hereafter
 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
 * this software subject to the terms herein. With respect to the foregoing patent
 * license, such license is granted solely to the extent that any such patent is necessary
 * to Utilize the software alone. The patent license shall not apply to any combinations which
 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license (including the
 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
 * in the documentation and/or other materials provided with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided that the following
 * conditions are met:
 *
 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
 * software provided in binary form.
 * * any redistribution and use are licensed by TI for use only with TI Devices.
 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the source code are permitted
 * provided that the following conditions are met:
 *
 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
 * TI for use only with TI Devices.
 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TI AND TI"S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef YANG_DB_RUNTIME_H_
#define YANG_DB_RUNTIME_H_
 
#include "../uc_dbal.h"
#include "../hal/uc_hwal.h"
#include "../uc_notice.h"
#include "yang_db_access.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define YANG_DB_LINE_BUF_SIZE 512u
 
typedef struct yang_db_runtime_data yang_db_runtime_dataq_t;
 
yang_db_runtime_dataq_t *yang_db_runtime_init(uc_dbald *dbald, uc_hwald *hwald);
 
void yang_db_runtime_close(yang_db_runtime_dataq_t *ydrd);
 
void yang_db_runtime_set_hwadl(yang_db_runtime_dataq_t *ydrd, uc_hwald *hwald);
 
 
int yang_db_runtime_readfile(yang_db_runtime_dataq_t *ydrd, const char* fname);
 
int yang_db_runtime_read_conffile(uc_dbald *dbald, const char* fname);
 
int yang_db_runtime_get_vtype(uc_dbald *dbald, uint8_t *aps);
 
int yang_db_runtime_put_oneline(yang_db_runtime_dataq_t *ydrd,
                char *kstr, char *vstr, uint8_t onhw);
 
int yang_db_runtime_askaction(yang_db_runtime_dataq_t *ydrd,
                  uc_notice_data_t *ucntd);
 
 
uc_range *yang_db_runtime_range_fromline(yang_db_runtime_dataq_t *ydrd,
                     const char* line, void **kvs, uint8_t *kss,
                     bool status);
 
int yang_db_runtime_get_oneline(yang_db_runtime_dataq_t *ydrd,
                const char* line, void **value, uint32_t *vsize);
 
/*
 * 'uc_nc_notice_register' is called by creating key from 'line'
 * 'semname' must be a unique name.
 */
int yang_db_runtime_notice_register(yang_db_runtime_dataq_t *ydrd, uc_notice_data_t *ucntd,
                    const char* line, char *semname, UC_NOTICE_SIG_T **sem);
 
uint8_t yang_db_runtime_getvknum(uc_dbald *dbald, uint8_t *aps);
 
int yang_db_runtime_getvkvtype(uc_dbald *dbald, uint8_t *aps, uint8_t vkindex,
                   uint8_t *vkey, uint8_t *vtype);
 
int yang_db_runtime_getvkstr(uc_dbald *dbald,
                 uint8_t *aps, uint8_t vkindex, char **rstr);
 
int yang_db_runtime_waititem(yang_db_runtime_dataq_t *ydrd, const char* witem,
                 void *waitv, uint32_t wvsize, int tout_ms);
 
int yang_db_runtime_apkv2keyvkstr(uc_dbald *dbald, uint8_t *aps,
                  kvs_t *kvs, uint8_t *kss, char **rstr);
int yang_db_runtime_getkeyvkstr(uc_dbald *dbald,
                void *key, uint32_t ksize, char **rstr);
 
int yang_db_runtime_proc_nodestring(yang_db_runtime_dataq_t *ydrd, bool reset,
                    char *kstr, char *vstr);
 
int yang_db_runtime_state_keyvkstr(yang_db_runtime_dataq_t *ydrd, char **rstr);
 
// functions in convxml2conf.c
const char *convxml2conf_getconf(yang_db_runtime_dataq_t *ydrd, const char *ifname,
                 const char *ofname);
 
bool yang_db_runtime_needaction(yang_db_runtime_dataq_t *ydrd);
 
int yang_db_runtime_nodestr2apkv(yang_db_runtime_dataq_t *ydrd,
                    const char* line, uint8_t *aps, void **kvs, uint8_t *kss);
 
void yang_db_runtime_readdb_log(bool consoleprint, uc_dbald *dbald, const char *headmsg,
                uint8_t aps[], void *kvs[], uint8_t kss[]);
 
int yang_db_runtime_iterate_fromline(yang_db_runtime_dataq_t *ydrd, uc_range **range,
                     const char* line, void *kvs[], uint8_t kss[],
                     bool status, void **value,
                     uint32_t *vsize, char **qstr);
 
int yang_db_runtime_cache_fromline(yang_db_runtime_dataq_t *ydrd,
                   const char* line, bool status,
                   char **rvalue, int *rvsize);
 
void yang_db_runtime_cache_fromline_release(char *rvalue);
 
 
#ifdef __cplusplus
}
#endif
 
#endif