libexec/tftpd/tftp-utils.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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 __FBSDID("$FreeBSD$");
  30
  31 /*
  32  */
  33 #define TIMEOUT         5
  34 #define MAX_TIMEOUTS    5
  35
  36 /* Generic values */
  37 #define MAXSEGSIZE      65464           /* Maximum size of the data segment */
  38 #define MAXPKTSIZE      (MAXSEGSIZE + 4) /* Maximum size of the packet */
  39
  40 /* For the blksize option */
  41 #define BLKSIZE_MIN     8               /* Minimum size of the data segment */
  42 #define BLKSIZE_MAX     MAXSEGSIZE      /* Maximum size of the data segment */
  43
  44 /* For the timeout option */
  45 #define TIMEOUT_MIN     0               /* Minimum timeout value */
  46 #define TIMEOUT_MAX     255             /* Maximum timeout value */
  47 #define MIN_TIMEOUTS    3
  48
  49 extern int      timeoutpacket;
  50 extern int      timeoutnetwork;
  51 extern int      maxtimeouts;
  52 int     settimeouts(int timeoutpacket, int timeoutnetwork, int maxtimeouts);
  53
  54 extern uint16_t segsize;
  55 extern uint16_t pktsize;
  56
  57 extern int      acting_as_client;
  58
  59 /*
  60  */
  61 void    unmappedaddr(struct sockaddr_in6 *sin6);
  62 ssize_t get_field(int peer, char *buffer, ssize_t size);
  63
  64 /*
  65  * Packet types
  66  */
  67 struct packettypes {
  68         int     value;
  69         const char *const name;
  70 };
  71 extern struct packettypes packettypes[];
  72 const char *packettype(int);
  73
  74 /*
  75  * RP_
  76  */
  77 struct rp_errors {
  78         int     error;
  79         const char *const desc;
  80 };
  81 extern struct rp_errors rp_errors[];
  82 char    *rp_strerror(int error);
  83
  84 /*
  85  * Debug features
  86  */
  87 #define DEBUG_NONE      0x0000
  88 #define DEBUG_PACKETS   0x0001
  89 #define DEBUG_SIMPLE    0x0002
  90 #define DEBUG_OPTIONS   0x0004
  91 #define DEBUG_ACCESS    0x0008
  92 struct debugs {
  93         int     value;
  94         const char *const name;
  95         const char *const desc;
  96 };
  97 extern int      debug;
  98 extern struct debugs debugs[];
  99 extern int      packetdroppercentage;
 100 int     debug_find(char *s);
 101 int     debug_finds(char *s);
 102 const char *debug_show(int d);
 103
 104 /*
 105  * Log routines
 106  */
 107 #define DEBUG(s) tftp_log(LOG_DEBUG, "%s", s)
 108 extern int tftp_logtostdout;
 109 void    tftp_openlog(const char *ident, int logopt, int facility);
 110 void    tftp_closelog(void);
 111 void    tftp_log(int priority, const char *message, ...) __printflike(2, 3);
 112
 113 /*
 114  * Performance figures
 115  */
 116 struct tftp_stats {
 117         size_t          amount;
 118         int             rollovers;
 119         uint32_t        blocks;
 120         int             retries;
 121         struct timeval  tstart;
 122         struct timeval  tstop;
 123 };
 124
 125 void    stats_init(struct tftp_stats *ts);
 126 void    printstats(const char *direction, int verbose, struct tftp_stats *ts);