summaryrefslogtreecommitdiffstats
path: root/filter
diff options
context:
space:
mode:
authorPavel Machek <pavel@ucw.cz>2000-04-30 20:47:48 +0200
committerPavel Machek <pavel@ucw.cz>2000-04-30 20:47:48 +0200
commit2337ade7546254eb48a22a1e195cc7999e684d21 (patch)
tree8e0a55620c806a2d93f8f3d53cec4869399b835c /filter
parentc6c56264361e102691fe42134ab585f631f83898 (diff)
downloadbird-2337ade7546254eb48a22a1e195cc7999e684d21.tar
bird-2337ade7546254eb48a22a1e195cc7999e684d21.zip
Moved documentation to top of file, where it belongs.
Diffstat (limited to 'filter')
-rw-r--r--filter/filter.c34
1 files changed, 19 insertions, 15 deletions
diff --git a/filter/filter.c b/filter/filter.c
index 76c0119..f70474a 100644
--- a/filter/filter.c
+++ b/filter/filter.c
@@ -7,6 +7,25 @@
*
*/
+/**
+ * DOC: Filters
+ *
+ * Filter consists of tree of &f_inst structures, one structure per
+ * "instruction". Each &f_inst contains code, aux value which is
+ * usually type of data this instruction operates on, and two generic
+ * arguments (a1, a2). Some instructinos contain pointer(s) to other
+ * instructions in their (a1, a2) fields.
+ *
+ * Filters use structure &f_val for its variables. Each &f_val
+ * contains type and value. Types are constants prefixed with %T_. Few
+ * of types are special; %T_RETURN can be or-ed with type to indicate
+ * that return from function/from whole filter should be
+ * forced. Important thing about &f_val s is that they may be copied
+ * with simple =. That's fine for all currently defined types: strings
+ * are read-only (and therefore okay), paths are copied for each
+ * operation (okay too).
+ */
+
#define LOCAL_DEBUG
#include "nest/bird.h"
@@ -624,21 +643,6 @@ i_same(struct f_inst *f1, struct f_inst *f2)
* @filter: pointer to filter to run
* @rte: pointer to pointer to rte being filtered. When route is modified, this is changed with rte_cow.
* @tmp_pool: all filter allocations go from this pool
- *
- * Filter consists of tree of &f_inst structures, one structure per
- * "instruction". Each &f_inst contains code, aux value which is
- * usually type of data this instruction operates on, and two generic
- * arguments (a1, a2). Some instructinos contain pointer(s) to other
- * instructions in their (a1, a2) fields.
- *
- * Filters use structure &f_val for its variables. Each &f_val
- * contains type and value. Types are constants prefixed with %T_. Few
- * of types are special; %T_RETURN can be or-ed with type to indicate
- * that return from function/from whole filter should be
- * forced. Important thing about &f_val s is that they may be copied
- * with simple =. That's fine for all currently defined types: strings
- * are read-only (and therefore okay), paths are copied for each
- * operation (okay too).
*/
int
f_run(struct filter *filter, struct rte **rte, struct ea_list **tmp_attrs, struct linpool *tmp_pool, int flags)