net-snmp 5.7
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
net-snmp agent related processing
The Net-SNMP agent

Data Structures

struct  addrCache
struct  _agent_nsap
struct  agent_set_cache_s

Defines

#define SNMP_NEED_REQUEST_LIST
#define SNMP_ADDRCACHE_SIZE   10
#define SNMP_ADDRCACHE_MAXAGE   300

Typedefs

typedef struct _agent_nsap agent_nsap
typedef struct agent_set_cache_s agent_set_cache

Enumerations

enum  { SNMP_ADDRCACHE_UNUSED = 0, SNMP_ADDRCACHE_USED = 1 }

Functions

 netsnmp_feature_child_of (snmp_agent, libnetsnmpagent)
NETSNMP_INLINE int netsnmp_agent_remove_list_data (netsnmp_agent_request_info *ari, const char *name)
NETSNMP_INLINE void * netsnmp_agent_get_list_data (netsnmp_agent_request_info *ari, const char *name)
NETSNMP_INLINE void netsnmp_free_agent_data_set (netsnmp_agent_request_info *ari)
NETSNMP_INLINE void netsnmp_free_agent_data_sets (netsnmp_agent_request_info *ari)
NETSNMP_INLINE void netsnmp_free_agent_request_info (netsnmp_agent_request_info *ari)
int netsnmp_agent_check_packet (netsnmp_session *, struct netsnmp_transport_s *, void *, int)
int netsnmp_agent_check_parse (netsnmp_session *, netsnmp_pdu *, int)
void delete_subnetsnmp_tree_cache (netsnmp_agent_session *asp)
int handle_pdu (netsnmp_agent_session *asp)
 This function calls into netsnmp_set_mode_request_error, sets error_value given a reqinfo->mode value.
int netsnmp_handle_request (netsnmp_agent_session *asp, int status)
int netsnmp_wrap_up_request (netsnmp_agent_session *asp, int status)
int check_delayed_request (netsnmp_agent_session *asp)
int handle_getnext_loop (netsnmp_agent_session *asp)
 repeatedly calls getnext handlers looking for an answer till all requests are satisified.
int handle_set_loop (netsnmp_agent_session *asp)
int netsnmp_check_queued_chain_for (netsnmp_agent_session *asp)
int netsnmp_add_queued (netsnmp_agent_session *asp)
int netsnmp_remove_from_delegated (netsnmp_agent_session *asp)
int netsnmp_allocate_globalcacheid (void)
int netsnmp_get_local_cachid (netsnmp_cachemap *cache_store, int globalid)
netsnmp_cachemap * netsnmp_get_or_add_local_cachid (netsnmp_cachemap **cache_store, int globalid, int localid)
void netsnmp_free_cachemap (netsnmp_cachemap *cache_store)
agent_set_cache * save_set_cache (netsnmp_agent_session *asp)
int get_set_cache (netsnmp_agent_session *asp)
NETSNMP_STATIC_INLINE void _reorder_getbulk (netsnmp_agent_session *asp)
NETSNMP_STATIC_INLINE void _fix_endofmibview (netsnmp_agent_session *asp)
int agent_check_and_process (int block)
 This function checks for packets arriving on the SNMP port and processes them(snmp_read) if some are found, using the select().
void netsnmp_addrcache_initialise (void)
void netsnmp_addrcache_destroy (void)
int netsnmp_addrcache_add (const char *addr)
void netsnmp_addrcache_age (void)
int netsnmp_register_agent_nsap (netsnmp_transport *t)
void netsnmp_deregister_agent_nsap (int handle)
int init_master_agent (void)
void clear_nsap_list (void)
void shutdown_master_agent (void)
netsnmp_agent_session * init_agent_snmp_session (netsnmp_session *session, netsnmp_pdu *pdu)
void free_agent_snmp_session (netsnmp_agent_session *asp)
int netsnmp_check_for_delegated (netsnmp_agent_session *asp)
int netsnmp_check_delegated_chain_for (netsnmp_agent_session *asp)
int netsnmp_check_for_delegated_and_add (netsnmp_agent_session *asp)
int netsnmp_remove_delegated_requests_for_session (netsnmp_session *sess)
void dump_sess_list (void)
void netsnmp_remove_and_free_agent_snmp_session (netsnmp_agent_session *asp)
void netsnmp_free_agent_snmp_session_by_session (netsnmp_session *sess, void(*free_request)(netsnmp_request_list *))
int handle_snmp_packet (int op, netsnmp_session *session, int reqid, netsnmp_pdu *pdu, void *magic)
 handles an incoming SNMP packet into the agent
netsnmp_request_info * netsnmp_add_varbind_to_cache (netsnmp_agent_session *asp, int vbcount, netsnmp_variable_list *varbind_ptr, netsnmp_subtree *tp)
int check_acm (netsnmp_agent_session *asp, u_char type)
int netsnmp_create_subtree_cache (netsnmp_agent_session *asp)
int netsnmp_reassign_requests (netsnmp_agent_session *asp)
void netsnmp_delete_request_infos (netsnmp_request_info *reqlist)
void netsnmp_delete_subtree_cache (netsnmp_agent_session *asp)
int netsnmp_check_all_requests_error (netsnmp_agent_session *asp, int look_for_specific)
int netsnmp_check_requests_error (netsnmp_request_info *requests)
int netsnmp_check_requests_status (netsnmp_agent_session *asp, netsnmp_request_info *requests, int look_for_specific)
int netsnmp_check_all_requests_status (netsnmp_agent_session *asp, int look_for_specific)
int handle_var_requests (netsnmp_agent_session *asp)
void netsnmp_check_outstanding_agent_requests (void)
int netsnmp_check_transaction_id (int transaction_id)
 Decide if the requested transaction_id is still being processed within the agent.
int check_getnext_results (netsnmp_agent_session *asp)
 returns 1 if there are valid GETNEXT requests left.
int handle_set (netsnmp_agent_session *asp)
NETSNMP_STATIC_INLINE int _request_set_error (netsnmp_request_info *request, int mode, int error_value)
 set error for a request
int netsnmp_request_set_error (netsnmp_request_info *request, int error_value)
 set error for a request
int netsnmp_request_set_error_idx (netsnmp_request_info *request, int error_value, int idx)
 set error for a request within a request list
NETSNMP_INLINE int netsnmp_request_set_error_all (netsnmp_request_info *requests, int error)
 set error for all requests
u_long netsnmp_marker_uptime (marker_t pm)
u_long netsnmp_timeval_uptime (struct timeval *tv)
const_marker_t netsnmp_get_agent_starttime (void)
 Return a pointer to the variable in which the Net-SNMP start time has been stored.
void netsnmp_set_agent_starttime (marker_t s)
 Set the time at which Net-SNMP started either to the current time (if s == NULL) or to *s (if s is not NULL).
u_long netsnmp_get_agent_uptime (void)
void netsnmp_set_agent_uptime (u_long hsec)
int netsnmp_set_request_error (netsnmp_agent_request_info *reqinfo, netsnmp_request_info *request, int error_value)
 set error for a request
int netsnmp_set_mode_request_error (int mode, netsnmp_request_info *request, int error_value)
 set error for a request
int netsnmp_set_all_requests_error (netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests, int error_value)
 set error for all request

Variables

oid version_sysoid [] = { NETSNMP_SYSTEM_MIB }
int version_sysoid_len = OID_LENGTH(version_sysoid)
int log_addresses = 0
netsnmp_agent_session * netsnmp_processing_set = NULL
netsnmp_agent_session * agent_delegated_list = NULL
netsnmp_agent_session * netsnmp_agent_queued_list = NULL
int netsnmp_running = 1
netsnmp_session * main_session = NULL
struct timeval starttime

Function Documentation

NETSNMP_STATIC_INLINE int _request_set_error ( netsnmp_request_info *  request,
int  mode,
int  error_value 
)

set error for a request

Definition at line 3559 of file snmp_agent.c.

int agent_check_and_process ( int  block)

This function checks for packets arriving on the SNMP port and processes them(snmp_read) if some are found, using the select().

If block is non zero, the function call blocks until a packet arrives

Parameters:
blockused to control blocking in the select() function, 1 = block forever, and 0 = don't block
Returns:
Returns a positive integer if packets were processed, and -1 if an error was found.

Definition at line 635 of file snmp_agent.c.

int check_getnext_results ( netsnmp_agent_session *  asp)

returns 1 if there are valid GETNEXT requests left.

Returns 0 if not.

Definition at line 2950 of file snmp_agent.c.

int handle_getnext_loop ( netsnmp_agent_session *  asp)

repeatedly calls getnext handlers looking for an answer till all requests are satisified.

It's expected that one pass has been made before entering this function

Definition at line 3067 of file snmp_agent.c.

int handle_pdu ( netsnmp_agent_session *  asp)

This function calls into netsnmp_set_mode_request_error, sets error_value given a reqinfo->mode value.

It's used to send specific errors back to the agent to process accordingly.

If error_value is set to SNMP_NOSUCHOBJECT, SNMP_NOSUCHINSTANCE, or SNMP_ENDOFMIBVIEW the following is applicable: Sets the error_value to request->requestvb->type if reqinfo->mode value is set to MODE_GET. If the reqinfo->mode value is set to MODE_GETNEXT or MODE_GETBULK the code calls snmp_log logging an error message.

Otherwise, the request->status value is checked, if it's < 0 snmp_log is called with an error message and SNMP_ERR_GENERR is assigned to request->status. If the request->status value is >= 0 the error_value is set to request->status.

Parameters:
reqinfois a pointer to the netsnmp_agent_request_info struct. It contains the reqinfo->mode which is required to set error_value or log error messages.
requestis a pointer to the netsnmp_request_info struct. The error_value is set to request->requestvb->type
error_valueis the exception value you want to set, below are possible values.
  • SNMP_NOSUCHOBJECT
  • SNMP_NOSUCHINSTANCE
  • SNMP_ENDOFMIBVIEW
  • SNMP_ERR_NOERROR
  • SNMP_ERR_TOOBIG
  • SNMP_ERR_NOSUCHNAME
  • SNMP_ERR_BADVALUE
  • SNMP_ERR_READONLY
  • SNMP_ERR_GENERR
  • SNMP_ERR_NOACCESS
  • SNMP_ERR_WRONGTYPE
  • SNMP_ERR_WRONGLENGTH
  • SNMP_ERR_WRONGENCODING
  • SNMP_ERR_WRONGVALUE
  • SNMP_ERR_NOCREATION
  • SNMP_ERR_INCONSISTENTVALUE
  • SNMP_ERR_RESOURCEUNAVAILABLE
  • SNMP_ERR_COMMITFAILED
  • SNMP_ERR_UNDOFAILED
  • SNMP_ERR_AUTHORIZATIONERROR
  • SNMP_ERR_NOTWRITABLE
  • SNMP_ERR_INCONSISTENTNAME
Returns:
Returns error_value under all conditions.

Definition at line 3365 of file snmp_agent.c.

int handle_snmp_packet ( int  op,
netsnmp_session *  session,
int  reqid,
netsnmp_pdu *  pdu,
void *  magic 
)

handles an incoming SNMP packet into the agent

Definition at line 1889 of file snmp_agent.c.

netsnmp_request_info* netsnmp_add_varbind_to_cache ( netsnmp_agent_session *  asp,
int  vbcount,
netsnmp_variable_list *  varbind_ptr,
netsnmp_subtree *  tp 
)

Todo:
make this be more intelligent about ranges. Right now we merely take the highest level commonality of a registration range and use that. At times we might be able to be smarter about checking the range itself as opposed to the node above where the range exists, but I doubt this will come up all that frequently.

Definition at line 1998 of file snmp_agent.c.

int netsnmp_check_transaction_id ( int  transaction_id)

Decide if the requested transaction_id is still being processed within the agent.

This is used to validate whether a delayed cache (containing possibly freed pointers) is still usable.

returns SNMPERR_SUCCESS if it's still valid, or SNMPERR_GENERR if not.

Definition at line 2851 of file snmp_agent.c.

const_marker_t netsnmp_get_agent_starttime ( void  )

Return a pointer to the variable in which the Net-SNMP start time has been stored.

Definition at line 3735 of file snmp_agent.c.

int netsnmp_request_set_error ( netsnmp_request_info *  request,
int  error_value 
)

set error for a request

Parameters:
requestrequest which has error
error_valueerror value for request

Definition at line 3633 of file snmp_agent.c.

NETSNMP_INLINE int netsnmp_request_set_error_all ( netsnmp_request_info *  requests,
int  error 
)

set error for all requests

Parameters:
requestsrequest list
errorerror value for requests
Returns:
SNMPERR_SUCCESS, or an error code

paranoid sanity checks

Definition at line 3678 of file snmp_agent.c.

int netsnmp_request_set_error_idx ( netsnmp_request_info *  request,
int  error_value,
int  idx 
)

set error for a request within a request list

Parameters:
requesthead of the request list
error_valueerror value for request
idxindex of the request which has the error

Definition at line 3649 of file snmp_agent.c.

void netsnmp_set_agent_starttime ( marker_t  s)

Set the time at which Net-SNMP started either to the current time (if s == NULL) or to *s (if s is not NULL).

Definition at line 3745 of file snmp_agent.c.

int netsnmp_set_all_requests_error ( netsnmp_agent_request_info *  reqinfo,
netsnmp_request_info *  requests,
int  error_value 
)

set error for all request

Deprecated:
use netsnmp_request_set_error_all
Parameters:
reqinfoagent_request_info pointer for requests
requestsrequest list
error_valueerror value for requests
Returns:
error_value

Definition at line 3831 of file snmp_agent.c.

int netsnmp_set_mode_request_error ( int  mode,
netsnmp_request_info *  request,
int  error_value 
)

set error for a request

deprecated, use netsnmp_request_set_error instead

Deprecated:
, use netsnmp_request_set_error instead
Parameters:
modeNet-SNMP agent processing mode
requestrequest_info pointer
error_valueerror value for requests
Returns:
error_value

Definition at line 3814 of file snmp_agent.c.

int netsnmp_set_request_error ( netsnmp_agent_request_info *  reqinfo,
netsnmp_request_info *  request,
int  error_value 
)

set error for a request

deprecated, use netsnmp_request_set_error instead

Deprecated:
, use netsnmp_request_set_error instead
Parameters:
reqinfoagent_request_info pointer for request
requestrequest_info pointer
error_valueerror value for requests
Returns:
error_value
Examples:
delayed_instance.c.

Definition at line 3795 of file snmp_agent.c.

int netsnmp_wrap_up_request ( netsnmp_agent_session *  asp,
int  status 
)

if asp->pdu

Definition at line 1620 of file snmp_agent.c.

Generated on Thu Jul 14 2011 for net-snmp by  doxygen 1.7.4