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
34#ifndef _PFCTL_H_
35#define _PFCTL_H_
36
37#include <libpfctl.h>
38
39struct pfctl;
40
41enum pfctl_show { PFCTL_SHOW_RULES, PFCTL_SHOW_LABELS, PFCTL_SHOW_NOTHING };
42
43enum {	PFRB_TABLES = 1, PFRB_TSTATS, PFRB_ADDRS, PFRB_ASTATS,
44	PFRB_IFACES, PFRB_TRANS, PFRB_MAX };
45struct pfr_buffer {
46	int	 pfrb_type;	/* type of content, see enum above */
47	int	 pfrb_size;	/* number of objects in buffer */
48	int	 pfrb_msize;	/* maximum number of objects in buffer */
49	void	*pfrb_caddr;	/* malloc'ated memory area */
50};
51#define PFRB_FOREACH(var, buf)				\
52	for ((var) = pfr_buf_next((buf), NULL);		\
53	    (var) != NULL;				\
54	    (var) = pfr_buf_next((buf), (var)))
55
56int	 pfr_get_fd(void);
57int	 pfr_clr_tables(struct pfr_table *, int *, int);
58int	 pfr_add_tables(struct pfr_table *, int, int *, int);
59int	 pfr_del_tables(struct pfr_table *, int, int *, int);
60int	 pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
61int	 pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
62int	 pfr_clr_tstats(struct pfr_table *, int, int *, int);
63int	 pfr_clr_addrs(struct pfr_table *, int *, int);
64int	 pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
65int	 pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
66int	 pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
67	    int *, int *, int *, int);
68int	 pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
69int	 pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
70int	 pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
71int	 pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
72	    int *, int, int);
73void	 pfr_buf_clear(struct pfr_buffer *);
74int	 pfr_buf_add(struct pfr_buffer *, const void *);
75void	*pfr_buf_next(struct pfr_buffer *, const void *);
76int	 pfr_buf_grow(struct pfr_buffer *, int);
77int	 pfr_buf_load(struct pfr_buffer *, char *, int,
78	    int (*)(struct pfr_buffer *, char *, int));
79char	*pfr_strerror(int);
80int	 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
81int	 pfi_clr_istats(const char *, int *, int);
82
83void	 pfctl_print_title(char *);
84int	 pfctl_clear_tables(const char *, int);
85int	 pfctl_show_tables(const char *, int);
86int	 pfctl_command_tables(int, char *[], char *, const char *, char *,
87	    const char *, int);
88int	 pfctl_show_altq(int, const char *, int, int);
89void	 warn_namespace_collision(const char *);
90int	 pfctl_show_ifaces(const char *, int);
91void	pfctl_show_creators(int);
92FILE	*pfctl_fopen(const char *, const char *);
93
94#ifdef __FreeBSD__
95extern int altqsupport;
96extern int dummynetsupport;
97#define	HTONL(x)		(x) = htonl((__uint32_t)(x))
98#endif
99
100#ifndef DEFAULT_PRIORITY
101#define DEFAULT_PRIORITY	1
102#endif
103
104#ifndef DEFAULT_QLIMIT
105#define DEFAULT_QLIMIT		50
106#endif
107
108/*
109 * generalized service curve used for admission control
110 */
111struct segment {
112	LIST_ENTRY(segment)	_next;
113	double			x, y, d, m;
114};
115
116extern	int loadopt;
117
118int		 check_commit_altq(int, int);
119void		 pfaltq_store(struct pf_altq *);
120char		*rate2str(double);
121
122void	 print_addr(struct pf_addr_wrap *, sa_family_t, int);
123void	 print_host(struct pf_addr *, u_int16_t p, sa_family_t, int);
124void	 print_seq(struct pfctl_state_peer *);
125void	 print_state(struct pfctl_state *, int);
126int	 unmask(struct pf_addr *, sa_family_t);
127
128int	 pfctl_cmdline_symset(char *);
129int	 pfctl_add_trans(struct pfr_buffer *, int, const char *);
130u_int32_t
131	 pfctl_get_ticket(struct pfr_buffer *, int, const char *);
132int	 pfctl_trans(int, struct pfr_buffer *, u_long, int);
133
134int	 pf_get_ruleset_number(u_int8_t);
135void	 pf_init_ruleset(struct pfctl_ruleset *);
136int	 pfctl_anchor_setup(struct pfctl_rule *,
137	    const struct pfctl_ruleset *, const char *);
138void	 pf_remove_if_empty_ruleset(struct pfctl_ruleset *);
139struct pfctl_ruleset	*pf_find_ruleset(const char *);
140struct pfctl_ruleset	*pf_find_or_create_ruleset(const char *);
141void			 pf_init_eth_ruleset(struct pfctl_eth_ruleset *);
142int			 pfctl_eth_anchor_setup(struct pfctl *,
143			    struct pfctl_eth_rule *,
144			    const struct pfctl_eth_ruleset *, const char *);
145struct pfctl_eth_ruleset	*pf_find_or_create_eth_ruleset(const char *);
146void			 pf_remove_if_empty_eth_ruleset(
147			    struct pfctl_eth_ruleset *);
148
149void		 expand_label(char *, size_t, struct pfctl_rule *);
150
151const char *pfctl_proto2name(int);
152
153#endif /* _PFCTL_H_ */
154