| blob | 558ccf9f17f3f7b72797e5e0609679b49d09c1bc |
1 #
2 # Copyright (C) 1993 AmiTCP/IP Group, <amitcp-group@hut.fi>
3 # Helsinki University of Technology, Finland.
4 # All rights reserved.
5 # Copyright (C) 2005 - 2007 The AROS Dev Team
6 #
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License version 2 as
9 # published by the Free Software Foundation.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 # MA 02111-1307, USA.
20 #
22 #
23 # Code for AmiTCP
24 # FS="[\t ]*;[\t ]*", comment = ^#
25 # $1= [alias=...]variable
26 # $2= level of variable
27 # $3= description of variable
28 #
29 WITH ; 1 ; Include a file with multiple settings. (This pseudo variable is a extension to the @code{SET} command.)
30 /* read_sets() is declared in amiga_config.h */
31 { VAR_FUNC, VF_RW, NULL, NULL, (notify_f)read_sets }
32 #
33 # ICMP
34 #
35 IC=ICMP ; 1 ; Variables related to Internet Message Control Protocol.
36 extern LONG icmpstat;
37 { VAR_LONG, VF_TABLE|VF_READ, KW_ICMP, &icmpstat, NULL }
38 E=ERROR ; 2 ; Number of calls to icmp_error().
39 S=SHORTOLD ; 2 ; No error because old IP was too short.
40 I=ICMPOLD ; 2 ; No error because old was ICMP.
41 CO=CODE ; 2 ; ICMP code out of range.
42 T=TOOSHORT ; 2 ; Packet too short.
43 CH=CHKSUM ; 2 ; Checksum error.
44 L=LENGTH ; 2 ; Data length larger than packet.
45 R=RESPONSES ; 2 ; Number of responses.
46 #
47 # ICMP HISTORY
48 #
49 ICH=ICMPHIST; 1 ; ICMP packet send and reception history. For details on the output format, see @ref{ICMPHIST output}.
50 extern LONG read_icmphist(struct CSource *args, UBYTE **errstrp, struct CSource *res);
51 { VAR_FUNC, VF_READ, NULL, (notify_f)read_icmphist, NULL }
52 #
53 # IP
54 #
55 IP ; 1 ; Variables related to Internet Protocol.
56 extern LONG ipstat;
57 { VAR_LONG, VF_TABLE|VF_READ, KW_IP, &ipstat, NULL }
58 T=TOTAL ; 2 ; Total number of packets.
59 CH=CHKSUM ; 2 ; Checksum error.
60 TOOSH=TOOSHORT ;2 ; Packet too short.
61 TOOSM=TOOSMALL ;2 ; Not enough data.
62 H=HEADER ; 2 ; IP header length less than data size.
63 LE=LENGTH ; 2 ; IP header length larger than packet.
64 FS=FRAGMENTS ; 2 ; Packet fragments received.
65 FD=FDROP ; 2 ; Fragments dropped (duplicates, out of space).
66 FT=FTIMEOUT ; 2 ; Fragments timed out.
67 FO=FORWARD ; 2 ; Packets forwarded.
68 FW=FWDCANT ; 2 ; Packets received for unreachable destination.
69 RED=REDIRECTSENT ;2 ; Packets forwarded on same net.
70 N=NOPROTO ; 2 ; Unknown or unsupported protocol.
71 D=DELIVER ; 2 ; Packets consumed here.
72 LO=LOCALOUT ; 2 ; Total IP packets generated here.
73 OD=ODROPPED ; 2 ; Lost packets due to nobufs, etc.
74 REA=REASSEMBLED ;2 ; Total packets reassembled ok.
75 FE=FED ; 2 ; Output packets fragmented ok.
76 OF=OFRAGMENTS ; 2 ; Output fragments created.
77 FC=FCANT ; 2 ; Don't fragment flag was set, etc.
78 #
79 # TCP
80 #
81 T=TCP ; 1 ; Variables related to Transmission Control Protocol.
82 extern LONG tcpstat;
83 { VAR_LONG, VF_TABLE|VF_READ, KW_TCP, &tcpstat, NULL }
84 CA=CATTEM ; 2 ; Connections initiated.
85 A=ACCEPTS ; 2 ; Connections accepted.
86 CO=CONNECT ; 2 ; Connections established.
87 DR=DROPS ; 2 ; Connections dropped.
88 CD=CDROPS ; 2 ; Embryonic connections dropped.
89 CL=CLOSED ; 2 ; Connections closed (incl. drops).
90 SE=SEGSTIMED ; 2 ; Segments where we tried to get rtt.
91 RTT=RTTUPDATE ; 2 ; Times we succeed rtt.
92 DE=DELACK ; 2 ; Delayed acknowledgments sent.
93 T=TIMEODROP ; 2 ; Connection dropped in rxmt timeout.
94 RE=REXMTT ; 2 ; Retransmit timeouts.
95 P=PERSIST ; 2 ; Persist timeouts.
96 KAT=KATIMEO ; 2 ; Keepalive timeouts.
97 KAP=KAPROBE ; 2 ; Keepalive probes sent.
98 KAD=KADROPS ; 2 ; Connections dropped in keepalive.
99 ST=STOTAL ; 2 ; Total packets sent.
100 SP=SPACK ; 2 ; Data packets sent.
101 SB=SBYTE ; 2 ; Data bytes sent.
102 SREP=SREPACK ; 2 ; Data packets retransmitted.
103 SREB=SREBYTE ; 2 ; Data bytes retransmitted.
104 SA=SACKS ; 2 ; Ack-only packets sent.
105 SWP=SWPROBE ; 2 ; Window probes sent.
106 SU=SURGENT ; 2 ; Packets sent with URG only.
107 SWU=SWUPDATE ; 2 ; Window update-only packets sent.
108 SC=SCTRL ; 2 ; Control @code{(SYN|FIN|RST)} packets sent.
109 RTO=RTOTAL ; 2 ; Total packets received.
110 RPA=RPACK ; 2 ; Packets received in sequence.
111 RB=RBYTE ; 2 ; Bytes received in sequence.
112 RC=RCHKSUM ; 2 ; Packets received with checksum errors.
113 ROF=ROFFSET ; 2 ; Packets received with bad offset.
114 RPS=RPSHORT ; 2 ; Packets received too short.
115 RDUPP=RDUPPACK ;2 ; Duplicate-only packets received.
116 RDUPB=RDUPBYTE ;2 ; Duplicate-only bytes received.
117 RPDUPD=RPDUPDATA ;2 ; Packets with some duplicate data.
118 RPDUPB=RPDUPBYTE ;2 ; Dup. bytes in part-dup. packets.
119 ROOP=ROOPACK ; 2 ; Out-of-order packets received.
120 ROOB=ROOBYTE ; 2 ; Out-of-order bytes received.
121 RPL=RPLATE ; 2 ; Packets with data after window.
122 RBL=RBLATE ; 2 ; Bytes received after window.
123 RAF=RAFTER ; 2 ; Packets received after close.
124 RWP=RWPROBE ; 2 ; Received window probe packets.
125 RDUPA=RDUPACK ; 2 ; Received duplicate acknowledgments.
126 RACKT=RACKTOOM ;2 ; Received acknowledgments for unsent data.
127 RACKP=RACKPACK ;2 ; Received acknowledgment packets.
128 RACKB=RACKBYTE ;2 ; Bytes acknowledged by received acknowledgments.
129 RWU=RWUPDATE ; 2 ; Received window update packets.
130 #
131 # UDP
132 #
133 U=UDP ; 1 ; Variables related to User Datagram Protocol.
134 extern LONG udpstat;
135 { VAR_LONG, VF_TABLE|VF_READ, KW_UDP, &udpstat, NULL }
136 I=ITOTAL ; 2 ; Total input packets.
137 H=HEADSHORT ; 2 ; Packet shorter than header.
138 C=CHKSUM ; 2 ; Checksum error.
139 L=LENGTH ; 2 ; Data length larger than packet.
140 N=NOPORT ; 2 ; No socket on port.
141 B=BCNOPORT ; 2 ; No socket on port, arrived as broadcast.
142 F=FULLSOC ; 2 ; Not delivered, input socket full.
143 M=MISPCB ; 2 ; Input packets missing pcb cache.
144 O=OTOTAL ; 2 ; Total output packets.
145 #
146 # Connection table
147 #
148 CONNECTIONS; 1 ; Returns a list of all TCP and UDP connections, including server (listening) sockets. For the output format description, see @ref{CONNECTIONS output}.
149 LONG getsockets(struct CSource *args, UBYTE **errstrp, struct CSource *res);
150 { VAR_FUNC, VF_READ, NULL, (notify_f)getsockets, NULL }
151 #
152 # Host Name
153 #
154 HOSTNAME ; 1 ; The name of the host returned by the gethostname() function.
155 LONG rexx_gethostname(struct CSource *args, UBYTE **errstrp, struct CSource *res); LONG rexx_sethostname(struct CSource *args, UBYTE **errstrp, struct CSource *res);
156 { VAR_FUNC, VF_RW, NULL, (notify_f)rexx_gethostname, (notify_f)rexx_sethostname }
157 #
158 # Routing table
159 #
160 ROUTES ; 1 ; Returns a list of routing entries for specified protocol family. For the output format description, see @ref{Routing Format}.
161 LONG getroutes(struct CSource *args, UBYTE **errstrp, struct CSource *res);
162 { VAR_FUNC, VF_READ, NULL, (notify_f)getroutes, NULL }
163 #
164 # These are in the numeric order as in <sys/socket.h>.
165 # Do not change the order!
166 #
167 global STRPTR KW_Protocols = KW_ROUTES;
168 ALL ; 2 ; Unspecified
169 UNIX ; 2 ; Local to host (pipes, portals)
170 INET ; 2 ; Internetwork: UDP, TCP, etc.
171 IMPLINK ; 2 ; Arpanet IMP Addresses
172 PUP ; 2 ; PUP Protocols: e.g. BSP
173 CHAOS ; 2 ; mit CHAOS protocols
174 NS ; 2 ; XEROX NS protocols
175 ISO ; 2 ; ISO protocols
176 ECMA ; 2 ; European Computer Manufacturers
177 DATAKIT ; 2 ; Datakit Protocols
178 CCITT ; 2 ; CCITT protocols, X.25 etc
179 SNA ; 2 ; IBM SNA
180 DECnet ; 2 ; DECnet
181 DLI ; 2 ; DEC Direct Data Link Interface
182 LAT ; 2 ; LAT
183 HYLINK ; 2 ; NSC Hyperchannel
184 APPLETALK ; 2 ; Apple Talk
185 ROUTE ; 2 ; Internal Routing Protocol
186 LINK ; 2 ; Link layer interface
187 XTP ; 2 ; eXpress Transfer Protocol
188 #
189 # MBUF
190 #
191 MBS=MBUF_STAT ; 1 ; Memory buffer statistics.
192 extern struct mbstat mbstat;
193 { VAR_LONG, VF_TABLE|VF_READ, KW_MBUF_STAT, &mbstat, NULL }
194 M=MBUFS ; 2 ; Total number of allocated memory buffers.
195 CL=CLUSTERS ; 2 ; Total number of allocated memory buffer clusters.
196 CLF=CLFREE ; 2 ; Number of memory buffer clusters free.
197 MD=MDROPS ; 2 ; Times failed to find space.
198 NW=NWAITED ; 2 ; Times waited for space.
199 ND=NDRAINED ; 2 ; Times drained protocols for space.
200 TMU=TOTALMEMORYUSED ;2; Total amount of memory used for the mbufs.
201 #
202 # MBUF type specific statistics
203 #
204 MBTS=MBUF_TYPE_STATS; 1 ; Returns type specific statistics of mbuf allocations. The last number is the total number of mbufs allocated.
205 extern LONG mb_read_stats(struct CSource *args, UBYTE **errstrp, struct CSource *res);
206 { VAR_FUNC, VF_READ, NULL, (notify_f)mb_read_stats, NULL }
207 #
208 # MBUF Configuration
209 #
210 MBC=MBUF_CONF ; 1 ; Memory buffer configuration.
211 extern struct mbconf mbconf; int mb_check_conf(void *pt, IPTR new);
212 { VAR_LONG, VF_TABLE|VF_RCONF, KW_MBUF_CONF, &mbconf, mb_check_conf }
213 I=INITIAL ; 2 ; Number of mbuf chunks to allocate initially.
214 CH=CHUNK ; 2 ; Number of mbufs to allocate at a time.
215 CL=CLCHUNK ; 2 ; Number of clusters to allocate at a time.
216 MM=MAXMEM ; 2 ; Maximum memory to use (in kilobytes).
217 CS=CLUSTERSIZE ;2 ; Size of an mbuf cluster.
218 #
219 # LOG configuration
220 #
221 LOG ; 1 ; Logging system configuration.
222 extern LONG log_cnf;
223 { VAR_LONG, VF_TABLE|VF_RCONF, KW_LOG, &log_cnf, NULL }
224 COUNT ; 2 ; Number of log messages to use.
225 LEN ; 2 ; Maximum length of a log message.
226 FILTERFILE ; 2 ; Log level filter
227 #
228 # GUI configuration
229 GUI ; 1 ; GUI system configuration
230 extern LONG gui_cnf;
231 { VAR_STRP, VF_TABLE|VF_RCONF, KW_GUI, &gui_cnf, NULL }
232 PANEL ; 2 ; Panel name
233 FONT ; 2 ; Font name for the panel
234 #
235 SHOW; 1 ; What to show in the panel
236 extern LONG gui_show[];
237 { VAR_ENUM, VF_TABLE|VF_RCONF, KW_SHOW, gui_show, boolean_enum }
238 SPEED ; 2 ; Interace speed
239 RATE ; 2 ; Transfer rate
240 UPTIME ; 2 ; Uptime
241 BYTES ; 2 ; Transferred bytes counter
242 IFCONTROL ; 2 ; Interface control buttons
243 GUICONTROL ; 2 ; Panel control buttons
244 #
245 #
246 # Single variables
247 #
248 # This is an example of the VAR_INET type variable
249 #
250 #NS=NS1=NSPRIM ; 1 ; Address of the primary nameserver.
251 #struct sockaddr_in ns_1 = { sizeof(ns_1), AF_INET };
252 #{ VAR_INET, VF_RW, NULL, &ns_1.sin_addr, NULL }
253 #
254 TASKNAME ; 1 ; Name of @AMITCP task.
255 extern STRPTR taskname; int taskname_changed(void *pt, IPTR new);
256 { VAR_STRP, VF_RCONF, NULL, &taskname, taskname_changed }
257 #
258 NTH=NTHBASE ; 1 ; Current @AMITCP has nth @LIB base currently in memory.
259 extern LONG nthLibrary;
260 { VAR_LONG, VF_RW, NULL, &nthLibrary, NULL }
261 #
262 DBSANA=DEBUGSANA ; 1 ; Boolean to switch the SANA-II device interface debugging on and off@footnote{For description about boolean variable, see @ref{Boolean Variables}.}.
263 extern LONG debug_sana;
264 { VAR_ENUM, VF_RW, NULL, &debug_sana, boolean_enum }
265 #
266 DBICMP=DEBUGICMP ; 1 ; Boolean to switch the ICMP debugging on and off.
267 extern LONG icmpprintfs;
268 { VAR_ENUM, VF_RW, NULL, &icmpprintfs, boolean_enum }
269 #
270 DBIP=DEBUGIP ; 1 ; Boolean telling whether IP should log debugging information.
271 extern LONG ipprintfs;
272 { VAR_ENUM, VF_RW, NULL, &ipprintfs, boolean_enum }
273 #
274 GTW=GATEWAY ; 1 ; Boolean to switch gateway functionality on and off.
275 extern LONG ipforwarding;
276 { VAR_ENUM, VF_RW, NULL, &ipforwarding, boolean_enum }
277 #
278 REDIR=IPSENDREDIRECTS ; 1 ; Boolean telling whether IP should send ICMP redirect messages.
279 extern LONG ipsendredirects;
280 { VAR_ENUM, VF_RW, NULL, &ipsendredirects, boolean_enum }
281 #
282 USENS=USENAMESERVER ; 1 ; How to use name server. Possible values are:\n@table @code\n@item NO\nDo not use name server at all. Local database will be used instead.\n@item FIRST\nQuery the name servers first and if that fails, use local database.\n@item SECOND\nFirst look up the local database, then, if that fails, query the name servers.\n@end table
283 extern LONG usens;
284 { VAR_ENUM, VF_RW, NULL, &usens, (notify_f)"NO,FIRST,SECOND" }
285 #
286 ULO=USELOOPBACK ; 1 ; If true use the local loop device for local traffic.
287 extern LONG useloopback;
288 { VAR_ENUM, VF_RW, NULL, &useloopback, boolean_enum }
289 #
290 TCPSND=TCP_SENDSPACE ; 1 ; Default size of the sending socket buffer (TCP).
291 extern ULONG tcp_sendspace;
292 { VAR_LONG, VF_RW, NULL, (LONG*)&tcp_sendspace, NULL }
293 #
294 TCPRCV=TCP_RECVSPACE ; 1 ; Default size of the receiving socket buffer (TCP).
295 extern ULONG tcp_recvspace;
296 { VAR_LONG, VF_RW, NULL, (LONG*)&tcp_recvspace, NULL }
297 #
298 CON=CONSOLENAME ; 1 ; Filename for the log console.
299 extern STRPTR consolename ; int logname_changed(void *pt, IPTR new);
300 { VAR_STRP, VF_RW, NULL, &consolename, logname_changed }
301 #
302 LOGF=LOGFILENAME ; 1 ; Filename for the log file.
303 extern STRPTR logfilename;
304 { VAR_STRP, VF_RW, NULL, &logfilename, logname_changed }
305 #
306 OPENGUI ; 1 ; Boolean to open GUI on startup
307 extern LONG OpenGUIOnStartup;
308 { VAR_ENUM, VF_RCONF, NULL, &OpenGUIOnStartup, boolean_enum }
309 #
310 REFRESH ; 1 ; GUI refresh period in seconds
311 extern ULONG gui_refresh;
312 { VAR_LONG, VF_RCONF, NULL, &gui_refresh, NULL }