1/* $FreeBSD: stable/11/sys/net/pfil.h 332513 2018-04-15 15:22:28Z kp $ */ 2/* $NetBSD: pfil.h,v 1.22 2003/06/23 12:57:08 martin Exp $ */ 3 4/*- 5 * Copyright (c) 1996 Matthew R. Green 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. The name of the author may not be used to endorse or promote products 17 * derived from this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32#ifndef _NET_PFIL_H_ 33#define _NET_PFIL_H_ 34 35#include <sys/systm.h> 36#include <sys/queue.h> 37#include <sys/_lock.h> 38#include <sys/_mutex.h> 39#include <sys/lock.h> 40#include <sys/rmlock.h> 41#include <net/vnet.h> 42 43struct mbuf; 44struct ifnet; 45struct inpcb; 46 47typedef int (*pfil_func_t)(void *, struct mbuf **, struct ifnet *, int, 48 struct inpcb *); 49typedef int (*pfil_func_flags_t)(void *, struct mbuf **, struct ifnet *, 50 int, int, struct inpcb *); 51 52/* 53 * The packet filter hooks are designed for anything to call them to 54 * possibly intercept the packet. Multiple filter hooks are chained 55 * together and after each other in the specified order. 56 */ 57struct packet_filter_hook { 58 TAILQ_ENTRY(packet_filter_hook) pfil_chain; 59 pfil_func_t pfil_func; 60 pfil_func_flags_t pfil_func_flags; 61 void *pfil_arg; 62}; 63 64#define PFIL_IN 0x00000001 65#define PFIL_OUT 0x00000002 66#define PFIL_WAITOK 0x00000004 67#define PFIL_FWD 0x00000008 68#define PFIL_ALL (PFIL_IN|PFIL_OUT) 69 70typedef TAILQ_HEAD(pfil_chain, packet_filter_hook) pfil_chain_t; 71 72#define PFIL_TYPE_AF 1 /* key is AF_* type */ 73#define PFIL_TYPE_IFNET 2 /* key is ifnet pointer */ 74 75#define PFIL_FLAG_PRIVATE_LOCK 0x01 /* Personal lock instead of global */ 76 77/* 78 * A pfil head is created by each protocol or packet intercept point. 79 * For packet is then run through the hook chain for inspection. 80 */ 81struct pfil_head { 82 pfil_chain_t ph_in; 83 pfil_chain_t ph_out; 84 int ph_type; 85 int ph_nhooks; 86#if defined( __linux__ ) || defined( _WIN32 ) 87 rwlock_t ph_mtx; 88#else 89 struct rmlock *ph_plock; /* Pointer to the used lock */ 90 struct rmlock ph_lock; /* Private lock storage */ 91 int flags; 92#endif 93 union { 94 u_long phu_val; 95 void *phu_ptr; 96 } ph_un; 97#define ph_af ph_un.phu_val 98#define ph_ifnet ph_un.phu_ptr 99 LIST_ENTRY(pfil_head) ph_list; 100}; 101 102VNET_DECLARE(struct rmlock, pfil_lock); 103#define V_pfil_lock VNET(pfil_lock) 104 105/* Public functions for pfil hook management by packet filters. */ 106struct pfil_head *pfil_head_get(int, u_long); 107int pfil_add_hook_flags(pfil_func_flags_t, void *, int, struct pfil_head *); 108int pfil_add_hook(pfil_func_t, void *, int, struct pfil_head *); 109int pfil_remove_hook_flags(pfil_func_flags_t, void *, int, struct pfil_head *); 110int pfil_remove_hook(pfil_func_t, void *, int, struct pfil_head *); 111#define PFIL_HOOKED(p) ((p)->ph_nhooks > 0) 112 113/* Public functions to run the packet inspection by protocols. */ 114int pfil_run_hooks(struct pfil_head *, struct mbuf **, struct ifnet *, int, 115 int, struct inpcb *inp); 116 117/* Public functions for pfil head management by protocols. */ 118int pfil_head_register(struct pfil_head *); 119int pfil_head_unregister(struct pfil_head *); 120 121/* Public pfil locking functions for self managed locks by packet filters. */ 122int pfil_try_rlock(struct pfil_head *, struct rm_priotracker *); 123void pfil_rlock(struct pfil_head *, struct rm_priotracker *); 124void pfil_runlock(struct pfil_head *, struct rm_priotracker *); 125void pfil_wlock(struct pfil_head *); 126void pfil_wunlock(struct pfil_head *); 127int pfil_wowned(struct pfil_head *ph); 128 129#endif /* _NET_PFIL_H_ */ 130