xref: /freebsd/sys/netinet/libalias/alias_mod.h (revision 1019f603d557f059a34e128d45f58d519b802734)
1 /*-
2  * Copyright (c) 2005 Paolo Pisati <piso@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /*
30  * Alias_mod.h defines the outside world interfaces for the packet aliasing
31  * modular framework
32  */
33 
34 #ifndef _ALIAS_MOD_H_
35 #define _ALIAS_MOD_H_
36 
37 #ifdef _KERNEL
38 MALLOC_DECLARE(M_ALIAS);
39 
40 /* Use kernel allocator. */
41 #if defined(_SYS_MALLOC_H_)
42 #define	malloc(x)	malloc(x, M_ALIAS, M_NOWAIT|M_ZERO)
43 #define	calloc(x, n)	malloc(x*n)
44 #define	free(x)		free(x, M_ALIAS)
45 #endif
46 #endif
47 
48 /* Packet flow direction. */
49 #define IN	1
50 #define OUT	2
51 
52 /* Working protocol. */
53 #define IP	1
54 #define TCP	2
55 #define UDP	4
56 
57 /*
58  * Data passed to protocol handler module, it must be filled
59  * right before calling find_handler() to determine which
60  * module is elegible to be called.
61  */
62 struct alias_data {
63 	struct alias_link	*lnk;
64 	struct in_addr		*oaddr;		/* Original address. */
65 	struct in_addr		*aaddr;		/* Alias address. */
66 	uint16_t		*aport;		/* Alias port. */
67 	uint16_t		*sport, *dport;	/* Source & destination port */
68 	uint16_t		maxpktsize;	/* Max packet size. */
69 };
70 
71 /*
72  * This structure contains all the information necessary to make
73  * a protocol handler correctly work.
74  */
75 struct proto_handler {
76 	u_int pri;		/* Handler priority. */
77 	int16_t dir;		/* Flow direction. */
78 	uint8_t proto;		/* Working protocol. */
79 	/* Fingerprint * function. */
80 	int (*fingerprint)(struct libalias *, struct alias_data *);
81 	/* Aliasing * function. */
82 	int (*protohandler)(struct libalias *, struct ip *,
83 	    struct alias_data *);
84 	LIST_ENTRY(proto_handler) entries;
85 }
86 ;
87 /* End of handlers. */
88 #define EOH     -1
89 
90 /* Functions used with protocol handlers. */
91 void handler_chain_init(void);
92 void handler_chain_destroy(void);
93 int LibAliasAttachHandlers(struct proto_handler *);
94 int LibAliasDetachHandlers(struct proto_handler *);
95 int detach_handler(struct proto_handler *);
96 int find_handler(int8_t, int8_t, struct libalias *, struct ip *,
97     struct alias_data *);
98 struct proto_handler *first_handler(void);
99 
100 #ifndef _KERNEL
101 /*
102  * Used only in userland when libalias needs to keep track of all
103  * module loaded. In kernel land (kld mode) we don't need to care
104  * care about libalias modules cause it's kld to do it for us.
105  */
106 #define DLL_LEN	 32
107 struct dll {
108 	char	name[DLL_LEN];	/* Name of module. */
109 	void	*handle;	/*
110 				 * Ptr to shared obj obtained through
111 				 * dlopen() - use this ptr to get access
112 				 * to any symbols from a loaded module
113 				 * via dlsym().
114 				 */
115 	SLIST_ENTRY(dll)	next;
116 };
117 
118 /* Functions used with dll module. */
119 void dll_chain_init(void);
120 void dll_chain_destroy(void);
121 int attach_dll(struct dll *);
122 void *detach_dll(char *);
123 struct dll *walk_dll_chain(void);
124 
125 /*
126  * Some defines borrowed from sys/module.h used to compile a kld
127  * in userland as a shared lib.
128  */
129 typedef enum modeventtype {
130 	MOD_LOAD,
131 	MOD_UNLOAD,
132 	MOD_SHUTDOWN,
133 	MOD_QUIESCE
134 } modeventtype_t;
135 
136 typedef struct module *module_t;
137 typedef int (*modeventhand_t)(module_t, int /* modeventtype_t */, void *);
138 
139 /*
140  * Struct for registering modules statically via SYSINIT.
141  */
142 typedef struct moduledata {
143 	const char	*name;	/* module name */
144 	modeventhand_t	evhand;	/* event handler */
145 	void		*priv;	/* extra data */
146 } moduledata_t;
147 #endif /* !_KERNEL */
148 
149 #endif /* !_ALIAS_MOD_H_ */
150