NetBSD/sys/net/pfil.c
rmind f04a92b1d6 - Rewrite parts of pfil(9): use array to store hooks and thus be more cache
friendly (there are only few hooks in the system).  Make the structures
  opaque and the interface more strict.
- Remove PFIL_HOOKS option by making pfil(9) mandatory.
2013-06-29 21:06:57 +00:00

281 lines
6.5 KiB
C

/* $NetBSD: pfil.c,v 1.28 2013/06/29 21:06:58 rmind Exp $ */
/*
* Copyright (c) 2013 Mindaugas Rasiukevicius <rmind at NetBSD org>
* Copyright (c) 1996 Matthew R. Green
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: pfil.c,v 1.28 2013/06/29 21:06:58 rmind Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/queue.h>
#include <sys/kmem.h>
#include <net/if.h>
#include <net/pfil.h>
#define MAX_HOOKS 8
typedef struct {
pfil_func_t pfil_func;
void * pfil_arg;
} pfil_hook_t;
typedef struct {
pfil_hook_t hooks[MAX_HOOKS];
u_int nhooks;
} pfil_list_t;
struct pfil_head {
pfil_list_t ph_in;
pfil_list_t ph_out;
pfil_list_t ph_ifaddr;
pfil_list_t ph_ifevent;
int ph_type;
void * ph_key;
LIST_ENTRY(pfil_head) ph_list;
};
static const int pfil_flag_cases[] = {
PFIL_IN, PFIL_OUT, PFIL_IFADDR, PFIL_IFNET
};
static LIST_HEAD(, pfil_head) pfil_head_list __read_mostly =
LIST_HEAD_INITIALIZER(&pfil_head_list);
/*
* pfil_head_create: create and register a packet filter head.
*/
pfil_head_t *
pfil_head_create(int type, void *key)
{
pfil_head_t *ph;
if (pfil_head_get(type, key)) {
return NULL;
}
ph = kmem_zalloc(sizeof(pfil_head_t), KM_SLEEP);
ph->ph_type = type;
ph->ph_key = key;
LIST_INSERT_HEAD(&pfil_head_list, ph, ph_list);
return ph;
}
/*
* pfil_head_destroy: remove and destroy a packet filter head.
*/
void
pfil_head_destroy(pfil_head_t *pfh)
{
LIST_REMOVE(pfh, ph_list);
kmem_free(pfh, sizeof(pfil_head_t));
}
/*
* pfil_head_get: returns the packer filter head for a given key.
*/
pfil_head_t *
pfil_head_get(int type, void *key)
{
pfil_head_t *ph;
LIST_FOREACH(ph, &pfil_head_list, ph_list) {
if (ph->ph_type == type && ph->ph_key == key)
break;
}
return ph;
}
static pfil_list_t *
pfil_hook_get(int dir, pfil_head_t *ph)
{
switch (dir) {
case PFIL_IN:
return &ph->ph_in;
case PFIL_OUT:
return &ph->ph_out;
case PFIL_IFADDR:
return &ph->ph_ifaddr;
case PFIL_IFNET:
return &ph->ph_ifevent;
}
return NULL;
}
static int
pfil_list_add(pfil_list_t *phlist, pfil_func_t func, void *arg, int flags)
{
const u_int nhooks = phlist->nhooks;
pfil_hook_t *pfh;
/* Check if we have a free slot. */
if (nhooks == MAX_HOOKS) {
return ENOSPC;
}
KASSERT(nhooks < MAX_HOOKS);
/* Make sure the hook is not already added. */
for (u_int i = 0; i < nhooks; i++) {
pfh = &phlist->hooks[i];
if (pfh->pfil_func == func && pfh->pfil_arg == arg)
return EEXIST;
}
/*
* Finally, add the hook. Note: for PFIL_IN we insert the hooks in
* reverse order of the PFIL_OUT so that the same path is followed
* in or out of the kernel.
*/
if (flags & PFIL_IN) {
/* XXX: May want to revisit this later; */
size_t len = sizeof(pfil_hook_t) * nhooks;
pfh = &phlist->hooks[0];
memmove(&phlist->hooks[1], pfh, len);
} else {
pfh = &phlist->hooks[nhooks];
}
phlist->nhooks++;
pfh->pfil_func = func;
pfh->pfil_arg = arg;
return 0;
}
/*
* pfil_add_hook: add a function (hook) to the packet filter head.
* The possible flags are:
*
* PFIL_IN call on incoming packets
* PFIL_OUT call on outgoing packets
* PFIL_ALL call on all of the above
* PFIL_IFADDR call on interface reconfig (mbuf is ioctl #)
* PFIL_IFNET call on interface attach/detach (mbuf is PFIL_IFNET_*)
*/
int
pfil_add_hook(pfil_func_t func, void *arg, int flags, pfil_head_t *ph)
{
int error = 0;
KASSERT(func != NULL);
for (u_int i = 0; i < __arraycount(pfil_flag_cases); i++) {
const int fcase = pfil_flag_cases[i];
pfil_list_t *phlist;
if ((flags & fcase) == 0) {
continue;
}
phlist = pfil_hook_get(fcase, ph);
if ((error = pfil_list_add(phlist, func, arg, flags)) != 0) {
break;
}
}
if (error) {
pfil_remove_hook(func, arg, flags, ph);
}
return error;
}
/*
* pfil_list_remove: remove the hook from a specified list.
*/
static int
pfil_list_remove(pfil_list_t *phlist, pfil_func_t func, void *arg)
{
const u_int nhooks = phlist->nhooks;
for (u_int i = 0; i < nhooks; i++) {
pfil_hook_t *last, *pfh = &phlist->hooks[i];
if (pfh->pfil_func != func || pfh->pfil_arg != arg) {
continue;
}
if ((last = &phlist->hooks[nhooks - 1]) != pfh) {
memcpy(pfh, last, sizeof(pfil_hook_t));
}
phlist->nhooks--;
return 0;
}
return ENOENT;
}
/*
* pfil_remove_hook: remove the hook from the packet filter head.
*/
int
pfil_remove_hook(pfil_func_t func, void *arg, int flags, pfil_head_t *ph)
{
for (u_int i = 0; i < __arraycount(pfil_flag_cases); i++) {
const int fcase = pfil_flag_cases[i];
pfil_list_t *pflist;
if ((flags & fcase) == 0) {
continue;
}
pflist = pfil_hook_get(fcase, ph);
(void)pfil_list_remove(pflist, func, arg);
}
return 0;
}
/*
* pfil_run_hooks: run the specified packet filter hooks.
*/
int
pfil_run_hooks(pfil_head_t *ph, struct mbuf **mp, ifnet_t *ifp, int dir)
{
const bool pass_mbuf = (dir & PFIL_ALL) != 0 && mp;
struct mbuf *m = pass_mbuf ? *mp : NULL;
pfil_list_t *phlist;
int ret = 0;
if ((phlist = pfil_hook_get(dir, ph)) == NULL) {
return ret;
}
for (u_int i = 0; i < phlist->nhooks; i++) {
pfil_hook_t *pfh = &phlist->hooks[i];
pfil_func_t func = pfh->pfil_func;
if (__predict_true(dir & PFIL_ALL)) {
ret = (*func)(pfh->pfil_arg, &m, ifp, dir);
if (m == NULL)
break;
} else {
ret = (*func)(pfh->pfil_arg, mp, ifp, dir);
}
if (ret)
break;
}
if (pass_mbuf) {
*mp = m;
}
return ret;
}