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