 |
yumapro
20.10-12
YumaPro SDK
|
Go to the documentation of this file.
38 #include <sys/select.h>
40 #include <xmlstring.h>
108 extern const char *term_reason_str (ses_term_reason_t termreason);
183 #if defined(WITH_SNMP) && defined(WITH_RESTCONF)
235 const char *client_addr);
256 boolean clear_locks);
280 ses_term_reason_t termreason);
294 ses_term_reason_t termreason);
308 ses_term_reason_t termreason);
399 const val_value_t *virval,
400 val_value_t *dstval);
418 const val_value_t *virval,
419 val_value_t *dstval);
437 const val_value_t *virval,
438 val_value_t *dstval);
456 const val_value_t *virval,
457 val_value_t *dstval);
475 const val_value_t *virval,
476 val_value_t *dstval);
495 const val_value_t *virval,
496 val_value_t *dstval);
514 const val_value_t *virval,
515 val_value_t *dstval);
534 const val_value_t *virval,
535 val_value_t *dstval);
553 const val_value_t *virval,
554 val_value_t *dstval);
572 const val_value_t *virval,
573 val_value_t *dstval);
591 const val_value_t *virval,
592 val_value_t *dstval);
NETCONF Session Common definitions module.
@ SES_TR_OTHER
other
Definition: ses.h:393
Yuma Interface to net-snmp data structures. Agent interface.
status_t agt_ses_get_inBadHellos(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the inBadHellos counter
Definition: agt_ses.c:1888
Server Session Management.
Utility Functions for NCX Server method routines.
status_t xml_reset_reader_for_session(xmlInputReadCallback readfn, xmlInputCloseCallback closefn, void *context, xmlTextReaderPtr reader)
Reset the xmlTextReader for parsing the input of a NETCONF session.
Definition: xml_util.c:418
ses_cb_t * ses_new_coap_scb(void)
Create a new global CoAP session control block.
Definition: ses.c:2132
xmlChar * xml_strdup(const xmlChar *copyFrom)
String duplicate for xmlChar.
Definition: xml_util.c:1553
#define SES_IS_YCONTROL(S)
test if this is a YControl session
Definition: ses.h:138
val_value_t * val_find_child(const val_value_t *parent, const xmlChar *modname, const xmlChar *childname)
Find the first instance of the specified child node.
Definition: val.c:8560
NETCONF State Monitoring Data Model Module support.
ses_cb_t * ses_new_dummy_scb(void)
Create a new dummy session control block.
Definition: ses.c:2100
@ ERR_NCX_DEF_NOT_FOUND
250
Definition: status_enum.h:289
@ SES_ST_IDLE
adble to accept requests
Definition: ses.h:358
void log_error(const char *fstr,...) __attribute__((format(printf
Generate a new LOG_DEBUG_ERROR log entry.
void agt_ncxserver_clear_fd(int fd)
Clear a dead session from the select loop.
Definition: agt_ncxserver.c:4021
Value Node Basic Support.
#define NCX_NCSSH_PORT
Default NETCONF over SSH port.
Definition: ncxconst.h:127
GET1 and GET2 Callback Support.
void agt_ses_fill_writeset(fd_set *fdset, int *maxfdnum)
Drain the ses_msg outreadyQ and set the specified fdset Used by agt_ncxserver write_fd_set.
Definition: agt_ses.c:1819
void agt_ncx_check_cc_timeout(void)
Check if a confirmed-commit has timed out, and needs to be canceled.
Definition: agt_ncx.c:5689
NETCONF protocol remote procedure call server-side definitions.
status_t agt_ses_get_inRpcs(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the inRpcs counter
Definition: agt_ses.c:1918
ses_ready_t * ses_msg_get_first_inready(boolean ycontrol)
Dequeue the first entry in the inreadyQ, if any.
Definition: ses_msg.c:971
@ NCX_PROTO_NETCONF11
RFC 6241 base:1.1.
Definition: ncxtypes.h:784
status_t agt_ses_get_inBadRpcs(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the inBadRpcs counter
Definition: agt_ses.c:1948
void ses_msg_make_inready(ses_cb_t *scb)
Put the session on the inreadyQ if it is not already there.
Definition: ses_msg.c:834
boolean agt_ncxserver_thread_clear_session(ses_id_t sid, ses_id_t killedby, ses_term_reason_t termreason)
Signal session clear to the appropriate RX thread for session.
Definition: agt_ncxserver.c:3104
void cfg_release_locks(ses_id_t sesid)
Release any configuration locks held by the specified session.
Definition: cfg.c:2632
void agt_ses_set_idle_timeout(uint32 val)
Set the idle-timeout parameter.
Definition: agt_ses.c:2466
NCX Server Transport and IO Library.
@ SES_TYP_SNMP
RESTCONF over SNMP.
Definition: ses.h:324
boolean agt_ncx_cc_active(void)
Check if a confirmed-commit is active, and the timeout may need to be processed.
Definition: agt_ncx.c:5623
void thd_clear_locks(thd_tcb_t *tcb)
Clear mutexes and RWLOCKs prior to termination.
Definition: thd.c:580
void agt_ses_go_active(void)
Activate MGMT sessions because YP-HA mode is active.
Definition: agt_ses.c:2302
status_t agt_ses_init(void)
INIT 1: Initialize the session manager module data structures.
Definition: agt_ses.c:465
@ SES_TYP_NETCONF
any network configuration protocol
Definition: ses.h:320
void agt_acm_clear_session_cache(ses_cb_t *scb)
Clear an agt_acm_cache_t struct in a session control block.
Definition: agt_acm.c:755
void agt_ses_free_session2(ses_cb_t *scb, boolean clear_locks)
Free a real session control block but with optional unlocking.
Definition: agt_ses.c:889
void agt_sys_send_sysSessionEnd(const ses_cb_t *scb, ses_term_reason_t termreason, ses_id_t killedby)
Queue the Session End notification.
Definition: agt_sys.c:1260
void ses_msg_dump(log_debug_t lvl, const ses_msg_t *msg, const xmlChar *text)
Dump the message contents.
Definition: ses_msg.c:1100
NETCONF Session Message Common definitions module.
boolean agt_ses_ssh_port_allowed(uint16 port)
Check if the port number used for SSH connect is okay.
Definition: agt_ses.c:1768
uint32 ses_id_t
Session ID.
Definition: ses.h:306
ses_id_t agt_ncx_cc_ses_id(void)
Get the confirmed commit session ID.
Definition: agt_ncx.c:5640
NETCONF Server Data Model callback handler.
boolean thd_yield_for_cdx(int max_yield_count, uint usec, int ival, test_cdx_int_t sid_test_func)
Yield scheduler in loop until specified condition(s) are met or max loop count is exceeded.
Definition: thd.c:1618
@ NCX_CC_EVENT_CANCEL
cancel event
Definition: ncxtypes.h:1225
status_t agt_ses_get_session_outRpcErrors(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the outRpcErrors counter
Definition: agt_ses.c:2148
boolean agt_ses_session_id_valid(ses_id_t sid)
Check if a session-id is for an active session.
Definition: agt_ses.c:1031
boolean agt_ses_process_first_ready(boolean ycontrol)
Check the readyQ and process the first message, if any.
Definition: agt_ses.c:1468
void void void void void log_info(const char *fstr,...) __attribute__((format(printf
Generate a new LOG_DEBUG_INFO log entry.
uint32 agt_ses_mgmt_session_count(void)
Get number of management sessions open.
Definition: agt_ses.c:2272
void void void void void void void void void log_debug2(const char *fstr,...) __attribute__((format(printf
Generate a new LOG_DEBUG_DEBUG2 log entry.
@ SES_TYP_COAP
RESTCONF over CoAP; static socket, libcoap.
Definition: ses.h:323
Definition Registry module.
void agt_ses_check_timeouts(ses_id_t sid)
Check if any sessions need to be dropped because they have been idle too long.
Definition: agt_ses.c:1631
void agt_ses_thread_kill_session(ses_cb_t *scb, ses_id_t killedby, ses_term_reason_t termreason)
Kill the specified session; called from session thread.
Definition: agt_ses.c:1118
void agt_ses_kill_session(ses_cb_t *scb, ses_id_t killedby, ses_term_reason_t termreason)
Kill the specified session.
Definition: agt_ses.c:1213
@ NO_ERR
000
Definition: status_enum.h:188
@ SES_TRANSPORT_CLI
YumaPro CLI hook (ncxconnect, NETCONF framing)
Definition: ses.h:340
int ses_read_cb(void *context, char *buffer, int len)
The IO input front-end for the xmlTextReader parser read fn.
Definition: ses.c:3093
ses_cb_t * agt_ses_new_session(ses_transport_t transport, int fd)
Create a real server session control block.
Definition: agt_ses.c:811
void agt_ses_cleanup(void)
Cleanup the session manager module data structures.
Definition: agt_ses.c:499
status_t def_reg_add_scb(int fd, ses_cb_t *scb)
add one FD to SCB mapping to the registry
Definition: def_reg.c:457
ses_cb_t * agt_ses_new_snmp_session(void)
Create a dummy SNMP session control block.
Definition: agt_ses.c:737
@ NCX_SES_EVENT_END
session ended event
Definition: ncxtypes.h:1412
NETCONF protocol audit log support.
void void void void void void void void void void void void void log_debug4(const char *fstr,...) __attribute__((format(printf
Generate a new LOG_DEBUG_DEBUG4 log entry.
NETCONF Server standard method routines.
const xmlChar * ses_get_transport_name(ses_transport_t transport)
Get the name of the transport for a given enum value.
Definition: ses.c:3598
#define LOGDEBUG2
Check if at least log-level=debug2.
Definition: log.h:292
@ ERR_INTERNAL_VAL
004
Definition: status_enum.h:194
@ SES_MODE_XML
XML mode.
Definition: ses.h:379
ses_total_stats_t * ses_get_total_stats(void)
Get a r/w pointer to the the session totals stats.
Definition: ses.c:3560
void dlq_remove(void *nodeP)
remove the queue entry from its queue list entry MUST have been enqueued somehow before this function...
Definition: dlq.c:519
boolean agt_ses_max_cli_sessions(void)
Check if max-cli-sessions parameter has been reached.
Definition: agt_ses.c:2364
status_t agt_ses_set_dummy_session_acm(ses_cb_t *dummy_session, ses_id_t use_sid)
Set the session ID and username of the user that will be responsible for the rollback if needed.
Definition: agt_ses.c:576
@ ERR_NCX_INVALID_VALUE
258
Definition: status_enum.h:299
@ SES_TR_BAD_HELLO
bad <hello> received
Definition: ses.h:395
Server Instrumentation Library Support.
void agt_acm_invalidate_session_cache(ses_cb_t *scb)
Mark an agt_acm_cache_t struct in a session control block as invalid so it will be refreshed next use...
Definition: agt_acm.c:790
NETCONF protocol remote procedure call common definitions.
boolean agt_ses_request_close(ses_cb_t *scb, ses_id_t killedby, ses_term_reason_t termreason)
Start the close of the specified session.
Definition: agt_ses.c:1056
ses_cb_t * ses_new_snmp_scb(void)
Create a new global SNMP session control block.
Definition: ses.c:2185
@ ERR_INTERNAL_MEM
003
Definition: status_enum.h:193
void ses_msg_free_msg(ses_cb_t *scb, ses_msg_t *msg)
Free the session message and all its buffer chunks.
Definition: ses_msg.c:325
@ SES_TYP_DUMMY
internal session for rollback, etc.
Definition: ses.h:321
const xmlChar * ses_state_name(ses_state_t state)
Get the name of a session state from the enum value.
Definition: ses.c:3419
@ SES_TR_DROPPED
dropped by remote peer
Definition: ses.h:391
@ ERR_INTERNAL_INIT_SEQ
007
Definition: status_enum.h:197
void agt_ses_free_snmp_session(ses_cb_t *scb)
Free a dummy snmp session control block.
Definition: agt_ses.c:782
const char * get_error_string(status_t res)
Get the error message for a specific internal error.
Definition: status.c:239
void agt_ses_set_max_cli_sessions(uint16 val)
Set the max-cli-sessions parameter.
Definition: agt_ses.c:2428
void agt_openssl_cleanup_session(ses_cb_t *scb)
Cleanup a NETCONF over TLS session.
Definition: agt_openssl.c:1243
void void void void void void void log_debug(const char *fstr,...) __attribute__((format(printf
Generate a new LOG_DEBUG_DEBUG log entry.
boolean ncx_protocol_enabled(ncx_protocol_t proto)
Check if the specified protocol version is enabled.
Definition: ncx.c:10192
ses_cb_t * agt_ses_new_session_tls(ses_transport_t transport, int fd, const char *client_addr)
Create a real agent session control block for TLS.
Definition: agt_ses.c:836
#define LOGINFO
Check if at least log-level=info.
Definition: log.h:279
#define dlq_nextEntry(nodeP)
get the next queue entry after the current entry
Definition: dlq.h:265
Multi-Protocol Network Management Server.
@ NCX_PROTO_YCONTROL
YumaPro Internal Control 1.0.
Definition: ncxtypes.h:787
void agt_ses_go_standby(void)
Deactivate MGMT sessions because YP-HA mode is standby.
Definition: agt_ses.c:2317
#define AGT_MAX_PORTS
maximum number of –port leaf-list values that will be saved
Definition: agt.h:188
@ ERR_NCX_RESOURCE_DENIED
269
Definition: status_enum.h:310
thd_tcb_t * thd_get_thread_tcb(void)
Return the TCB of the current thread.
Definition: thd.c:994
status_t agt_ses_get_session_inBadRpcs(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the inBadRpcs counter
Definition: agt_ses.c:2108
@ GETCB_GET_VALUE
GET request.
Definition: getcb.h:247
@ SES_ST_SHUTDOWN
session shutting down
Definition: ses.h:361
void agt_ses_invalidate_session_acm_caches(void)
Invalidate all session ACM caches so they will be rebuilt.
Definition: agt_ses.c:2224
@ SES_TR_KILLED
kill-session
Definition: ses.h:390
void agt_ses_set_max_sessions(uint16 val)
Set the max-sessions parameter.
Definition: agt_ses.c:2409
boolean agt_acm_session_is_superuser(const ses_cb_t *scb)
Check if the specified session is the superuser.
Definition: agt_acm.c:868
@ ERR_NCX_OPERATION_NOT_SUPPORTED
273
Definition: status_enum.h:314
#define VAL_UINT(V)
Access the value as an uint32 ONLY if NCX_BT_UINT8, 16, 32.
Definition: val.h:482
void agt_ypsnmp_cleanup(void)
Cleanup the agt_ypsnmp module.
Definition: agt_ypsnmp.c:3390
ses_ready_t * ses_msg_get_first_inready_ses(ses_id_t sid)
Dequeue the first matching session entry in the inreadyQ, if any.
Definition: ses_msg.c:1005
ses_cb_t * ses_new_scb(void)
Create a new session control block.
Definition: ses.c:2025
const xmlChar * obj_get_mod_name(const obj_template_t *obj)
Get the module name for this object.
Definition: obj.c:12176
void agt_ycontrol_remove_subsys(ses_id_t sid, const xmlChar *subsys_id)
Remove a subsystem connection to the ycontrol manager because the connection was closed or shutting d...
Definition: agt_ycontrol.c:1871
void tstamp_datetime(xmlChar *buff)
Set the current date and time in an XML dateTime string format.
Definition: tstamp.c:160
void agt_ncx_clear_cc_ses_id(void)
Clear the confirmed commit session ID.
Definition: agt_ncx.c:5657
@ SES_ST_SHUTDOWN_REQ
session shutdown requested
Definition: ses.h:360
status_t agt_ses_get_outRpcErrors(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the outRpcErrors counter
Definition: agt_ses.c:1978
status_t agt_ses_get_session_inRpcs(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the session/inRpcs counter
Definition: agt_ses.c:2068
#define NCX_FL_PROTO_NETCONF10
bit definitions for NETCONF session protocol versions
Definition: ncxconst.h:1585
#define LOGDEBUG4
Check if at least log-level=debug4.
Definition: log.h:302
NCX System Logging Manager.
void log_flush(void)
Flush output buffers.
Definition: log.c:1880
boolean agt_top_dispatch_msg(ses_cb_t **ppscb)
Find the appropriate top node handler and call it.
Definition: agt_top.c:108
NETCONF system.yang DM module support.
#define LOGDEBUG
Check if at least log-level=debug.
Definition: log.h:287
Handle the <ncx-connect> (top-level) element.
boolean agt_ses_process_first_ready_by_sid(ses_id_t sid)
Check the readyQ and process the first message matching session, if any.
Definition: agt_ses.c:1440
const xmlChar * agt_ncx_cc_persist_id(void)
Get the confirmed commit persist ID.
Definition: agt_ncx.c:5674
#define SES_STATE(S)
get the session state
Definition: ses.h:177
void agt_ncx_cancel_confirmed_commit(ses_cb_t *scb, ncx_confirm_event_t event)
Cancel the confirmed-commit in progress and rollback to the backup-cfg.xml file.
Definition: agt_ncx.c:5775
status_t agt_ses_get_outNotifications(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the outNotifications counter
Definition: agt_ses.c:2008
status_t agt_ses_get_droppedSessions(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the droppedSessions counter
Definition: agt_ses.c:2038
#define dlq_empty(listP)
check if queue list is empty
Definition: dlq.h:367
NETCONF Server Access Control Entry Points.
uint32 xml_strcpy(xmlChar *copyTo, const xmlChar *copyFrom)
String copy for xmlChar.
Definition: xml_util.c:1486
ses_cb_t * agt_ses_get_session_for_id(ses_id_t sid)
get the session for the supplied sid
Definition: agt_ses.c:2252
void agt_audit_handle_end_session(ses_cb_t *scb, ses_term_reason_t termreason, ses_id_t killedby)
Generate an end (client or control) session event if enabled.
Definition: agt_audit.c:531
agt_profile_t * agt_get_profile(void)
Get the server profile struct.
Definition: agt.c:4118
void agt_cb_run_session_hook(ncx_ses_event_t ses_event, const ses_cb_t *scb)
Run Session Hook callbacks.
Definition: agt_cb.c:4742
ses_cb_t * agt_ses_new_coap_session(void)
Create a dummy CoAP session control block.
Definition: agt_ses.c:666
ses_ready_t * ses_msg_get_first_outready(void)
Dequeue the first entry in the outreadyQ, if any.
Definition: ses_msg.c:1044
@ SES_TR_CLOSED
close-session
Definition: ses.h:389
void agt_timer_get_timenow(time_t *tnow)
Get the current time using the system or monotonic clock.
Definition: agt_timer.c:457
#define dlq_firstEntry(listP)
get the first entry in the queue list
Definition: dlq.h:337
void def_reg_del_scb(int fd)
delete one FD to SCB mapping from the registry
Definition: def_reg.c:542
@ SES_ST_HELLO_WAIT
waiting for peer <hello>
Definition: ses.h:355
boolean ses_is_control_session(ses_cb_t *scb)
Check if the specified session is a control session.
Definition: ses.c:4386
@ SES_TR_TIMEOUT
inactivity timeout
Definition: ses.h:392
#define TSTAMP_MIN_SIZE
normal minimum buffer size for a tstamp buffer
Definition: tstamp.h:67
#define SES_MY_SID(S)
get session-id
Definition: ses.h:105
Handle the YumaPro Control Protocol <ycontrol> (top-level) element.
ses_cb_t * agt_ses_new_dummy_session(void)
Create a dummy session control block.
Definition: agt_ses.c:535
@ SES_TR_BAD_START
bad session start
Definition: ses.h:394
status_t ses_msg_new_buff(ses_cb_t *scb, boolean outbuff, ses_msg_buff_t **buff)
Malloc a new session buffer chuck.
Definition: ses_msg.c:378
void agt_ses_set_hello_timeout(uint32 val)
Set the hello-timeout parameter.
Definition: agt_ses.c:2447
void agt_state_remove_session(ses_cb_t *scb)
Remove a session entry from the netconf-state DM.
Definition: agt_state.c:2402
Handle timer services for the server.
void ses_free_scb(ses_cb_t *scb)
Free a session control block.
Definition: ses.c:2221
#define SET_ERROR(E)
macro SET_ERROR
Definition: status_enum.h:103
@ SES_ST_INIT
initialization state
Definition: ses.h:354
status_t agt_ses_get_session_outNotifications(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the outNotifications counter
Definition: agt_ses.c:2188
void agt_not_remove_subscription(ses_id_t sid)
Remove and expire a subscription with the specified session ID.
Definition: agt_not.c:5889
void agt_ses_free_coap_session(ses_cb_t *scb)
Free a dummy CoAP session control block.
Definition: agt_ses.c:711
void tstamp_local_datetime(xmlChar *buff)
Set the current date and time in an XML dateTime string format.
Definition: tstamp.c:189
OpenSSL support for netconf-tls.
void agt_ses_free_session(ses_cb_t *scb)
Free a real session control block.
Definition: agt_ses.c:870
void ncx_socket_close(int fd)
Close a socket; check result.
Definition: ncx.c:13214
@ NCX_PROTO_NETCONF10
RFC 4741 base:1.0
Definition: ncxtypes.h:783
#define SES_CURMSG(S)
get the session current message
Definition: ses.h:204
Global error messages for status code enumerations.
void agt_ses_free_dummy_session(ses_cb_t *scb)
Free a dummy session control block.
Definition: agt_ses.c:641
NETCONF Server Top Element module. Manage callback registry for received XML messages.
@ SES_ST_IN_MSG
processing a request
Definition: ses.h:359
status_t agt_ses_get_inSessions(ses_cb_t *scb, getcb_mode_t cbmode, const val_value_t *virval, val_value_t *dstval)
<get> operation handler for the inSessions counter
Definition: agt_ses.c:1858
@ SES_INST_IDLE
idle state
Definition: ses.h:368
status_t xml_get_reader_for_session(xmlInputReadCallback readfn, xmlInputCloseCallback closefn, void *context, xmlTextReaderPtr *reader)
Get a new xmlTextReader for parsing the input of a NETCONF session.
Definition: xml_util.c:378
1.8.17