]> git.proxmox.com Git - mirror_frr.git/blame - lib/agentx.c
*: move CLI node names to cmd_node->name
[mirror_frr.git] / lib / agentx.c
CommitLineData
d6be5fb9
VB
1/* SNMP support
2 * Copyright (C) 2012 Vincent Bernat <bernat@luffy.cx>
3 *
4 * This file is part of GNU Zebra.
5 *
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
9 * later version.
10 *
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
896014f4
DL
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
d6be5fb9
VB
19 */
20
21#include <zebra.h>
22
5986b66b 23#ifdef SNMP_AGENTX
d6be5fb9
VB
24#include <net-snmp/net-snmp-config.h>
25#include <net-snmp/net-snmp-includes.h>
56e2c5e8
DL
26#include <net-snmp/agent/net-snmp-agent-includes.h>
27#include <net-snmp/agent/snmp_vars.h>
d6be5fb9
VB
28
29#include "command.h"
30#include "smux.h"
d11f748b 31#include "memory.h"
56e2c5e8 32#include "linklist.h"
ae435b19 33#include "version.h"
220d7368 34#include "lib_errors.h"
d6be5fb9 35
56e2c5e8
DL
36static int agentx_enabled = 0;
37
38static struct thread_master *agentx_tm;
39static struct thread *timeout_thr = NULL;
40static struct list *events = NULL;
41
42static void agentx_events_update(void);
43
d62a17ae 44static int agentx_timeout(struct thread *t)
56e2c5e8 45{
d62a17ae 46 timeout_thr = NULL;
56e2c5e8 47
d62a17ae 48 snmp_timeout();
49 run_alarms();
50 netsnmp_check_outstanding_agent_requests();
51 agentx_events_update();
52 return 0;
56e2c5e8
DL
53}
54
d62a17ae 55static int agentx_read(struct thread *t)
56e2c5e8 56{
d62a17ae 57 fd_set fds;
19d95d40 58 int flags, new_flags = 0;
3b717261 59 int nonblock = false;
d62a17ae 60 struct listnode *ln = THREAD_ARG(t);
61 list_delete_node(events, ln);
56e2c5e8 62
3b717261 63 /* fix for non blocking socket */
64 flags = fcntl(THREAD_FD(t), F_GETFL, 0);
19d95d40
DS
65 if (-1 == flags) {
66 flog_err(EC_LIB_SYSTEM_CALL, "Failed to get FD settings fcntl: %s(%d)",
67 strerror(errno), errno);
3b717261 68 return -1;
19d95d40 69 }
3b717261 70
71 if (flags & O_NONBLOCK)
72 nonblock = true;
73 else
19d95d40
DS
74 new_flags = fcntl(THREAD_FD(t), F_SETFL, flags | O_NONBLOCK);
75
76 if (new_flags == -1)
77 flog_err(EC_LIB_SYSTEM_CALL, "Failed to set snmp fd non blocking: %s(%d)",
78 strerror(errno), errno);
3b717261 79
d62a17ae 80 FD_ZERO(&fds);
81 FD_SET(THREAD_FD(t), &fds);
82 snmp_read(&fds);
56e2c5e8 83
3b717261 84 /* Reset the flag */
19d95d40
DS
85 if (!nonblock) {
86 new_flags = fcntl(THREAD_FD(t), F_SETFL, flags);
87
88 if (new_flags == -1)
89 flog_err(
90 EC_LIB_SYSTEM_CALL,
91 "Failed to set snmp fd back to original settings: %s(%d)",
92 strerror(errno), errno);
93 }
3b717261 94
d62a17ae 95 netsnmp_check_outstanding_agent_requests();
96 agentx_events_update();
97 return 0;
56e2c5e8
DL
98}
99
d62a17ae 100static void agentx_events_update(void)
56e2c5e8 101{
d62a17ae 102 int maxfd = 0;
103 int block = 1;
104 struct timeval timeout = {.tv_sec = 0, .tv_usec = 0};
105 fd_set fds;
106 struct listnode *ln;
107 struct thread *thr;
108 int fd, thr_fd;
109
110 THREAD_OFF(timeout_thr);
111
112 FD_ZERO(&fds);
113 snmp_select_info(&maxfd, &fds, &timeout, &block);
114
115 if (!block) {
116 timeout_thr = NULL;
117 thread_add_timer_tv(agentx_tm, agentx_timeout, NULL, &timeout,
118 &timeout_thr);
119 }
120
121 ln = listhead(events);
122 thr = ln ? listgetdata(ln) : NULL;
123 thr_fd = thr ? THREAD_FD(thr) : -1;
124
125 /* "two-pointer" / two-list simultaneous iteration
126 * ln/thr/thr_fd point to the next existing event listener to hit while
127 * fd counts to catch up */
128 for (fd = 0; fd < maxfd; fd++) {
129 /* caught up */
130 if (thr_fd == fd) {
131 struct listnode *nextln = listnextnode(ln);
132 if (!FD_ISSET(fd, &fds)) {
133 thread_cancel(thr);
134 list_delete_node(events, ln);
135 }
136 ln = nextln;
137 thr = ln ? listgetdata(ln) : NULL;
138 thr_fd = thr ? THREAD_FD(thr) : -1;
139 }
140 /* need listener, but haven't hit one where it would be */
141 else if (FD_ISSET(fd, &fds)) {
142 struct listnode *newln;
143 thr = NULL;
144 thread_add_read(agentx_tm, agentx_read, NULL, fd, &thr);
145 newln = listnode_add_before(events, ln, thr);
146 thr->arg = newln;
147 }
148 }
149
150 /* leftover event listeners at this point have fd > maxfd, delete them
151 */
152 while (ln) {
153 struct listnode *nextln = listnextnode(ln);
154 thread_cancel(listgetdata(ln));
155 list_delete_node(events, ln);
156 ln = nextln;
157 }
56e2c5e8 158}
d6be5fb9
VB
159
160/* AgentX node. */
612c2c15 161static int config_write_agentx(struct vty *vty);
62b346ee 162static struct cmd_node agentx_node = {
f4b8291f 163 .name = "smux",
62b346ee
DL
164 .node = SMUX_NODE,
165 .prompt = "",
612c2c15 166 .config_write = config_write_agentx,
62b346ee 167};
d6be5fb9
VB
168
169/* Logging NetSNMP messages */
d62a17ae 170static int agentx_log_callback(int major, int minor, void *serverarg,
171 void *clientarg)
d6be5fb9 172{
d62a17ae 173 struct snmp_log_message *slm = (struct snmp_log_message *)serverarg;
174 char *msg = XSTRDUP(MTYPE_TMP, slm->msg);
175 if (msg)
176 msg[strlen(msg) - 1] = '\0';
177 switch (slm->priority) {
178 case LOG_EMERG:
1c50c1c0 179 flog_err(EC_LIB_SNMP, "snmp[emerg]: %s", msg ? msg : slm->msg);
d62a17ae 180 break;
181 case LOG_ALERT:
1c50c1c0 182 flog_err(EC_LIB_SNMP, "snmp[alert]: %s", msg ? msg : slm->msg);
d62a17ae 183 break;
184 case LOG_CRIT:
1c50c1c0 185 flog_err(EC_LIB_SNMP, "snmp[crit]: %s", msg ? msg : slm->msg);
d62a17ae 186 break;
187 case LOG_ERR:
1c50c1c0 188 flog_err(EC_LIB_SNMP, "snmp[err]: %s", msg ? msg : slm->msg);
d62a17ae 189 break;
190 case LOG_WARNING:
450971aa 191 flog_warn(EC_LIB_SNMP, "snmp[warning]: %s",
ade6974d 192 msg ? msg : slm->msg);
d62a17ae 193 break;
194 case LOG_NOTICE:
195 zlog_notice("snmp[notice]: %s", msg ? msg : slm->msg);
196 break;
197 case LOG_INFO:
198 zlog_info("snmp[info]: %s", msg ? msg : slm->msg);
199 break;
200 case LOG_DEBUG:
201 zlog_debug("snmp[debug]: %s", msg ? msg : slm->msg);
202 break;
203 }
204 XFREE(MTYPE_TMP, msg);
205 return SNMP_ERR_NOERROR;
d6be5fb9
VB
206}
207
d62a17ae 208static int config_write_agentx(struct vty *vty)
d6be5fb9 209{
d62a17ae 210 if (agentx_enabled)
211 vty_out(vty, "agentx\n");
212 return 1;
d6be5fb9
VB
213}
214
215DEFUN (agentx_enable,
216 agentx_enable_cmd,
217 "agentx",
007b0667 218 "SNMP AgentX protocol settings\n")
d6be5fb9 219{
d62a17ae 220 if (!agentx_enabled) {
221 init_snmp(FRR_SMUX_NAME);
222 events = list_new();
223 agentx_events_update();
224 agentx_enabled = 1;
d62a17ae 225 }
5fedee18 226
d62a17ae 227 return CMD_SUCCESS;
d6be5fb9
VB
228}
229
230DEFUN (no_agentx,
231 no_agentx_cmd,
232 "no agentx",
233 NO_STR
007b0667 234 "SNMP AgentX protocol settings\n")
d6be5fb9 235{
d62a17ae 236 if (!agentx_enabled)
237 return CMD_SUCCESS;
238 vty_out(vty, "SNMP AgentX support cannot be disabled once enabled\n");
239 return CMD_WARNING_CONFIG_FAILED;
d6be5fb9
VB
240}
241
d62a17ae 242void smux_init(struct thread_master *tm)
d6be5fb9 243{
d62a17ae 244 agentx_tm = tm;
245
246 netsnmp_enable_subagent();
247 snmp_disable_log();
248 snmp_enable_calllog();
249 snmp_register_callback(SNMP_CALLBACK_LIBRARY, SNMP_CALLBACK_LOGGING,
250 agentx_log_callback, NULL);
251 init_agent(FRR_SMUX_NAME);
252
612c2c15 253 install_node(&agentx_node);
d62a17ae 254 install_element(CONFIG_NODE, &agentx_enable_cmd);
255 install_element(CONFIG_NODE, &no_agentx_cmd);
d6be5fb9
VB
256}
257
d62a17ae 258void smux_register_mib(const char *descr, struct variable *var, size_t width,
259 int num, oid name[], size_t namelen)
d6be5fb9 260{
d62a17ae 261 register_mib(descr, var, width, num, name, namelen);
d6be5fb9
VB
262}
263
d62a17ae 264int smux_trap(struct variable *vp, size_t vp_len, const oid *ename,
265 size_t enamelen, const oid *name, size_t namelen,
266 const oid *iname, size_t inamelen,
267 const struct trap_object *trapobj, size_t trapobjlen,
d7c0a89a 268 uint8_t sptrap)
d6be5fb9 269{
d62a17ae 270 oid objid_snmptrap[] = {1, 3, 6, 1, 6, 3, 1, 1, 4, 1, 0};
0d6f7fd6 271 size_t objid_snmptrap_len = sizeof(objid_snmptrap) / sizeof(oid);
d62a17ae 272 oid notification_oid[MAX_OID_LEN];
273 size_t notification_oid_len;
274 unsigned int i;
275
276 netsnmp_variable_list *notification_vars = NULL;
277 if (!agentx_enabled)
278 return 0;
279
280 /* snmpTrapOID */
281 oid_copy(notification_oid, ename, enamelen);
282 notification_oid[enamelen] = sptrap;
283 notification_oid_len = enamelen + 1;
284 snmp_varlist_add_variable(&notification_vars, objid_snmptrap,
285 objid_snmptrap_len, ASN_OBJECT_ID,
d7c0a89a 286 (uint8_t *)notification_oid,
d62a17ae 287 notification_oid_len * sizeof(oid));
288
289 /* Provided bindings */
290 for (i = 0; i < trapobjlen; i++) {
291 unsigned int j;
292 oid oid[MAX_OID_LEN];
293 size_t oid_len, onamelen;
d7c0a89a 294 uint8_t *val;
d62a17ae 295 size_t val_len;
296 WriteMethod *wm = NULL;
297 struct variable cvp;
298
299 /* Make OID. */
300 if (trapobj[i].namelen > 0) {
301 /* Columnar object */
302 onamelen = trapobj[i].namelen;
303 oid_copy(oid, name, namelen);
304 oid_copy(oid + namelen, trapobj[i].name, onamelen);
305 oid_copy(oid + namelen + onamelen, iname, inamelen);
306 oid_len = namelen + onamelen + inamelen;
307 } else {
308 /* Scalar object */
309 onamelen = trapobj[i].namelen * (-1);
310 oid_copy(oid, name, namelen);
311 oid_copy(oid + namelen, trapobj[i].name, onamelen);
312 oid[onamelen + namelen] = 0;
313 oid_len = namelen + onamelen + 1;
314 }
315
316 /* Locate the appropriate function and type in the MIB registry.
317 */
318 for (j = 0; j < vp_len; j++) {
319 if (oid_compare(trapobj[i].name, onamelen, vp[j].name,
320 vp[j].namelen)
321 != 0)
322 continue;
323 /* We found the appropriate variable in the MIB
324 * registry. */
325 oid_copy(cvp.name, name, namelen);
326 oid_copy(cvp.name + namelen, vp[j].name, vp[j].namelen);
327 cvp.namelen = namelen + vp[j].namelen;
328 cvp.type = vp[j].type;
329 cvp.magic = vp[j].magic;
330 cvp.acl = vp[j].acl;
331 cvp.findVar = vp[j].findVar;
332 /* Grab the result. */
333 val = cvp.findVar(&cvp, oid, &oid_len, 1, &val_len,
334 &wm);
335 if (!val)
336 break;
337 snmp_varlist_add_variable(&notification_vars, oid,
338 oid_len, vp[j].type, val,
339 val_len);
340 break;
341 }
b7c0d065 342 }
b7c0d065
VB
343
344
d62a17ae 345 send_v2trap(notification_vars);
346 snmp_free_varbind(notification_vars);
347 agentx_events_update();
348 return 1;
d6be5fb9
VB
349}
350
5986b66b 351#endif /* SNMP_AGENTX */