1154133Sharti/*- 2154133Sharti * Copyright (c) 2005-2006 The FreeBSD Project 3154133Sharti * All rights reserved. 4154133Sharti * 5154133Sharti * Author: Victor Cruceru <soc-victor@freebsd.org> 6154133Sharti * 7154133Sharti * Redistribution of this software and documentation and use in source and 8154133Sharti * binary forms, with or without modification, are permitted provided that 9154133Sharti * the following conditions are met: 10154133Sharti * 11154133Sharti * 1. Redistributions of source code or documentation must retain the above 12154133Sharti * copyright notice, this list of conditions and the following disclaimer. 13154133Sharti * 2. Redistributions in binary form must reproduce the above copyright 14154133Sharti * notice, this list of conditions and the following disclaimer in the 15154133Sharti * documentation and/or other materials provided with the distribution. 16154133Sharti * 17154133Sharti * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18154133Sharti * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19154133Sharti * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20154133Sharti * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21154133Sharti * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22154133Sharti * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23154133Sharti * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24154133Sharti * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25154133Sharti * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26154133Sharti * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27154133Sharti * SUCH DAMAGE. 28154133Sharti * 29154133Sharti * $FreeBSD$ 30154133Sharti */ 31154133Sharti 32154133Sharti/* 33154133Sharti * Host Resources MIB implementation for SNMPd: instrumentation for 34154133Sharti * hrNetworkTable 35154133Sharti */ 36154133Sharti 37154133Sharti#include <sys/types.h> 38154133Sharti#include <sys/ioctl.h> 39154133Sharti#include <sys/socket.h> 40154133Sharti#include <sys/sysctl.h> 41154133Sharti 42154133Sharti#include <net/if.h> 43154133Sharti#include <net/if_mib.h> 44154133Sharti 45154133Sharti#include <assert.h> 46154133Sharti#include <ctype.h> 47154133Sharti#include <err.h> 48154133Sharti#include <errno.h> 49154133Sharti#include <ifaddrs.h> 50154133Sharti#include <stdarg.h> 51154133Sharti#include <stdlib.h> 52154133Sharti#include <string.h> 53154133Sharti#include <syslog.h> 54154133Sharti#include <unistd.h> 55154133Sharti 56154133Sharti#include "hostres_snmp.h" 57154133Sharti#include "hostres_oid.h" 58154133Sharti#include "hostres_tree.h" 59154133Sharti 60154133Sharti#include <bsnmp/snmp_mibII.h> 61154133Sharti 62154133Sharti/* 63154133Sharti * This structure is used to hold a SNMP table entry 64154133Sharti * for HOST-RESOURCES-MIB's hrNetworkTable 65154133Sharti */ 66154133Shartistruct network_entry { 67154133Sharti int32_t index; 68154133Sharti int32_t ifIndex; 69154133Sharti TAILQ_ENTRY(network_entry) link; 70160341Sharti#define HR_NETWORK_FOUND 0x001 71154133Sharti uint32_t flags; 72154133Sharti 73154133Sharti}; 74154133ShartiTAILQ_HEAD(network_tbl, network_entry); 75154133Sharti 76154133Sharti/* the head of the list with hrNetworkTable's entries */ 77154133Shartistatic struct network_tbl network_tbl = TAILQ_HEAD_INITIALIZER(network_tbl); 78154133Sharti 79154133Sharti/* last (agent) tick when hrNetworkTable was updated */ 80154133Shartistatic uint64_t network_tick; 81154133Sharti 82154133Sharti/* maximum number of ticks between updates of network table */ 83154133Shartiuint32_t network_tbl_refresh = HR_NETWORK_TBL_REFRESH * 100; 84154133Sharti 85154133Sharti/* Constants */ 86154133Shartistatic const struct asn_oid OIDX_hrDeviceNetwork_c = OIDX_hrDeviceNetwork; 87154133Sharti 88154133Sharti/** 89154133Sharti * Create a new entry into the network table 90154133Sharti */ 91154133Shartistatic struct network_entry * 92154133Shartinetwork_entry_create(const struct device_entry *devEntry) 93154133Sharti{ 94154133Sharti struct network_entry *entry; 95154133Sharti 96154133Sharti assert(devEntry != NULL); 97154133Sharti if (devEntry == NULL) 98154133Sharti return (NULL); 99154133Sharti 100154133Sharti if ((entry = malloc(sizeof(*entry))) == NULL) { 101154133Sharti syslog(LOG_WARNING, "%s: %m", __func__); 102154133Sharti return (NULL); 103154133Sharti } 104154133Sharti 105154133Sharti memset(entry, 0, sizeof(*entry)); 106154133Sharti entry->index = devEntry->index; 107154133Sharti INSERT_OBJECT_INT(entry, &network_tbl); 108154133Sharti 109154133Sharti return (entry); 110154133Sharti} 111154133Sharti 112154133Sharti/** 113154133Sharti * Delete an entry in the network table 114154133Sharti */ 115154133Shartistatic void 116154133Shartinetwork_entry_delete(struct network_entry* entry) 117154133Sharti{ 118154133Sharti 119154133Sharti TAILQ_REMOVE(&network_tbl, entry, link); 120154133Sharti free(entry); 121154133Sharti} 122154133Sharti 123154133Sharti/** 124154133Sharti * Fetch the interfaces from the mibII module, get their real name from the 125154133Sharti * kernel and try to find it in the device table. 126154133Sharti */ 127154133Shartistatic void 128154133Shartinetwork_get_interfaces(void) 129154133Sharti{ 130154133Sharti struct device_entry *dev; 131154133Sharti struct network_entry *net; 132154133Sharti struct mibif *ifp; 133154133Sharti int name[6]; 134154133Sharti size_t len; 135154133Sharti char *dname; 136154133Sharti 137154133Sharti name[0] = CTL_NET; 138154133Sharti name[1] = PF_LINK; 139154133Sharti name[2] = NETLINK_GENERIC; 140154133Sharti name[3] = IFMIB_IFDATA; 141154133Sharti name[5] = IFDATA_DRIVERNAME; 142154133Sharti 143154133Sharti for (ifp = mib_first_if(); ifp != NULL; ifp = mib_next_if(ifp)) { 144154133Sharti HRDBG("%s %s", ifp->name, ifp->descr); 145154133Sharti 146154133Sharti name[4] = ifp->sysindex; 147154133Sharti 148154133Sharti /* get the original name */ 149154133Sharti len = 0; 150154133Sharti if (sysctl(name, 6, NULL, &len, 0, 0) < 0) { 151154133Sharti syslog(LOG_ERR, "sysctl(net.link.ifdata.%d." 152154133Sharti "drivername): %m", ifp->sysindex); 153154133Sharti continue; 154154133Sharti } 155154133Sharti if ((dname = malloc(len)) == NULL) { 156154133Sharti syslog(LOG_ERR, "malloc: %m"); 157154133Sharti continue; 158154133Sharti } 159154133Sharti if (sysctl(name, 6, dname, &len, 0, 0) < 0) { 160154133Sharti syslog(LOG_ERR, "sysctl(net.link.ifdata.%d." 161154133Sharti "drivername): %m", ifp->sysindex); 162154133Sharti free(dname); 163154133Sharti continue; 164154133Sharti } 165154133Sharti 166154133Sharti HRDBG("got device %s (%s)", ifp->name, dname); 167154133Sharti 168154133Sharti if ((dev = device_find_by_name(dname)) == NULL) { 169154133Sharti HRDBG("%s not in hrDeviceTable", dname); 170154133Sharti free(dname); 171154133Sharti continue; 172154133Sharti } 173154133Sharti HRDBG("%s found in hrDeviceTable", dname); 174154133Sharti 175160341Sharti dev->type = &OIDX_hrDeviceNetwork_c; 176154133Sharti dev->flags |= HR_DEVICE_IMMUTABLE; 177154133Sharti 178154133Sharti free(dname); 179154133Sharti 180154133Sharti /* Then check hrNetworkTable for this device */ 181154133Sharti TAILQ_FOREACH(net, &network_tbl, link) 182154133Sharti if (net->index == dev->index) 183154133Sharti break; 184154133Sharti 185154133Sharti if (net == NULL && (net = network_entry_create(dev)) == NULL) 186154133Sharti continue; 187154133Sharti 188154133Sharti net->flags |= HR_NETWORK_FOUND; 189154133Sharti net->ifIndex = ifp->index; 190154133Sharti } 191154133Sharti 192154133Sharti network_tick = this_tick; 193154133Sharti} 194154133Sharti 195154133Sharti/** 196154133Sharti * Finalization routine for hrNetworkTable. 197154133Sharti * It destroys the lists and frees any allocated heap memory. 198154133Sharti */ 199154133Shartivoid 200154133Shartifini_network_tbl(void) 201154133Sharti{ 202154133Sharti struct network_entry *n1; 203154133Sharti 204154133Sharti while ((n1 = TAILQ_FIRST(&network_tbl)) != NULL) { 205154133Sharti TAILQ_REMOVE(&network_tbl, n1, link); 206154133Sharti free(n1); 207154133Sharti } 208154133Sharti} 209154133Sharti 210154133Sharti/** 211154133Sharti * Get the interface list from mibII only at this point to be sure that 212154133Sharti * it is there already. 213154133Sharti */ 214154133Shartivoid 215154133Shartistart_network_tbl(void) 216154133Sharti{ 217154133Sharti 218154133Sharti mib_refresh_iflist(); 219154133Sharti network_get_interfaces(); 220154133Sharti} 221154133Sharti 222154133Sharti/** 223154133Sharti * Refresh the table. 224154133Sharti */ 225154133Shartistatic void 226154133Shartirefresh_network_tbl(void) 227154133Sharti{ 228154133Sharti struct network_entry *entry, *entry_tmp; 229154133Sharti 230154133Sharti if (this_tick - network_tick < network_tbl_refresh) { 231154133Sharti HRDBG("no refresh needed"); 232154133Sharti return; 233154133Sharti } 234154133Sharti 235154133Sharti /* mark each entry as missing */ 236154133Sharti TAILQ_FOREACH(entry, &network_tbl, link) 237154133Sharti entry->flags &= ~HR_NETWORK_FOUND; 238154133Sharti 239154133Sharti network_get_interfaces(); 240154133Sharti 241154133Sharti /* 242154133Sharti * Purge items that disappeared 243154133Sharti */ 244154133Sharti TAILQ_FOREACH_SAFE(entry, &network_tbl, link, entry_tmp) { 245154133Sharti if (!(entry->flags & HR_NETWORK_FOUND)) 246154133Sharti network_entry_delete(entry); 247154133Sharti } 248154133Sharti 249154133Sharti HRDBG("refresh DONE"); 250154133Sharti} 251154133Sharti 252154133Sharti/* 253154133Sharti * This is the implementation for a generated (by our SNMP tool) 254154133Sharti * function prototype, see hostres_tree.h 255154133Sharti * It handles the SNMP operations for hrNetworkTable 256154133Sharti */ 257154133Shartiint 258154133Shartiop_hrNetworkTable(struct snmp_context *ctx __unused, struct snmp_value *value, 259154133Sharti u_int sub, u_int iidx __unused, enum snmp_op curr_op) 260154133Sharti{ 261154133Sharti struct network_entry *entry; 262154133Sharti 263154133Sharti refresh_network_tbl(); 264154133Sharti 265154133Sharti switch (curr_op) { 266154133Sharti 267154133Sharti case SNMP_OP_GETNEXT: 268154133Sharti if ((entry = NEXT_OBJECT_INT(&network_tbl, 269154133Sharti &value->var, sub)) == NULL) 270154133Sharti return (SNMP_ERR_NOSUCHNAME); 271154133Sharti value->var.len = sub + 1; 272154133Sharti value->var.subs[sub] = entry->index; 273154133Sharti goto get; 274154133Sharti 275154133Sharti case SNMP_OP_GET: 276154133Sharti if ((entry = FIND_OBJECT_INT(&network_tbl, 277154133Sharti &value->var, sub)) == NULL) 278154133Sharti return (SNMP_ERR_NOSUCHNAME); 279154133Sharti goto get; 280154133Sharti 281154133Sharti case SNMP_OP_SET: 282154133Sharti if ((entry = FIND_OBJECT_INT(&network_tbl, 283154133Sharti &value->var, sub)) == NULL) 284154133Sharti return (SNMP_ERR_NO_CREATION); 285154133Sharti return (SNMP_ERR_NOT_WRITEABLE); 286154133Sharti 287154133Sharti case SNMP_OP_ROLLBACK: 288154133Sharti case SNMP_OP_COMMIT: 289154133Sharti abort(); 290154133Sharti } 291154133Sharti abort(); 292154133Sharti 293154133Sharti get: 294154133Sharti switch (value->var.subs[sub - 1]) { 295154133Sharti 296154133Sharti case LEAF_hrNetworkIfIndex: 297154133Sharti value->v.integer = entry->ifIndex; 298154133Sharti return (SNMP_ERR_NOERROR); 299154133Sharti 300154133Sharti } 301154133Sharti abort(); 302154133Sharti} 303