rx: Do not ignore RXS_* op errors
[openafs.git] / src / rx / rx.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifdef KDUMP_RX_LOCK
11 /* kdump for SGI needs MP and SP versions of rx_serverQueueEntry,
12  * rx_peer, rx_connection and rx_call structs. rx.h gets included a
13  * second time to pick up mp_ versions of those structs. Currently
14  * the affected struct's have #ifdef's in them for the second pass.
15  * This should change once we start using only ANSI compilers.
16  * Actually, kdump does not use rx_serverQueueEntry, but I'm including
17  * it for completeness.
18  */
19 #undef _RX_
20 #endif
21
22 #ifndef _RX_
23 #define _RX_
24
25 #ifndef KDUMP_RX_LOCK
26 #ifdef  KERNEL
27 #include "rx_kmutex.h"
28 #include "rx_kernel.h"
29 #if defined (AFS_OBSD_ENV) && !defined (MLEN)
30 #include "sys/mbuf.h"
31 #endif
32 #include "netinet/in.h"
33 #include "sys/socket.h"
34 #else /* KERNEL */
35 # include <sys/types.h>
36 # include <stdio.h>
37 # include <string.h>
38 #ifdef AFS_PTHREAD_ENV
39 # include "rx_pthread.h"
40 #else
41 # include "rx_lwp.h"
42 #endif
43 #ifdef AFS_NT40_ENV
44 #include <malloc.h>
45 #include <winsock2.h>
46 #include <ws2tcpip.h>
47 #endif
48 # include "rx_user.h"
49 #ifndef AFS_NT40_ENV
50 # include <netinet/in.h>
51 # include <sys/socket.h>
52 #endif
53 #endif /* KERNEL */
54
55 #include <opr/queue.h>
56
57 #include "rx_clock.h"
58 #include "rx_event.h"
59 #include "rx_misc.h"
60 #include "rx_null.h"
61 #include "rx_multi.h"
62
63 /* These items are part of the new RX API. They're living in this section
64  * for now, to keep them separate from everything else... */
65
66 struct rx_connection;
67 struct rx_call;
68 struct rx_packet;
69
70 /* Connection management */
71
72 extern afs_uint32  rx_GetConnectionEpoch(struct rx_connection *conn);
73 extern afs_uint32  rx_GetConnectionId(struct rx_connection *conn);
74 extern void *rx_GetSecurityData(struct rx_connection *conn);
75 extern void  rx_SetSecurityData(struct rx_connection *conn, void *data);
76 extern int  rx_IsUsingPktCksum(struct rx_connection *conn);
77 extern void rx_SetSecurityHeaderSize(struct rx_connection *conn, afs_uint32 size);
78 extern afs_uint32  rx_GetSecurityHeaderSize(struct rx_connection *conn);
79 extern void rx_SetSecurityMaxTrailerSize(struct rx_connection *conn, afs_uint32 size);
80 extern afs_uint32  rx_GetSecurityMaxTrailerSize(struct rx_connection *conn);
81 extern void rx_SetMsgsizeRetryErr(struct rx_connection *conn, int err);
82 extern int  rx_IsServerConn(struct rx_connection *conn);
83 extern int  rx_IsClientConn(struct rx_connection *conn);
84 extern struct rx_securityClass *rx_SecurityObjectOf(const struct rx_connection *);
85 extern struct rx_peer *rx_PeerOf(struct rx_connection *);
86 extern u_short rx_ServiceIdOf(struct rx_connection *);
87 extern int rx_SecurityClassOf(struct rx_connection *);
88 extern struct rx_service *rx_ServiceOf(struct rx_connection *);
89 extern int rx_ConnError(struct rx_connection *);
90
91 /* Call management */
92 extern struct rx_connection *rx_ConnectionOf(struct rx_call *call);
93 extern int rx_Error(struct rx_call *call);
94 extern int rx_GetRemoteStatus(struct rx_call *call);
95 extern void rx_SetLocalStatus(struct rx_call *call, int status);
96 extern int rx_GetCallAbortCode(struct rx_call *call);
97 extern void rx_SetCallAbortCode(struct rx_call *call, int code);
98
99 extern void rx_RecordCallStatistics(struct rx_call *call,
100                                     unsigned int rxInterface,
101                                     unsigned int currentFunc,
102                                     unsigned int totalFunc,
103                                     int isServer);
104
105 extern void rx_GetCallStatus(struct rx_call *call,
106                              afs_int32 *readNext,
107                              afs_int32 *transmitNext,
108                              int *lastSendTime,
109                              int *lastReceiveTime);
110 /* Peer management */
111 extern afs_uint32 rx_HostOf(struct rx_peer *peer);
112 extern u_short rx_PortOf(struct rx_peer *peer);
113
114 /* Packets */
115
116 /* Packet classes, for rx_AllocPacket and rx_packetQuota */
117 #define RX_PACKET_CLASS_RECEIVE     0
118 #define RX_PACKET_CLASS_SEND        1
119 #define RX_PACKET_CLASS_SPECIAL     2
120 #define RX_PACKET_CLASS_RECV_CBUF   3
121 #define RX_PACKET_CLASS_SEND_CBUF   4
122
123 #define RX_N_PACKET_CLASSES         5   /* Must agree with above list */
124
125 #define RX_PACKET_TYPES     {"data", "ack", "busy", "abort", "ackall", "challenge", "response", "debug", "params", "unused", "unused", "unused", "version"}
126 #define RX_N_PACKET_TYPES           13  /* Must agree with above list;
127                                          * counts 0
128                                          * WARNING: if this number ever
129                                          * grows past 13, rxdebug packets
130                                          * will need to be modified */
131
132
133 /* For most Unixes, maximum elements in an iovec is 16 */
134 #define RX_MAXIOVECS 16                 /* limit for ReadvProc/WritevProc */
135 #define RX_MAXWVECS (RX_MAXIOVECS-1)    /* need one iovec for packet header */
136
137 /* Debugging */
138
139 /* Call flags, states and modes are exposed by the debug interface */
140 #ifndef KDUMP_RX_LOCK
141 /* Major call states */
142 #define RX_STATE_NOTINIT  0     /* Call structure has never been initialized */
143 #define RX_STATE_PRECALL  1     /* Server-only:  call is not in progress, but packets have arrived */
144 #define RX_STATE_ACTIVE   2     /* An active call; a process is dealing with this call */
145 #define RX_STATE_DALLY    3     /* Dallying after process is done with call */
146 #define RX_STATE_HOLD     4     /* Waiting for acks on reply data packets */
147 #define RX_STATE_RESET    5     /* Call is being reset */
148
149 /* Call modes:  the modes of a call in RX_STATE_ACTIVE state (process attached) */
150 #define RX_MODE_SENDING   1     /* Sending or ready to send */
151 #define RX_MODE_RECEIVING 2     /* Receiving or ready to receive */
152 #define RX_MODE_ERROR     3     /* Something in error for current conversation */
153 #define RX_MODE_EOF       4     /* Server has flushed (or client has read) last reply packet */
154
155 /* Flags */
156 #define RX_CALL_READER_WAIT        1    /* Reader is waiting for next packet */
157 #define RX_CALL_WAIT_WINDOW_ALLOC  2    /* Sender is waiting for window to allocate buffers */
158 #define RX_CALL_WAIT_WINDOW_SEND   4    /* Sender is waiting for window to send buffers */
159 #define RX_CALL_WAIT_PACKETS       8    /* Sender is waiting for packet buffers */
160 #define RX_CALL_WAIT_PROC         16    /* Waiting for a process to be assigned */
161 #define RX_CALL_RECEIVE_DONE      32    /* All packets received on this call */
162 #define RX_CALL_CLEARED           64    /* Receive queue cleared in precall state */
163 #define RX_CALL_TQ_BUSY          128    /* Call's Xmit Queue is busy; don't modify */
164 #define RX_CALL_TQ_CLEARME       256    /* Need to clear this call's TQ later */
165 #define RX_CALL_TQ_SOME_ACKED    512    /* rxi_Start needs to discard ack'd packets. */
166 #define RX_CALL_TQ_WAIT         1024    /* Reader is waiting for TQ_BUSY to be reset */
167 #define RX_CALL_FAST_RECOVER    2048    /* call is doing congestion recovery */
168 /* 4096 was RX_CALL_FAST_RECOVER_WAIT */
169 #define RX_CALL_SLOW_START_OK   8192    /* receiver acks every other packet */
170 #define RX_CALL_IOVEC_WAIT      16384   /* waiting thread is using an iovec */
171 #define RX_CALL_HAVE_LAST       32768   /* Last packet has been received */
172 #define RX_CALL_NEED_START      0x10000 /* tells rxi_Start to start again */
173 /* 0x20000 was RX_CALL_PEER_BUSY */
174 #define RX_CALL_ACKALL_SENT     0x40000 /* ACKALL has been sent on the call */
175 #define RX_CALL_FLUSH           0x80000 /* Transmit queue should be flushed to peer */
176 #endif
177
178
179 /* Configurable parameters */
180 #define RX_IDLE_DEAD_TIME       60      /* default idle dead time */
181 #define RX_MAX_SERVICES         20      /* Maximum number of services that may be installed */
182 #if defined(KERNEL) && defined(AFS_AIX51_ENV) && defined(__64__)
183 #define RX_DEFAULT_STACK_SIZE   24000
184 #else
185 #define RX_DEFAULT_STACK_SIZE   16000   /* Default process stack size; overriden by rx_SetStackSize */
186 #endif
187
188 /* This parameter should not normally be changed */
189 #define RX_PROCESS_PRIORITY     LWP_NORMAL_PRIORITY
190
191 #define ADDRSPERSITE 16
192
193 #ifndef KDUMP_RX_LOCK
194 /* Bottom n-bits of the Call Identifier give the call number */
195 #define RX_MAXCALLS 4           /* Power of 2; max async calls per connection */
196 #define RX_CIDSHIFT 2           /* Log2(RX_MAXCALLS) */
197 #define RX_CHANNELMASK (RX_MAXCALLS-1)
198 #define RX_CIDMASK  (~RX_CHANNELMASK)
199 #endif /* !KDUMP_RX_LOCK */
200
201 #ifndef KERNEL
202 typedef void (*rx_destructor_t) (void *);
203 int rx_KeyCreate(rx_destructor_t);
204 osi_socket rxi_GetHostUDPSocket(u_int host, u_short port);
205 osi_socket rxi_GetUDPSocket(u_short port);
206 #endif /* KERNEL */
207
208
209 int ntoh_syserr_conv(int error);
210
211 #define RX_WAIT     1
212 #define RX_DONTWAIT 0
213
214 #define rx_GetLocalStatus(call, status) ((call)->localStatus)
215
216
217 static_inline int
218 rx_IsLoopbackAddr(afs_uint32 addr)
219 {
220     return ((addr & 0xffff0000) == 0x7f000000);
221 }
222
223 /*******************
224  * Macros callable by the user to further define attributes of a
225  * service.  Must be called before rx_StartServer
226  */
227
228 /* Set the service stack size.  This currently just sets the stack
229  * size for all processes to be the maximum seen, so far */
230 #define rx_SetStackSize(service, stackSize) \
231   rx_stackSize = (((stackSize) > rx_stackSize)? stackSize: rx_stackSize)
232
233 /* Set minimum number of processes guaranteed to be available for this
234  * service at all times */
235 #define rx_SetMinProcs(service, min) ((service)->minProcs = (min))
236
237 /* Set maximum number of processes that will be made available to this
238  * service (also a guarantee that this number will be made available
239  * if there is no competition) */
240 #define rx_SetMaxProcs(service, max) ((service)->maxProcs = (max))
241
242 /* Define a procedure to be called just before a server connection is destroyed */
243 #define rx_SetDestroyConnProc(service,proc) ((service)->destroyConnProc = (proc))
244
245 /* Define procedure to set service dead time */
246 #define rx_SetIdleDeadTime(service,time) ((service)->idleDeadTime = (time))
247
248 /* Define procedures for getting and setting before and after execute-request procs */
249 #define rx_SetAfterProc(service,proc) ((service)->afterProc = (proc))
250 #define rx_SetBeforeProc(service,proc) ((service)->beforeProc = (proc))
251 #define rx_GetAfterProc(service) ((service)->afterProc)
252 #define rx_GetBeforeProc(service) ((service)->beforeProc)
253 #define rx_SetPostProc(service,proc) ((service)->postProc = (proc))
254 #define rx_GetPostProc(service) ((service)->postProc)
255
256 /* Define a procedure to be called when a server connection is created */
257 #define rx_SetNewConnProc(service, proc) ((service)->newConnProc = (proc))
258
259 /* NOTE:  We'll probably redefine the following three routines, again, sometime. */
260
261 /* Set the connection dead time for any connections created for this service (server only) */
262 #define rx_SetServiceDeadTime(service, seconds) ((service)->secondsUntilDead = (seconds))
263
264 /* Enable or disable asymmetric client checking for a service */
265 #define rx_SetCheckReach(service, x) ((service)->checkReach = (x))
266
267 /* Set the overload threshold and the overload error */
268 #define rx_SetBusyThreshold(threshold, code) (rx_BusyThreshold=(threshold),rx_BusyError=(code))
269
270 /* If this flag is set,no new requests are processed by rx, all new requests are
271 returned with an error code of RX_CALL_DEAD ( transient error ) */
272 #define rx_SetRxTranquil()              (rx_tranquil = 1)
273 #define rx_ClearRxTranquil()            (rx_tranquil = 0)
274
275 /* Set the threshold and time to delay aborts for consecutive errors */
276 #define rx_SetCallAbortThreshold(A) (rxi_callAbortThreshhold = (A))
277 #define rx_SetCallAbortDelay(A) (rxi_callAbortDelay = (A))
278 #define rx_SetConnAbortThreshold(A) (rxi_connAbortThreshhold = (A))
279 #define rx_SetConnAbortDelay(A) (rxi_connAbortDelay = (A))
280
281
282
283 #define cpspace(call) ((call)->curlen)
284 #define cppos(call) ((call)->curpos)
285
286 #define rx_Read(call, buf, nbytes)   rx_ReadProc(call, buf, nbytes)
287 #define rx_Read32(call, value)   rx_ReadProc32(call, value)
288 #define rx_Readv(call, iov, nio, maxio, nbytes) \
289    rx_ReadvProc(call, iov, nio, maxio, nbytes)
290 #define rx_Write(call, buf, nbytes) rx_WriteProc(call, buf, nbytes)
291 #define rx_Write32(call, value) rx_WriteProc32(call, value)
292 #define rx_Writev(call, iov, nio, nbytes) \
293    rx_WritevProc(call, iov, nio, nbytes)
294
295 /* This is the maximum size data packet that can be sent on this connection, accounting for security module-specific overheads. */
296 #define rx_MaxUserDataSize(call)                ((call)->MTU - RX_HEADER_SIZE - (call)->conn->securityHeaderSize - (call)->conn->securityMaxTrailerSize)
297
298 /* Macros to turn the hot thread feature on and off. Enabling hot threads
299  * allows the listener thread to trade places with an idle worker thread,
300  * which moves the context switch from listener to worker out of the
301  * critical path.
302  */
303 #define rx_EnableHotThread()            (rx_enable_hot_thread = 1)
304 #define rx_DisableHotThread()           (rx_enable_hot_thread = 0)
305
306 #define rx_PutConnection(conn) rx_DestroyConnection(conn)
307
308 /* A service is installed by rx_NewService, and specifies a service type that
309  * is exported by this process.  Incoming calls are stamped with the service
310  * type, and must match an installed service for the call to be accepted.
311  * Each service exported has a (port,serviceId) pair to uniquely identify it.
312  * It is also named:  this is intended to allow a remote statistics gathering
313  * program to retrieve per service statistics without having to know the local
314  * service id's.  Each service has a number of
315  */
316
317 /* security objects (instances of security classes) which implement
318  * various types of end-to-end security protocols for connections made
319  * to this service.  Finally, there are two parameters controlling the
320  * number of requests which may be executed in parallel by this
321  * service: minProcs is the number of requests to this service which
322  * are guaranteed to be able to run in parallel at any time; maxProcs
323  * has two meanings: it limits the total number of requests which may
324  * execute in parallel and it also guarantees that that many requests
325  * may be handled in parallel if no other service is handling any
326  * requests. */
327
328 struct rx_service {
329     u_short serviceId;          /* Service number */
330     afs_uint32 serviceHost;     /* IP address for this service */
331     u_short servicePort;        /* UDP port for this service */
332     char *serviceName;          /* Name of the service */
333     osi_socket socket;          /* socket structure or file descriptor */
334     u_short nRequestsRunning;   /* Number of requests currently in progress */
335     u_short nSecurityObjects;   /* Number of entries in security objects array */
336     struct rx_securityClass **securityObjects;  /* Array of security class objects */
337       afs_int32(*executeRequestProc) (struct rx_call * acall);  /* Routine to call when an rpc request is received */
338     void (*destroyConnProc) (struct rx_connection * tcon);      /* Routine to call when a server connection is destroyed */
339     void (*newConnProc) (struct rx_connection * tcon);  /* Routine to call when a server connection is created */
340     void (*beforeProc) (struct rx_call * acall);        /* routine to call before a call is executed */
341     void (*afterProc) (struct rx_call * acall, afs_int32 code); /* routine to call after a call is executed */
342     void (*postProc) (afs_int32 code);  /* routine to call after the call has ended */
343     u_short maxProcs;           /* Maximum procs to be used for this service */
344     u_short minProcs;           /* Minimum # of requests guaranteed executable simultaneously */
345     u_short connDeadTime;       /* Seconds until a client of this service will be declared dead, if it is not responding */
346     u_short idleDeadTime;       /* Time a server will wait for I/O to start up again */
347     u_char checkReach;          /* Check for asymmetric clients? */
348     int nSpecific;              /* number entries in specific data */
349     void **specific;            /* pointer to connection specific data */
350 #ifdef  RX_ENABLE_LOCKS
351     afs_kmutex_t svc_data_lock; /* protect specific data */
352 #endif
353
354 };
355
356 #endif /* KDUMP_RX_LOCK */
357
358 #ifndef KDUMP_RX_LOCK
359 /* Flag bits for connection structure */
360 #define RX_CONN_MAKECALL_WAITING    1   /* rx_NewCall is waiting for a channel */
361 #define RX_CONN_DESTROY_ME          2   /* Destroy *client* connection after last call */
362 #define RX_CONN_USING_PACKET_CKSUM  4   /* non-zero header.spare field seen */
363 #define RX_CONN_KNOW_WINDOW         8   /* window size negotiation works */
364 #define RX_CONN_RESET              16   /* connection is reset, remove */
365 #define RX_CONN_BUSY               32   /* connection is busy; don't delete */
366 #define RX_CONN_ATTACHWAIT         64   /* attach waiting for peer->lastReach */
367 #define RX_CONN_MAKECALL_ACTIVE   128   /* a thread is actively in rx_NewCall */
368 #define RX_CONN_NAT_PING          256   /* nat ping requested */
369
370 /* Type of connection, client or server */
371 #define RX_CLIENT_CONNECTION    0
372 #define RX_SERVER_CONNECTION    1
373 #endif /* !KDUMP_RX_LOCK */
374
375 /* Maximum number of acknowledgements in an acknowledge packet */
376 #define RX_MAXACKS          255
377
378 #ifndef KDUMP_RX_LOCK
379
380 /* The structure of the data portion of an acknowledge packet: An acknowledge
381  * packet is in network byte order at all times.  An acknowledgement is always
382  * prompted for a specific reason by a specific incoming packet.  This reason
383  * is reported in "reason" and the packet's sequence number in the packet
384  * header.seq.  In addition to this information, all of the current
385  * acknowledgement information about this call is placed in the packet.
386  * "FirstPacket" is the sequence number of the first packet represented in an
387  * array of bytes, "acks", containing acknowledgement information for a number
388  * of consecutive packets.  All packets prior to FirstPacket are implicitly
389  * acknowledged: the sender need no longer be concerned about them.  Packets
390  * from firstPacket+nAcks and on are not acknowledged.  Packets in the range
391  * [firstPacket,firstPacket+nAcks) are each acknowledged explicitly.  The
392  * acknowledgement may be RX_NACK if the packet is not (currently) at the
393  * receiver (it may have never been received, or received and then later
394  * dropped), or it may be RX_ACK if the packet is queued up waiting to be read
395  * by the upper level software.  RX_ACK does not imply that the packet may not
396  * be dropped before it is read; it does imply that the sender should stop
397  * retransmitting the packet until notified otherwise.  The field
398  * previousPacket identifies the previous packet received by the peer.  This
399  * was used in a previous version of this software, and could be used in the
400  * future.  The serial number in the data part of the ack packet corresponds to
401  * the serial number oof the packet which prompted the acknowledge.  Any
402  * packets which are explicitly not acknowledged, and which were last
403  * transmitted with a serial number less than the provided serial number,
404  * should be retransmitted immediately.  Actually, this is slightly inaccurate:
405  * packets are not necessarily received in order.  When packets are habitually
406  * transmitted out of order, this is allowed for in the retransmission
407  * algorithm by introducing the notion of maximum packet skew: the degree of
408  * out-of-orderness of the packets received on the wire.  This number is
409  * communicated from the receiver to the sender in ack packets. */
410
411 struct rx_ackPacket {
412     u_short bufferSpace;        /* Number of packet buffers available.  That is:  the number of buffers that the sender of the ack packet is willing to provide for data, on this or subsequent calls.  Lying is permissable. */
413     u_short maxSkew;            /* Maximum difference between serial# of packet acknowledged and highest packet yet received */
414     afs_uint32 firstPacket;     /* The first packet in the list of acknowledged packets */
415     afs_uint32 previousPacket;  /* The previous packet number received (obsolete?) */
416     afs_uint32 serial;          /* Serial number of the packet which prompted the acknowledge */
417     u_char reason;              /* Reason for the acknowledge of ackPacket, defined below */
418     u_char nAcks;               /* Number of acknowledgements */
419     u_char acks[RX_MAXACKS];    /* Up to RX_MAXACKS packet acknowledgements, defined below */
420     /* Packets <firstPacket are implicitly acknowledged and may be discarded by the sender.  Packets >= firstPacket+nAcks are implicitly NOT acknowledged.  No packets with sequence numbers >= firstPacket should be discarded by the sender (they may thrown out at any time by the receiver) */
421 };
422
423 #define FIRSTACKOFFSET 4
424
425 /* Reason for acknowledge message */
426 #define RX_ACK_REQUESTED        1       /* Peer requested an ack on this packet */
427 #define RX_ACK_DUPLICATE        2       /* Duplicate packet */
428 #define RX_ACK_OUT_OF_SEQUENCE  3       /* Packet out of sequence */
429 #define RX_ACK_EXCEEDS_WINDOW   4       /* Packet sequence number higher than window; discarded */
430 #define RX_ACK_NOSPACE          5       /* No buffer space at all */
431 #define RX_ACK_PING             6       /* This is a keep-alive ack */
432 #define RX_ACK_PING_RESPONSE    7       /* Ack'ing because we were pinged */
433 #define RX_ACK_DELAY            8       /* Ack generated since nothing has happened since receiving packet */
434 #define RX_ACK_IDLE             9       /* Similar to RX_ACK_DELAY, but can
435                                          * be used to compute RTT */
436 #define RX_ACK_MTU             -1       /* will be rewritten to ACK_PING */
437
438 /* Packet acknowledgement type */
439 #define RX_ACK_TYPE_NACK        0       /* I Don't have this packet */
440 #define RX_ACK_TYPE_ACK         1       /* I have this packet, although I may discard it later */
441
442 /* The packet size transmitted for an acknowledge is adjusted to reflect the actual size of the acks array.  This macro defines the size */
443 #define rx_AckDataSize(nAcks) (3 + nAcks + offsetof(struct rx_ackPacket, acks[0]))
444
445 #define RX_CHALLENGE_TIMEOUT    2       /* Number of seconds before another authentication request packet is generated */
446 #define RX_CHALLENGE_MAXTRIES   50      /* Max # of times we resend challenge */
447 #define RX_CHECKREACH_TIMEOUT   2       /* Number of seconds before another ping is generated */
448 #define RX_CHECKREACH_TTL       60      /* Re-check reachability this often */
449
450 /*
451  * rx_GetNetworkError 'origin' constants. These define the meaning of the
452  * 'type' and 'code' values returned by rx_GetNetworkError.
453  */
454
455 /* Used for ICMP errors; the type and code are the ICMP type and code,
456  * respectively */
457 #define RX_NETWORK_ERROR_ORIGIN_ICMP (0)
458
459 /*
460  * RX error codes.  RX uses error codes from -1 to -64 and -100.
461  * Rxgen uses other error codes < -64 (see src/rxgen/rpc_errors.h);
462  * user programs are expected to return positive error codes
463  */
464
465 /* Something bad happened to the connection; temporary loss of communication */
466 #define RX_CALL_DEAD                (-1)
467
468 /*
469  * An invalid operation, such as a client attempting to send data
470  * after having received the beginning of a reply from the server.
471  */
472 #define RX_INVALID_OPERATION        (-2)
473
474 /* An optional timeout per call may be specified */
475 #define RX_CALL_TIMEOUT             (-3)
476
477 /* End of data on a read.  Not currently in use. */
478 #define RX_EOF                      (-4)
479
480 /* Some sort of low-level protocol error. */
481 #define RX_PROTOCOL_ERROR           (-5)
482
483 /*
484  * Generic user abort code; used when no more specific error code needs to be
485  * communicated.  For example, multi rx clients use this code to abort a multi-
486  * rx call.
487  */
488 #define RX_USER_ABORT               (-6)
489
490 /* Port already in use (from rx_Init).  This error is never sent on the wire. */
491 #define RX_ADDRINUSE                (-7)
492
493 /* EMSGSIZE returned from network.  Packet too big, must fragment */
494 #define RX_MSGSIZE                  (-8)
495
496 /* The value -9 was previously used for RX_CALL_IDLE but is now free for
497  * reuse. */
498
499 /* The value -10 was previously used for RX_CALL_BUSY but is now free for
500  * reuse. */
501
502 /* transient failure detected ( possibly the server is restarting ) */
503 /* this should be equal to VRESTARTING ( util/errors.h ) for old clients to work */
504 #define RX_RESTARTING               (-100)
505
506 typedef enum {
507     RX_SECIDX_NULL = 0,         /** rxnull, no security. */
508     RX_SECIDX_VAB  = 1,         /** vice tokens with bcrypt.  Unused. */
509     RX_SECIDX_KAD  = 2,         /** kerberos/DES. */
510     RX_SECIDX_KAE  = 3,         /** rxkad, but always encrypt. */
511     RX_SECIDX_GK   = 4,         /** rxgk, RFC 3961 crypto. */
512     RX_SECIDX_K5   = 5,         /** kerberos 5 tickets as tokens. */
513 } rx_securityIndex;
514
515 /*
516  * We use an enum for the symbol definitions but have no need for a typedef
517  * because the enum is at least as wide as 'int' and these have to fit into
518  * a field of type 'char'.  Direct assigment will do the right thing if the
519  * enum value fits into that type.
520  */
521 enum {
522     RX_SECTYPE_UNK = 0,
523     RX_SECTYPE_NULL = 1,
524     RX_SECTYPE_VAB = 2,
525     RX_SECTYPE_KAD = 3,
526 };
527 struct rx_securityObjectStats {
528     char type;                  /* An RX_SECTYPE_* value */
529     char level;
530     char sparec[10];            /* force correct alignment */
531     afs_int32 flags;            /* 1=>unalloc, 2=>auth, 4=>expired */
532     afs_uint32 expires;
533     afs_uint32 packetsReceived;
534     afs_uint32 packetsSent;
535     afs_uint32 bytesReceived;
536     afs_uint32 bytesSent;
537     short spares[4];
538     afs_int32 sparel[8];
539 };
540
541 /* Configuration settings */
542
543 /* Enum for storing configuration variables which can be set via the
544  * SetConfiguration method in the rx_securityClass, below
545  */
546
547 typedef enum {
548      RXS_CONFIG_FLAGS /* afs_uint32 set of bitwise flags */
549 } rx_securityConfigVariables;
550
551 /* For the RXS_CONFIG_FLAGS, the following bit values are defined */
552
553 /* Disable the principal name contains dot check in rxkad */
554 #define RXS_CONFIG_FLAGS_DISABLE_DOTCHECK       0x01
555
556 /* XXXX (rewrite this description) A security class object contains a set of
557  * procedures and some private data to implement a security model for rx
558  * connections.  These routines are called by rx as appropriate.  Rx knows
559  * nothing about the internal details of any particular security model, or
560  * about security state.  Rx does maintain state per connection on behalf of
561  * the security class.  Each security class implementation is also expected to
562  * provide routines to create these objects.  Rx provides a basic routine to
563  * allocate one of these objects; this routine must be called by the class. */
564 struct rx_securityClass {
565     struct rx_securityOps {
566         int (*op_Close) (struct rx_securityClass * aobj);
567         int (*op_NewConnection) (struct rx_securityClass * aobj,
568                                  struct rx_connection * aconn);
569         int (*op_PreparePacket) (struct rx_securityClass * aobj,
570                                  struct rx_call * acall,
571                                  struct rx_packet * apacket);
572         int (*op_SendPacket) (struct rx_securityClass * aobj,
573                               struct rx_call * acall,
574                               struct rx_packet * apacket);
575         int (*op_CheckAuthentication) (struct rx_securityClass * aobj,
576                                        struct rx_connection * aconn);
577         int (*op_CreateChallenge) (struct rx_securityClass * aobj,
578                                    struct rx_connection * aconn);
579         int (*op_GetChallenge) (struct rx_securityClass * aobj,
580                                 struct rx_connection * aconn,
581                                 struct rx_packet * apacket);
582         int (*op_GetResponse) (struct rx_securityClass * aobj,
583                                struct rx_connection * aconn,
584                                struct rx_packet * apacket);
585         int (*op_CheckResponse) (struct rx_securityClass * aobj,
586                                  struct rx_connection * aconn,
587                                  struct rx_packet * apacket);
588         int (*op_CheckPacket) (struct rx_securityClass * aobj,
589                                struct rx_call * acall,
590                                struct rx_packet * apacket);
591         void (*op_DestroyConnection) (struct rx_securityClass * aobj,
592                                       struct rx_connection * aconn);
593         int (*op_GetStats) (struct rx_securityClass * aobj,
594                             struct rx_connection * aconn,
595                             struct rx_securityObjectStats * astats);
596         int (*op_SetConfiguration) (struct rx_securityClass * aobj,
597                                     struct rx_connection * aconn,
598                                     rx_securityConfigVariables atype,
599                                     void * avalue,
600                                     void ** acurrentValue);
601         int (*op_Spare2) (void);
602         int (*op_Spare3) (void);
603     } *ops;
604     void *privateData;
605     int refCount;
606 };
607
608 #define RXS_OP(obj,op,args) ((obj && (obj->ops->op_ ## op)) ? (*(obj)->ops->op_ ## op)args : 0)
609 #define RXS_OP_VOID(obj,op,args) do { \
610     if (obj && (obj->ops->op_ ## op)) \
611         (*(obj)->ops->op_ ## op)args; \
612 } while (0)
613
614 #define RXS_Close(obj) RXS_OP(obj,Close,(obj))
615 #define RXS_NewConnection(obj,conn) RXS_OP(obj,NewConnection,(obj,conn))
616 #define RXS_PreparePacket(obj,call,packet) RXS_OP(obj,PreparePacket,(obj,call,packet))
617 #define RXS_SendPacket(obj,call,packet) RXS_OP(obj,SendPacket,(obj,call,packet))
618 #define RXS_CheckAuthentication(obj,conn) RXS_OP(obj,CheckAuthentication,(obj,conn))
619 #define RXS_CreateChallenge(obj,conn) RXS_OP(obj,CreateChallenge,(obj,conn))
620 #define RXS_GetChallenge(obj,conn,packet) RXS_OP(obj,GetChallenge,(obj,conn,packet))
621 #define RXS_GetResponse(obj,conn,packet) RXS_OP(obj,GetResponse,(obj,conn,packet))
622 #define RXS_CheckResponse(obj,conn,packet) RXS_OP(obj,CheckResponse,(obj,conn,packet))
623 #define RXS_CheckPacket(obj,call,packet) RXS_OP(obj,CheckPacket,(obj,call,packet))
624 #define RXS_DestroyConnection(obj,conn) RXS_OP_VOID(obj,DestroyConnection,(obj,conn))
625 #define RXS_GetStats(obj,conn,stats) RXS_OP(obj,GetStats,(obj,conn,stats))
626 #define RXS_SetConfiguration(obj, conn, type, value, currentValue) RXS_OP(obj, SetConfiguration,(obj,conn,type,value,currentValue))
627
628
629
630 /* Structure for keeping rx statistics.  Note that this structure is returned
631  * by rxdebug, so, for compatibility reasons, new fields should be appended (or
632  * spares used), the rxdebug protocol checked, if necessary, and the PrintStats
633  * code should be updated as well.
634  *
635  * Clearly we assume that ntohl will work on these structures so sizeof(int)
636  * must equal sizeof(afs_int32). */
637
638 struct rx_statistics {          /* General rx statistics */
639     int packetRequests;         /* Number of packet allocation requests */
640     int receivePktAllocFailures;
641     int sendPktAllocFailures;
642     int specialPktAllocFailures;
643     int socketGreedy;           /* Whether SO_GREEDY succeeded */
644     int bogusPacketOnRead;      /* Number of inappropriately short packets received */
645     int bogusHost;              /* Host address from bogus packets */
646     int noPacketOnRead;         /* Number of read packets attempted when there was actually no packet to read off the wire */
647     int noPacketBuffersOnRead;  /* Number of dropped data packets due to lack of packet buffers */
648     int selects;                /* Number of selects waiting for packet or timeout */
649     int sendSelects;            /* Number of selects forced when sending packet */
650     int packetsRead[RX_N_PACKET_TYPES]; /* Total number of packets read, per type */
651     int dataPacketsRead;        /* Number of unique data packets read off the wire */
652     int ackPacketsRead;         /* Number of ack packets read */
653     int dupPacketsRead;         /* Number of duplicate data packets read */
654     int spuriousPacketsRead;    /* Number of inappropriate data packets */
655     int packetsSent[RX_N_PACKET_TYPES]; /* Number of rxi_Sends: packets sent over the wire, per type */
656     int ackPacketsSent;         /* Number of acks sent */
657     int pingPacketsSent;        /* Total number of ping packets sent */
658     int abortPacketsSent;       /* Total number of aborts */
659     int busyPacketsSent;        /* Total number of busies sent received */
660     int dataPacketsSent;        /* Number of unique data packets sent */
661     int dataPacketsReSent;      /* Number of retransmissions */
662     int dataPacketsPushed;      /* Number of retransmissions pushed early by a NACK */
663     int ignoreAckedPacket;      /* Number of packets with acked flag, on rxi_Start */
664     struct clock totalRtt;      /* Total round trip time measured (use to compute average) */
665     struct clock minRtt;        /* Minimum round trip time measured */
666     struct clock maxRtt;        /* Maximum round trip time measured */
667     int nRttSamples;            /* Total number of round trip samples */
668     int nServerConns;           /* Total number of server connections */
669     int nClientConns;           /* Total number of client connections */
670     int nPeerStructs;           /* Total number of peer structures */
671     int nCallStructs;           /* Total number of call structures allocated */
672     int nFreeCallStructs;       /* Total number of previously allocated free call structures */
673     int netSendFailures;
674     afs_int32 fatalErrors;
675     int ignorePacketDally;      /* packets dropped because call is in dally state */
676     int receiveCbufPktAllocFailures;
677     int sendCbufPktAllocFailures;
678     int nBusies;
679     int spares[4];
680 };
681
682 /* structures for debug input and output packets */
683
684 /* debug input types */
685 struct rx_debugIn {
686     afs_int32 type;
687     afs_int32 index;
688 };
689
690 /* Invalid rx debug package type */
691 #define RX_DEBUGI_BADTYPE     (-8)
692
693 #define RX_DEBUGI_VERSION_MINIMUM ('L') /* earliest real version */
694 #define RX_DEBUGI_VERSION     ('S')    /* Latest version */
695     /* first version w/ secStats */
696 #define RX_DEBUGI_VERSION_W_SECSTATS ('L')
697     /* version M is first supporting GETALLCONN and RXSTATS type */
698 #define RX_DEBUGI_VERSION_W_GETALLCONN ('M')
699 #define RX_DEBUGI_VERSION_W_RXSTATS ('M')
700     /* last version with unaligned debugConn */
701 #define RX_DEBUGI_VERSION_W_UNALIGNED_CONN ('L')
702 #define RX_DEBUGI_VERSION_W_WAITERS ('N')
703 #define RX_DEBUGI_VERSION_W_IDLETHREADS ('O')
704 #define RX_DEBUGI_VERSION_W_NEWPACKETTYPES ('P')
705 #define RX_DEBUGI_VERSION_W_GETPEER ('Q')
706 #define RX_DEBUGI_VERSION_W_WAITED ('R')
707 #define RX_DEBUGI_VERSION_W_PACKETS ('S')
708
709 #define RX_DEBUGI_GETSTATS      1       /* get basic rx stats */
710 #define RX_DEBUGI_GETCONN       2       /* get connection info */
711 #define RX_DEBUGI_GETALLCONN    3       /* get even uninteresting conns */
712 #define RX_DEBUGI_RXSTATS       4       /* get all rx stats */
713 #define RX_DEBUGI_GETPEER       5       /* get all peer structs */
714
715 struct rx_debugStats {
716     afs_int32 nFreePackets;
717     afs_int32 packetReclaims;
718     afs_int32 callsExecuted;
719     char waitingForPackets;
720     char usedFDs;
721     char version;
722     char spare1;
723     afs_int32 nWaiting;
724     afs_int32 idleThreads;      /* Number of server threads that are idle */
725     afs_int32 nWaited;
726     afs_int32 nPackets;
727     afs_int32 spare2[6];
728 };
729
730 struct rx_debugConn_vL {
731     afs_uint32 host;
732     afs_int32 cid;
733     afs_int32 serial;
734     afs_int32 callNumber[RX_MAXCALLS];
735     afs_int32 error;
736     short port;
737     char flags;
738     char type;
739     char securityIndex;
740     char callState[RX_MAXCALLS];
741     char callMode[RX_MAXCALLS];
742     char callFlags[RX_MAXCALLS];
743     char callOther[RX_MAXCALLS];
744     /* old style getconn stops here */
745     struct rx_securityObjectStats secStats;
746     afs_int32 sparel[10];
747 };
748
749 struct rx_debugConn {
750     afs_uint32 host;
751     afs_int32 cid;
752     afs_int32 serial;
753     afs_int32 callNumber[RX_MAXCALLS];
754     afs_int32 error;
755     short port;
756     char flags;
757     char type;
758     char securityIndex;
759     char sparec[3];             /* force correct alignment */
760     char callState[RX_MAXCALLS];
761     char callMode[RX_MAXCALLS];
762     char callFlags[RX_MAXCALLS];
763     char callOther[RX_MAXCALLS];
764     /* old style getconn stops here */
765     struct rx_securityObjectStats secStats;
766     afs_int32 epoch;
767     afs_int32 natMTU;
768     afs_int32 sparel[9];
769 };
770
771 struct rx_debugPeer {
772     afs_uint32 host;
773     u_short port;
774     u_short ifMTU;
775     afs_uint32 idleWhen;
776     short refCount;
777     u_char burstSize;
778     u_char burst;
779     struct clock burstWait;
780     afs_int32 rtt;
781     afs_int32 rtt_dev;
782     struct clock timeout;
783     afs_int32 nSent;
784     afs_int32 reSends;
785     afs_int32 inPacketSkew;
786     afs_int32 outPacketSkew;
787     afs_int32 rateFlag;
788     u_short natMTU;
789     u_short maxMTU;
790     u_short maxDgramPackets;
791     u_short ifDgramPackets;
792     u_short MTU;
793     u_short cwind;
794     u_short nDgramPackets;
795     u_short congestSeq;
796     afs_hyper_t bytesSent;
797     afs_hyper_t bytesReceived;
798     afs_int32 sparel[10];
799 };
800
801 #define RX_OTHER_IN     1       /* packets avail in in queue */
802 #define RX_OTHER_OUT    2       /* packets avail in out queue */
803
804 #define RX_SERVER_DEBUG_SEC_STATS               0x1
805 #define RX_SERVER_DEBUG_ALL_CONN                0x2
806 #define RX_SERVER_DEBUG_RX_STATS                0x4
807 #define RX_SERVER_DEBUG_WAITER_CNT              0x8
808 #define RX_SERVER_DEBUG_IDLE_THREADS            0x10
809 #define RX_SERVER_DEBUG_OLD_CONN                0x20
810 #define RX_SERVER_DEBUG_NEW_PACKETS             0x40
811 #define RX_SERVER_DEBUG_ALL_PEER                0x80
812 #define RX_SERVER_DEBUG_WAITED_CNT              0x100
813 #define RX_SERVER_DEBUG_PACKETS_CNT              0x200
814
815 #define AFS_RX_STATS_CLEAR_ALL                  0xffffffff
816 #define AFS_RX_STATS_CLEAR_INVOCATIONS          0x1
817 #define AFS_RX_STATS_CLEAR_BYTES_SENT           0x2
818 #define AFS_RX_STATS_CLEAR_BYTES_RCVD           0x4
819 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SUM       0x8
820 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SQUARE    0x10
821 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MIN       0x20
822 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MAX       0x40
823 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SUM        0x80
824 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SQUARE     0x100
825 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MIN        0x200
826 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MAX        0x400
827
828 typedef struct rx_function_entry_v1 {
829     afs_uint32 remote_peer;
830     afs_uint32 remote_port;
831     afs_uint32 remote_is_server;
832     afs_uint32 interfaceId;
833     afs_uint32 func_total;
834     afs_uint32 func_index;
835     afs_uint64 invocations;
836     afs_uint64 bytes_sent;
837     afs_uint64 bytes_rcvd;
838     struct clock queue_time_sum;
839     struct clock queue_time_sum_sqr;
840     struct clock queue_time_min;
841     struct clock queue_time_max;
842     struct clock execution_time_sum;
843     struct clock execution_time_sum_sqr;
844     struct clock execution_time_min;
845     struct clock execution_time_max;
846 } rx_function_entry_v1_t, *rx_function_entry_v1_p;
847
848 /*
849  * If you need to change rx_function_entry, you should probably create a brand
850  * new structure.  Keeping the old structure will allow backwards compatibility
851  * with old clients (even if it is only used to calculate allocation size).
852  * If you do change the size or the format, you'll need to bump
853  * RX_STATS_RETRIEVAL_VERSION.  This allows some primitive form
854  * of versioning a la rxdebug.
855  */
856
857 #define RX_STATS_RETRIEVAL_VERSION 1    /* latest version */
858 #define RX_STATS_RETRIEVAL_FIRST_EDITION 1      /* first implementation */
859
860 typedef struct rx_interface_stat {
861     struct opr_queue entry;
862     struct opr_queue entryPeers;
863     rx_function_entry_v1_t stats[1];    /* make sure this is aligned correctly */
864 } rx_interface_stat_t, *rx_interface_stat_p;
865
866 #define RX_STATS_SERVICE_ID 409
867
868 #ifdef AFS_NT40_ENV
869 extern int rx_DumpCalls(FILE *outputFile, char *cookie);
870 #endif
871
872 #endif /* _RX_   End of rx.h */
873
874 #ifdef  KERNEL
875 #include "rx/rx_prototypes.h"
876 #else
877 #include "rx_prototypes.h"
878 #endif
879
880 static_inline afs_uint32
881 RPCOpStat_Peer(void *blob) {
882     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
883     return rpcop_stat->remote_peer;
884 }
885
886 static_inline afs_uint32
887 RPCOpStat_Port(void *blob) {
888     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
889     return rpcop_stat->remote_port;
890 }
891
892 static_inline afs_uint32
893 RPCOpStat_IsServer(void *blob) {
894     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
895     return rpcop_stat->remote_is_server;
896 }
897
898 static_inline afs_uint32
899 RPCOpStat_InterfaceId(void *blob) {
900     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
901     return rpcop_stat->interfaceId;
902 }
903
904 static_inline afs_uint32
905 RPCOpStat_NumFuncs(void *blob) {
906     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
907     return rpcop_stat->func_total;
908 }
909
910 static_inline afs_uint32
911 RPCOpStat_CurFunc(void *blob) {
912     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
913     return rpcop_stat->func_index;
914 }
915
916 static_inline struct clock *
917 RPCOpStat_QTimeSum(void *blob) {
918     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
919     return &(rpcop_stat->queue_time_sum);
920 }
921
922 static_inline struct clock *
923 RPCOpStat_QTimeSumSqr(void *blob) {
924     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
925     return &(rpcop_stat->queue_time_sum_sqr);
926 }
927
928 static_inline struct clock *
929 RPCOpStat_QTimeSumMin(void *blob) {
930     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
931     return &(rpcop_stat->queue_time_min);
932 }
933
934 static_inline struct clock *
935 RPCOpStat_QTimeSumMax(void *blob) {
936     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
937     return &(rpcop_stat->queue_time_max);
938 }
939
940 static_inline struct clock *
941 RPCOpStat_ExecTimeSum(void *blob) {
942     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
943     return &(rpcop_stat->execution_time_sum);
944 }
945
946 static_inline struct clock *
947 RPCOpStat_ExecTimeSumSqr(void *blob) {
948     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
949     return &(rpcop_stat->execution_time_sum_sqr);
950 }
951
952 static_inline struct clock *
953 RPCOpStat_ExecTimeSumMin(void *blob) {
954     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
955     return &(rpcop_stat->execution_time_min);
956 }
957
958 static_inline struct clock *
959 RPCOpStat_ExecTimeSumMax(void *blob) {
960     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
961     return &(rpcop_stat->execution_time_max);
962 }
963
964 static_inline afs_uint64
965 RPCOpStat_NumCalls(void *blob) {
966     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
967     return rpcop_stat->invocations;
968 }
969
970 static_inline afs_uint64
971 RPCOpStat_BytesSent(void *blob) {
972     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
973     return rpcop_stat->bytes_sent;
974 }
975
976 static_inline afs_uint64
977 RPCOpStat_BytesRcvd(void *blob) {
978     rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
979     return rpcop_stat->bytes_rcvd;
980 }
981 #endif /* !KDUMP_RX_LOCK */