xref: /freebsd/libexec/tftpd/tftp-utils.h (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (C) 2008 Edwin Groothuis. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 /*
30  */
31 #define	TIMEOUT		5
32 #define	MAX_TIMEOUTS	5
33 
34 /* Generic values */
35 #define MAXSEGSIZE	65464		/* Maximum size of the data segment */
36 #define	MAXPKTSIZE	(MAXSEGSIZE + 4) /* Maximum size of the packet */
37 
38 /* For the blksize option */
39 #define BLKSIZE_MIN	8		/* Minimum size of the data segment */
40 #define BLKSIZE_MAX	MAXSEGSIZE	/* Maximum size of the data segment */
41 
42 /* For the timeout option */
43 #define TIMEOUT_MIN	0		/* Minimum timeout value */
44 #define TIMEOUT_MAX	255		/* Maximum timeout value */
45 #define MIN_TIMEOUTS	3
46 
47 /* For the windowsize option */
48 #define	WINDOWSIZE	1
49 #define	WINDOWSIZE_MIN	1
50 #define	WINDOWSIZE_MAX	65535
51 
52 extern int	timeoutpacket;
53 extern int	timeoutnetwork;
54 extern int	maxtimeouts;
55 int	settimeouts(int timeoutpacket, int timeoutnetwork, int maxtimeouts);
56 
57 extern uint16_t	segsize;
58 extern uint16_t	pktsize;
59 extern uint16_t	windowsize;
60 
61 extern int	acting_as_client;
62 
63 /*
64  */
65 void	unmappedaddr(struct sockaddr_in6 *sin6);
66 ssize_t	get_field(int peer, char *buffer, ssize_t size);
67 
68 /*
69  * Packet types
70  */
71 struct packettypes {
72 	int	value;
73 	const char *const name;
74 };
75 extern struct packettypes packettypes[];
76 const char *packettype(int);
77 
78 /*
79  * RP_
80  */
81 struct rp_errors {
82 	int	error;
83 	const char *const desc;
84 };
85 extern struct rp_errors rp_errors[];
86 char	*rp_strerror(int error);
87 
88 /*
89  * Debug features
90  */
91 #define	DEBUG_NONE	0x0000
92 #define DEBUG_PACKETS	0x0001
93 #define DEBUG_SIMPLE	0x0002
94 #define DEBUG_OPTIONS	0x0004
95 #define DEBUG_ACCESS	0x0008
96 struct debugs {
97 	int	value;
98 	const char *const name;
99 	const char *const desc;
100 };
101 extern int	debug;
102 extern struct debugs debugs[];
103 extern int	packetdroppercentage;
104 int	debug_find(char *s);
105 int	debug_finds(char *s);
106 const char *debug_show(int d);
107 
108 /*
109  * Log routines
110  */
111 #define DEBUG(s) tftp_log(LOG_DEBUG, "%s", s)
112 extern int tftp_logtostdout;
113 void	tftp_openlog(const char *ident, int logopt, int facility);
114 void	tftp_closelog(void);
115 void	tftp_log(int priority, const char *message, ...) __printflike(2, 3);
116 
117 /*
118  * Performance figures
119  */
120 struct tftp_stats {
121 	size_t		amount;
122 	int		rollovers;
123 	uint32_t	blocks;
124 	int		retries;
125 	struct timeval	tstart;
126 	struct timeval	tstop;
127 };
128 
129 void	stats_init(struct tftp_stats *ts);
130 void	printstats(const char *direction, int verbose, struct tftp_stats *ts);
131