FBSD: deal with kernel API rename
[openafs.git] / src / rx / rx_globals.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 /* RX:  Globals for internal use, basically */
11
12 #ifndef AFS_RX_GLOBALS_H
13 #define AFS_RX_GLOBALS_H
14
15
16 #ifdef  KERNEL
17 #include "rx/rx.h"
18 #else /* KERNEL */
19 # include "rx.h"
20 #endif /* KERNEL */
21
22 #ifndef GLOBALSINIT
23 #define GLOBALSINIT(x)
24 #if defined(AFS_NT40_ENV)
25 #define RX_STATS_INTERLOCKED 1
26 #if defined(AFS_PTHREAD_ENV)
27 #define EXT __declspec(dllimport) extern
28 #else /* AFS_PTHREAD_ENV */
29 #define EXT extern
30 #endif /* AFS_PTHREAD_ENV */
31 #else /* AFS_NT40_ENV */
32 #define EXT extern
33 #endif /* AFS_NT40_ENV */
34 #endif /* !GLOBALSINIT */
35
36 /* Basic socket for client requests; other sockets (for receiving server requests) are in the service structures */
37 EXT osi_socket rx_socket;
38
39 /* The array of installed services.  Null terminated. */
40 EXT struct rx_service *rx_services[RX_MAX_SERVICES + 1];
41 #ifdef RX_ENABLE_LOCKS
42 /* Protects nRequestsRunning as well as pool allocation variables. */
43 EXT afs_kmutex_t rx_serverPool_lock;
44 #endif /* RX_ENABLE_LOCKS */
45
46 /* Incoming calls wait on this queue when there are no available server processes */
47 EXT struct rx_queue rx_incomingCallQueue;
48
49 /* Server processes wait on this queue when there are no appropriate calls to process */
50 EXT struct rx_queue rx_idleServerQueue;
51
52 /* Constant delay time before sending a hard ack if the receiver consumes
53  * a packet while no delayed ack event is scheduled. Ensures that the
54  * sender is able to advance its window when the receiver consumes a packet
55  * after the sender has exhausted its transmit window.
56  */
57 EXT struct clock rx_hardAckDelay;
58
59 #if defined(RXDEBUG) || defined(AFS_NT40_ENV)
60 /* Variable to allow introduction of network unreliability; exported from libafsrpc */
61 EXT int rx_intentionallyDroppedPacketsPer100 GLOBALSINIT(0);    /* Dropped on Send */
62 EXT int rx_intentionallyDroppedOnReadPer100  GLOBALSINIT(0);    /* Dropped on Read */
63 #endif
64
65 /* extra packets to add to the quota */
66 EXT int rx_extraQuota GLOBALSINIT(0);
67 /* extra packets to alloc (2 * maxWindowSize by default) */
68 EXT int rx_extraPackets GLOBALSINIT(256);
69
70 EXT int rx_stackSize GLOBALSINIT(RX_DEFAULT_STACK_SIZE);
71
72 /* Time until an unresponsive connection is declared dead */
73 EXT int rx_connDeadTime GLOBALSINIT(12);
74
75 /* Set rx default connection dead time; set on both services and connections at creation time */
76 #ifdef AFS_NT40_ENV
77 void rx_SetRxDeadTime(int seconds);
78 #else
79 #define rx_SetRxDeadTime(seconds)   (rx_connDeadTime = (seconds))
80 #endif
81
82 /* Time until we toss an idle connection */
83 EXT int rx_idleConnectionTime GLOBALSINIT(700);
84 /* Time until we toss a peer structure, after all connections using are gone */
85 EXT int rx_idlePeerTime GLOBALSINIT(60);
86
87 /* The file server is temporarily salvaging */
88 EXT int rx_tranquil GLOBALSINIT(0);
89
90 /* UDP rcv buffer size */
91 EXT int rx_UdpBufSize GLOBALSINIT(64 * 1024);
92 #ifdef AFS_NT40_ENV
93 int   rx_GetMinUdpBufSize(void);
94 void  rx_SetUdpBufSize(int x);
95 #else
96 #define rx_GetMinUdpBufSize()   (64*1024)
97 #define rx_SetUdpBufSize(x)     (((x)>rx_GetMinUdpBufSize()) ? (rx_UdpBufSize = (x)):0)
98 #endif
99 /*
100  * Variables to control RX overload management. When the number of calls
101  * waiting for a thread exceed the threshold, new calls are aborted
102  * with the busy error.
103  */
104 EXT int rx_BusyThreshold GLOBALSINIT(-1);       /* default is disabled */
105 EXT int rx_BusyError GLOBALSINIT(-1);
106
107 /* These definitions should be in one place */
108 #ifdef  AFS_SUN5_ENV
109 #define RX_CBUF_TIME    180     /* Check for packet deficit */
110 #define RX_REAP_TIME    90      /* Check for tossable connections every 90 seconds */
111 #else
112 #define RX_CBUF_TIME    120     /* Check for packet deficit */
113 #define RX_REAP_TIME    60      /* Check for tossable connections every 60 seconds */
114 #endif
115
116 #define RX_FAST_ACK_RATE 1      /* as of 3.4, ask for an ack every
117                                  * other packet. */
118
119 EXT int rx_minPeerTimeout GLOBALSINIT(20);      /* in milliseconds */
120 EXT int rx_minWindow GLOBALSINIT(1);
121 EXT int rx_maxWindow GLOBALSINIT(RX_MAXACKS);   /* must ack what we receive */
122 EXT int rx_initReceiveWindow GLOBALSINIT(16);   /* how much to accept */
123 EXT int rx_maxReceiveWindow GLOBALSINIT(32);    /* how much to accept */
124 EXT int rx_initSendWindow GLOBALSINIT(16);
125 EXT int rx_maxSendWindow GLOBALSINIT(32);
126 EXT int rx_nackThreshold GLOBALSINIT(3);        /* Number NACKS to trigger congestion recovery */
127 EXT int rx_nDgramThreshold GLOBALSINIT(4);      /* Number of packets before increasing
128                                                  * packets per datagram */
129 #define RX_MAX_FRAGS 4
130 EXT int rxi_nSendFrags GLOBALSINIT(RX_MAX_FRAGS);       /* max fragments in a datagram */
131 EXT int rxi_nRecvFrags GLOBALSINIT(RX_MAX_FRAGS);
132 EXT int rxi_OrphanFragSize GLOBALSINIT(512);
133
134 #define RX_MAX_DGRAM_PACKETS 6  /* max packets per jumbogram */
135
136 EXT int rxi_nDgramPackets GLOBALSINIT(RX_MAX_DGRAM_PACKETS);
137 /* allow n packets between soft acks - must be power of 2 -1, else change
138  * macro below */
139 EXT int rxi_SoftAckRate GLOBALSINIT(RX_FAST_ACK_RATE);
140 /* consume n packets before sending hard ack, should be larger than above,
141    but not absolutely necessary.  If it's smaller, than fast receivers will
142    send a soft ack, immediately followed by a hard ack. */
143 EXT int rxi_HardAckRate GLOBALSINIT(RX_FAST_ACK_RATE + 1);
144
145 /* If window sizes become very variable (in terms of #packets), be
146  * sure that the sender can get back a hard acks without having to wait for
147  * some kind of timer event first (like a keep-alive, for instance).
148  * It might be kind of tricky, so it might be better to shrink the
149  * window size by reducing the packet size below the "natural" MTU. */
150
151 #define ACKHACK(p,r) { if (((p)->header.seq & (rxi_SoftAckRate))==0) (p)->header.flags |= RX_REQUEST_ACK; }
152
153 EXT int rx_nPackets GLOBALSINIT(0);     /* preallocate packets with rx_extraPackets */
154
155 /*
156  * pthreads thread-specific rx info support
157  * the rx_ts_info_t struct is meant to support all kinds of
158  * thread-specific rx data:
159  *
160  *  _FPQ member contains a thread-specific free packet queue
161  */
162 #ifdef AFS_PTHREAD_ENV
163 EXT pthread_key_t rx_ts_info_key;
164 typedef struct rx_ts_info_t {
165     struct {
166         struct rx_queue queue;
167         int len;                /* local queue length */
168         int delta;              /* number of new packets alloc'd locally since last sync w/ global queue */
169
170         /* FPQ stats */
171         int checkin_ops;
172         int checkin_xfer;
173         int checkout_ops;
174         int checkout_xfer;
175         int gtol_ops;
176         int gtol_xfer;
177         int ltog_ops;
178         int ltog_xfer;
179         int lalloc_ops;
180         int lalloc_xfer;
181         int galloc_ops;
182         int galloc_xfer;
183     } _FPQ;
184     struct rx_packet * local_special_packet;
185 } rx_ts_info_t;
186 EXT struct rx_ts_info_t * rx_ts_info_init(void);   /* init function for thread-specific data struct */
187 #define RX_TS_INFO_GET(ts_info_p) \
188     do { \
189         ts_info_p = (struct rx_ts_info_t*)pthread_getspecific(rx_ts_info_key); \
190         if (ts_info_p == NULL) { \
191             osi_Assert((ts_info_p = rx_ts_info_init()) != NULL); \
192         } \
193     } while(0)
194 #endif /* AFS_PTHREAD_ENV */
195
196
197 /* List of free packets */
198 /* in pthreads rx, free packet queue is now a two-tiered queueing system
199  * in which the first tier is thread-specific, and the second tier is
200  * a global free packet queue */
201 EXT struct rx_queue rx_freePacketQueue;
202 #ifdef RX_TRACK_PACKETS
203 #define RX_FPQ_MARK_FREE(p) \
204     do { \
205         if ((p)->flags & RX_PKTFLAG_FREE) \
206             osi_Panic("rx packet already free\n"); \
207         (p)->flags |= RX_PKTFLAG_FREE; \
208         (p)->flags &= ~(RX_PKTFLAG_TQ|RX_PKTFLAG_IOVQ|RX_PKTFLAG_RQ|RX_PKTFLAG_CP); \
209         (p)->length = 0; \
210         (p)->niovecs = 0; \
211     } while(0)
212 #define RX_FPQ_MARK_USED(p) \
213     do { \
214         if (!((p)->flags & RX_PKTFLAG_FREE)) \
215             osi_Panic("rx packet not free\n"); \
216         (p)->flags = 0;         /* clear RX_PKTFLAG_FREE, initialize the rest */ \
217         (p)->header.flags = 0; \
218     } while(0)
219 #else
220 #define RX_FPQ_MARK_FREE(p) \
221     do { \
222         (p)->length = 0; \
223         (p)->niovecs = 0; \
224     } while(0)
225 #define RX_FPQ_MARK_USED(p) \
226     do { \
227         (p)->flags = 0;         /* clear RX_PKTFLAG_FREE, initialize the rest */ \
228         (p)->header.flags = 0; \
229     } while(0)
230 #endif
231 #define RX_PACKET_IOV_INIT(p) \
232     do { \
233         (p)->wirevec[0].iov_base = (char *)((p)->wirehead); \
234         (p)->wirevec[0].iov_len = RX_HEADER_SIZE; \
235         (p)->wirevec[1].iov_base = (char *)((p)->localdata); \
236         (p)->wirevec[1].iov_len = RX_FIRSTBUFFERSIZE; \
237     } while(0)
238 #define RX_PACKET_IOV_FULLINIT(p) \
239     do { \
240         (p)->wirevec[0].iov_base = (char *)((p)->wirehead); \
241         (p)->wirevec[0].iov_len = RX_HEADER_SIZE; \
242         (p)->wirevec[1].iov_base = (char *)((p)->localdata); \
243         (p)->wirevec[1].iov_len = RX_FIRSTBUFFERSIZE; \
244         (p)->niovecs = 2; \
245         (p)->length = RX_FIRSTBUFFERSIZE; \
246     } while(0)
247
248 #ifdef RX_ENABLE_LOCKS
249 EXT afs_kmutex_t rx_freePktQ_lock;
250 #endif /* RX_ENABLE_LOCKS */
251
252 #if defined(AFS_PTHREAD_ENV)
253 #define RX_ENABLE_TSFPQ
254 EXT int rx_TSFPQGlobSize GLOBALSINIT(3); /* number of packets to transfer between global and local queues in one op */
255 EXT int rx_TSFPQLocalMax GLOBALSINIT(15); /* max number of packets on local FPQ before returning a glob to the global pool */
256 EXT int rx_TSFPQMaxProcs GLOBALSINIT(0); /* max number of threads expected */
257 #define RX_TS_FPQ_FLUSH_GLOBAL 1
258 #define RX_TS_FPQ_PULL_GLOBAL 1
259 #define RX_TS_FPQ_ALLOW_OVERCOMMIT 1
260 /*
261  * compute the localmax and globsize values from rx_TSFPQMaxProcs and rx_nPackets.
262  * arbitarily set local max so that all threads consume 90% of packets, if all local queues are full.
263  * arbitarily set transfer glob size to 20% of max local packet queue length.
264  * also set minimum values of 15 and 3.  Given the algorithms, the number of buffers allocated
265  * by each call to AllocPacketBufs() will increase indefinitely without a cap on the transfer
266  * glob size.  A cap of 64 is selected because that will produce an allocation of greater than
267  * three times that amount which is greater than half of ncalls * maxReceiveWindow.
268  * Must be called under rx_packets_mutex.
269  */
270 #define RX_TS_FPQ_COMPUTE_LIMITS \
271     do { \
272         int newmax, newglob; \
273         newmax = (rx_nPackets * 9) / (10 * rx_TSFPQMaxProcs); \
274         newmax = (newmax >= 15) ? newmax : 15; \
275         newglob = newmax / 5; \
276         newglob = (newglob >= 3) ? (newglob < 64 ? newglob : 64) : 3; \
277         rx_TSFPQLocalMax = newmax; \
278         rx_TSFPQGlobSize = newglob; \
279     } while(0)
280 /* record the number of packets allocated by this thread
281  * and stored in the thread local queue */
282 #define RX_TS_FPQ_LOCAL_ALLOC(rx_ts_info_p,num_alloc) \
283     do { \
284         (rx_ts_info_p)->_FPQ.lalloc_ops++; \
285         (rx_ts_info_p)->_FPQ.lalloc_xfer += num_alloc; \
286     } while (0)
287 /* record the number of packets allocated by this thread
288  * and stored in the global queue */
289 #define RX_TS_FPQ_GLOBAL_ALLOC(rx_ts_info_p,num_alloc) \
290     do { \
291         (rx_ts_info_p)->_FPQ.galloc_ops++; \
292         (rx_ts_info_p)->_FPQ.galloc_xfer += num_alloc; \
293     } while (0)
294 /* move packets from local (thread-specific) to global free packet queue.
295    rx_freePktQ_lock must be held. default is to reduce the queue size to 40% ofmax */
296 #define RX_TS_FPQ_LTOG(rx_ts_info_p) \
297     do { \
298         int i; \
299         struct rx_packet * p; \
300         int tsize = MIN((rx_ts_info_p)->_FPQ.len, (rx_ts_info_p)->_FPQ.len - rx_TSFPQLocalMax + 3 *  rx_TSFPQGlobSize); \
301         if (tsize <= 0) break; \
302         for (i=0,p=queue_Last(&((rx_ts_info_p)->_FPQ), rx_packet); \
303              i < tsize; i++,p=queue_Prev(p, rx_packet)); \
304         queue_SplitAfterPrepend(&((rx_ts_info_p)->_FPQ),&rx_freePacketQueue,p); \
305         (rx_ts_info_p)->_FPQ.len -= tsize; \
306         rx_nFreePackets += tsize; \
307         (rx_ts_info_p)->_FPQ.ltog_ops++; \
308         (rx_ts_info_p)->_FPQ.ltog_xfer += tsize; \
309         if ((rx_ts_info_p)->_FPQ.delta) { \
310             MUTEX_ENTER(&rx_packets_mutex); \
311             RX_TS_FPQ_COMPUTE_LIMITS; \
312             MUTEX_EXIT(&rx_packets_mutex); \
313            (rx_ts_info_p)->_FPQ.delta = 0; \
314         } \
315     } while(0)
316 /* same as above, except user has direct control over number to transfer */
317 #define RX_TS_FPQ_LTOG2(rx_ts_info_p,num_transfer) \
318     do { \
319         int i; \
320         struct rx_packet * p; \
321         if (num_transfer <= 0) break; \
322         for (i=0,p=queue_Last(&((rx_ts_info_p)->_FPQ), rx_packet); \
323              i < (num_transfer); i++,p=queue_Prev(p, rx_packet)); \
324         queue_SplitAfterPrepend(&((rx_ts_info_p)->_FPQ),&rx_freePacketQueue,p); \
325         (rx_ts_info_p)->_FPQ.len -= (num_transfer); \
326         rx_nFreePackets += (num_transfer); \
327         (rx_ts_info_p)->_FPQ.ltog_ops++; \
328         (rx_ts_info_p)->_FPQ.ltog_xfer += (num_transfer); \
329         if ((rx_ts_info_p)->_FPQ.delta) { \
330             MUTEX_ENTER(&rx_packets_mutex); \
331             RX_TS_FPQ_COMPUTE_LIMITS; \
332             MUTEX_EXIT(&rx_packets_mutex); \
333             (rx_ts_info_p)->_FPQ.delta = 0; \
334         } \
335     } while(0)
336 /* move packets from global to local (thread-specific) free packet queue.
337    rx_freePktQ_lock must be held. */
338 #define RX_TS_FPQ_GTOL(rx_ts_info_p) \
339     do { \
340         int i, tsize; \
341         struct rx_packet * p; \
342         tsize = (rx_TSFPQGlobSize <= rx_nFreePackets) ? \
343                  rx_TSFPQGlobSize : rx_nFreePackets; \
344         for (i=0,p=queue_First(&rx_freePacketQueue, rx_packet); \
345              i < tsize; i++,p=queue_Next(p, rx_packet)); \
346         queue_SplitBeforeAppend(&rx_freePacketQueue,&((rx_ts_info_p)->_FPQ),p); \
347         (rx_ts_info_p)->_FPQ.len += i; \
348         rx_nFreePackets -= i; \
349         (rx_ts_info_p)->_FPQ.gtol_ops++; \
350         (rx_ts_info_p)->_FPQ.gtol_xfer += i; \
351     } while(0)
352 /* same as above, except user has direct control over number to transfer */
353 #define RX_TS_FPQ_GTOL2(rx_ts_info_p,num_transfer) \
354     do { \
355         int i, tsize; \
356         struct rx_packet * p; \
357         tsize = (num_transfer); \
358         if (tsize > rx_nFreePackets) tsize = rx_nFreePackets; \
359         for (i=0,p=queue_First(&rx_freePacketQueue, rx_packet); \
360              i < tsize; i++,p=queue_Next(p, rx_packet)); \
361         queue_SplitBeforeAppend(&rx_freePacketQueue,&((rx_ts_info_p)->_FPQ),p); \
362         (rx_ts_info_p)->_FPQ.len += i; \
363         rx_nFreePackets -= i; \
364         (rx_ts_info_p)->_FPQ.gtol_ops++; \
365         (rx_ts_info_p)->_FPQ.gtol_xfer += i; \
366     } while(0)
367 /* checkout a packet from the thread-specific free packet queue */
368 #define RX_TS_FPQ_CHECKOUT(rx_ts_info_p,p) \
369     do { \
370         (p) = queue_First(&((rx_ts_info_p)->_FPQ), rx_packet); \
371         queue_Remove(p); \
372         RX_FPQ_MARK_USED(p); \
373         (rx_ts_info_p)->_FPQ.len--; \
374         (rx_ts_info_p)->_FPQ.checkout_ops++; \
375         (rx_ts_info_p)->_FPQ.checkout_xfer++; \
376     } while(0)
377 /* checkout multiple packets from the thread-specific free packet queue.
378  * num_transfer must be a variable.
379  */
380 #define RX_TS_FPQ_QCHECKOUT(rx_ts_info_p,num_transfer,q) \
381     do { \
382         int i; \
383         struct rx_packet *p; \
384         if (num_transfer > (rx_ts_info_p)->_FPQ.len) num_transfer = (rx_ts_info_p)->_FPQ.len; \
385         for (i=0, p=queue_First(&((rx_ts_info_p)->_FPQ), rx_packet); \
386              i < num_transfer; \
387              i++, p=queue_Next(p, rx_packet)) { \
388             RX_FPQ_MARK_USED(p); \
389         } \
390         queue_SplitBeforeAppend(&((rx_ts_info_p)->_FPQ),(q),p); \
391         (rx_ts_info_p)->_FPQ.len -= num_transfer; \
392         (rx_ts_info_p)->_FPQ.checkout_ops++; \
393         (rx_ts_info_p)->_FPQ.checkout_xfer += num_transfer; \
394     } while(0)
395 /* check a packet into the thread-specific free packet queue */
396 #define RX_TS_FPQ_CHECKIN(rx_ts_info_p,p) \
397     do { \
398         queue_Prepend(&((rx_ts_info_p)->_FPQ), (p)); \
399         RX_FPQ_MARK_FREE(p); \
400         (rx_ts_info_p)->_FPQ.len++; \
401         (rx_ts_info_p)->_FPQ.checkin_ops++; \
402         (rx_ts_info_p)->_FPQ.checkin_xfer++; \
403     } while(0)
404 /* check multiple packets into the thread-specific free packet queue */
405 /* num_transfer must equal length of (q); it is not a means of checking
406  * in part of (q).  passing num_transfer just saves us instructions
407  * since caller already knows length of (q) for other reasons */
408 #define RX_TS_FPQ_QCHECKIN(rx_ts_info_p,num_transfer,q) \
409     do { \
410         struct rx_packet *p, *np; \
411         for (queue_Scan((q), p, np, rx_packet)) { \
412             RX_FPQ_MARK_FREE(p); \
413         } \
414         queue_SplicePrepend(&((rx_ts_info_p)->_FPQ),(q)); \
415         (rx_ts_info_p)->_FPQ.len += (num_transfer); \
416         (rx_ts_info_p)->_FPQ.checkin_ops++; \
417         (rx_ts_info_p)->_FPQ.checkin_xfer += (num_transfer); \
418     } while(0)
419 #endif /* AFS_PTHREAD_ENV */
420
421 /* Number of free packets */
422 EXT int rx_nFreePackets GLOBALSINIT(0);
423 EXT int rxi_NeedMorePackets GLOBALSINIT(0);
424 EXT int rx_packetReclaims GLOBALSINIT(0);
425
426 /* largest packet which we can safely receive, initialized to AFS 3.2 value
427  * This is provided for backward compatibility with peers which may be unable
428  * to swallow anything larger. THIS MUST NEVER DECREASE WHILE AN APPLICATION
429  * IS RUNNING! */
430 EXT afs_uint32 rx_maxReceiveSize GLOBALSINIT(_OLD_MAX_PACKET_SIZE * RX_MAX_FRAGS +
431                                       UDP_HDR_SIZE * (RX_MAX_FRAGS - 1));
432
433 /* this is the maximum packet size that the user wants us to receive */
434 /* this is set by rxTune if required */
435 EXT afs_uint32 rx_maxReceiveSizeUser GLOBALSINIT(0xffffffff);
436
437 /* rx_MyMaxSendSize is the size of the largest packet we will send,
438  * including the RX header. Just as rx_maxReceiveSize is the
439  * max we will receive, including the rx header.
440  */
441 EXT afs_uint32 rx_MyMaxSendSize GLOBALSINIT(8588);
442
443 /* Maximum size of a jumbo datagram we can receive */
444 EXT afs_uint32 rx_maxJumboRecvSize GLOBALSINIT(RX_MAX_PACKET_SIZE);
445
446 /* need this to permit progs to run on AIX systems */
447 EXT int (*rxi_syscallp) (afs_uint32 a3, afs_uint32 a4, void *a5)GLOBALSINIT(0);
448
449 /* List of free queue entries */
450 EXT struct rx_serverQueueEntry *rx_FreeSQEList GLOBALSINIT(0);
451 #ifdef  RX_ENABLE_LOCKS
452 EXT afs_kmutex_t freeSQEList_lock;
453 #endif
454
455 /* List of free call structures */
456 EXT struct rx_queue rx_freeCallQueue;
457 #ifdef  RX_ENABLE_LOCKS
458 EXT afs_kmutex_t rx_freeCallQueue_lock;
459 #endif
460 EXT afs_int32 rxi_nCalls GLOBALSINIT(0);
461
462 /* Port requested at rx_Init.  If this is zero, the actual port used will be different--but it will only be used for client operations.  If non-zero, server provided services may use the same port. */
463 EXT u_short rx_port;
464
465 #if !defined(KERNEL) && !defined(AFS_PTHREAD_ENV)
466 /* 32-bit select Mask for rx_Listener. */
467 EXT fd_set rx_selectMask;
468 EXT osi_socket rx_maxSocketNumber;      /* Maximum socket number in the select mask. */
469 /* Minumum socket number in the select mask. */
470 EXT osi_socket rx_minSocketNumber GLOBALSINIT(0x7fffffff);
471 #endif
472
473 /* This is actually the minimum number of packets that must remain free,
474     overall, immediately after a packet of the requested class has been
475     allocated.  *WARNING* These must be assigned with a great deal of care.
476     In order, these are receive quota, send quota, special quota, receive
477     continuation quota, and send continuation quota. */
478 #define RX_PACKET_QUOTAS {1, 10, 0, 1, 10}
479 /* value large enough to guarantee that no allocation fails due to RX_PACKET_QUOTAS.
480    Make it a little bigger, just for fun */
481 #define RX_MAX_QUOTA    15      /* part of min packet computation */
482 EXT int rx_packetQuota[RX_N_PACKET_CLASSES] GLOBALSINIT(RX_PACKET_QUOTAS);
483 EXT int meltdown_1pkt GLOBALSINIT(1);   /* prefer to schedule single-packet calls */
484 EXT int rxi_doreclaim GLOBALSINIT(1);   /* if discard one packet, discard all */
485 EXT int rxi_md2cnt GLOBALSINIT(0);      /* counter of skipped calls */
486 EXT int rxi_2dchoice GLOBALSINIT(1);    /* keep track of another call to schedule */
487
488 /* quota system: each attached server process must be able to make
489     progress to avoid system deadlock, so we ensure that we can always
490     handle the arrival of the next unacknowledged data packet for an
491     attached call.  rxi_dataQuota gives the max # of packets that must be
492     reserved for active calls for them to be able to make progress, which is
493     essentially enough to queue up a window-full of packets (the first packet
494     may be missing, so these may not get read) + the # of packets the thread
495     may use before reading all of its input (# free must be one more than send
496     packet quota).  Thus, each thread allocates rx_maxReceiveWindow+1 (max
497     queued packets) + an extra for sending data.  The system also reserves
498     RX_MAX_QUOTA (must be more than RX_PACKET_QUOTA[i], which is 10), so that
499     the extra packet can be sent (must be under the system-wide send packet
500     quota to send any packets) */
501 /* # to reserve so that thread with input can still make calls (send packets)
502    without blocking */
503 EXT int rxi_dataQuota GLOBALSINIT(RX_MAX_QUOTA);        /* packets to reserve for active threads */
504
505 EXT afs_int32 rxi_availProcs GLOBALSINIT(0);    /* number of threads in the pool */
506 EXT afs_int32 rxi_totalMin GLOBALSINIT(0);      /* Sum(minProcs) forall services */
507 EXT afs_int32 rxi_minDeficit GLOBALSINIT(0);    /* number of procs needed to handle all minProcs */
508
509 EXT int rx_nextCid;             /* Next connection call id */
510 EXT int rx_epoch;               /* Initialization time of rx */
511 #ifdef  RX_ENABLE_LOCKS
512 EXT afs_kcondvar_t rx_waitingForPackets_cv;
513 #endif
514 EXT char rx_waitingForPackets;  /* Processes set and wait on this variable when waiting for packet buffers */
515
516 EXT struct rx_peer **rx_peerHashTable;
517 EXT struct rx_connection **rx_connHashTable;
518 EXT struct rx_connection *rx_connCleanup_list GLOBALSINIT(0);
519 EXT afs_uint32 rx_hashTableSize GLOBALSINIT(257);       /* Prime number */
520 #ifdef RX_ENABLE_LOCKS
521 EXT afs_kmutex_t rx_peerHashTable_lock;
522 EXT afs_kmutex_t rx_connHashTable_lock;
523 #endif /* RX_ENABLE_LOCKS */
524
525 #define CONN_HASH(host, port, cid, epoch, type) ((((cid)>>RX_CIDSHIFT)%rx_hashTableSize))
526
527 #define PEER_HASH(host, port)  ((host ^ port) % rx_hashTableSize)
528
529 /* Forward definitions of internal procedures */
530 #define rxi_ChallengeOff(conn)  rxevent_Cancel((conn)->challengeEvent, (struct rx_call*)0, 0);
531 #define rxi_KeepAliveOff(call) rxevent_Cancel((call)->keepAliveEvent, call, RX_CALL_REFCOUNT_ALIVE)
532 #define rxi_NatKeepAliveOff(conn) rxevent_Cancel((conn)->natKeepAliveEvent, (struct rx_call*)0, 0)
533
534 #define rxi_AllocSecurityObject() rxi_Alloc(sizeof(struct rx_securityClass))
535 #define rxi_FreeSecurityObject(obj) rxi_Free(obj, sizeof(struct rx_securityClass))
536 #define rxi_AllocService()      rxi_Alloc(sizeof(struct rx_service))
537 #define rxi_FreeService(obj) \
538 do { \
539     MUTEX_DESTROY(&(obj)->svc_data_lock);  \
540     rxi_Free((obj), sizeof(struct rx_service)); \
541 } while (0)
542 #define rxi_AllocPeer()         rxi_Alloc(sizeof(struct rx_peer))
543 #define rxi_FreePeer(peer)      rxi_Free(peer, sizeof(struct rx_peer))
544 #define rxi_AllocConnection()   rxi_Alloc(sizeof(struct rx_connection))
545 #define rxi_FreeConnection(conn) (rxi_Free(conn, sizeof(struct rx_connection)))
546
547 EXT afs_int32 rx_stats_active GLOBALSINIT(1);   /* boolean - rx statistics gathering */
548
549 #ifndef KERNEL
550 /* Some debugging stuff */
551 EXT FILE *rx_debugFile;         /* Set by the user to a stdio file for debugging output */
552 EXT FILE *rxevent_debugFile;    /* Set to an stdio descriptor for event logging to that file */
553 #endif
554
555 #ifdef RXDEBUG
556 # define rx_Log rx_debugFile
557 # ifdef AFS_NT40_ENV
558 EXT int rxdebug_active;
559 #  define dpf(args) do { if (rxdebug_active) rxi_DebugPrint args; } while (0)
560 # else
561 #  ifdef DPF_FSLOG
562 #   include <afs/afsutil.h>
563 #   define dpf(args) FSLog args
564 #  else
565 #   define dpf(args) do { if (rx_debugFile) rxi_DebugPrint args; } while (0)
566 #  endif
567 # endif
568 # define rx_Log_event rxevent_debugFile
569 #else
570 # define dpf(args)
571 #endif /* RXDEBUG */
572
573 EXT char *rx_packetTypes[RX_N_PACKET_TYPES] GLOBALSINIT(RX_PACKET_TYPES);       /* Strings defined in rx.h */
574
575 #ifndef KERNEL
576 /*
577  * Counter used to implement connection specific data
578  */
579 EXT int rxi_keyCreate_counter GLOBALSINIT(0);
580 /*
581  * Array of function pointers used to destory connection specific data
582  */
583 EXT rx_destructor_t *rxi_keyCreate_destructor GLOBALSINIT(NULL);
584 #ifdef RX_ENABLE_LOCKS
585 EXT afs_kmutex_t rxi_keyCreate_lock;
586 #endif /* RX_ENABLE_LOCKS */
587 #endif /* !KERNEL */
588
589 /*
590  * SERVER ONLY: Threshholds used to throttle error replies to looping
591  * clients. When consecutive calls are aborting with the same error, the
592  * server throttles the client by waiting before sending error messages.
593  * Disabled if abort thresholds are zero.
594  */
595 EXT int rxi_connAbortThreshhold GLOBALSINIT(0);
596 EXT int rxi_connAbortDelay GLOBALSINIT(3000);
597 EXT int rxi_callAbortThreshhold GLOBALSINIT(0);
598 EXT int rxi_callAbortDelay GLOBALSINIT(3000);
599
600 /*
601  * Thread specific thread ID used to implement LWP_Index().
602  */
603
604 #if defined(AFS_PTHREAD_ENV)
605 EXT int rxi_fcfs_thread_num GLOBALSINIT(0);
606 EXT pthread_key_t rx_thread_id_key;
607 #else
608 #define rxi_fcfs_thread_num (0)
609 #endif
610
611 #if defined(RX_ENABLE_LOCKS)
612 EXT afs_kmutex_t rx_waiting_mutex;      /* used to protect waiting counters */
613 EXT afs_kmutex_t rx_quota_mutex;        /* used to protect quota counters */
614 EXT afs_kmutex_t rx_pthread_mutex;      /* used to protect pthread counters */
615 EXT afs_kmutex_t rx_packets_mutex;      /* used to protect packet counters */
616 EXT afs_kmutex_t rx_refcnt_mutex;       /* used to protect conn/call ref counts */
617 #endif
618
619 EXT int rx_enable_stats GLOBALSINIT(0);
620
621 /*
622  * Set this flag to enable the listener thread to trade places with an idle
623  * worker thread to move the context switch from listener to worker out of
624  * the request path.
625  */
626 EXT int rx_enable_hot_thread GLOBALSINIT(0);
627
628 EXT int RX_IPUDP_SIZE GLOBALSINIT(_RX_IPUDP_SIZE);
629 #endif /* AFS_RX_GLOBALS_H */