2 * Copyright 2000, International Business Machines Corporation and others.
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
10 #include <afsconfig.h>
12 #include "afs/param.h"
14 #include <afs/param.h>
18 #include <sys/time_impl.h>
26 #include "afs/afs_osi.h"
28 #include "afs/sysincludes.h"
29 #include "afsincludes.h"
31 #include "rx/rx_clock.h"
32 #include "rx/rx_queue.h"
33 #include "rx/rx_event.h"
34 #include "rx/rx_kernel.h"
35 #include "rx_kmutex.h"
36 #ifdef RX_ENABLE_LOCKS
38 #endif /* RX_ENABLE_LOCKS */
39 #include "rx/rx_globals.h"
40 #if defined(AFS_SGI_ENV)
41 #include "sys/debug.h"
42 /* These are necessary to get curproc (used by GLOCK asserts) to work. */
44 #if !defined(AFS_SGI64_ENV) && !defined(UKERNEL)
47 extern void *osi_Alloc();
49 #if defined(AFS_OBSD_ENV)
58 #ifdef AFS_PTHREAD_ENV
59 #include <rx/rx_pthread.h>
63 #ifdef RX_ENABLE_LOCKS
65 #endif /* RX_ENABLE_LOCKS */
66 #include "rx_globals.h"
73 /* All event processing is relative to the apparent current time given by clock_GetTime */
75 /* This should be static, but event_test wants to look at the free list... */
76 struct rx_queue rxevent_free; /* It's somewhat bogus to use a doubly-linked queue for the free list */
77 struct rx_queue rxepoch_free; /* It's somewhat bogus to use a doubly-linked queue for the free list */
78 static struct rx_queue rxepoch_queue; /* list of waiting epochs */
79 static int rxevent_allocUnit = 10; /* Allocation unit (number of event records to allocate at one time) */
80 static int rxepoch_allocUnit = 10; /* Allocation unit (number of epoch records to allocate at one time) */
81 int rxevent_nFree; /* Number of free event records */
82 int rxevent_nPosted; /* Current number of posted events */
83 int rxepoch_nFree; /* Number of free epoch records */
84 static void (*rxevent_ScheduledEarlierEvent) (void); /* Proc to call when an event is scheduled that is earlier than all other events */
88 struct xfreelist *next;
90 static struct xfreelist *xfreemallocs = 0, *xsp = 0;
92 struct clock rxevent_nextRaiseEvents; /* Time of next call to raise events */
93 int rxevent_raiseScheduled; /* true if raise events is scheduled */
95 #ifdef RX_ENABLE_LOCKS
97 /* rxdb_fileID is used to identify the lock location, along with line#. */
98 static int rxdb_fileID = RXDB_FILE_RX_EVENT;
99 #endif /* RX_LOCKS_DB */
100 #define RX_ENABLE_LOCKS 1
101 afs_kmutex_t rxevent_lock;
102 #endif /* RX_ENABLE_LOCKS */
104 #ifdef AFS_PTHREAD_ENV
106 * This mutex protects the following global variables:
107 * rxevent_initialized
111 pthread_mutex_t rx_event_mutex;
112 #define LOCK_EV_INIT assert(pthread_mutex_lock(&rx_event_mutex)==0)
113 #define UNLOCK_EV_INIT assert(pthread_mutex_unlock(&rx_event_mutex)==0)
116 #define UNLOCK_EV_INIT
117 #endif /* AFS_PTHREAD_ENV */
120 /* Pass in the number of events to allocate at a time */
121 int rxevent_initialized = 0;
123 rxevent_Init(int nEvents, void (*scheduler) (void))
126 if (rxevent_initialized) {
130 MUTEX_INIT(&rxevent_lock, "rxevent_lock", MUTEX_DEFAULT, 0);
133 rxevent_allocUnit = nEvents;
134 queue_Init(&rxevent_free);
135 queue_Init(&rxepoch_free);
136 queue_Init(&rxepoch_queue);
137 rxevent_nFree = rxevent_nPosted = 0;
139 rxevent_ScheduledEarlierEvent = scheduler;
140 rxevent_initialized = 1;
141 clock_Zero(&rxevent_nextRaiseEvents);
142 rxevent_raiseScheduled = 0;
146 /* Create and initialize new epoch structure */
148 rxepoch_Allocate(struct clock *when)
153 /* If we are short on free epoch entries, create a block of new oned
154 * and add them to the free queue */
155 if (queue_IsEmpty(&rxepoch_free)) {
156 #if defined(AFS_AIX32_ENV) && defined(KERNEL)
157 ep = (struct rxepoch *)rxi_Alloc(sizeof(struct rxepoch));
158 queue_Append(&rxepoch_free, &ep[0]), rxepoch_nFree++;
160 ep = (struct rxepoch *)
161 osi_Alloc(sizeof(struct rxepoch) * rxepoch_allocUnit);
164 (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
165 xfreemallocs->mem = (void *)ep;
166 xfreemallocs->size = sizeof(struct rxepoch) * rxepoch_allocUnit;
167 xfreemallocs->next = xsp;
168 for (i = 0; i < rxepoch_allocUnit; i++)
169 queue_Append(&rxepoch_free, &ep[i]), rxepoch_nFree++;
172 ep = queue_First(&rxepoch_free, rxepoch);
175 ep->epochSec = when->sec;
176 queue_Init(&ep->events);
180 /* Add the indicated event (function, arg) at the specified clock time. The
181 * "when" argument specifies when "func" should be called, in clock (clock.h)
186 rxevent_Post(struct clock *when,
187 void (*func) (struct rxevent * event,
188 struct rx_connection * conn,
189 struct rx_call * acall), void *arg, void *arg1)
191 static struct rxevent *
192 _rxevent_Post(struct clock *when, void (*func) (), void *arg, void *arg1,
193 int arg2, int newargs)
196 register struct rxevent *ev, *evqe, *evqpr;
197 register struct rxepoch *ep, *epqe, *epqpr;
200 MUTEX_ENTER(&rxevent_lock);
205 fprintf(rx_Log_event, "%d.%d: rxevent_Post(%d.%d, %lx, %lx, %lx, %d)\n",
206 (int)now.sec, (int)now.usec, (int)when->sec, (int)when->usec,
207 (unsigned long)func, (unsigned long)arg,
208 (unsigned long)arg1, arg2);
212 /* Get a pointer to the epoch for this event, if none is found then
213 * create a new epoch and insert it into the sorted list */
214 for (ep = NULL, queue_ScanBackwards(&rxepoch_queue, epqe, epqpr, rxepoch)) {
215 if (when->sec == epqe->epochSec) {
216 /* already have an structure for this epoch */
218 if (ep == queue_First(&rxepoch_queue, rxepoch))
221 } else if (when->sec > epqe->epochSec) {
222 /* Create a new epoch and insert after qe */
223 ep = rxepoch_Allocate(when);
224 queue_InsertAfter(epqe, ep);
229 /* Create a new epoch and place it at the head of the list */
230 ep = rxepoch_Allocate(when);
231 queue_Prepend(&rxepoch_queue, ep);
235 /* If we're short on free event entries, create a block of new ones and add
236 * them to the free queue */
237 if (queue_IsEmpty(&rxevent_free)) {
239 #if defined(AFS_AIX32_ENV) && defined(KERNEL)
240 ev = (struct rxevent *)rxi_Alloc(sizeof(struct rxevent));
241 queue_Append(&rxevent_free, &ev[0]), rxevent_nFree++;
243 ev = (struct rxevent *)osi_Alloc(sizeof(struct rxevent) *
247 (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
248 xfreemallocs->mem = (void *)ev;
249 xfreemallocs->size = sizeof(struct rxevent) * rxevent_allocUnit;
250 xfreemallocs->next = xsp;
251 for (i = 0; i < rxevent_allocUnit; i++)
252 queue_Append(&rxevent_free, &ev[i]), rxevent_nFree++;
256 /* Grab and initialize a new rxevent structure */
257 ev = queue_First(&rxevent_free, rxevent);
261 /* Record user defined event state */
262 ev->eventTime = *when;
267 ev->newargs = newargs;
268 rxevent_nPosted += 1; /* Rather than ++, to shut high-C up
269 * regarding never-set variables
272 /* Insert the event into the sorted list of events for this epoch */
273 for (queue_ScanBackwards(&ep->events, evqe, evqpr, rxevent)) {
274 if (when->usec >= evqe->eventTime.usec) {
275 /* Insert event after evqe */
276 queue_InsertAfter(evqe, ev);
277 MUTEX_EXIT(&rxevent_lock);
281 /* Insert event at head of current epoch */
282 queue_Prepend(&ep->events, ev);
283 if (isEarliest && rxevent_ScheduledEarlierEvent
284 && (!rxevent_raiseScheduled
285 || clock_Lt(&ev->eventTime, &rxevent_nextRaiseEvents))) {
286 rxevent_raiseScheduled = 1;
287 clock_Zero(&rxevent_nextRaiseEvents);
288 MUTEX_EXIT(&rxevent_lock);
289 /* Notify our external scheduler */
290 (*rxevent_ScheduledEarlierEvent) ();
291 MUTEX_ENTER(&rxevent_lock);
293 MUTEX_EXIT(&rxevent_lock);
298 rxevent_Post(struct clock *when, void (*func) (), void *arg, void *arg1)
300 return _rxevent_Post(when, func, arg, arg1, 0, 0);
304 rxevent_Post2(struct clock *when, void (*func) (), void *arg, void *arg1,
307 return _rxevent_Post(when, func, arg, arg1, arg2, 1);
310 /* Cancel an event by moving it from the event queue to the free list.
311 * Warning, the event must be on the event queue! If not, this should core
312 * dump (reference through 0). This routine should be called using the macro
313 * event_Cancel, which checks for a null event and also nulls the caller's
314 * event pointer after cancelling the event.
316 #ifdef RX_ENABLE_LOCKS
317 #ifdef RX_REFCOUNT_CHECK
318 int rxevent_Cancel_type = 0;
323 rxevent_Cancel_1(register struct rxevent *ev, register struct rx_call *call,
330 fprintf(rx_Log_event, "%d.%d: rxevent_Cancel_1(%d.%d, %lx, %lx)\n",
331 (int)now.sec, (int)now.usec, (int)ev->eventTime.sec,
332 (int)ev->eventTime.usec, (unsigned long)ev->func,
333 (unsigned long)ev->arg);
336 /* Append it to the free list (rather than prepending) to keep the free
337 * list hot so nothing pages out
339 MUTEX_ENTER(&rxevent_lock);
341 MUTEX_EXIT(&rxevent_lock);
344 #ifdef RX_ENABLE_LOCKS
345 /* It's possible we're currently processing this event. */
346 if (queue_IsOnQueue(ev)) {
347 queue_MoveAppend(&rxevent_free, ev);
352 #ifdef RX_REFCOUNT_CHECK
353 call->refCDebug[type]--;
354 if (call->refCDebug[type] < 0) {
355 rxevent_Cancel_type = type;
356 osi_Panic("rxevent_Cancel: call refCount < 0");
358 #endif /* RX_REFCOUNT_CHECK */
361 #else /* RX_ENABLE_LOCKS */
362 queue_MoveAppend(&rxevent_free, ev);
365 #endif /* RX_ENABLE_LOCKS */
366 MUTEX_EXIT(&rxevent_lock);
369 /* Process all epochs that have expired relative to the current clock time
370 * (which is not re-evaluated unless clock_NewTime has been called). The
371 * relative time to the next epoch is returned in the output parameter next
372 * and the function returns 1. If there are is no next epoch, the function
376 rxevent_RaiseEvents(struct clock *next)
378 register struct rxepoch *ep;
379 register struct rxevent *ev;
380 volatile struct clock now;
382 MUTEX_ENTER(&rxevent_lock);
384 /* Events are sorted by time, so only scan until an event is found that has
385 * not yet timed out */
388 while (queue_IsNotEmpty(&rxepoch_queue)) {
389 ep = queue_First(&rxepoch_queue, rxepoch);
390 if (queue_IsEmpty(&ep->events)) {
392 queue_Append(&rxepoch_free, ep);
397 ev = queue_First(&ep->events, rxevent);
398 if (clock_Lt(&now, &ev->eventTime)) {
400 if (clock_Lt(&now, &ev->eventTime)) {
401 *next = rxevent_nextRaiseEvents = ev->eventTime;
402 rxevent_raiseScheduled = 1;
403 clock_Sub(next, &now);
404 MUTEX_EXIT(&rxevent_lock);
410 MUTEX_EXIT(&rxevent_lock);
412 ev->func(ev, ev->arg, ev->arg1, ev->arg2);
414 ev->func(ev, ev->arg, ev->arg1);
416 MUTEX_ENTER(&rxevent_lock);
417 queue_Append(&rxevent_free, ev);
419 } while (queue_IsNotEmpty(&ep->events));
423 fprintf(rx_Log_event, "rxevent_RaiseEvents(%d.%d)\n", (int)now.sec,
426 rxevent_raiseScheduled = 0;
427 MUTEX_EXIT(&rxevent_lock);
432 shutdown_rxevent(void)
434 struct xfreelist *xp, *nxp;
437 if (!rxevent_initialized) {
441 rxevent_initialized = 0;
443 MUTEX_DESTROY(&rxevent_lock);
444 #if defined(AFS_AIX32_ENV) && defined(KERNEL)
445 /* Everything is freed in afs_osinet.c */
450 osi_Free((char *)xp->mem, xp->size);
451 osi_Free((char *)xp, sizeof(struct xfreelist));