7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
25 */
26
27 #include <fm/fmd_adm.h>
28 #include <fm/fmd_snmp.h>
29 #include <net-snmp/net-snmp-config.h>
30 #include <net-snmp/net-snmp-includes.h>
31 #include <net-snmp/agent/net-snmp-agent-includes.h>
32 #include <pthread.h>
33 #include <stddef.h>
34 #include <errno.h>
35 #include <libuutil.h>
36 #include "sunFM_impl.h"
37 #include "module.h"
38
39 static uu_avl_pool_t *mod_name_avl_pool;
40 static uu_avl_pool_t *mod_index_avl_pool;
41 static uu_avl_t *mod_name_avl;
42 static uu_avl_t *mod_index_avl;
43
44 #define VALID_AVL_STATE (mod_name_avl_pool != NULL && \
45 mod_index_avl_pool != NULL && mod_name_avl != NULL && \
46 mod_index_avl != NULL)
47
48 #define UPDATE_WAIT_MILLIS 10 /* poll interval in milliseconds */
49
50 /*
51 * Update types. Single-index and all are mutually exclusive.
52 */
53 #define UCT_INDEX 0x1
54 #define UCT_ALL 0x2
55 #define UCT_FLAGS 0x3
56
57 #define MODULE_DATA_VALID(d) ((d)->d_valid == valid_stamp)
58
59 /*
60 * Locking rules are straightforward. There is only one updater thread
61 * for each table, and requests for update that are received while
62 * another update is in progress are ignored. The single per-table lock
63 * protects all the data for the table, the valid_stamp and max_index
64 * tags for new data, and - importantly - all the hidden static data
65 * used by the Net-SNMP library. The result return callbacks are always
66 * called in the master agent thread; holding the table lock is
67 * therefore sufficient since only one table's callback can be run at
68 * any one time. Finer-grained locking is possible here but
69 * substantially more difficult because nearly all Net-SNMP functions
70 * are unsafe.
71 *
72 * In practice this is more than adequate, since the purpose of
73 * threading out the update is to prevent excessively time-consuming
74 * data collection from bottlenecking the entire agent, not to improve
75 * result throughput (SNMP is not intended to be used for applications
76 * requiring high throughput anyway). If the agent itself ever becomes
77 * multithreaded, locking requirements become limited to our local
78 * per-table data (the tree, max_index, and valid_stamp), and the
79 * implementation could be revisited for better performance.
80 */
81
82 static ulong_t max_index;
83 static int valid_stamp;
84 static pthread_mutex_t update_lock;
85 static pthread_cond_t update_cv;
86 static volatile enum { US_QUIET, US_NEEDED, US_INPROGRESS } update_status;
87
88 static Netsnmp_Node_Handler sunFmModuleTable_handler;
89
90 static sunFmModule_data_t *
91 key_build(const char *name, const ulong_t index)
92 {
93 static sunFmModule_data_t key;
94
95 key.d_index = index;
96 if (name)
97 (void) strlcpy(key.d_ami_name, name, sizeof (key.d_ami_name));
98 else
99 key.d_ami_name[0] = '\0';
100
101 return (&key);
102 }
103
104 /*
105 * If name is the name of a module we have previously seen and indexed, return
106 * data for it. Otherwise, return NULL. Note that the module may not be
253 update_ctx->uc_version)) == NULL) {
254 (void) snmp_log(LOG_ERR, MODNAME_STR ": Communication with fmd "
255 "failed: %s\n", strerror(errno));
256 return (SNMP_ERR_RESOURCEUNAVAILABLE);
257 }
258
259 ++valid_stamp;
260 if (fmd_adm_module_iter(adm, modinfo_update_one, update_ctx) != 0) {
261 (void) snmp_log(LOG_ERR, MODNAME_STR ": fmd module information "
262 "update failed: %s\n", fmd_adm_errmsg(adm));
263 fmd_adm_close(adm);
264 return (SNMP_ERR_RESOURCEUNAVAILABLE);
265 }
266
267 DEBUGMSGTL((MODNAME_STR, "module iteration completed\n"));
268
269 fmd_adm_close(adm);
270 return (SNMP_ERR_NOERROR);
271 }
272
273 /*ARGSUSED*/
274 static void
275 update_thread(void *arg)
276 {
277 /*
278 * The current modinfo_update implementation offers minimal savings
279 * for the use of index-only updates; therefore we always do a full
280 * update. If it becomes advantageous to limit updates to a single
281 * index, the contexts can be queued by the handler instead.
282 */
283 sunFmModule_update_ctx_t uc;
284
285 uc.uc_host = NULL;
286 uc.uc_prog = FMD_ADM_PROGRAM;
287 uc.uc_version = FMD_ADM_VERSION;
288
289 uc.uc_index = 0;
290 uc.uc_type = UCT_ALL;
291
292 for (;;) {
293 (void) pthread_mutex_lock(&update_lock);
294 update_status = US_QUIET;
295 while (update_status == US_QUIET)
296 (void) pthread_cond_wait(&update_cv, &update_lock);
297 update_status = US_INPROGRESS;
298 (void) pthread_mutex_unlock(&update_lock);
299 (void) modinfo_update(&uc);
300 }
301 }
302
303 static void
304 request_update(void)
305 {
306 (void) pthread_mutex_lock(&update_lock);
307 if (update_status != US_QUIET) {
308 (void) pthread_mutex_unlock(&update_lock);
309 return;
310 }
311 update_status = US_NEEDED;
312 (void) pthread_cond_signal(&update_cv);
313 (void) pthread_mutex_unlock(&update_lock);
314 }
315
316 /*ARGSUSED*/
317 static int
318 module_compare_name(const void *l, const void *r, void *private)
319 {
320 sunFmModule_data_t *l_data = (sunFmModule_data_t *)l;
321 sunFmModule_data_t *r_data = (sunFmModule_data_t *)r;
322
323 ASSERT(l_data != NULL && r_data != NULL);
324
325 return (strcmp(l_data->d_ami_name, r_data->d_ami_name));
326 }
327
328 /*ARGSUSED*/
329 static int
330 module_compare_index(const void *l, const void *r, void *private)
331 {
332 sunFmModule_data_t *l_data = (sunFmModule_data_t *)l;
333 sunFmModule_data_t *r_data = (sunFmModule_data_t *)r;
334
335 ASSERT(l_data != NULL && r_data != NULL);
336
337 return (l_data->d_index < r_data->d_index ? -1 :
338 l_data->d_index > r_data->d_index ? 1 : 0);
339 }
340
341 int
342 sunFmModuleTable_init(void)
343 {
344 static oid sunFmModuleTable_oid[] = { SUNFMMODULETABLE_OID };
345 netsnmp_table_registration_info *table_info;
346 netsnmp_handler_registration *handler;
347 int err;
348
349 if ((err = pthread_mutex_init(&update_lock, NULL)) != 0) {
350 (void) snmp_log(LOG_ERR, MODNAME_STR ": mutex_init failure: "
351 "%s\n", strerror(err));
352 return (MIB_REGISTRATION_FAILED);
353 }
354 if ((err = pthread_cond_init(&update_cv, NULL)) != 0) {
355 (void) snmp_log(LOG_ERR, MODNAME_STR ": cond_init failure: "
356 "%s\n", strerror(err));
357 return (MIB_REGISTRATION_FAILED);
358 }
359
360 if ((err = pthread_create(NULL, NULL, (void *(*)(void *))update_thread,
361 NULL)) != 0) {
362 (void) snmp_log(LOG_ERR, MODNAME_STR ": error creating update "
363 "thread: %s\n", strerror(err));
364 return (MIB_REGISTRATION_FAILED);
365 }
366
367 if ((table_info =
368 SNMP_MALLOC_TYPEDEF(netsnmp_table_registration_info)) == NULL)
369 return (MIB_REGISTRATION_FAILED);
370
371 if ((handler = netsnmp_create_handler_registration("sunFmModuleTable",
372 sunFmModuleTable_handler, sunFmModuleTable_oid,
373 OID_LENGTH(sunFmModuleTable_oid), HANDLER_CAN_RONLY)) == NULL) {
374 SNMP_FREE(table_info);
375 return (MIB_REGISTRATION_FAILED);
376 }
377
378 /*
379 * The Net-SNMP template uses add_indexes here, but that
380 * function is unsafe because it does not check for failure.
381 */
382 if (netsnmp_table_helper_add_index(table_info, ASN_UNSIGNED) == NULL) {
383 SNMP_FREE(table_info);
384 SNMP_FREE(handler);
385 return (MIB_REGISTRATION_FAILED);
386 }
431 uu_avl_pool_destroy(mod_index_avl_pool);
432 return (MIB_REGISTRATION_FAILED);
433 }
434
435 if ((err = netsnmp_register_table(handler, table_info)) !=
436 MIB_REGISTERED_OK) {
437 snmp_free_varbind(table_info->indexes);
438 SNMP_FREE(table_info);
439 SNMP_FREE(handler);
440 uu_avl_destroy(mod_name_avl);
441 uu_avl_pool_destroy(mod_name_avl_pool);
442 uu_avl_destroy(mod_index_avl);
443 uu_avl_pool_destroy(mod_index_avl_pool);
444 return (err);
445 }
446
447 return (MIB_REGISTERED_OK);
448 }
449
450 /*
451 * These two functions form the core of GET/GETNEXT/GETBULK handling (the
452 * only kind we do). They perform two functions:
453 *
454 * - First, frob the request to set all the index variables to correspond
455 * to the value that's going to be returned. For GET, this is a nop;
456 * for GETNEXT/GETBULK it always requires some work.
457 * - Second, find and return the fmd module information corresponding to
458 * the (possibly updated) indices.
459 *
460 * These should be as fast as possible; they run in the agent thread.
461 */
462 static sunFmModule_data_t *
463 sunFmModuleTable_nextmod(netsnmp_handler_registration *reginfo,
464 netsnmp_table_request_info *table_info)
465 {
466 sunFmModule_data_t *data;
467 netsnmp_variable_list *var;
468 ulong_t index;
469
470 /*
471 * If we have no index, we must make one.
472 */
473 if (table_info->number_indexes < 1) {
474 oid tmpoid[MAX_OID_LEN];
475 index = 1;
476
477 DEBUGMSGTL((MODNAME_STR, "nextmod: no indexes given\n"));
478 var = SNMP_MALLOC_TYPEDEF(netsnmp_variable_list);
479 (void) snmp_set_var_typed_value(var, ASN_UNSIGNED,
480 (uchar_t *)&index, sizeof (index));
481 (void) memcpy(tmpoid, reginfo->rootoid,
482 reginfo->rootoid_len * sizeof (oid));
483 tmpoid[reginfo->rootoid_len] = 1; /* Entry is .1 */
484 tmpoid[reginfo->rootoid_len + 1] = table_info->colnum;
485 if (build_oid(&var->name, &var->name_length, tmpoid,
486 reginfo->rootoid_len + 2, var) != SNMPERR_SUCCESS) {
487 snmp_free_varbind(var);
488 return (NULL);
489 }
490 DEBUGMSGTL((MODNAME_STR, "nextmod: built fake index:\n"));
491 DEBUGMSGVAR((MODNAME_STR, var));
492 DEBUGMSG((MODNAME_STR, "\n"));
493 } else {
494 var = snmp_clone_varbind(table_info->indexes);
495 index = *var->val.integer;
496 DEBUGMSGTL((MODNAME_STR, "nextmod: received index:\n"));
497 DEBUGMSGVAR((MODNAME_STR, var));
498 DEBUGMSG((MODNAME_STR, "\n"));
499 index++;
500 }
501
502 snmp_free_varbind(table_info->indexes);
503 table_info->indexes = NULL;
504 table_info->number_indexes = 0;
505
506 if ((data = module_lookup_index_nextvalid(index)) == NULL) {
507 DEBUGMSGTL((MODNAME_STR, "nextmod: exact match not found for "
508 "index %lu; trying next column\n", index));
509 if (table_info->colnum >=
510 netsnmp_find_table_registration_info(reginfo)->max_column) {
511 snmp_free_varbind(var);
512 DEBUGMSGTL((MODNAME_STR, "nextmod: out of columns\n"));
513 return (NULL);
514 }
515 table_info->colnum++;
516 index = 1;
529 table_info->indexes = var;
530 table_info->number_indexes = 1;
531
532 DEBUGMSGTL((MODNAME_STR, "matching data is %lu/%s@%p\n", data->d_index,
533 data->d_ami_name, data));
534
535 return (data);
536 }
537
538 /*ARGSUSED*/
539 static sunFmModule_data_t *
540 sunFmModuleTable_mod(netsnmp_handler_registration *reginfo,
541 netsnmp_table_request_info *table_info)
542 {
543 ASSERT(table_info->number_indexes == 1);
544
545 return (module_lookup_index_exact(table_info->index_oid[0]));
546 }
547
548 /*ARGSUSED*/
549 static void
550 sunFmModuleTable_return(unsigned int reg, void *arg)
551 {
552 netsnmp_delegated_cache *cache = (netsnmp_delegated_cache *)arg;
553 netsnmp_request_info *request;
554 netsnmp_agent_request_info *reqinfo;
555 netsnmp_handler_registration *reginfo;
556 netsnmp_table_request_info *table_info;
557 sunFmModule_data_t *data;
558 ulong_t modstate;
559
560 ASSERT(netsnmp_handler_check_cache(cache) != NULL);
561
562 (void) pthread_mutex_lock(&update_lock);
563 if (update_status != US_QUIET) {
564 struct timeval tv;
565
566 tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
567 tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
568
569 (void) snmp_alarm_register_hr(tv, 0, sunFmModuleTable_return,
570 cache);
571 (void) pthread_mutex_unlock(&update_lock);
572 return;
573 }
574
575 request = cache->requests;
576 reqinfo = cache->reqinfo;
577 reginfo = cache->reginfo;
578
579 table_info = netsnmp_extract_table_info(request);
580 request->delegated = 0;
581
582 ASSERT(table_info->colnum >= SUNFMMODULE_COLMIN);
583 ASSERT(table_info->colnum <= SUNFMMODULE_COLMAX);
584
585 /*
586 * table_info->colnum contains the column number requested.
587 * table_info->indexes contains a linked list of snmp variable
588 * bindings for the indexes of the table. Values in the list
589 * have been set corresponding to the indexes of the
590 * request. We have other guarantees as well:
591 *
592 * - The column number is always within range.
593 * - If we have no index data, table_info->index_oid_len is 0.
594 * - We will never receive requests outside our table nor
595 * those with the first subid anything other than 1 (Entry)
596 * nor those without a column number. This is true even
597 * for GETNEXT requests.
598 */
599
600 switch (reqinfo->mode) {
601 case MODE_GET:
602 if ((data = sunFmModuleTable_mod(reginfo, table_info)) ==
603 NULL) {
604 netsnmp_free_delegated_cache(cache);
605 (void) pthread_mutex_unlock(&update_lock);
606 return;
607 }
608 break;
609 case MODE_GETNEXT:
610 case MODE_GETBULK:
611 if ((data = sunFmModuleTable_nextmod(reginfo, table_info)) ==
612 NULL) {
613 netsnmp_free_delegated_cache(cache);
614 (void) pthread_mutex_unlock(&update_lock);
615 return;
616 }
617 break;
618 default:
619 (void) snmp_log(LOG_ERR, MODNAME_STR ": Unsupported request "
620 "mode %d\n", reqinfo->mode);
621 netsnmp_free_delegated_cache(cache);
622 (void) pthread_mutex_unlock(&update_lock);
623 return;
624 }
625
626 switch (table_info->colnum) {
627 case SUNFMMODULE_COL_NAME:
628 (void) netsnmp_table_build_result(reginfo, request, table_info,
629 ASN_OCTET_STR, (uchar_t *)data->d_ami_name,
630 strlen(data->d_ami_name));
631 break;
632 case SUNFMMODULE_COL_VERSION:
633 (void) netsnmp_table_build_result(reginfo, request, table_info,
634 ASN_OCTET_STR, (uchar_t *)data->d_ami_vers,
635 strlen(data->d_ami_vers));
636 break;
637 case SUNFMMODULE_COL_STATUS:
638 modstate = (data->d_ami_flags & FMD_ADM_MOD_FAILED) ?
639 SUNFMMODULE_STATE_FAILED : SUNFMMODULE_STATE_ACTIVE;
640 (void) netsnmp_table_build_result(reginfo, request, table_info,
641 ASN_INTEGER, (uchar_t *)&modstate,
642 sizeof (modstate));
643 break;
644 case SUNFMMODULE_COL_DESCRIPTION:
645 (void) netsnmp_table_build_result(reginfo, request, table_info,
646 ASN_OCTET_STR, (uchar_t *)data->d_ami_desc,
647 strlen(data->d_ami_desc));
648 break;
649 default:
650 break;
651 }
652 netsnmp_free_delegated_cache(cache);
653 (void) pthread_mutex_unlock(&update_lock);
654 }
655
656 static int
657 sunFmModuleTable_handler(netsnmp_mib_handler *handler,
658 netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
659 netsnmp_request_info *requests)
660 {
661 netsnmp_request_info *request;
662 struct timeval tv;
663
664 tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
665 tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
666
667 request_update();
668
669 for (request = requests; request; request = request->next) {
670 if (request->processed != 0)
671 continue;
672
673 if (netsnmp_extract_table_info(request) == NULL)
674 continue;
675
676 request->delegated = 1;
677 (void) snmp_alarm_register_hr(tv, 0, sunFmModuleTable_return,
678 (void *) netsnmp_create_delegated_cache(handler, reginfo,
679 reqinfo, request, NULL));
680 }
681
682 return (SNMP_ERR_NOERROR);
683 }
|
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
25 */
26
27 /*
28 * Copyright 2018 Nexenta Systems, Inc.
29 */
30
31 #include <fm/fmd_adm.h>
32 #include <fm/fmd_snmp.h>
33
34 #include <net-snmp/net-snmp-config.h>
35 #include <net-snmp/net-snmp-includes.h>
36 #include <net-snmp/agent/net-snmp-agent-includes.h>
37
38 #include <errno.h>
39 #include <libuutil.h>
40 #include <pthread.h>
41 #include <stddef.h>
42
43 #include "sunFM_impl.h"
44 #include "module.h"
45
46 static uu_avl_pool_t *mod_name_avl_pool;
47 static uu_avl_pool_t *mod_index_avl_pool;
48 static uu_avl_t *mod_name_avl;
49 static uu_avl_t *mod_index_avl;
50
51 #define VALID_AVL_STATE (mod_name_avl_pool != NULL && \
52 mod_index_avl_pool != NULL && mod_name_avl != NULL && \
53 mod_index_avl != NULL)
54
55 /*
56 * Update types. Single-index and all are mutually exclusive.
57 */
58 #define UCT_INDEX 0x1
59 #define UCT_ALL 0x2
60 #define UCT_FLAGS 0x3
61
62 #define MODULE_DATA_VALID(d) ((d)->d_valid == valid_stamp)
63
64 static ulong_t max_index;
65 static int valid_stamp;
66 static pthread_mutex_t update_lock;
67
68 static Netsnmp_Node_Handler sunFmModuleTable_handler;
69
70 static sunFmModule_data_t *
71 key_build(const char *name, const ulong_t index)
72 {
73 static sunFmModule_data_t key;
74
75 key.d_index = index;
76 if (name)
77 (void) strlcpy(key.d_ami_name, name, sizeof (key.d_ami_name));
78 else
79 key.d_ami_name[0] = '\0';
80
81 return (&key);
82 }
83
84 /*
85 * If name is the name of a module we have previously seen and indexed, return
86 * data for it. Otherwise, return NULL. Note that the module may not be
233 update_ctx->uc_version)) == NULL) {
234 (void) snmp_log(LOG_ERR, MODNAME_STR ": Communication with fmd "
235 "failed: %s\n", strerror(errno));
236 return (SNMP_ERR_RESOURCEUNAVAILABLE);
237 }
238
239 ++valid_stamp;
240 if (fmd_adm_module_iter(adm, modinfo_update_one, update_ctx) != 0) {
241 (void) snmp_log(LOG_ERR, MODNAME_STR ": fmd module information "
242 "update failed: %s\n", fmd_adm_errmsg(adm));
243 fmd_adm_close(adm);
244 return (SNMP_ERR_RESOURCEUNAVAILABLE);
245 }
246
247 DEBUGMSGTL((MODNAME_STR, "module iteration completed\n"));
248
249 fmd_adm_close(adm);
250 return (SNMP_ERR_NOERROR);
251 }
252
253 static void
254 request_update(void)
255 {
256 sunFmModule_update_ctx_t uc;
257
258 /*
259 * The current modinfo_update implementation offers minimal savings
260 * for the use of index-only updates; therefore we always do a full
261 * update. If it becomes advantageous to limit updates to a single
262 * index, the contexts can be queued by the handler instead.
263 */
264 uc.uc_host = NULL;
265 uc.uc_prog = FMD_ADM_PROGRAM;
266 uc.uc_version = FMD_ADM_VERSION;
267 uc.uc_index = 0;
268 uc.uc_type = UCT_ALL;
269
270 (void) modinfo_update(&uc);
271 }
272
273 /*ARGSUSED*/
274 static int
275 module_compare_name(const void *l, const void *r, void *private)
276 {
277 sunFmModule_data_t *l_data = (sunFmModule_data_t *)l;
278 sunFmModule_data_t *r_data = (sunFmModule_data_t *)r;
279
280 ASSERT(l_data != NULL && r_data != NULL);
281
282 return (strcmp(l_data->d_ami_name, r_data->d_ami_name));
283 }
284
285 /*ARGSUSED*/
286 static int
287 module_compare_index(const void *l, const void *r, void *private)
288 {
289 sunFmModule_data_t *l_data = (sunFmModule_data_t *)l;
290 sunFmModule_data_t *r_data = (sunFmModule_data_t *)r;
291
292 ASSERT(l_data != NULL && r_data != NULL);
293
294 return (l_data->d_index < r_data->d_index ? -1 :
295 l_data->d_index > r_data->d_index ? 1 : 0);
296 }
297
298 int
299 sunFmModuleTable_init(void)
300 {
301 static oid sunFmModuleTable_oid[] = { SUNFMMODULETABLE_OID };
302 netsnmp_table_registration_info *table_info;
303 netsnmp_handler_registration *handler;
304 int err;
305
306 if ((err = pthread_mutex_init(&update_lock, NULL)) != 0) {
307 (void) snmp_log(LOG_ERR, MODNAME_STR ": mutex_init failure: "
308 "%s\n", strerror(err));
309 return (MIB_REGISTRATION_FAILED);
310 }
311
312 if ((table_info =
313 SNMP_MALLOC_TYPEDEF(netsnmp_table_registration_info)) == NULL)
314 return (MIB_REGISTRATION_FAILED);
315
316 if ((handler = netsnmp_create_handler_registration("sunFmModuleTable",
317 sunFmModuleTable_handler, sunFmModuleTable_oid,
318 OID_LENGTH(sunFmModuleTable_oid), HANDLER_CAN_RONLY)) == NULL) {
319 SNMP_FREE(table_info);
320 return (MIB_REGISTRATION_FAILED);
321 }
322
323 /*
324 * The Net-SNMP template uses add_indexes here, but that
325 * function is unsafe because it does not check for failure.
326 */
327 if (netsnmp_table_helper_add_index(table_info, ASN_UNSIGNED) == NULL) {
328 SNMP_FREE(table_info);
329 SNMP_FREE(handler);
330 return (MIB_REGISTRATION_FAILED);
331 }
376 uu_avl_pool_destroy(mod_index_avl_pool);
377 return (MIB_REGISTRATION_FAILED);
378 }
379
380 if ((err = netsnmp_register_table(handler, table_info)) !=
381 MIB_REGISTERED_OK) {
382 snmp_free_varbind(table_info->indexes);
383 SNMP_FREE(table_info);
384 SNMP_FREE(handler);
385 uu_avl_destroy(mod_name_avl);
386 uu_avl_pool_destroy(mod_name_avl_pool);
387 uu_avl_destroy(mod_index_avl);
388 uu_avl_pool_destroy(mod_index_avl_pool);
389 return (err);
390 }
391
392 return (MIB_REGISTERED_OK);
393 }
394
395 /*
396 * These two functions form the core of GET/GETNEXT handling (the
397 * only kind we do). They perform two functions:
398 *
399 * - First, frob the request to set all the index variables to correspond
400 * to the value that's going to be returned. For GET, this is a nop;
401 * for GETNEXT it always requires some work.
402 * - Second, find and return the fmd module information corresponding to
403 * the (possibly updated) indices.
404 *
405 * These should be as fast as possible; they run in the agent thread.
406 */
407 static sunFmModule_data_t *
408 sunFmModuleTable_nextmod(netsnmp_handler_registration *reginfo,
409 netsnmp_table_request_info *table_info)
410 {
411 sunFmModule_data_t *data;
412 netsnmp_variable_list *var;
413 ulong_t index;
414
415 /*
416 * If we have no index, we must make one.
417 */
418 if (table_info->number_indexes < 1) {
419 oid tmpoid[MAX_OID_LEN];
420 index = 1;
421
422 DEBUGMSGTL((MODNAME_STR, "nextmod: no indexes given\n"));
423 var = SNMP_MALLOC_TYPEDEF(netsnmp_variable_list);
424 (void) snmp_set_var_typed_value(var, ASN_UNSIGNED,
425 (uchar_t *)&index, sizeof (index));
426 (void) memcpy(tmpoid, reginfo->rootoid,
427 reginfo->rootoid_len * sizeof (oid));
428 tmpoid[reginfo->rootoid_len] = 1; /* Entry is .1 */
429 tmpoid[reginfo->rootoid_len + 1] = table_info->colnum;
430 if (build_oid(&var->name, &var->name_length, tmpoid,
431 reginfo->rootoid_len + 2, var) != SNMPERR_SUCCESS) {
432 snmp_free_varbind(var);
433 return (NULL);
434 }
435 DEBUGMSGTL((MODNAME_STR, "nextmod: built fake index: "));
436 DEBUGMSGVAR((MODNAME_STR, var));
437 DEBUGMSG((MODNAME_STR, "\n"));
438 } else {
439 var = snmp_clone_varbind(table_info->indexes);
440 index = *var->val.integer;
441 DEBUGMSGTL((MODNAME_STR, "nextmod: received index: "));
442 DEBUGMSGVAR((MODNAME_STR, var));
443 DEBUGMSG((MODNAME_STR, "\n"));
444 index++;
445 }
446
447 snmp_free_varbind(table_info->indexes);
448 table_info->indexes = NULL;
449 table_info->number_indexes = 0;
450
451 if ((data = module_lookup_index_nextvalid(index)) == NULL) {
452 DEBUGMSGTL((MODNAME_STR, "nextmod: exact match not found for "
453 "index %lu; trying next column\n", index));
454 if (table_info->colnum >=
455 netsnmp_find_table_registration_info(reginfo)->max_column) {
456 snmp_free_varbind(var);
457 DEBUGMSGTL((MODNAME_STR, "nextmod: out of columns\n"));
458 return (NULL);
459 }
460 table_info->colnum++;
461 index = 1;
474 table_info->indexes = var;
475 table_info->number_indexes = 1;
476
477 DEBUGMSGTL((MODNAME_STR, "matching data is %lu/%s@%p\n", data->d_index,
478 data->d_ami_name, data));
479
480 return (data);
481 }
482
483 /*ARGSUSED*/
484 static sunFmModule_data_t *
485 sunFmModuleTable_mod(netsnmp_handler_registration *reginfo,
486 netsnmp_table_request_info *table_info)
487 {
488 ASSERT(table_info->number_indexes == 1);
489
490 return (module_lookup_index_exact(table_info->index_oid[0]));
491 }
492
493 /*ARGSUSED*/
494 static int
495 sunFmModuleTable_handler(netsnmp_mib_handler *handler,
496 netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
497 netsnmp_request_info *request)
498 {
499 netsnmp_table_request_info *table_info;
500 sunFmModule_data_t *data;
501 ulong_t modstate;
502 int ret = SNMP_ERR_NOERROR;
503
504 /*
505 * We don't support MODE_GETBULK directly, so all bulk requests should
506 * come through bulk_to_next helper. Make sure it stays that way.
507 */
508 ASSERT(reqinfo->mode == MODE_GET || reqinfo->mode == MODE_GETNEXT);
509
510 (void) pthread_mutex_lock(&update_lock);
511 request_update();
512
513 for (; request != NULL; request = request->next) {
514 table_info = netsnmp_extract_table_info(request);
515 if (table_info == NULL)
516 continue;
517
518 ASSERT(table_info->colnum >= SUNFMMODULE_COLMIN);
519 ASSERT(table_info->colnum <= SUNFMMODULE_COLMAX);
520
521 /*
522 * table_info->colnum contains the column number requested.
523 * table_info->indexes contains a linked list of snmp variable
524 * bindings for the indexes of the table. Values in the list
525 * have been set corresponding to the indexes of the
526 * request. We have other guarantees as well:
527 *
528 * - The column number is always within range.
529 * - If we have no index data, table_info->index_oid_len is 0.
530 * - We will never receive requests outside our table nor
531 * those with the first subid anything other than 1 (Entry)
532 * nor those without a column number. This is true even
533 * for GETNEXT requests.
534 */
535 switch (reqinfo->mode) {
536 case MODE_GET:
537 data = sunFmModuleTable_mod(reginfo, table_info);
538 if (data == NULL)
539 goto out;
540 break;
541 case MODE_GETNEXT:
542 data = sunFmModuleTable_nextmod(reginfo, table_info);
543 if (data == NULL)
544 goto out;
545 break;
546 default:
547 (void) snmp_log(LOG_ERR, MODNAME_STR
548 ": unsupported request mode: %d\n", reqinfo->mode);
549 ret = SNMP_ERR_GENERR;
550 goto out;
551 }
552
553 switch (table_info->colnum) {
554 case SUNFMMODULE_COL_NAME:
555 (void) netsnmp_table_build_result(reginfo, request,
556 table_info, ASN_OCTET_STR,
557 (uchar_t *)data->d_ami_name,
558 strlen(data->d_ami_name));
559 break;
560 case SUNFMMODULE_COL_VERSION:
561 (void) netsnmp_table_build_result(reginfo, request,
562 table_info, ASN_OCTET_STR,
563 (uchar_t *)data->d_ami_vers,
564 strlen(data->d_ami_vers));
565 break;
566 case SUNFMMODULE_COL_STATUS:
567 modstate = (data->d_ami_flags & FMD_ADM_MOD_FAILED) ?
568 SUNFMMODULE_STATE_FAILED : SUNFMMODULE_STATE_ACTIVE;
569 (void) netsnmp_table_build_result(reginfo, request,
570 table_info, ASN_INTEGER, (uchar_t *)&modstate,
571 sizeof (modstate));
572 break;
573 case SUNFMMODULE_COL_DESCRIPTION:
574 (void) netsnmp_table_build_result(reginfo, request,
575 table_info, ASN_OCTET_STR,
576 (uchar_t *)data->d_ami_desc,
577 strlen(data->d_ami_desc));
578 break;
579 default:
580 break;
581 }
582 }
583
584 out:
585 (void) pthread_mutex_unlock(&update_lock);
586 return (ret);
587 }
|