1 /* 2 * ntpq.h - definitions of interest to ntpq 3 */ 4 #ifdef HAVE_UNISTD_H 5 # include <unistd.h> 6 #endif 7 #include "ntp_fp.h" 8 #include "ntp.h" 9 #include "ntp_stdlib.h" 10 #include "ntp_string.h" 11 #include "ntp_malloc.h" 12 #include "ntp_assert.h" 13 #include "ntp_control.h" 14 15 #include "ntpq-opts.h" 16 17 /* 18 * Maximum number of arguments 19 */ 20 #define MAXARGS 4 21 22 /* 23 * Limit on packets in a single response. Increasing this value to 24 * 96 will marginally speed "mrulist" operation on lossless networks 25 * but it has been observed to cause loss on WiFi networks and with 26 * an IPv6 go6.net tunnel over UDP. That loss causes the request 27 * row limit to be cut in half, and it grows back very slowly to 28 * ensure forward progress is made and loss isn't triggered too quickly 29 * afterward. While the lossless case gains only marginally with 30 * MAXFRAGS == 96, the lossy case is a lot slower due to the repeated 31 * timeouts. Empirally, MAXFRAGS == 32 avoids most of the routine loss 32 * on both the WiFi and UDP v6 tunnel tests and seems a good compromise. 33 * This suggests some device in the path has a limit of 32 ~512 byte UDP 34 * packets in queue. 35 * Lowering MAXFRAGS may help with particularly lossy networks, but some 36 * ntpq commands may rely on the longtime value of 24 implicitly, 37 * assuming a single multipacket response will be large enough for any 38 * needs. In contrast, the "mrulist" command is implemented as a series 39 * of requests and multipacket responses to each. 40 */ 41 #define MAXFRAGS 32 42 43 /* 44 * Error codes for internal use 45 */ 46 #define ERR_UNSPEC 256 47 #define ERR_INCOMPLETE 257 48 #define ERR_TIMEOUT 258 49 #define ERR_TOOMUCH 259 50 51 /* 52 * Flags for forming descriptors. 53 */ 54 #define OPT 0x80 /* this argument is optional, or'd with type */ 55 56 #define NO 0x0 57 #define NTP_STR 0x1 /* string argument */ 58 #define NTP_UINT 0x2 /* unsigned integer */ 59 #define NTP_INT 0x3 /* signed integer */ 60 #define NTP_ADD 0x4 /* IP network address */ 61 #define IP_VERSION 0x5 /* IP version */ 62 #define NTP_ADP 0x6 /* IP address and port */ 63 #define NTP_LFP 0x7 /* NTP timestamp */ 64 #define NTP_MODE 0x8 /* peer mode */ 65 #define NTP_2BIT 0x9 /* leap bits */ 66 #define NTP_REFID 0xA /* RefID */ 67 68 /* 69 * Arguments are returned in a union 70 */ 71 typedef union { 72 const char *string; 73 long ival; 74 u_long uval; 75 sockaddr_u netnum; 76 } arg_v; 77 78 /* 79 * Structure for passing parsed command line 80 */ 81 struct parse { 82 const char *keyword; 83 arg_v argval[MAXARGS]; 84 size_t nargs; 85 }; 86 87 /* 88 * ntpdc includes a command parser which could charitably be called 89 * crude. The following structure is used to define the command 90 * syntax. 91 */ 92 struct xcmd { 93 const char *keyword; /* command key word */ 94 void (*handler) (struct parse *, FILE *); /* command handler */ 95 u_char arg[MAXARGS]; /* descriptors for arguments */ 96 const char *desc[MAXARGS]; /* descriptions for arguments */ 97 const char *comment; 98 }; 99 100 /* 101 * Structure to hold association data 102 */ 103 struct association { 104 associd_t assid; 105 u_short status; 106 }; 107 108 /* 109 * mrulist terminal status interval 110 */ 111 #define MRU_REPORT_SECS 5 112 113 /* 114 * var_format is used to override cooked formatting for selected vars. 115 */ 116 typedef struct var_format_tag { 117 const char * varname; 118 u_short fmt; 119 } var_format; 120 121 typedef struct chost_tag chost; 122 struct chost_tag { 123 const char *name; 124 int fam; 125 }; 126 127 extern chost chosts[]; 128 129 extern int interactive; /* are we prompting? */ 130 extern int old_rv; /* use old rv behavior? --old-rv */ 131 extern te_Refid drefid; /* How should we display a refid? */ 132 extern u_int assoc_cache_slots;/* count of allocated array entries */ 133 extern u_int numassoc; /* number of cached associations */ 134 extern u_int numhosts; 135 136 extern void grow_assoc_cache(void); 137 extern void asciize (int, char *, FILE *); 138 extern int getnetnum (const char *, sockaddr_u *, char *, int); 139 extern void sortassoc (void); 140 extern void show_error_msg (int, associd_t); 141 extern int dogetassoc (FILE *); 142 extern int doquery (int, associd_t, int, size_t, const char *, 143 u_short *, size_t *, const char **); 144 extern int doqueryex (int, associd_t, int, size_t, const char *, 145 u_short *, size_t *, const char **, int); 146 extern const char * nntohost (sockaddr_u *); 147 extern const char * nntohost_col (sockaddr_u *, size_t, int); 148 extern const char * nntohostp (sockaddr_u *); 149 extern int decodets (char *, l_fp *); 150 extern int decodeuint (char *, u_long *); 151 extern int nextvar (size_t *, const char **, char **, char **); 152 extern int decodetime (char *, l_fp *); 153 extern void printvars (size_t, const char *, int, int, int, FILE *); 154 extern int decodeint (char *, long *); 155 extern void makeascii (size_t, const char *, FILE *); 156 extern const char * trunc_left (const char *, size_t); 157 extern const char * trunc_right(const char *, size_t); 158 159 typedef int/*BOOL*/ (*Ctrl_C_Handler)(void); 160 extern int/*BOOL*/ push_ctrl_c_handler(Ctrl_C_Handler); 161 extern int/*BOOL*/ pop_ctrl_c_handler(Ctrl_C_Handler); 162