Debian Codegraph @

agent/mibgroup/disman/event/mteObjects.c

raw
1 /*
2 * DisMan Event MIB:
3 * Core implementation of the object handling behaviour
4 */
5
6 #include <net-snmp/net-snmp-config.h>
7 #include <net-snmp/net-snmp-includes.h>
8 #include <net-snmp/agent/net-snmp-agent-includes.h>
9 #include "disman/event/mteObjects.h"
10
11 netsnmp_tdata *objects_table_data;
12
13 /*
14 * Initialize the container for the object table
15 * regardless of which initialisation routine is called first.
16 */
17
18 void
19 init_objects_table_data(void)
20 {
21 if (!objects_table_data)
22 objects_table_data = netsnmp_tdata_create_table("mteObjectsTable", 0);
23 }
24
25
26
27 SNMPCallback _init_default_mteObject_lists;
28
29 /** Initializes the mteObjects module */
30 void
31 init_mteObjects(void)
32 {
33 init_objects_table_data();
34
35 /*
36 * Insert fixed object lists for the default trigger
37 * notifications, once the MIB files have been read in.
38 */
39 snmp_register_callback(SNMP_CALLBACK_LIBRARY,
40 SNMP_CALLBACK_POST_READ_CONFIG,
41 _init_default_mteObject_lists, NULL);
42 }
43
44
45 void
46 _init_default_mteObject( const char *oname, const char *object, int index, int wcard)
47 {
48 struct mteObject *entry;
49
50 entry = mteObjects_addOID( "_snmpd", oname, index, object, 0 );
51 if (entry) {
52 entry->flags |= MTE_OBJECT_FLAG_ACTIVE|
53 MTE_OBJECT_FLAG_FIXED |
54 MTE_OBJECT_FLAG_VALID;
55 if (wcard)
56 entry->flags |= MTE_OBJECT_FLAG_WILD;
57 }
58 }
59
60 int
61 _init_default_mteObject_lists( int majorID, int minorID,
62 void *serverargs, void *clientarg)
63 {
64 static int _defaults_init = 0;
65
66 if (_defaults_init)
67 return 0;
68 /* mteHotTrigger */
69 _init_default_mteObject( "_triggerFire", ".1.3.6.1.2.1.88.2.1.1", 1, 0);
70 /* mteHotTargetName */
71 _init_default_mteObject( "_triggerFire", ".1.3.6.1.2.1.88.2.1.2", 2, 0);
72 /* mteHotContextName */
73 _init_default_mteObject( "_triggerFire", ".1.3.6.1.2.1.88.2.1.3", 3, 0);
74 /* mteHotOID */
75 _init_default_mteObject( "_triggerFire", ".1.3.6.1.2.1.88.2.1.4", 4, 0);
76 /* mteHotValue */
77 _init_default_mteObject( "_triggerFire", ".1.3.6.1.2.1.88.2.1.5", 5, 0);
78
79
80 /* mteHotTrigger */
81 _init_default_mteObject( "_triggerFail", ".1.3.6.1.2.1.88.2.1.1", 1, 0);
82 /* mteHotTargetName */
83 _init_default_mteObject( "_triggerFail", ".1.3.6.1.2.1.88.2.1.2", 2, 0);
84 /* mteHotContextName */
85 _init_default_mteObject( "_triggerFail", ".1.3.6.1.2.1.88.2.1.3", 3, 0);
86 /* mteHotOID */
87 _init_default_mteObject( "_triggerFail", ".1.3.6.1.2.1.88.2.1.4", 4, 0);
88 /* mteFailedReason */
89 _init_default_mteObject( "_triggerFail", ".1.3.6.1.2.1.88.2.1.6", 5, 0);
90
91 /* ifIndex */
92 _init_default_mteObject( "_linkUpDown", ".1.3.6.1.2.1.2.2.1.1", 1, 1);
93 /* ifAdminStatus */
94 _init_default_mteObject( "_linkUpDown", ".1.3.6.1.2.1.2.2.1.7", 2, 1);
95 /* ifOperStatus */
96 _init_default_mteObject( "_linkUpDown", ".1.3.6.1.2.1.2.2.1.8", 3, 1);
97
98 _defaults_init = 1;
99 return 0;
100 }
101
102 /* ===================================================
103 *
104 * APIs for maintaining the contents of the mteObjectsTable container.
105 *
106 * =================================================== */
107
108 /*
109 * Create a new row in the object table
110 */
111 netsnmp_tdata_row *
112 mteObjects_createEntry(const char *owner, const char *oname, int index, int flags)
113 {
114 struct mteObject *entry;
115 netsnmp_tdata_row *row, *row2;
116 size_t owner_len = (owner) ? strlen(owner) : 0;
117 size_t oname_len = (oname) ? strlen(oname) : 0;
118
119 /*
120 * Create the mteObjects entry, and the
121 * (table-independent) row wrapper structure...
122 */
123 entry = SNMP_MALLOC_TYPEDEF(struct mteObject);
124 if (!entry)
125 return NULL;
126
127
128 row = netsnmp_tdata_create_row();
129 if (!row) {
130 SNMP_FREE(entry);
131 return NULL;
132 }
133 row->data = entry;
134
135 /*
136 * ... initialize this row with the indexes supplied
137 * and the default values for the row...
138 */
139 if (owner)
140 memcpy(entry->mteOwner, owner, owner_len);
141 netsnmp_tdata_row_add_index(row, ASN_OCTET_STR,
142 entry->mteOwner, owner_len);
143 if (oname)
144 memcpy(entry->mteOName, oname, oname_len);
145 netsnmp_tdata_row_add_index(row, ASN_OCTET_STR,
146 entry->mteOName, oname_len);
147 entry->mteOIndex = index;
148 netsnmp_tdata_row_add_index(row, ASN_INTEGER,
149 &entry->mteOIndex, sizeof(long));
150
151 entry->mteObjectID_len = 2; /* .0.0 */
152 if (flags & MTE_OBJECT_FLAG_FIXED)
153 entry->flags |= MTE_OBJECT_FLAG_FIXED;
154
155 /*
156 * Check whether there's already a row with the same indexes
157 * (XXX - relies on private internal data ???)
158 */
159 row2 = netsnmp_tdata_row_get_byoid(objects_table_data,
160 row->oid_index.oids,
161 row->oid_index.len);
162 if (row2) {
163 if (flags & MTE_OBJECT_FLAG_NEXT) {
164 /*
165 * If appropriate, keep incrementing the final
166 * index value until we find a free slot...
167 */
168 while (row2) {
169 row->oid_index.oids[row->oid_index.len]++;
170 row2 = netsnmp_tdata_row_get_byoid(objects_table_data,
171 row->oid_index.oids,
172 row->oid_index.len);
173 }
174 } else {
175 /*
176 * ... otherwise, this is an error.
177 * Tidy up, and return failure.
178 */
179 netsnmp_tdata_delete_row(row);
180 SNMP_FREE(entry);
181 return NULL;
182 }
183 }
184
185 /*
186 * ... finally, insert the row into the (common) table container
187 */
188 netsnmp_tdata_add_row(objects_table_data, row);
189 return row;
190 }
191
192
193 /*
194 * Add a row to the object table
195 */
196 struct mteObject *
197 mteObjects_addOID(const char *owner, const char *oname, int index,
198 const char *oid_name_buf, int wild )
199 {
200 netsnmp_tdata_row *row;
201 struct mteObject *entry;
202 oid name_buf[ MAX_OID_LEN ];
203 size_t name_buf_len;
204
205 name_buf_len = MAX_OID_LEN;
206 if (!snmp_parse_oid(oid_name_buf, name_buf, &name_buf_len)) {
207 snmp_log(LOG_ERR, "payload OID: %s\n", oid_name_buf);
208 config_perror("unknown payload OID");
209 return NULL;
210 }
211
212 row = mteObjects_createEntry(owner, oname, index,
213 MTE_OBJECT_FLAG_FIXED|MTE_OBJECT_FLAG_NEXT);
214 entry = (struct mteObject *)row->data;
215
216 entry->mteObjectID_len = name_buf_len;
217 memcpy(entry->mteObjectID, name_buf, name_buf_len*sizeof(oid));
218 if (wild)
219 entry->flags |= MTE_OBJECT_FLAG_WILD;
220 entry->flags |= MTE_OBJECT_FLAG_VALID|
221 MTE_OBJECT_FLAG_ACTIVE;
222
223 return entry;
224 }
225
226
227 /*
228 * Remove a row from the event table
229 */
230 void
231 mteObjects_removeEntry(netsnmp_tdata_row *row)
232 {
233 struct mteObject *entry;
234
235 if (!row)
236 return; /* Nothing to remove */
237 entry = (struct mteObject *)
238 netsnmp_tdata_remove_and_delete_row(objects_table_data, row);
239 SNMP_FREE(entry);
240 }
241
242
243 /*
244 * Remove all matching rows from the event table
245 */
246 void
247 mteObjects_removeEntries( const char *owner, char *oname )
248 {
249 netsnmp_tdata_row *row;
250 netsnmp_variable_list owner_var, oname_var;
251
252 memset(&owner_var, 0, sizeof(owner_var));
253 memset(&oname_var, 0, sizeof(oname_var));
254 snmp_set_var_typed_value( &owner_var, ASN_OCTET_STR,
255 owner, strlen(owner));
256 snmp_set_var_typed_value( &oname_var, ASN_OCTET_STR,
257 oname, strlen(oname));
258 owner_var.next_variable = &oname_var;
259
260 row = netsnmp_tdata_row_next_byidx( objects_table_data, &owner_var );
261
262 while (row && !netsnmp_tdata_compare_subtree_idx( row, &owner_var )) {
263 mteObjects_removeEntry(row);
264 row = netsnmp_tdata_row_next_byidx( objects_table_data, &owner_var );
265 }
266 return;
267 }
268
269
270 /* ===================================================
271 *
272 * API for retrieving a list of matching objects
273 *
274 * =================================================== */
275
276 int
277 mteObjects_vblist( netsnmp_variable_list *vblist,
278 char *owner, char *oname,
279 oid *suffix, size_t sfx_len )
280 {
281 netsnmp_tdata_row *row;
282 struct mteObject *entry;
283 netsnmp_variable_list owner_var, oname_var;
284 netsnmp_variable_list *var = vblist;
285 oid name[MAX_OID_LEN];
286 size_t name_len;
287
288 if (!oname || !*oname) {
289 DEBUGMSGTL(("disman:event:objects", "No objects to add (%s)\n",
290 owner));
291 return 1; /* Empty object name means nothing to add */
292 }
293
294 DEBUGMSGTL(("disman:event:objects", "Objects add (%s, %s)\n",
295 owner, oname ));
296
297 /*
298 * Retrieve any matching entries from the mteObjectTable
299 * and add them to the specified varbind list.
300 */
301 memset(&owner_var, 0, sizeof(owner_var));
302 memset(&oname_var, 0, sizeof(oname_var));
303 snmp_set_var_typed_value( &owner_var, ASN_OCTET_STR,
304 owner, strlen(owner));
305 snmp_set_var_typed_value( &oname_var, ASN_OCTET_STR,
306 oname, strlen(oname));
307 owner_var.next_variable = &oname_var;
308
309 row = netsnmp_tdata_row_next_byidx( objects_table_data, &owner_var );
310
311 while (row && !netsnmp_tdata_compare_subtree_idx( row, &owner_var )) {
312 entry = (struct mteObject *)netsnmp_tdata_row_entry(row);
313
314 memset(name, 0, sizeof(name));
315 memcpy(name, entry->mteObjectID,
316 entry->mteObjectID_len*sizeof(oid));
317 name_len = entry->mteObjectID_len;
318
319 /*
320 * If the trigger value is wildcarded (sfx_len > 0),
321 * *and* this object entry is wildcarded,
322 * then add the supplied instance suffix.
323 * Otherwise use the Object OID as it stands.
324 */
325 if (sfx_len &&
326 entry->flags & MTE_OBJECT_FLAG_WILD) {
327 memcpy(&name[name_len], suffix, sfx_len*sizeof(oid));
328 name_len += sfx_len;
329 }
330 snmp_varlist_add_variable( &var, name, name_len, ASN_NULL, NULL, 0);
331
332 row = netsnmp_tdata_row_next( objects_table_data, row );
333 }
334 return 0;
335 }
336
337
338 int
339 mteObjects_internal_vblist( netsnmp_variable_list *vblist,
340 char *oname,
341 struct mteTrigger *trigger,
342 netsnmp_session *sess)
343 {
344 netsnmp_variable_list *var = NULL, *vp;
345 oid mteHotTrigger[] = {1, 3, 6, 1, 2, 1, 88, 2, 1, 1, 0};
346 oid mteHotTarget[] = {1, 3, 6, 1, 2, 1, 88, 2, 1, 2, 0};
347 oid mteHotContext[] = {1, 3, 6, 1, 2, 1, 88, 2, 1, 3, 0};
348 oid mteHotOID[] = {1, 3, 6, 1, 2, 1, 88, 2, 1, 4, 0};
349 oid mteHotValue[] = {1, 3, 6, 1, 2, 1, 88, 2, 1, 5, 0};
350
351 oid ifIndexOid[] = {1, 3, 6, 1, 2, 1, 2, 2, 1, 1, 0};
352 oid ifAdminStatus[] = {1, 3, 6, 1, 2, 1, 2, 2, 1, 7, 0};
353 oid ifOperStatus[] = {1, 3, 6, 1, 2, 1, 2, 2, 1, 8, 0};
354
355 oid if_index;
356
357 /*
358 * Construct the varbinds for this (internal) event...
359 */
360 if (!strcmp(oname, "_triggerFire")) {
361
362 snmp_varlist_add_variable( &var,
363 mteHotTrigger, OID_LENGTH(mteHotTrigger),
364 ASN_OCTET_STR, trigger->mteTName,
365 strlen(trigger->mteTName));
366 snmp_varlist_add_variable( &var,
367 mteHotTarget, OID_LENGTH(mteHotTarget),
368 ASN_OCTET_STR, trigger->mteTriggerTarget,
369 strlen(trigger->mteTriggerTarget));
370 snmp_varlist_add_variable( &var,
371 mteHotContext, OID_LENGTH(mteHotContext),
372 ASN_OCTET_STR, trigger->mteTriggerContext,
373 strlen(trigger->mteTriggerContext));
374 snmp_varlist_add_variable( &var,
375 mteHotOID, OID_LENGTH(mteHotOID),
376 ASN_OBJECT_ID, (char *)trigger->mteTriggerFired->name,
377 trigger->mteTriggerFired->name_length*sizeof(oid));
378 snmp_varlist_add_variable( &var,
379 mteHotValue, OID_LENGTH(mteHotValue),
380 trigger->mteTriggerFired->type,
381 trigger->mteTriggerFired->val.string,
382 trigger->mteTriggerFired->val_len);
383 } else if ((!strcmp(oname, "_linkUpDown" ))) {
384 /*
385 * The ifOperStatus varbind that triggered this entry
386 * is held in the trigger->mteTriggerFired field
387 *
388 * We can retrieve the ifIndex and ifOperStatus values
389 * from this varbind. But first we need to tweak the
390 * static ifXXX OID arrays to include the correct index.
391 * (or this could be passed in from the calling routine?)
392 *
393 * Unfortunately we don't have the current AdminStatus value,
394 * so we'll need to make another query to retrieve that.
395 */
396 if_index = trigger->mteTriggerFired->name[10];
397 ifIndexOid[ 10 ] = if_index;
398 ifAdminStatus[ 10 ] = if_index;
399 ifOperStatus[ 10 ] = if_index;
400 snmp_varlist_add_variable( &var,
401 ifIndexOid, OID_LENGTH(ifIndexOid),
402 ASN_INTEGER, &if_index, sizeof(if_index));
403
404 /* Set up a dummy varbind for ifAdminStatus... */
405 snmp_varlist_add_variable( &var,
406 ifAdminStatus, OID_LENGTH(ifAdminStatus),
407 ASN_INTEGER,
408 trigger->mteTriggerFired->val.integer,
409 trigger->mteTriggerFired->val_len);
410 /* ... then retrieve the actual value */
411 netsnmp_query_get( var->next_variable, sess );
412
413 snmp_varlist_add_variable( &var,
414 ifOperStatus, OID_LENGTH(ifOperStatus),
415 ASN_INTEGER,
416 trigger->mteTriggerFired->val.integer,
417 trigger->mteTriggerFired->val_len);
418 } else {
419 DEBUGMSGTL(("disman:event:objects",
420 "Unknown internal objects tag (%s)\n", oname));
421 return 1;
422 }
423
424 /*
425 * ... and insert them into the main varbind list
426 * (at the point specified)
427 */
428 for (vp = var; vp && vp->next_variable; vp=vp->next_variable)
429 ;
430 vp->next_variable = vblist->next_variable;
431 vblist->next_variable = var;
432 return 0;
433 }