/usr/include/yuma/agt/agt_val.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, 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_agt_val
#define _H_agt_val
/* FILE: agt_val.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Server database callback handler
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
20-may-06 abb Begun
30-sep-08 abb Implement AGT_CB_TEST_APPLY and
agt_val_split_root_test for YANG support of
dummy running config commit-time validation
*/
#ifndef _H_agt
#include "agt.h"
#endif
#ifndef _H_agt_cfg
#include "agt_cfg.h"
#endif
#ifndef _H_cfg
#include "cfg.h"
#endif
#ifndef _H_ncxtypes
#include "ncxtypes.h.h"
#endif
#ifndef _H_op
#include "op.h"
#endif
#ifndef _H_rpc
#include "rpc.h"
#endif
#ifndef _H_ses
#include "ses.h"
#endif
#ifndef _H_status
#include "status.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/* General val_value_t processing
*
* step 1: call agt_val_parse_nc
* step 2: call val_add_defaults
* step 3: call agt_val_rpc_xpath_check
* step 4: call agt_val_instance_check
*
* Additional steps to write to a config database
*
* step 4: call agt_val_validate_write
* step 5: call agt_val_apply_write
*
* Steps to test for commit-ready
*
* step 6a: agt_val_root_check (candidate)
* step 6b: agt_val_split_root_check (running)
* step 7: agt_val_apply_commit
*/
/********************************************************************
* FUNCTION agt_val_rpc_xpath_check
*
* Check for any nodes which are present
* but have false when-stmts associated
* with the node. These are errors and
* need to be flagged as unknown-element
*
* Any false nodes will be removed from the input PDU
* and discarded, after the error is recorded.
* This prevents false positives or negatives in
* the agt_val_instance_check, called after this function
*
* Also checks any false must-stmts for nodes
* which are present (after false when removal)
* These are flagged as 'must-violation' errors
* as per YANG, 13.4
*
* INPUTS:
* scb == session control block (may be NULL; no session stats)
* rpcmsg == RPC msg header for audit purposes
* msg == xml_msg_hdr t from msg in progress
* == NULL MEANS NO RPC-ERRORS ARE RECORDED
* rpcinput == RPC input node conceptually under rpcroot
* except this rpcinput has no parent node
* so a fake one will be termporarily added
* to prevent false XPath validation errors
* rpcroot == RPC method node.
* The conceptual parent of this node
* is used as the document root (/rpc == /)
*
* OUTPUTS:
* if false nodes found under :
* they are deleted
* if msg not NULL:
* msg->msg_errQ may have rpc_err_rec_t structs added to it
* which must be freed by the called with the
* rpc_err_free_record function
*
* RETURNS:
* status of the operation
* NO_ERR if no false when or must statements found
*********************************************************************/
extern status_t
agt_val_rpc_xpath_check (ses_cb_t *scb,
rpc_msg_t *rpcmsg,
xml_msg_hdr_t *msg,
val_value_t *rpcinput,
obj_template_t *rpcroot);
/********************************************************************
* FUNCTION agt_val_instance_check
*
* Check for the proper number of object instances for
* the specified value struct.
*
* The top-level value set passed cannot represent a choice
* or a case within a choice.
*
* This function is intended for validating PDUs (RPC requests)
* during the PDU processing. It does not check the instance
* count or must-stmt expressions for any <config> (ncx:root)
* container. This must be done with the agt_val_root_check function.
*
* INPUTS:
* scb == session control block (may be NULL; no session stats)
* msg == xml_msg_hdr t from msg in progress
* == NULL MEANS NO RPC-ERRORS ARE RECORDED
* valset == val_value_t list, leaf-list, or container to check
* valroot == root node of the database
* layer == NCX layer calling this function (for error purposes only)
*
* OUTPUTS:
* if msg not NULL:
* msg->msg_errQ may have rpc_err_rec_t structs added to it
* which must be freed by the called with the
* rpc_err_free_record function
*
* RETURNS:
* status of the operation, NO_ERR if no validation errors found
*********************************************************************/
extern status_t
agt_val_instance_check (ses_cb_t *scb,
xml_msg_hdr_t *msg,
val_value_t *valset,
val_value_t *valroot,
ncx_layer_t layer);
/********************************************************************
* FUNCTION agt_val_root_check
*
* !!! Full database validation !!!
* Check for the proper number of object instances for
* the specified configuration database
* Check must and when statements
* Check empty NP containers
* Check choices (selected case, and it is complete)
*
* Tests are divided into 3 groups:
* A) top-level nodes (child of conceptual <config> root
* B) parent data node for child instance tests (mand/min/max)
* C) data node referential tests (must/unique/leaf)
*
* Test pruning
* The global variable agt_profile.agt_rootflags is used
* to determine if any type (A) commit tests are needed
*
* The global variable agt_profile.agt_config_state is
* used to force complete testing; There are 3 states:
* AGT_CFG_STATE_INIT : running config has not been
* validated, or validation-in-progress
* AGT_CFG_STATE_OK : running config has been validated
* and it passed all validation checks
* AGT_CFG_STATE_BAD: running config validation has been
* attempted and it failed; running config is not valid!
* The server will shutdown if
* The target nodes in the undoQ records
* INPUTS:
* scb == session control block (may be NULL; no session stats)
* msghdr == XML message header in progress
* == NULL MEANS NO RPC-ERRORS ARE RECORDED
* txcb == transaction control block
* target == target database to use
* root == val_value_t for the target config being checked
*
* OUTPUTS:
* if mshdr not NULL:
* msghdr->msg_errQ may have rpc_err_rec_t
* structs added to it which must be freed by the
* caller with the rpc_err_free_record function
*
* RETURNS:
* status of the operation, NO_ERR if no validation errors found
*********************************************************************/
extern status_t
agt_val_root_check (ses_cb_t *scb,
xml_msg_hdr_t *msghdr,
agt_cfg_transaction_t *txcb,
val_value_t *root);
/********************************************************************
* FUNCTION agt_val_validate_write
*
* Validate the requested <edit-config> write operation
*
* Check all the embedded operation attributes against
* the default-operation and maintained current operation.
*
* Invoke all the user AGT_CB_VALIDATE callbacks for a
* 'new value' and 'existing value' pairs, for a given write operation,
*
* These callbacks are invoked bottom-up, so the first step is to
* step through all the child nodes and traverse the
* 'new' data model (from the PDU) all the way to the leaf nodes
*
* The operation attribute is checked against the real data model
* on the way down the tree, and the user callbacks are invoked
* bottom-up on the way back. This way, the user callbacks can
* share sub-tree validation routines, and perhaps add additional
* <rpc-error> information, based on the context and specific errors
* reported from 'below'.
*
* INPUTS:
* scb == session control block
* msg == incoming rpc_msg_t in progress
* target == cfg_template_t for the config database to write
* == NULL for no actual write acess (validate only)
* valroot == the val_value_t struct containing the root
* (NCX_BT_CONTAINER, ncx:root)
* datatype representing the config root with
* proposed changes to the target
* editop == requested start-state write operation
* (usually from the default-operation parameter)
* OUTPUTS:
* rpc_err_rec_t structs may be malloced and added to the msg->rpc_errQ
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
agt_val_validate_write (ses_cb_t *scb,
rpc_msg_t *msg,
cfg_template_t *target,
val_value_t *valroot,
op_editop_t editop);
/********************************************************************
* FUNCTION agt_val_apply_write
*
* Apply the requested write operation
*
* Invoke all the AGT_CB_APPLY callbacks for a
* source and target and write operation
*
* INPUTS:
* scb == session control block
* msg == incoming rpc_msg_t in progress
* target == cfg_template_t for the config database to write
* pducfg == the 'root' value struct that represents the
* tree of changes to apply to the target
* editop == requested start-state write operation
* (usually from the default-operation parameter)
*
* OUTPUTS:
* rpc_err_rec_t structs may be malloced and added to the msg->mhsr.errQ
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_val_apply_write (ses_cb_t *scb,
rpc_msg_t *msg,
cfg_template_t *target,
val_value_t *pducfg,
op_editop_t editop);
/********************************************************************
* FUNCTION agt_val_apply_commit
*
* Apply the requested commit operation
*
* Invoke all the AGT_CB_COMMIT callbacks for a
* source and target and write operation
*
* INPUTS:
* scb == session control block
* msg == incoming commit rpc_msg_t in progress
* source == cfg_template_t for the source (candidate)
* target == cfg_template_t for the config database to
* write (running)
* save_nvstore == TRUE if the mirrored NV-store
* should be updated after the commit is done
* FALSE if this is the start of a confirmed-commit
* so the NV-store update is deferred
* Never save to NV-store if :startup is supported
*
* OUTPUTS:
* rpc_err_rec_t structs may be malloced and added
* to the msg->mhsr.errQ
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_val_apply_commit (ses_cb_t *scb,
rpc_msg_t *msg,
cfg_template_t *source,
cfg_template_t *target,
boolean save_nvstore);
/********************************************************************
* FUNCTION agt_val_check_commit_edits
*
* Check if the requested commit operation
* would cause any ACM or partial lock violations
* in the running config
* Invoke all the AGT_CB_VALIDATE callbacks for a
* source and target and write operation
*
* INPUTS:
* scb == session control block
* msg == incoming commit rpc_msg_t in progress
* source == cfg_template_t for the source (e.g., candidate)
* target == cfg_template_t for the config database to
* write (e.g., running)
*
* OUTPUTS:
* rpc_err_rec_t structs may be malloced and added
* to the msg->mhdr.errQ
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_val_check_commit_edits (ses_cb_t *scb,
rpc_msg_t *msg,
cfg_template_t *source,
cfg_template_t *target);
/********************************************************************
* FUNCTION agt_val_delete_dead_nodes
*
* Mark nodes deleted for each false when-stmt from <validate>
* INPUTS:
* scb == session control block
* msg == incoming validate rpc_msg_t in progress
* root == value tree to check for deletions
*
* OUTPUTS:
* rpc_err_rec_t structs may be malloced and added
* to the msg->mhdr.errQ
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_val_delete_dead_nodes (ses_cb_t *scb,
rpc_msg_t *msg,
val_value_t *root);
/********************************************************************
* FUNCTION agt_val_add_module_commit_tests
*
* !!! Initialize module data node validation !!!
* !!! Must call after all modules are initially loaded !!!
*
* Find all the data node objects in the specified module
* that need some sort database referential integrity test
*
* !!! dynamic features are not supported. Any disabled objects
* due to false if-feature stmts will be skipped. No support yet
* to add or remove tests from the commit_testQ when obj_is_enabled()
* return value changes.
*
* INPUTS:
* mod == module to check and add tests
*
* SIDE EFFECTS:
* agt_profile->commit_testQ will contain an agt_commit_test_t struct
* for each object found with commit-time validation tests
*
* RETURNS:
* status of the operation, NO_ERR unless internal errors found
* or malloc error
*********************************************************************/
extern status_t
agt_val_add_module_commit_tests (ncx_module_t *mod);
/********************************************************************
* FUNCTION agt_val_init_commit_tests
*
* !!! Initialize full database validation !!!
* !!! Must call after all modules are initially loaded !!!
* !!! Must be called before load_running_config is called !!!
*
* Find all the data node objects that need some sort
* database referential integrity test
* For :candidate this is done during the
* validate of the <commit> RPC
* For :writable-running, this is done during
* <edit-config> or <copy-config>
*
* SIDE EFFECTS:
* all commit_test_t records created are stored in the
* agt_profile->commit_testQ
*
* RETURNS:
* status of the operation, NO_ERR unless internal errors found
* or malloc error
*********************************************************************/
extern status_t
agt_val_init_commit_tests (void);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_agt_val */
|