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