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