2 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #ifndef _IPFW2_TABLE_H
27 #define _IPFW2_TABLE_H
30 * Internal constants and data structures used by ipfw tables
31 * not meant to be exported outside the kernel.
36 struct tables_config {
37 struct namedobj_instance *namehash;
38 struct namedobj_instance *valhash;
41 struct table_algo *algo[256];
42 struct table_algo *def_algo[IPFW_TABLE_MAXTYPE + 1];
43 TAILQ_HEAD(op_state_l,op_state) state_list;
45 #define CHAIN_TO_TCFG(chain) ((struct tables_config *)(chain)->tblcfg)
48 table_lookup_t *lookup; /* Lookup function */
49 void *state; /* Lookup radix/other structure */
50 void *xstate; /* eXtended state */
51 u_long data; /* Hints for given func */
57 struct table_value *pvalue;
58 void *ptv; /* Temporary field to hold obj */
59 uint8_t masklen; /* mask length */
61 uint16_t flags; /* record flags */
62 uint32_t value; /* value index */
64 #define TEI_FLAGS_UPDATE 0x0001 /* Add or update rec if exists */
65 #define TEI_FLAGS_UPDATED 0x0002 /* Entry has been updated */
66 #define TEI_FLAGS_COMPAT 0x0004 /* Called from old ABI */
67 #define TEI_FLAGS_DONTADD 0x0008 /* Do not create new rec */
68 #define TEI_FLAGS_ADDED 0x0010 /* Entry was added */
69 #define TEI_FLAGS_DELETED 0x0020 /* Entry was deleted */
70 #define TEI_FLAGS_LIMIT 0x0040 /* Limit was hit */
71 #define TEI_FLAGS_ERROR 0x0080 /* Unknown request error */
72 #define TEI_FLAGS_NOTFOUND 0x0100 /* Entry was not found */
73 #define TEI_FLAGS_EXISTS 0x0200 /* Entry already exists */
75 typedef int (ta_init)(struct ip_fw_chain *ch, void **ta_state,
76 struct table_info *ti, char *data, uint8_t tflags);
77 typedef void (ta_destroy)(void *ta_state, struct table_info *ti);
78 typedef int (ta_prepare_add)(struct ip_fw_chain *ch, struct tentry_info *tei,
80 typedef int (ta_prepare_del)(struct ip_fw_chain *ch, struct tentry_info *tei,
82 typedef int (ta_add)(void *ta_state, struct table_info *ti,
83 struct tentry_info *tei, void *ta_buf, uint32_t *pnum);
84 typedef int (ta_del)(void *ta_state, struct table_info *ti,
85 struct tentry_info *tei, void *ta_buf, uint32_t *pnum);
86 typedef void (ta_flush_entry)(struct ip_fw_chain *ch, struct tentry_info *tei,
89 typedef int (ta_need_modify)(void *ta_state, struct table_info *ti,
90 uint32_t count, uint64_t *pflags);
91 typedef int (ta_prepare_mod)(void *ta_buf, uint64_t *pflags);
92 typedef int (ta_fill_mod)(void *ta_state, struct table_info *ti,
93 void *ta_buf, uint64_t *pflags);
94 typedef void (ta_modify)(void *ta_state, struct table_info *ti,
95 void *ta_buf, uint64_t pflags);
96 typedef void (ta_flush_mod)(void *ta_buf);
98 typedef void (ta_change_ti)(void *ta_state, struct table_info *ti);
99 typedef void (ta_print_config)(void *ta_state, struct table_info *ti, char *buf,
102 typedef int ta_foreach_f(void *node, void *arg);
103 typedef void ta_foreach(void *ta_state, struct table_info *ti, ta_foreach_f *f,
105 typedef int ta_dump_tentry(void *ta_state, struct table_info *ti, void *e,
106 ipfw_obj_tentry *tent);
107 typedef int ta_find_tentry(void *ta_state, struct table_info *ti,
108 ipfw_obj_tentry *tent);
109 typedef void ta_dump_tinfo(void *ta_state, struct table_info *ti,
110 ipfw_ta_tinfo *tinfo);
111 typedef uint32_t ta_get_count(void *ta_state, struct table_info *ti);
123 ta_prepare_add *prepare_add;
124 ta_prepare_del *prepare_del;
127 ta_flush_entry *flush_entry;
128 ta_find_tentry *find_tentry;
129 ta_need_modify *need_modify;
130 ta_prepare_mod *prepare_mod;
131 ta_fill_mod *fill_mod;
133 ta_flush_mod *flush_mod;
134 ta_change_ti *change_ti;
136 ta_dump_tentry *dump_tentry;
137 ta_print_config *print_config;
138 ta_dump_tinfo *dump_tinfo;
139 ta_get_count *get_count;
141 #define TA_FLAG_DEFAULT 0x01 /* Algo is default for given type */
142 #define TA_FLAG_READONLY 0x02 /* Algo does not support modifications*/
143 #define TA_FLAG_EXTCOUNTER 0x04 /* Algo has external counter available*/
145 int ipfw_add_table_algo(struct ip_fw_chain *ch, struct table_algo *ta,
146 size_t size, int *idx);
147 void ipfw_del_table_algo(struct ip_fw_chain *ch, int idx);
149 void ipfw_table_algo_init(struct ip_fw_chain *chain);
150 void ipfw_table_algo_destroy(struct ip_fw_chain *chain);
152 MALLOC_DECLARE(M_IPFW_TBL);
153 /* Exported to support legacy opcodes */
154 int add_table_entry(struct ip_fw_chain *ch, struct tid_info *ti,
155 struct tentry_info *tei, uint8_t flags, uint32_t count);
156 int del_table_entry(struct ip_fw_chain *ch, struct tid_info *ti,
157 struct tentry_info *tei, uint8_t flags, uint32_t count);
158 int flush_table(struct ip_fw_chain *ch, struct tid_info *ti);
159 void ipfw_import_table_value_legacy(uint32_t value, struct table_value *v);
160 uint32_t ipfw_export_table_value_legacy(struct table_value *v);
161 int ipfw_get_table_size(struct ip_fw_chain *ch, ip_fw3_opheader *op3,
162 struct sockopt_data *sd);
164 /* ipfw_table_value.c functions */
166 struct tableop_state;
167 void ipfw_table_value_init(struct ip_fw_chain *ch, int first);
168 void ipfw_table_value_destroy(struct ip_fw_chain *ch, int last);
169 int ipfw_link_table_values(struct ip_fw_chain *ch, struct tableop_state *ts,
171 void ipfw_garbage_table_values(struct ip_fw_chain *ch, struct table_config *tc,
172 struct tentry_info *tei, uint32_t count, int rollback);
173 void ipfw_import_table_value_v1(ipfw_table_value *iv);
174 void ipfw_export_table_value_v1(struct table_value *v, ipfw_table_value *iv);
175 void ipfw_unref_table_values(struct ip_fw_chain *ch, struct table_config *tc,
176 struct table_algo *ta, void *astate, struct table_info *ti);
177 void rollback_table_values(struct tableop_state *ts);
179 int ipfw_rewrite_table_uidx(struct ip_fw_chain *chain,
180 struct rule_check_info *ci);
181 int ipfw_mark_table_kidx(struct ip_fw_chain *chain, struct ip_fw *rule,
183 int ipfw_export_table_ntlv(struct ip_fw_chain *ch, uint16_t kidx,
184 struct sockopt_data *sd);
185 void ipfw_unref_rule_tables(struct ip_fw_chain *chain, struct ip_fw *rule);
186 struct namedobj_instance *ipfw_get_table_objhash(struct ip_fw_chain *ch);
188 /* utility functions */
189 int ipfw_move_tables_sets(struct ip_fw_chain *ch, ipfw_range_tlv *rt,
191 void ipfw_swap_tables_sets(struct ip_fw_chain *ch, uint32_t old_set,
192 uint32_t new_set, int mv);
193 int ipfw_foreach_table_tentry(struct ip_fw_chain *ch, uint16_t kidx,
194 ta_foreach_f f, void *arg);
196 /* internal functions */
197 void tc_ref(struct table_config *tc);
198 void tc_unref(struct table_config *tc);
201 typedef void (op_rollback_f)(void *object, struct op_state *state);
203 TAILQ_ENTRY(op_state) next; /* chain link */
207 struct tableop_state {
208 struct op_state opstate;
209 struct ip_fw_chain *ch;
210 struct table_config *tc;
211 struct table_algo *ta;
212 struct tentry_info *tei;
219 void add_toperation_state(struct ip_fw_chain *ch, struct tableop_state *ts);
220 void del_toperation_state(struct ip_fw_chain *ch, struct tableop_state *ts);
221 void rollback_toperation_state(struct ip_fw_chain *ch, void *object);
223 /* Legacy interfaces */
224 int ipfw_count_table(struct ip_fw_chain *ch, struct tid_info *ti,
226 int ipfw_count_xtable(struct ip_fw_chain *ch, struct tid_info *ti,
228 int ipfw_dump_table_legacy(struct ip_fw_chain *ch, struct tid_info *ti,
232 #endif /* _IPFW2_TABLE_H */