/* implements the table data helper. This is the routine that takes
* care of all SNMP requests coming into the table. */
int
netsnmp_table_data_set_helper_handler(netsnmp_mib_handler *handler,
netsnmp_handler_registration
*reginfo,
netsnmp_agent_request_info *reqinfo,
netsnmp_request_info *requests)
{
netsnmp_table_data_set_storage *data = NULL;
newrow_stash *newrowstash = NULL;
netsnmp_table_row *row, *newrow = NULL;
netsnmp_table_request_info *table_info;
netsnmp_request_info *request;
netsnmp_oid_stash_node **stashp = NULL;
if (!handler)
return SNMPERR_GENERR;
DEBUGMSGTL(("netsnmp_table_data_set", "handler starting\n"));
for (request = requests; request; request = request->next) {
netsnmp_table_data_set *datatable =
(netsnmp_table_data_set *) handler->myvoid;
const oid * const suffix =
requests->requestvb->name + reginfo->rootoid_len + 2;
const size_t suffix_len =
requests->requestvb->name_length - (reginfo->rootoid_len + 2);
if (request->processed)
continue;
/*
* extract our stored data and table info
*/
row = netsnmp_extract_table_row(request);
table_info = netsnmp_extract_table_info(request);
#ifndef NETSNMP_NO_WRITE_SUPPORT
if (MODE_IS_SET(reqinfo->mode)) {
/*
* use a cached copy of the row for modification
*/
/*
* cache location: may have been created already by other
* SET requests in the same master request.
*/
stashp = netsnmp_table_dataset_get_or_create_stash(reqinfo,
datatable,
table_info);
if (NULL == stashp) {
netsnmp_set_request_error(reqinfo, request, SNMP_ERR_GENERR);
continue;
}
newrowstash
= (newrow_stash*)netsnmp_oid_stash_get_data(*stashp, suffix, suffix_len);
if (!newrowstash) {
if (!row) {
if (datatable->allow_creation) {
/*
* entirely new row. Create the row from the template
*/
newrowstash =
netsnmp_table_data_set_create_newrowstash(
datatable, table_info);
newrow = newrowstash->newrow;
} else if (datatable->rowstatus_column == 0) {
/*
* A RowStatus object may be used to control the
* creation of a new row. But if this object
* isn't declared (and the table isn't marked as
* 'auto-create'), then we can't create a new row.
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_NOCREATION);
continue;
}
} else {
/*
* existing row that needs to be modified
*/
newrowstash = SNMP_MALLOC_TYPEDEF(newrow_stash);
if (newrowstash == NULL) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_GENERR);
continue;
}
newrow = netsnmp_table_data_set_clone_row(row);
newrowstash->newrow = newrow;
}
netsnmp_oid_stash_add_data(stashp, suffix, suffix_len,
newrowstash);
} else {
newrow = newrowstash->newrow;
}
/*
* all future SET data modification operations use this
* temp pointer
*/
if (reqinfo->mode == MODE_SET_RESERVE1 ||
reqinfo->mode == MODE_SET_RESERVE2)
row = newrow;
}
#endif /* NETSNMP_NO_WRITE_SUPPORT */
if (row)
data = (netsnmp_table_data_set_storage *) row->data;
if (!row || !table_info || !data) {
if (!table_info
#ifndef NETSNMP_NO_WRITE_SUPPORT
|| !MODE_IS_SET(reqinfo->mode)
#endif /* !NETSNMP_NO_WRITE_SUPPORT */
) {
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
continue;
}
}
data =
netsnmp_table_data_set_find_column(data, table_info->colnum);
switch (reqinfo->mode) {
case MODE_GET:
case MODE_GETNEXT:
case MODE_GETBULK: /* XXXWWW */
if (!data || data->type == SNMP_NOSUCHINSTANCE) {
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
} else {
/*
* Note: data->data.voidp can be NULL, e.g. when a zero-length
* octet string has been stored in the table cache.
*/
netsnmp_table_data_build_result(reginfo, reqinfo, request,
row,
table_info->colnum,
data->type,
(u_char*)data->data.voidp,
data->data_len);
}
break;
#ifndef NETSNMP_NO_WRITE_SUPPORT
case MODE_SET_RESERVE1:
if (data) {
/*
* Can we modify the existing row?
*/
if (!data->writable) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_NOTWRITABLE);
} else if (request->requestvb->type != data->type) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_WRONGTYPE);
}
} else if (datatable->rowstatus_column == table_info->colnum) {
/*
* Otherwise, this is where we create a new row using
* the RowStatus object (essentially duplicating the
* steps followed earlier in the 'allow_creation' case)
*/
switch (*(request->requestvb->val.integer)) {
case RS_CREATEANDGO:
case RS_CREATEANDWAIT:
newrowstash =
netsnmp_table_data_set_create_newrowstash(
datatable, table_info);
newrow = newrowstash->newrow;
row = newrow;
netsnmp_oid_stash_add_data(stashp, suffix, suffix_len,
newrowstash);
}
}
break;
case MODE_SET_RESERVE2:
/*
* If the agent receives a SET request for an object in a non-existant
* row, then the RESERVE1 pass will create the row automatically.
*
* But since the row doesn't exist at that point, the test for whether
* the object is writable or not will be skipped. So we need to check
* for this possibility again here.
*
* Similarly, if row creation is under the control of the RowStatus
* object (i.e. allow_creation == 0), but this particular request
* doesn't include such an object, then the row won't have been created,
* and the writable check will also have been skipped. Again - check here.
*/
if (data && data->writable == 0) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_NOTWRITABLE);
continue;
}
if (datatable->rowstatus_column == table_info->colnum) {
switch (*(request->requestvb->val.integer)) {
case RS_ACTIVE:
case RS_NOTINSERVICE:
/*
* Can only operate on pre-existing rows.
*/
if (!newrowstash || newrowstash->created) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_INCONSISTENTVALUE);
continue;
}
break;
case RS_CREATEANDGO:
case RS_CREATEANDWAIT:
/*
* Can only operate on newly created rows.
*/
if (!(newrowstash && newrowstash->created)) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_INCONSISTENTVALUE);
continue;
}
break;
case RS_DESTROY:
/*
* Can operate on new or pre-existing rows.
*/
break;
case RS_NOTREADY:
default:
/*
* Not a valid value to Set
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_WRONGVALUE);
continue;
}
}
if (!data ) {
netsnmp_set_request_error(reqinfo, request,
SNMP_ERR_NOCREATION);
continue;
}
/*
* modify row and set new value
*/
SNMP_FREE(data->data.string);
data->data.string = (u_char *)
netsnmp_strdup_and_null(request->requestvb->val.string,
request->requestvb->val_len);
if (!data->data.string) {
netsnmp_set_request_error(reqinfo, requests,
SNMP_ERR_RESOURCEUNAVAILABLE);
}
data->data_len = request->requestvb->val_len;
if (datatable->rowstatus_column == table_info->colnum) {
switch (*(request->requestvb->val.integer)) {
case RS_CREATEANDGO:
/*
* XXX: check legality
*/
*(data->data.integer) = RS_ACTIVE;
break;
case RS_CREATEANDWAIT:
/*
* XXX: check legality
*/
*(data->data.integer) = RS_NOTINSERVICE;
break;
case RS_DESTROY:
newrowstash->deleted = 1;
break;
}
}
break;
case MODE_SET_ACTION:
/*
* Install the new row into the stored table.
* Do this only *once* per row ....
*/
if (newrowstash->state != STATE_ACTION) {
newrowstash->state = STATE_ACTION;
if (newrowstash->created) {
netsnmp_table_dataset_add_row(datatable, newrow);
} else {
netsnmp_table_dataset_replace_row(datatable,
row, newrow);
}
}
/*
* ... but every (relevant) varbind in the request will
* need to know about this new row, so update the
* per-request row information regardless
*/
if (newrowstash->created) {
netsnmp_request_add_list_data(request,
netsnmp_create_data_list(TABLE_DATA_NAME,
newrow, NULL));
}
break;
case MODE_SET_UNDO:
/*
* extract the new row, replace with the old or delete
*/
if (newrowstash->state != STATE_UNDO) {
newrowstash->state = STATE_UNDO;
if (newrowstash->created) {
netsnmp_table_dataset_remove_and_delete_row(datatable, newrow);
} else {
netsnmp_table_dataset_replace_row(datatable,
newrow, row);
netsnmp_table_dataset_delete_row(newrow);
}
newrow = NULL;
}
break;
case MODE_SET_COMMIT:
if (newrowstash->state != STATE_COMMIT) {
newrowstash->state = STATE_COMMIT;
if (!newrowstash->created) {
netsnmp_request_info *req;
netsnmp_table_dataset_delete_row(row);
/* Walk the request list to update the reference to the old row w/ th new one */
for (req = requests; req; req=req->next) {
/*
* For requests that have the old row values,
* so add the newly-created row information.
*/
if ((netsnmp_table_row *) netsnmp_extract_table_row(req) == row) {
netsnmp_request_remove_list_data(req, TABLE_DATA_ROW);
netsnmp_request_add_list_data(req,
netsnmp_create_data_list(TABLE_DATA_ROW, newrow, NULL));
}
}
row = NULL;
}
if (newrowstash->deleted) {
netsnmp_table_dataset_remove_and_delete_row(datatable, newrow);
newrow = NULL;
}
}
break;
case MODE_SET_FREE:
if (newrowstash && newrowstash->state != STATE_FREE) {
newrowstash->state = STATE_FREE;
netsnmp_table_dataset_delete_row(newrow);
newrow = NULL;
}
break;
#endif /* NETSNMP_NO_WRITE_SUPPORT */
default:
snmp_log(LOG_ERR,
"table_dataset: unknown mode passed into the handler\n");
return SNMP_ERR_GENERR;
}
}
/* next handler called automatically - 'AUTO_NEXT' */
return SNMP_ERR_NOERROR;
}
/*
* The helper handler that takes care of passing a specific row of
* data down to the lower handler(s). It sets request->processed if
* the request should not be handled.
*/
int
netsnmp_table_data_helper_handler(netsnmp_mib_handler *handler,
netsnmp_handler_registration *reginfo,
netsnmp_agent_request_info *reqinfo,
netsnmp_request_info *requests)
{
netsnmp_table_data *table = (netsnmp_table_data *) handler->myvoid;
netsnmp_request_info *request;
int valid_request = 0;
netsnmp_table_row *row;
netsnmp_table_request_info *table_info;
netsnmp_table_registration_info *table_reg_info =
netsnmp_find_table_registration_info(reginfo);
int result, regresult;
int oldmode;
for (request = requests; request; request = request->next) {
if (request->processed)
continue;
table_info = netsnmp_extract_table_info(request);
if (!table_info)
continue; /* ack */
switch (reqinfo->mode) {
case MODE_GET:
case MODE_GETNEXT:
case MODE_SET_RESERVE1:
netsnmp_request_add_list_data(request,
netsnmp_create_data_list(
TABLE_DATA_TABLE, table, NULL));
}
/*
* find the row in question
*/
switch (reqinfo->mode) {
case MODE_GETNEXT:
case MODE_GETBULK: /* XXXWWW */
if (request->requestvb->type != ASN_NULL)
continue;
/*
* loop through data till we find the next row
*/
result = snmp_oid_compare(request->requestvb->name,
request->requestvb->name_length,
reginfo->rootoid,
reginfo->rootoid_len);
regresult = snmp_oid_compare(request->requestvb->name,
SNMP_MIN(request->requestvb->
name_length,
reginfo->rootoid_len),
reginfo->rootoid,
reginfo->rootoid_len);
if (regresult == 0
&& request->requestvb->name_length < reginfo->rootoid_len)
regresult = -1;
if (result < 0 || 0 == result) {
/*
* before us entirely, return the first
*/
row = table->first_row;
table_info->colnum = table_reg_info->min_column;
} else if (regresult == 0 && request->requestvb->name_length ==
reginfo->rootoid_len + 1 &&
/* entry node must be 1, but any column is ok */
request->requestvb->name[reginfo->rootoid_len] == 1) {
/*
* exactly to the entry
*/
row = table->first_row;
table_info->colnum = table_reg_info->min_column;
} else if (regresult == 0 && request->requestvb->name_length ==
reginfo->rootoid_len + 2 &&
/* entry node must be 1, but any column is ok */
request->requestvb->name[reginfo->rootoid_len] == 1) {
/*
* exactly to the column
*/
row = table->first_row;
} else {
/*
* loop through all rows looking for the first one
* that is equal to the request or greater than it
*/
for (row = table->first_row; row; row = row->next) {
/*
* compare the index of the request to the row
*/
result =
snmp_oid_compare(row->index_oid,
row->index_oid_len,
request->requestvb->name + 2 +
reginfo->rootoid_len,
request->requestvb->name_length -
2 - reginfo->rootoid_len);
if (result == 0) {
/*
* equal match, return the next row
*/
if (row) {
row = row->next;
}
break;
} else if (result > 0) {
/*
* the current row is greater than the
* request, use it
*/
break;
}
}
}
if (!row) {
table_info->colnum++;
if (table_info->colnum <= table_reg_info->max_column) {
row = table->first_row;
}
}
if (row) {
valid_request = 1;
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_ROW, row,
NULL));
/*
* Set the name appropriately, so we can pass this
* request on as a simple GET request
*/
netsnmp_table_data_build_result(reginfo, reqinfo, request,
row,
table_info->colnum,
ASN_NULL, NULL, 0);
} else { /* no decent result found. Give up. It's beyond us. */
request->processed = 1;
}
break;
case MODE_GET:
if (request->requestvb->type != ASN_NULL)
continue;
/*
* find the row in question
*/
if (request->requestvb->name_length < (reginfo->rootoid_len + 3)) { /* table.entry.column... */
/*
* request too short
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
break;
} else if (NULL ==
(row =
netsnmp_table_data_get_from_oid(table,
request->
requestvb->name +
reginfo->
rootoid_len + 2,
request->
requestvb->
name_length -
reginfo->
rootoid_len -
2))) {
/*
* no such row
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
break;
} else {
valid_request = 1;
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_ROW, row,
NULL));
}
break;
case MODE_SET_RESERVE1:
valid_request = 1;
if (NULL !=
(row =
netsnmp_table_data_get_from_oid(table,
request->requestvb->name +
reginfo->rootoid_len + 2,
request->requestvb->
name_length -
reginfo->rootoid_len -
2))) {
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_ROW, row,
NULL));
}
break;
case MODE_SET_RESERVE2:
case MODE_SET_ACTION:
case MODE_SET_COMMIT:
case MODE_SET_FREE:
case MODE_SET_UNDO:
valid_request = 1;
}
}
if (valid_request &&
(reqinfo->mode == MODE_GETNEXT || reqinfo->mode == MODE_GETBULK)) {
/*
* If this is a GetNext or GetBulk request, then we've identified
* the row that ought to include the appropriate next instance.
* Convert the request into a Get request, so that the lower-level
* handlers don't need to worry about skipping on, and call these
* handlers ourselves (so we can undo this again afterwards).
*/
oldmode = reqinfo->mode;
reqinfo->mode = MODE_GET;
result = netsnmp_call_next_handler(handler, reginfo, reqinfo,
requests);
reqinfo->mode = oldmode;
handler->flags |= MIB_HANDLER_AUTO_NEXT_OVERRIDE_ONCE;
return result;
}
else
/* next handler called automatically - 'AUTO_NEXT' */
return SNMP_ERR_NOERROR;
}
/**
* The helper handler that takes care of passing a specific row of
* data down to the lower handler(s). It sets request->processed if
* the request should not be handled.
*/
int
netsnmp_table_data_helper_handler(netsnmp_mib_handler *handler,
netsnmp_handler_registration *reginfo,
netsnmp_agent_request_info *reqinfo,
netsnmp_request_info *requests)
{
netsnmp_table_data *table = (netsnmp_table_data *) handler->myvoid;
netsnmp_request_info *request;
int valid_request = 0;
netsnmp_table_row *row;
netsnmp_table_request_info *table_info;
netsnmp_table_registration_info *table_reg_info =
netsnmp_find_table_registration_info(reginfo);
int result, regresult;
int oldmode;
for (request = requests; request; request = request->next) {
if (request->processed)
continue;
table_info = netsnmp_extract_table_info(request);
if (!table_info)
continue; /* ack */
/*
* find the row in question
*/
switch (reqinfo->mode) {
case MODE_GETNEXT:
case MODE_GETBULK: /* XXXWWW */
if (request->requestvb->type != ASN_NULL)
continue;
/*
* loop through data till we find the next row
*/
result = snmp_oid_compare(request->requestvb->name,
request->requestvb->name_length,
reginfo->rootoid,
reginfo->rootoid_len);
regresult = snmp_oid_compare(request->requestvb->name,
SNMP_MIN(request->requestvb->
name_length,
reginfo->rootoid_len),
reginfo->rootoid,
reginfo->rootoid_len);
if (regresult == 0
&& request->requestvb->name_length < reginfo->rootoid_len)
regresult = -1;
if (result < 0 || 0 == result) {
/*
* before us entirely, return the first
*/
row = table->first_row;
table_info->colnum = table_reg_info->min_column;
} else if (regresult == 0 && request->requestvb->name_length ==
reginfo->rootoid_len + 1 &&
/* entry node must be 1, but any column is ok */
request->requestvb->name[reginfo->rootoid_len] == 1) {
/*
* exactly to the entry
*/
row = table->first_row;
table_info->colnum = table_reg_info->min_column;
} else if (regresult == 0 && request->requestvb->name_length ==
reginfo->rootoid_len + 2 &&
/* entry node must be 1, but any column is ok */
request->requestvb->name[reginfo->rootoid_len] == 1) {
/*
* exactly to the column
*/
row = table->first_row;
} else {
/*
* loop through all rows looking for the first one
* that is equal to the request or greater than it
*/
for (row = table->first_row; row; row = row->next) {
/*
* compare the index of the request to the row
*/
result =
snmp_oid_compare(row->index_oid,
row->index_oid_len,
request->requestvb->name + 2 +
reginfo->rootoid_len,
request->requestvb->name_length -
2 - reginfo->rootoid_len);
if (result == 0) {
/*
* equal match, return the next row
*/
if (row) {
row = row->next;
}
break;
} else if (result > 0) {
/*
* the current row is greater than the
* request, use it
*/
break;
}
}
}
if (!row) {
table_info->colnum++;
if (table_info->colnum <= table_reg_info->max_column) {
row = table->first_row;
}
}
if (row) {
valid_request = 1;
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_NAME, row,
NULL));
/*
* Set the name appropriately, so we can pass this
* request on as a simple GET request
*/
netsnmp_table_data_build_result(reginfo, reqinfo, request,
row,
table_info->colnum,
ASN_NULL, NULL, 0);
} else { /* no decent result found. Give up. It's beyond us. */
request->processed = 1;
}
break;
case MODE_GET:
if (request->requestvb->type != ASN_NULL)
continue;
/*
* find the row in question
*/
if (request->requestvb->name_length < (reginfo->rootoid_len + 3)) { /* table.entry.column... */
/*
* request too short
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
break;
} else if (NULL ==
(row =
netsnmp_table_data_get_from_oid(table,
request->
requestvb->name +
reginfo->
rootoid_len + 2,
request->
requestvb->
name_length -
reginfo->
rootoid_len -
2))) {
/*
* no such row
*/
netsnmp_set_request_error(reqinfo, request,
SNMP_NOSUCHINSTANCE);
break;
} else {
valid_request = 1;
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_NAME, row,
NULL));
}
break;
case MODE_SET_RESERVE1:
valid_request = 1;
if (NULL !=
(row =
netsnmp_table_data_get_from_oid(table,
request->requestvb->name +
reginfo->rootoid_len + 2,
request->requestvb->
name_length -
reginfo->rootoid_len -
2))) {
netsnmp_request_add_list_data(request,
netsnmp_create_data_list
(TABLE_DATA_NAME, row,
NULL));
}
break;
case MODE_SET_RESERVE2:
case MODE_SET_ACTION:
case MODE_SET_COMMIT:
case MODE_SET_FREE:
case MODE_SET_UNDO:
valid_request = 1;
}
}
if (valid_request) {
/*
* If this is a GetNext or GetBulk request, then we've identified
* the row that ought to include the appropriate next instance.
* Convert the request into a Get request, so that the lower-level
* handlers don't need to worry about skipping on....
*/
oldmode = reqinfo->mode;
if (reqinfo->mode == MODE_GETNEXT || reqinfo->mode == MODE_GETBULK) {
reqinfo->mode = MODE_GET;
}
result = netsnmp_call_next_handler(handler, reginfo, reqinfo,
requests);
if (oldmode == MODE_GETNEXT || oldmode == MODE_GETBULK) { /* XXX */
for (request = requests; request; request = request->next) {
/*
* ... but if the lower-level handlers aren't dealing with
* skipping on to the next instance, then we must handle
* this situation here.
* Mark 'holes' in the table as needing to be retried.
*
* This approach is less efficient than handling such
* holes directly in the table_dataset handler, but allows
* user-provided handlers to override the dataset handler
* if this proves necessary.
*/
if (request->requestvb->type == ASN_NULL ||
request->requestvb->type == SNMP_NOSUCHINSTANCE) {
request->requestvb->type = ASN_PRIV_RETRY;
}
/* XXX - Move on to the next object */
if (request->requestvb->type == SNMP_NOSUCHOBJECT) {
request->requestvb->type = ASN_PRIV_RETRY;
}
}
reqinfo->mode = oldmode;
}
return result;
}
else
return SNMP_ERR_NOERROR;
}
