104 lines
4.7 KiB
C
104 lines
4.7 KiB
C
/*
|
|
*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2009-2019 Olof Hagsand
|
|
Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)
|
|
|
|
This file is part of CLIXON.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
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.
|
|
|
|
Alternatively, the contents of this file may be used under the terms of
|
|
the GNU General Public License Version 3 or later (the "GPL"),
|
|
in which case the provisions of the GPL are applicable instead
|
|
of those above. If you wish to allow use of your version of this file only
|
|
under the terms of the GPL, and not to allow others to
|
|
use your version of this file under the terms of Apache License version 2,
|
|
indicate your decision by deleting the provisions above and replace them with
|
|
the notice and other provisions required by the GPL. If you do not delete
|
|
the provisions above, a recipient may use your version of this file under
|
|
the terms of any one of the Apache License version 2 or the GPL.
|
|
|
|
***** END LICENSE BLOCK *****
|
|
|
|
* Clixon Datastore (XMLDB)
|
|
* Saves Clixon data as clear-text XML (or JSON)
|
|
*/
|
|
#ifndef _CLIXON_DATASTORE_H
|
|
#define _CLIXON_DATASTORE_H
|
|
|
|
/*
|
|
* Types
|
|
*/
|
|
/* Struct per database in hash
|
|
* Semantics of de_modified is to implement this from RFC 6241 Sec 7.5:
|
|
* The target configuration is <candidate>, it has already been
|
|
* modified, and these changes have not been committed or rolled back.
|
|
*/
|
|
struct db_elmnt {
|
|
uint32_t de_id; /* If set, locked by this client/session id */
|
|
struct timeval de_tv; /* Timevalue, set by lock/unlock */
|
|
cxobj *de_xml; /* cache */
|
|
int de_modified; /* Dirty since loaded/copied/committed/etc
|
|
* For NETCONF lock. Set by edit-config, copy, delete,
|
|
* reset by commit, discard
|
|
*/
|
|
int de_empty; /* Empty on read from file, xmldb_readfile and xmldb_put sets it */
|
|
int de_volatile; /* Do not sync to disk on every update (ie xmldb_put) */
|
|
};
|
|
typedef struct db_elmnt db_elmnt;
|
|
|
|
/*
|
|
* Prototypes
|
|
*/
|
|
|
|
db_elmnt *clicon_db_elmnt_get(clixon_handle h, const char *db);
|
|
int clicon_db_elmnt_set(clixon_handle h, const char *db, db_elmnt *xc);
|
|
int xmldb_db2file(clixon_handle h, const char *db, char **filename);
|
|
|
|
/* API */
|
|
int xmldb_connect(clixon_handle h);
|
|
int xmldb_disconnect(clixon_handle h);
|
|
/* in clixon_datastore_read.[ch] */
|
|
int xmldb_get(clixon_handle h, const char *db, cvec *nsc, char *xpath, cxobj **xret);
|
|
int xmldb_get0(clixon_handle h, const char *db, yang_bind yb,
|
|
cvec *nsc, const char *xpath, int copy, withdefaults_type wdef,
|
|
cxobj **xret, modstate_diff_t *msd, cxobj **xerr);
|
|
int xmldb_put(clixon_handle h, const char *db, enum operation_type op, cxobj *xt, char *username, cbuf *cbret); /* in clixon_datastore_write.[ch] */
|
|
int xmldb_copy(clixon_handle h, const char *from, const char *to);
|
|
int xmldb_lock(clixon_handle h, const char *db, uint32_t id);
|
|
int xmldb_unlock(clixon_handle h, const char *db);
|
|
int xmldb_unlock_all(clixon_handle h, uint32_t id);
|
|
uint32_t xmldb_islocked(clixon_handle h, const char *db);
|
|
int xmldb_lock_timestamp(clixon_handle h, const char *db, struct timeval *tv);
|
|
int xmldb_exists(clixon_handle h, const char *db);
|
|
int xmldb_clear(clixon_handle h, const char *db);
|
|
int xmldb_delete(clixon_handle h, const char *db);
|
|
int xmldb_create(clixon_handle h, const char *db);
|
|
/* utility functions */
|
|
int xmldb_db_reset(clixon_handle h, const char *db);
|
|
cxobj *xmldb_cache_get(clixon_handle h, const char *db);
|
|
int xmldb_modified_get(clixon_handle h, const char *db);
|
|
int xmldb_modified_set(clixon_handle h, const char *db, int value);
|
|
int xmldb_empty_get(clixon_handle h, const char *db);
|
|
int xmldb_empty_set(clixon_handle h, const char *db, int value);
|
|
int xmldb_volatile_get(clixon_handle h, const char *db);
|
|
int xmldb_volatile_set(clixon_handle h, const char *db, int value);
|
|
int xmldb_print(clixon_handle h, FILE *f);
|
|
int xmldb_rename(clixon_handle h, const char *db, const char *newdb, const char *suffix);
|
|
int xmldb_populate(clixon_handle h, const char *db);
|
|
int xmldb_write_cache2file(clixon_handle h, const char *db);
|
|
int xmldb_dump(clixon_handle h, FILE *f, cxobj *xt, withdefaults_type wdef);
|
|
|
|
#endif /* _CLIXON_DATASTORE_H */
|