1 /*        $NetBSD: pfctl.h,v 1.5 2008/06/18 09:06:26 yamt Exp $       */
2 /*        $OpenBSD: pfctl.h,v 1.41 2007/05/31 04:13:37 mcbride Exp $ */
3 
4 /*
5  * Copyright (c) 2001 Daniel Hartmeier
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  *
12  *    - Redistributions of source code must retain the above copyright
13  *      notice, this list of conditions and the following disclaimer.
14  *    - Redistributions in binary form must reproduce the above
15  *      copyright notice, this list of conditions and the following
16  *      disclaimer in the documentation and/or other materials provided
17  *      with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 
34 #ifndef _PFCTL_H_
35 #define _PFCTL_H_
36 
37 enum pfctl_show { PFCTL_SHOW_RULES, PFCTL_SHOW_LABELS, PFCTL_SHOW_NOTHING };
38 
39 enum {    PFRB_TABLES = 1, PFRB_TSTATS, PFRB_ADDRS, PFRB_ASTATS,
40           PFRB_IFACES, PFRB_TRANS, PFRB_MAX };
41 struct pfr_buffer {
42           int        pfrb_type;         /* type of content, see enum above */
43           int        pfrb_size;         /* number of objects in buffer */
44           int        pfrb_msize;        /* maximum number of objects in buffer */
45           void      *pfrb_caddr;        /* malloc'ated memory area */
46 };
47 #define PFRB_FOREACH(var, buf)                                        \
48           for ((var) = pfr_buf_next((buf), NULL);           \
49               (var) != NULL;                                \
50               (var) = pfr_buf_next((buf), (var)))
51 
52 void       pfr_set_fd(int);
53 int        pfr_get_fd(void);
54 int        pfr_clr_tables(struct pfr_table *, int *, int);
55 int        pfr_add_tables(struct pfr_table *, int, int *, int);
56 int        pfr_del_tables(struct pfr_table *, int, int *, int);
57 int        pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
58 int        pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
59 int        pfr_clr_tstats(struct pfr_table *, int, int *, int);
60 int        pfr_clr_addrs(struct pfr_table *, int *, int);
61 int        pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
62 int        pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
63 int        pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
64               int *, int *, int *, int);
65 int        pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
66 int        pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
67 int        pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *, int);
68 int        pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
69 int        pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
70 int        pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
71               int *, int, int);
72 void       pfr_buf_clear(struct pfr_buffer *);
73 int        pfr_buf_add(struct pfr_buffer *, const void *);
74 void      *pfr_buf_next(struct pfr_buffer *, const void *);
75 int        pfr_buf_grow(struct pfr_buffer *, int);
76 int        pfr_buf_load(struct pfr_buffer *, char *, int,
77               int (*)(struct pfr_buffer *, char *, int));
78 char      *pfr_strerror(int);
79 int        pfi_get_ifaces(const char *, struct pfi_kif *, int *);
80 int        pfi_clr_istats(const char *, int *, int);
81 
82 void       pfctl_print_title(char *);
83 int        pfctl_clear_tables(const char *, int);
84 int        pfctl_show_tables(const char *, int);
85 int        pfctl_command_tables(int, char *[], char *, const char *, char *,
86               const char *, int);
87 int        pfctl_show_altq(int, const char *, int, int);
88 void       warn_namespace_collision(const char *);
89 int        pfctl_show_ifaces(const char *, int);
90 FILE      *pfctl_fopen(const char *, const char *);
91 
92 #ifndef DEFAULT_PRIORITY
93 #define DEFAULT_PRIORITY      1
94 #endif
95 
96 #ifndef DEFAULT_QLIMIT
97 #define DEFAULT_QLIMIT                  50
98 #endif
99 
100 /*
101  * generalized service curve used for admission control
102  */
103 struct segment {
104           LIST_ENTRY(segment) _next;
105           double                        x, y, d, m;
106 };
107 
108 extern    int loadopt;
109 
110 int                  check_commit_altq(int, int);
111 void                 pfaltq_store(struct pf_altq *);
112 struct pf_altq      *pfaltq_lookup(const char *);
113 char                *rate2str(double);
114 
115 void       print_addr(struct pf_addr_wrap *, sa_family_t, int);
116 void       print_host(struct pfsync_state_host *, sa_family_t, int);
117 void       print_seq(struct pfsync_state_peer *);
118 void       print_state(struct pfsync_state *, int);
119 int        unmask(struct pf_addr *, sa_family_t);
120 
121 int        pfctl_cmdline_symset(char *);
122 int        pfctl_add_trans(struct pfr_buffer *, int, const char *);
123 u_int32_t
124            pfctl_get_ticket(struct pfr_buffer *, int, const char *);
125 int        pfctl_trans(int, struct pfr_buffer *, u_long, int);
126 
127 #endif /* _PFCTL_H_ */
128