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>
11 #include "afs/param.h"
14 #include "afs/sysincludes.h" /* Standard vendor system headers */
15 #include "afsincludes.h" /* Afs-based standard headers */
16 #include "afs/afs_stats.h"
17 #include "rx/rx_globals.h"
18 #if !defined(UKERNEL) && !defined(AFS_LINUX20_ENV)
21 #include "h/hashing.h"
23 #if !defined(AFS_HPUX110_ENV) && !defined(AFS_DARWIN_ENV)
24 #include "netinet/in_var.h"
26 #endif /* !defined(UKERNEL) */
29 struct afs_icl_set *afs_iclSetp = (struct afs_icl_set *)0;
30 struct afs_icl_set *afs_iclLongTermSetp = (struct afs_icl_set *)0;
32 /* Matches below where ICL_APPENDLONG is 2 INT32s */
33 #if (defined(AFS_SGI61_ENV) && (_MIPS_SZLONG==64)) || (defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)) || defined(AFS_DARWIN_ENV) && defined(__amd64__)
39 int afs_icl_sizeofLong = ICL_LONG;
41 int afs_icl_inited = 0;
43 /* init function, called once, under afs_icl_lock */
51 /* Function called at shutdown - zap everything */
55 struct afs_icl_log *logp;
56 struct afs_icl_set *setp;
59 setp = afs_iclSetp; /* "cm" */
61 afs_icl_SetFree(setp);
63 if (afs_iclLongTermSetp) {
64 setp = afs_iclLongTermSetp; /* "cmlongterm" */
65 afs_iclLongTermSetp = NULL;
66 afs_icl_SetFree(setp);
68 logp = afs_icl_FindLog("cmfx");
70 /* Release the reference from Find, and the initial one */
71 afs_icl_LogFree(logp);
72 afs_icl_LogFree(logp);
77 afs_icl_InitLogs(void)
79 struct afs_icl_log *logp;
82 /* initialize the ICL system */
83 code = afs_icl_CreateLog("cmfx", 60 * 1024, &logp);
87 code = afs_icl_CreateSetWithFlags("cm", logp, NULL,
88 ICL_CRSET_FLAG_DEFAULT_OFF,
93 code = afs_icl_CreateSet("cmlongterm", logp, NULL,
94 &afs_iclLongTermSetp);
99 struct afs_icl_log *afs_icl_FindLog(char *);
100 struct afs_icl_set *afs_icl_FindSet(char *);
103 #ifdef AFS_DARWIN100_ENV
104 #define AFSKPTR(X) k ## X
106 Afscall_icl(long opcode, long p1, long p2, long p3, long p4, long *retval)
108 return Afscall64_icl(opcode,
109 CAST_USER_ADDR_T((p1)),
110 CAST_USER_ADDR_T((p2)),
111 CAST_USER_ADDR_T((p3)),
112 CAST_USER_ADDR_T((p4)),
116 #define AFSKPTR(X) ((caddr_t)X)
120 #ifdef AFS_DARWIN100_ENV
121 Afscall64_icl(int opcode, user_addr_t kp1, user_addr_t kp2, user_addr_t kp3, user_addr_t kp4, int *retval)
123 Afscall_icl(long opcode, long p1, long p2, long p3, long p4, long *retval)
126 afs_int32 *lp, elts, flags;
128 struct afs_icl_log *logp;
129 struct afs_icl_set *setp;
130 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
132 #else /* AFS_SGI61_ENV */
133 #if defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)
138 #endif /* AFS_SGI61_ENV */
140 afs_int32 startCookie;
142 struct afs_icl_log *tlp;
143 #ifdef AFS_DARWIN100_ENV
144 afs_uint32 p1 = (afs_uint32)kp1;
145 afs_uint32 p2 = (afs_uint32)kp2;
146 afs_uint32 p3 = (afs_uint32)kp3;
147 afs_uint32 p4 = (afs_uint32)kp4;
151 if (!afs_suser(CRED())) { /* only root can run this code */
155 if (!afs_suser(NULL)) { /* only root can run this code */
156 #if defined(KERNEL_HAVE_UERROR)
165 case ICL_OP_COPYOUTCLR: /* copy out data then clear */
166 case ICL_OP_COPYOUT: /* copy ouy data */
167 /* copyout: p1=logname, p2=&buffer, p3=size(words), p4=&cookie
168 * return flags<<24 + nwords.
169 * updates cookie to updated start (not end) if we had to
172 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
175 AFS_COPYIN(AFSKPTR(p4), (char *)&startCookie, sizeof(afs_int32), code);
178 logp = afs_icl_FindLog(tname);
181 #define BUFFERSIZE AFS_LRALLOCSIZ
182 lp = osi_AllocLargeSpace(AFS_LRALLOCSIZ);
183 elts = BUFFERSIZE / sizeof(afs_int32);
186 flags = (opcode == ICL_OP_COPYOUT) ? 0 : ICL_COPYOUTF_CLRAFTERREAD;
188 afs_icl_CopyOut(logp, lp, &elts, (afs_uint32 *) & startCookie,
191 osi_FreeLargeSpace((struct osi_buffer *)lp);
194 AFS_COPYOUT((char *)lp, AFSKPTR(p2), elts * sizeof(afs_int32), code);
197 AFS_COPYOUT((char *)&startCookie, AFSKPTR(p4), sizeof(afs_int32),
201 #if defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)
203 *retval = ((long)((flags << 24) | (elts & 0xffffff))) << 32;
206 *retval = (flags << 24) | (elts & 0xffffff);
208 afs_icl_LogRele(logp);
209 osi_FreeLargeSpace((struct osi_buffer *)lp);
212 case ICL_OP_ENUMLOGS: /* enumerate logs */
213 /* enumerate logs: p1=index, p2=&name, p3=sizeof(name), p4=&size.
214 * return 0 for success, otherwise error.
216 for (tlp = afs_icl_allLogs; tlp; tlp = tlp->nextp) {
221 return ENOENT; /* past the end of file */
222 temp = strlen(tlp->name) + 1;
225 AFS_COPYOUT(tlp->name, AFSKPTR(p2), temp, code);
226 if (!code) /* copy out size of log */
227 AFS_COPYOUT((char *)&tlp->logSize, AFSKPTR(p4), sizeof(afs_int32),
231 case ICL_OP_ENUMLOGSBYSET: /* enumerate logs by set name */
232 /* enumerate logs: p1=setname, p2=index, p3=&name, p4=sizeof(name).
233 * return 0 for success, otherwise error.
235 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
238 setp = afs_icl_FindSet(tname);
241 if (p2 >= ICL_LOGSPERSET)
243 if (!(tlp = setp->logs[p2]))
245 temp = strlen(tlp->name) + 1;
248 AFS_COPYOUT(tlp->name, AFSKPTR(p3), temp, code);
251 case ICL_OP_CLRLOG: /* clear specified log */
252 /* zero out the specified log: p1=logname */
253 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
256 logp = afs_icl_FindLog(tname);
259 code = afs_icl_ZeroLog(logp);
260 afs_icl_LogRele(logp);
263 case ICL_OP_CLRSET: /* clear specified set */
264 /* zero out the specified set: p1=setname */
265 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
268 setp = afs_icl_FindSet(tname);
271 code = afs_icl_ZeroSet(setp);
272 afs_icl_SetRele(setp);
275 case ICL_OP_CLRALL: /* clear all logs */
276 /* zero out all logs -- no args */
278 ObtainWriteLock(&afs_icl_lock, 178);
279 for (tlp = afs_icl_allLogs; tlp; tlp = tlp->nextp) {
280 tlp->refCount++; /* hold this guy */
281 ReleaseWriteLock(&afs_icl_lock);
282 /* don't clear persistent logs */
283 if ((tlp->states & ICL_LOGF_PERSISTENT) == 0)
284 code = afs_icl_ZeroLog(tlp);
285 ObtainWriteLock(&afs_icl_lock, 179);
286 if (--tlp->refCount == 0)
291 ReleaseWriteLock(&afs_icl_lock);
294 case ICL_OP_ENUMSETS: /* enumerate all sets */
295 /* enumerate sets: p1=index, p2=&name, p3=sizeof(name), p4=&states.
296 * return 0 for success, otherwise error.
298 for (setp = afs_icl_allSets; setp; setp = setp->nextp) {
303 return ENOENT; /* past the end of file */
304 temp = strlen(setp->name) + 1;
307 AFS_COPYOUT(setp->name, AFSKPTR(p2), temp, code);
308 if (!code) /* copy out size of log */
309 AFS_COPYOUT((char *)&setp->states, AFSKPTR(p4), sizeof(afs_int32),
313 case ICL_OP_SETSTAT: /* set status on a set */
314 /* activate the specified set: p1=setname, p2=op */
315 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
318 setp = afs_icl_FindSet(tname);
321 code = afs_icl_SetSetStat(setp, p2);
322 afs_icl_SetRele(setp);
325 case ICL_OP_SETSTATALL: /* set status on all sets */
326 /* activate the specified set: p1=op */
328 ObtainWriteLock(&afs_icl_lock, 180);
329 for (setp = afs_icl_allSets; setp; setp = setp->nextp) {
330 setp->refCount++; /* hold this guy */
331 ReleaseWriteLock(&afs_icl_lock);
332 /* don't set states on persistent sets */
333 if ((setp->states & ICL_SETF_PERSISTENT) == 0)
334 code = afs_icl_SetSetStat(setp, p1);
335 ObtainWriteLock(&afs_icl_lock, 181);
336 if (--setp->refCount == 0)
337 afs_icl_ZapSet(setp);
341 ReleaseWriteLock(&afs_icl_lock);
344 case ICL_OP_SETLOGSIZE: /* set size of log */
345 /* set the size of the specified log: p1=logname, p2=size (in words) */
346 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
349 logp = afs_icl_FindLog(tname);
352 code = afs_icl_LogSetSize(logp, p2);
353 afs_icl_LogRele(logp);
356 case ICL_OP_GETLOGINFO: /* get size of log */
357 /* zero out the specified log: p1=logname, p2=&logSize, p3=&allocated */
358 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
361 logp = afs_icl_FindLog(tname);
364 allocated = !!logp->datap;
365 AFS_COPYOUT((char *)&logp->logSize, AFSKPTR(p2), sizeof(afs_int32),
368 AFS_COPYOUT((char *)&allocated, AFSKPTR(p3), sizeof(afs_int32),
370 afs_icl_LogRele(logp);
373 case ICL_OP_GETSETINFO: /* get state of set */
374 /* zero out the specified set: p1=setname, p2=&state */
375 AFS_COPYINSTR(AFSKPTR(p1), tname, sizeof(tname), &temp, code);
378 setp = afs_icl_FindSet(tname);
381 AFS_COPYOUT((char *)&setp->states, AFSKPTR(p2), sizeof(afs_int32),
383 afs_icl_SetRele(setp);
394 afs_lock_t afs_icl_lock;
396 /* exported routine: a 4 parameter event */
398 afs_icl_Event4(struct afs_icl_set *setp, afs_int32 eventID,
399 afs_int32 lAndT, long p1, long p2, long p3, long p4)
406 /* If things aren't init'ed yet (or the set is inactive), don't panic */
407 if (!ICL_SETACTIVE(setp))
411 afs_icl_SetHold(setp);
412 mask = lAndT >> 24 & 0xff; /* mask of which logs to log to */
413 ix = ICL_EVENTBYTE(eventID);
414 ObtainReadLock(&setp->lock);
415 if (setp->eventFlags[ix] & ICL_EVENTMASK(eventID)) {
416 for (i = 0, tmask = 1; i < ICL_LOGSPERSET; i++, tmask <<= 1) {
418 afs_icl_AppendRecord(setp->logs[i], eventID, lAndT & 0xffffff,
423 break; /* break early */
426 ReleaseReadLock(&setp->lock);
427 afs_icl_SetRele(setp);
431 /* Next 4 routines should be implemented via var-args or something.
432 * Whole purpose is to avoid compiler warnings about parameter # mismatches.
433 * Otherwise, could call afs_icl_Event4 directly.
436 afs_icl_Event3(struct afs_icl_set *setp, afs_int32 eventID,
437 afs_int32 lAndT, long p1, long p2, long p3)
439 return afs_icl_Event4(setp, eventID, lAndT, p1, p2, p3, (long)0);
443 afs_icl_Event2(struct afs_icl_set *setp, afs_int32 eventID,
444 afs_int32 lAndT, long p1, long p2)
446 return afs_icl_Event4(setp, eventID, lAndT, p1, p2, (long)0, (long)0);
450 afs_icl_Event1(struct afs_icl_set *setp, afs_int32 eventID,
451 afs_int32 lAndT, long p1)
453 return afs_icl_Event4(setp, eventID, lAndT, p1, (long)0, (long)0,
458 afs_icl_Event0(struct afs_icl_set *setp, afs_int32 eventID,
461 return afs_icl_Event4(setp, eventID, lAndT, (long)0, (long)0, (long)0,
465 struct afs_icl_log *afs_icl_allLogs = 0;
467 /* function to purge records from the start of the log, until there
468 * is at least minSpace long's worth of space available without
469 * making the head and the tail point to the same word.
471 * Log must be write-locked.
474 afs_icl_GetLogSpace(struct afs_icl_log *logp, afs_int32 minSpace)
478 while (logp->logSize - logp->logElements <= minSpace) {
480 tsize = ((logp->datap[logp->firstUsed]) >> 24) & 0xff;
481 logp->logElements -= tsize;
482 logp->firstUsed += tsize;
483 if (logp->firstUsed >= logp->logSize)
484 logp->firstUsed -= logp->logSize;
485 logp->baseCookie += tsize;
489 /* append string astr to buffer, including terminating null char.
491 * log must be write-locked.
493 #define ICL_CHARSPERLONG 4
495 afs_icl_AppendString(struct afs_icl_log *logp, char *astr)
497 char *op; /* ptr to char to write */
499 int bib; /* bytes in buffer */
502 op = (char *)&(logp->datap[logp->firstFree]);
506 if (++bib >= ICL_CHARSPERLONG) {
509 if (++(logp->firstFree) >= logp->logSize) {
511 op = (char *)&(logp->datap[0]);
519 /* if we've used this word at all, allocate it */
520 if (++(logp->firstFree) >= logp->logSize) {
527 /* add a long to the log, ignoring overflow (checked already) */
528 #define ICL_APPENDINT32(lp, x) \
530 (lp)->datap[(lp)->firstFree] = (x); \
531 if (++((lp)->firstFree) >= (lp)->logSize) { \
532 (lp)->firstFree = 0; \
534 (lp)->logElements++; \
538 #define ICL_APPENDLONG(lp, x) \
540 ICL_APPENDINT32((lp), ((x) >> 32) & 0xffffffffL); \
541 ICL_APPENDINT32((lp), (x) & 0xffffffffL); \
545 #define ICL_APPENDLONG(lp, x) ICL_APPENDINT32((lp), (x))
548 /* routine to tell whether we're dealing with the address or the
552 afs_icl_UseAddr(int type)
554 if (type == ICL_TYPE_HYPER || type == ICL_TYPE_STRING
555 || type == ICL_TYPE_FID || type == ICL_TYPE_INT64)
562 afs_icl_AppendOne(struct afs_icl_log *logp, int type, long parm)
565 /* marshall parameter 3 now */
566 if (type == ICL_TYPE_STRING)
567 afs_icl_AppendString(logp, (char *)parm);
568 else if (type == ICL_TYPE_HYPER) {
569 ICL_APPENDINT32(logp,
570 (afs_int32) ((struct afs_hyper_t *)parm)->high);
571 ICL_APPENDINT32(logp,
572 (afs_int32) ((struct afs_hyper_t *)parm)->low);
573 } else if (type == ICL_TYPE_INT64) {
574 #ifndef WORDS_BIGENDIAN
575 #ifdef AFS_64BIT_CLIENT
576 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[1]);
577 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[0]);
578 #else /* AFS_64BIT_CLIENT */
579 ICL_APPENDINT32(logp, (afs_int32) parm);
580 ICL_APPENDINT32(logp, (afs_int32) 0);
581 #endif /* AFS_64BIT_CLIENT */
582 #else /* AFSLITTLE_ENDIAN */
583 #ifdef AFS_64BIT_CLIENT
584 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[0]);
585 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[1]);
586 #else /* AFS_64BIT_CLIENT */
587 ICL_APPENDINT32(logp, (afs_int32) 0);
588 ICL_APPENDINT32(logp, (afs_int32) parm);
589 #endif /* AFS_64BIT_CLIENT */
590 #endif /* AFSLITTLE_ENDIAN */
591 } else if (type == ICL_TYPE_FID) {
592 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[0]);
593 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[1]);
594 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[2]);
595 ICL_APPENDINT32(logp, (afs_int32) ((afs_int32 *) parm)[3]);
598 else if (type == ICL_TYPE_INT32)
599 ICL_APPENDINT32(logp, (afs_int32) parm);
602 ICL_APPENDLONG(logp, parm);
606 /* Function to append a record to the log. Written for speed
607 * since we know that we're going to have to make this work fast
608 * pretty soon, anyway. The log must be unlocked.
612 afs_icl_AppendRecord(struct afs_icl_log *logp, afs_int32 op,
613 afs_int32 types, long p1, long p2, long p3, long p4)
615 int rsize; /* record size in longs */
616 int tsize; /* temp size */
620 t4 = types & 0x3f; /* decode types */
628 osi_GetTime(&tv); /* It panics for solaris if inside */
629 ObtainWriteLock(&logp->lock, 182);
631 ReleaseWriteLock(&logp->lock);
635 /* get timestamp as # of microseconds since some time that doesn't
636 * change that often. This algorithm ticks over every 20 minutes
637 * or so (1000 seconds). Write a timestamp record if it has.
639 if (tv.tv_sec - logp->lastTS > 1024) {
640 /* the timer has wrapped -- write a timestamp record */
641 if (logp->logSize - logp->logElements <= 5)
642 afs_icl_GetLogSpace(logp, 5);
644 ICL_APPENDINT32(logp,
645 (afs_int32) (5 << 24) + (ICL_TYPE_UNIXDATE << 18));
646 ICL_APPENDINT32(logp, (afs_int32) ICL_INFO_TIMESTAMP);
647 ICL_APPENDINT32(logp, (afs_int32) 0); /* use thread ID zero for clocks */
648 ICL_APPENDINT32(logp,
649 (afs_int32) (tv.tv_sec & 0x3ff) * 1000000 +
651 ICL_APPENDINT32(logp, (afs_int32) tv.tv_sec);
653 logp->lastTS = tv.tv_sec;
656 rsize = 4; /* base case: see 4 items below */
658 /* compute size of parameter p1. Only tricky case is string.
659 * In that case, we have to call strlen to get the string length.
661 ICL_SIZEHACK(t1, p1, tsize, rsize);
664 /* compute size of parameter p2. Only tricky case is string.
665 * In that case, we have to call strlen to get the string length.
667 ICL_SIZEHACK(t2, p2, tsize, rsize);
670 /* compute size of parameter p3. Only tricky case is string.
671 * In that case, we have to call strlen to get the string length.
673 ICL_SIZEHACK(t3, p3, tsize, rsize);
676 /* compute size of parameter p4. Only tricky case is string.
677 * In that case, we have to call strlen to get the string length.
679 ICL_SIZEHACK(t4, p4, tsize, rsize);
682 /* At this point, we've computed all of the parameter sizes, and
683 * have in rsize the size of the entire record we want to append.
684 * Next, we check that we actually have room in the log to do this
685 * work, and then we do the append.
688 ReleaseWriteLock(&logp->lock);
689 return; /* log record too big to express */
692 if (logp->logSize - logp->logElements <= rsize)
693 afs_icl_GetLogSpace(logp, rsize);
695 ICL_APPENDINT32(logp,
696 (afs_int32) (rsize << 24) + (t1 << 18) + (t2 << 12) +
698 ICL_APPENDINT32(logp, (afs_int32) op);
699 ICL_APPENDINT32(logp, (afs_int32) osi_ThreadUnique());
700 ICL_APPENDINT32(logp,
701 (afs_int32) (tv.tv_sec & 0x3ff) * 1000000 + tv.tv_usec);
703 afs_icl_AppendOne(logp, t1, p1);
704 afs_icl_AppendOne(logp, t2, p2);
705 afs_icl_AppendOne(logp, t3, p3);
706 afs_icl_AppendOne(logp, t4, p4);
707 ReleaseWriteLock(&logp->lock);
710 /* create a log with size logSize; return it in *outLogpp and tag
711 * it with name "name."
714 afs_icl_CreateLog(char *name, afs_int32 logSize,
715 struct afs_icl_log **outLogpp)
717 return afs_icl_CreateLogWithFlags(name, logSize, /*flags */ 0, outLogpp);
720 /* create a log with size logSize; return it in *outLogpp and tag
721 * it with name "name." 'flags' can be set to make the log unclearable.
724 afs_icl_CreateLogWithFlags(char *name, afs_int32 logSize, afs_uint32 flags,
725 struct afs_icl_log **outLogpp)
727 struct afs_icl_log *logp;
729 /* add into global list under lock */
730 ObtainWriteLock(&afs_icl_lock, 183);
734 for (logp = afs_icl_allLogs; logp; logp = logp->nextp) {
735 if (strcmp(logp->name, name) == 0) {
736 /* found it already created, just return it */
739 if (flags & ICL_CRLOG_FLAG_PERSISTENT) {
740 ObtainWriteLock(&logp->lock, 184);
741 logp->states |= ICL_LOGF_PERSISTENT;
742 ReleaseWriteLock(&logp->lock);
744 ReleaseWriteLock(&afs_icl_lock);
749 logp = osi_AllocSmallSpace(sizeof(struct afs_icl_log));
750 memset((caddr_t) logp, 0, sizeof(*logp));
753 logp->name = osi_AllocSmallSpace(strlen(name) + 1);
754 strcpy(logp->name, name);
755 LOCK_INIT(&logp->lock, "logp lock");
756 logp->logSize = logSize;
757 logp->datap = NULL; /* don't allocate it until we need it */
759 if (flags & ICL_CRLOG_FLAG_PERSISTENT)
760 logp->states |= ICL_LOGF_PERSISTENT;
762 logp->nextp = afs_icl_allLogs;
763 afs_icl_allLogs = logp;
764 ReleaseWriteLock(&afs_icl_lock);
770 /* called with a log, a pointer to a buffer, the size of the buffer
771 * (in *bufSizep), the starting cookie (in *cookiep, use 0 at the start)
772 * and returns data in the provided buffer, and returns output flags
773 * in *flagsp. The flag ICL_COPYOUTF_MISSEDSOME is set if we can't
774 * find the record with cookie value cookie.
777 afs_icl_CopyOut(struct afs_icl_log *logp, afs_int32 * bufferp,
778 afs_int32 * bufSizep, afs_uint32 * cookiep,
781 afs_int32 nwords; /* number of words to copy out */
782 afs_uint32 startCookie; /* first cookie to use */
783 afs_int32 outWords; /* words we've copied out */
784 afs_int32 inWords; /* max words to copy out */
785 afs_int32 code; /* return code */
786 afs_int32 ix; /* index we're copying from */
787 afs_int32 outFlags; /* return flags */
788 afs_int32 inFlags; /* flags passed in */
791 inWords = *bufSizep; /* max to copy out */
792 outWords = 0; /* amount copied out */
793 startCookie = *cookiep;
798 ObtainWriteLock(&logp->lock, 185);
800 ReleaseWriteLock(&logp->lock);
804 /* first, compute the index of the start cookie we've been passed */
806 /* (re-)compute where we should start */
807 if (startCookie < logp->baseCookie) {
808 if (startCookie) /* missed some output */
809 outFlags |= ICL_COPYOUTF_MISSEDSOME;
810 /* skip to the first available record */
811 startCookie = logp->baseCookie;
812 *cookiep = startCookie;
815 /* compute where we find the first element to copy out */
816 ix = logp->firstUsed + startCookie - logp->baseCookie;
817 if (ix >= logp->logSize)
820 /* if have some data now, break out and process it */
821 if (startCookie - logp->baseCookie < logp->logElements)
824 /* At end of log, so clear it if we need to */
825 if (inFlags & ICL_COPYOUTF_CLRAFTERREAD) {
826 logp->firstUsed = logp->firstFree = 0;
827 logp->logElements = 0;
829 /* otherwise, either wait for the data to arrive, or return */
830 if (!(inFlags & ICL_COPYOUTF_WAITIO)) {
831 ReleaseWriteLock(&logp->lock);
835 logp->states |= ICL_LOGF_WAITING;
836 ReleaseWriteLock(&logp->lock);
837 afs_osi_Sleep(&logp->lock);
838 ObtainWriteLock(&logp->lock, 186);
840 /* copy out data from ix to logSize or firstFree, depending
841 * upon whether firstUsed <= firstFree (no wrap) or otherwise.
842 * be careful not to copy out more than nwords.
844 if (ix >= logp->firstUsed) {
845 if (logp->firstUsed <= logp->firstFree)
847 end = logp->firstFree; /* first element not to copy */
850 nwords = inWords; /* don't copy more than this */
851 if (end - ix < nwords)
854 memcpy((char *)bufferp, (char *)&logp->datap[ix],
855 sizeof(afs_int32) * nwords);
860 /* if we're going to copy more out below, we'll start here */
863 /* now, if active part of the log has wrapped, there's more stuff
864 * starting at the head of the log. Copy out more from there.
866 if (logp->firstUsed > logp->firstFree && ix < logp->firstFree
868 /* (more to) copy out from the wrapped section at the
869 * start of the log. May get here even if didn't copy any
870 * above, if the cookie points directly into the wrapped section.
873 if (logp->firstFree - ix < nwords)
874 nwords = logp->firstFree - ix;
875 memcpy((char *)bufferp, (char *)&logp->datap[ix],
876 sizeof(afs_int32) * nwords);
882 ReleaseWriteLock(&logp->lock);
886 *bufSizep = outWords;
892 /* return basic parameter information about a log */
894 afs_icl_GetLogParms(struct afs_icl_log *logp, afs_int32 * maxSizep,
895 afs_int32 * curSizep)
897 ObtainReadLock(&logp->lock);
898 *maxSizep = logp->logSize;
899 *curSizep = logp->logElements;
900 ReleaseReadLock(&logp->lock);
905 /* hold and release logs */
907 afs_icl_LogHold(struct afs_icl_log *logp)
909 ObtainWriteLock(&afs_icl_lock, 187);
911 ReleaseWriteLock(&afs_icl_lock);
915 /* hold and release logs, called with lock already held */
917 afs_icl_LogHoldNL(struct afs_icl_log *logp)
923 /* keep track of how many sets believe the log itself is allocated */
925 afs_icl_LogUse(struct afs_icl_log *logp)
927 ObtainWriteLock(&logp->lock, 188);
928 if (logp->setCount == 0) {
929 /* this is the first set actually using the log -- allocate it */
930 if (logp->logSize == 0) {
931 /* we weren't passed in a hint and it wasn't set */
932 logp->logSize = ICL_DEFAULT_LOGSIZE;
934 logp->datap = afs_osi_Alloc(sizeof(afs_int32) * logp->logSize);
935 osi_Assert(logp->datap != NULL);
936 #ifdef KERNEL_HAVE_PIN
937 pin((char *)logp->datap, sizeof(afs_int32) * logp->logSize);
941 ReleaseWriteLock(&logp->lock);
945 /* decrement the number of real users of the log, free if possible */
947 afs_icl_LogFreeUse(struct afs_icl_log *logp)
949 ObtainWriteLock(&logp->lock, 189);
950 if (--logp->setCount == 0) {
951 /* no more users -- free it (but keep log structure around) */
952 afs_osi_Free(logp->datap, sizeof(afs_int32) * logp->logSize);
953 #ifdef KERNEL_HAVE_PIN
954 unpin((char *)logp->datap, sizeof(afs_int32) * logp->logSize);
956 logp->firstUsed = logp->firstFree = 0;
957 logp->logElements = 0;
960 ReleaseWriteLock(&logp->lock);
964 /* set the size of the log to 'logSize' */
966 afs_icl_LogSetSize(struct afs_icl_log *logp, afs_int32 logSize)
968 ObtainWriteLock(&logp->lock, 190);
970 /* nothing to worry about since it's not allocated */
971 logp->logSize = logSize;
974 logp->firstUsed = logp->firstFree = 0;
975 logp->logElements = 0;
977 /* free and allocate a new one */
978 afs_osi_Free(logp->datap, sizeof(afs_int32) * logp->logSize);
979 #ifdef KERNEL_HAVE_PIN
980 unpin((char *)logp->datap, sizeof(afs_int32) * logp->logSize);
982 logp->datap = afs_osi_Alloc(sizeof(afs_int32) * logSize);
983 osi_Assert(logp->datap != NULL);
984 #ifdef KERNEL_HAVE_PIN
985 pin((char *)logp->datap, sizeof(afs_int32) * logSize);
987 logp->logSize = logSize;
989 ReleaseWriteLock(&logp->lock);
994 /* free a log. Called with afs_icl_lock locked. */
996 afs_icl_ZapLog(struct afs_icl_log *logp)
998 struct afs_icl_log **lpp, *tp;
1000 for (lpp = &afs_icl_allLogs, tp = *lpp; tp; lpp = &tp->nextp, tp = *lpp) {
1002 /* found the dude we want to remove */
1004 osi_FreeSmallSpace(logp->name);
1005 afs_osi_Free(logp->datap, sizeof(afs_int32) * logp->logSize);
1006 #ifdef KERNEL_HAVE_PIN
1007 unpin((char *)logp->datap, sizeof(afs_int32) * logp->logSize);
1009 osi_FreeSmallSpace(logp);
1010 break; /* won't find it twice */
1016 /* do the release, watching for deleted entries */
1018 afs_icl_LogRele(struct afs_icl_log *logp)
1020 ObtainWriteLock(&afs_icl_lock, 191);
1021 if (--logp->refCount == 0 && (logp->states & ICL_LOGF_DELETED)) {
1022 afs_icl_ZapLog(logp); /* destroys logp's lock! */
1024 ReleaseWriteLock(&afs_icl_lock);
1028 /* do the release, watching for deleted entries, log already held */
1030 afs_icl_LogReleNL(struct afs_icl_log *logp)
1032 if (--logp->refCount == 0 && (logp->states & ICL_LOGF_DELETED)) {
1033 afs_icl_ZapLog(logp); /* destroys logp's lock! */
1038 /* zero out the log */
1040 afs_icl_ZeroLog(struct afs_icl_log *logp)
1042 ObtainWriteLock(&logp->lock, 192);
1043 logp->firstUsed = logp->firstFree = 0;
1044 logp->logElements = 0;
1045 logp->baseCookie = 0;
1046 ReleaseWriteLock(&logp->lock);
1050 /* free a log entry, and drop its reference count */
1052 afs_icl_LogFree(struct afs_icl_log *logp)
1054 ObtainWriteLock(&logp->lock, 193);
1055 logp->states |= ICL_LOGF_DELETED;
1056 ReleaseWriteLock(&logp->lock);
1057 afs_icl_LogRele(logp);
1061 /* find a log by name, returning it held */
1062 struct afs_icl_log *
1063 afs_icl_FindLog(char *name)
1065 struct afs_icl_log *tp;
1066 ObtainWriteLock(&afs_icl_lock, 194);
1067 for (tp = afs_icl_allLogs; tp; tp = tp->nextp) {
1068 if (strcmp(tp->name, name) == 0) {
1069 /* this is the dude we want */
1074 ReleaseWriteLock(&afs_icl_lock);
1079 afs_icl_EnumerateLogs(int (*aproc)
1080 (char *name, char *arock, struct afs_icl_log * tp),
1083 struct afs_icl_log *tp;
1087 ObtainWriteLock(&afs_icl_lock, 195);
1088 for (tp = afs_icl_allLogs; tp; tp = tp->nextp) {
1089 tp->refCount++; /* hold this guy */
1090 ReleaseWriteLock(&afs_icl_lock);
1091 ObtainReadLock(&tp->lock);
1092 code = (*aproc) (tp->name, arock, tp);
1093 ReleaseReadLock(&tp->lock);
1094 ObtainWriteLock(&afs_icl_lock, 196);
1095 if (--tp->refCount == 0)
1100 ReleaseWriteLock(&afs_icl_lock);
1104 struct afs_icl_set *afs_icl_allSets = 0;
1107 afs_icl_CreateSet(char *name, struct afs_icl_log *baseLogp,
1108 struct afs_icl_log *fatalLogp,
1109 struct afs_icl_set **outSetpp)
1111 return afs_icl_CreateSetWithFlags(name, baseLogp, fatalLogp,
1112 /*flags */ 0, outSetpp);
1115 /* create a set, given pointers to base and fatal logs, if any.
1116 * Logs are unlocked, but referenced, and *outSetpp is returned
1117 * referenced. Function bumps reference count on logs, since it
1118 * addds references from the new afs_icl_set. When the set is destroyed,
1119 * those references will be released.
1122 afs_icl_CreateSetWithFlags(char *name, struct afs_icl_log *baseLogp,
1123 struct afs_icl_log *fatalLogp, afs_uint32 flags,
1124 struct afs_icl_set **outSetpp)
1126 struct afs_icl_set *setp;
1128 afs_int32 states = ICL_DEFAULT_SET_STATES;
1130 ObtainWriteLock(&afs_icl_lock, 197);
1131 if (!afs_icl_inited)
1134 for (setp = afs_icl_allSets; setp; setp = setp->nextp) {
1135 if (strcmp(setp->name, name) == 0) {
1138 if (flags & ICL_CRSET_FLAG_PERSISTENT) {
1139 ObtainWriteLock(&setp->lock, 198);
1140 setp->states |= ICL_SETF_PERSISTENT;
1141 ReleaseWriteLock(&setp->lock);
1143 ReleaseWriteLock(&afs_icl_lock);
1148 /* determine initial state */
1149 if (flags & ICL_CRSET_FLAG_DEFAULT_ON)
1150 states = ICL_SETF_ACTIVE;
1151 else if (flags & ICL_CRSET_FLAG_DEFAULT_OFF)
1152 states = ICL_SETF_FREED;
1153 if (flags & ICL_CRSET_FLAG_PERSISTENT)
1154 states |= ICL_SETF_PERSISTENT;
1156 setp = osi_AllocSmallSpace(sizeof(struct afs_icl_set));
1157 memset((caddr_t) setp, 0, sizeof(*setp));
1159 if (states & ICL_SETF_FREED)
1160 states &= ~ICL_SETF_ACTIVE; /* if freed, can't be active */
1161 setp->states = states;
1163 LOCK_INIT(&setp->lock, "setp lock");
1164 /* next lock is obtained in wrong order, hierarchy-wise, but
1165 * it doesn't matter, since no one can find this lock yet, since
1166 * the afs_icl_lock is still held, and thus the obtain can't block.
1168 ObtainWriteLock(&setp->lock, 199);
1169 setp->name = osi_AllocSmallSpace(strlen(name) + 1);
1170 strcpy(setp->name, name);
1171 setp->nevents = ICL_DEFAULTEVENTS;
1172 setp->eventFlags = afs_osi_Alloc(ICL_DEFAULTEVENTS);
1173 osi_Assert(setp->eventFlags != NULL);
1174 #ifdef KERNEL_HAVE_PIN
1175 pin((char *)setp->eventFlags, ICL_DEFAULTEVENTS);
1177 for (i = 0; i < ICL_DEFAULTEVENTS; i++)
1178 setp->eventFlags[i] = 0xff; /* default to enabled */
1180 /* update this global info under the afs_icl_lock */
1181 setp->nextp = afs_icl_allSets;
1182 afs_icl_allSets = setp;
1183 ReleaseWriteLock(&afs_icl_lock);
1185 /* set's basic lock is still held, so we can finish init */
1187 setp->logs[0] = baseLogp;
1188 afs_icl_LogHold(baseLogp);
1189 if (!(setp->states & ICL_SETF_FREED))
1190 afs_icl_LogUse(baseLogp); /* log is actually being used */
1193 setp->logs[1] = fatalLogp;
1194 afs_icl_LogHold(fatalLogp);
1195 if (!(setp->states & ICL_SETF_FREED))
1196 afs_icl_LogUse(fatalLogp); /* log is actually being used */
1198 ReleaseWriteLock(&setp->lock);
1204 /* function to change event enabling information for a particular set */
1206 afs_icl_SetEnable(struct afs_icl_set *setp, afs_int32 eventID, int setValue)
1210 ObtainWriteLock(&setp->lock, 200);
1211 if (!ICL_EVENTOK(setp, eventID)) {
1212 ReleaseWriteLock(&setp->lock);
1215 tp = &setp->eventFlags[ICL_EVENTBYTE(eventID)];
1217 *tp |= ICL_EVENTMASK(eventID);
1219 *tp &= ~(ICL_EVENTMASK(eventID));
1220 ReleaseWriteLock(&setp->lock);
1224 /* return indication of whether a particular event ID is enabled
1225 * for tracing. If *getValuep is set to 0, the event is disabled,
1226 * otherwise it is enabled. All events start out enabled by default.
1229 afs_icl_GetEnable(struct afs_icl_set *setp, afs_int32 eventID, int *getValuep)
1231 ObtainReadLock(&setp->lock);
1232 if (!ICL_EVENTOK(setp, eventID)) {
1233 ReleaseWriteLock(&setp->lock);
1236 if (setp->eventFlags[ICL_EVENTBYTE(eventID)] & ICL_EVENTMASK(eventID))
1240 ReleaseReadLock(&setp->lock);
1244 /* hold and release event sets */
1246 afs_icl_SetHold(struct afs_icl_set *setp)
1248 ObtainWriteLock(&afs_icl_lock, 201);
1250 ReleaseWriteLock(&afs_icl_lock);
1254 /* free a set. Called with afs_icl_lock locked */
1256 afs_icl_ZapSet(struct afs_icl_set *setp)
1258 struct afs_icl_set **lpp, *tp;
1260 struct afs_icl_log *tlp;
1262 for (lpp = &afs_icl_allSets, tp = *lpp; tp; lpp = &tp->nextp, tp = *lpp) {
1264 /* found the dude we want to remove */
1266 osi_FreeSmallSpace(setp->name);
1267 afs_osi_Free(setp->eventFlags, ICL_DEFAULTEVENTS);
1268 #ifdef KERNEL_HAVE_PIN
1269 unpin((char *)setp->eventFlags, ICL_DEFAULTEVENTS);
1271 for (i = 0; i < ICL_LOGSPERSET; i++) {
1272 if ((tlp = setp->logs[i]))
1273 afs_icl_LogReleNL(tlp);
1275 osi_FreeSmallSpace(setp);
1276 break; /* won't find it twice */
1282 /* do the release, watching for deleted entries */
1284 afs_icl_SetRele(struct afs_icl_set *setp)
1286 ObtainWriteLock(&afs_icl_lock, 202);
1287 if (--setp->refCount == 0 && (setp->states & ICL_SETF_DELETED)) {
1288 afs_icl_ZapSet(setp); /* destroys setp's lock! */
1290 ReleaseWriteLock(&afs_icl_lock);
1294 /* free a set entry, dropping its reference count */
1296 afs_icl_SetFree(struct afs_icl_set *setp)
1298 ObtainWriteLock(&setp->lock, 203);
1299 setp->states |= ICL_SETF_DELETED;
1300 ReleaseWriteLock(&setp->lock);
1301 afs_icl_SetRele(setp);
1305 /* find a set by name, returning it held */
1306 struct afs_icl_set *
1307 afs_icl_FindSet(char *name)
1309 struct afs_icl_set *tp;
1310 ObtainWriteLock(&afs_icl_lock, 204);
1311 for (tp = afs_icl_allSets; tp; tp = tp->nextp) {
1312 if (strcmp(tp->name, name) == 0) {
1313 /* this is the dude we want */
1318 ReleaseWriteLock(&afs_icl_lock);
1322 /* zero out all the logs in the set */
1324 afs_icl_ZeroSet(struct afs_icl_set *setp)
1329 struct afs_icl_log *logp;
1331 ObtainReadLock(&setp->lock);
1332 for (i = 0; i < ICL_LOGSPERSET; i++) {
1333 logp = setp->logs[i];
1335 afs_icl_LogHold(logp);
1336 tcode = afs_icl_ZeroLog(logp);
1338 code = tcode; /* save the last bad one */
1339 afs_icl_LogRele(logp);
1342 ReleaseReadLock(&setp->lock);
1347 afs_icl_EnumerateSets(int (*aproc)
1348 (char *name, char *arock, struct afs_icl_log * tp),
1351 struct afs_icl_set *tp, *np;
1355 ObtainWriteLock(&afs_icl_lock, 205);
1356 for (tp = afs_icl_allSets; tp; tp = np) {
1357 tp->refCount++; /* hold this guy */
1358 ReleaseWriteLock(&afs_icl_lock);
1359 code = (*aproc) (tp->name, arock, (struct afs_icl_log *)tp);
1360 ObtainWriteLock(&afs_icl_lock, 206);
1361 np = tp->nextp; /* tp may disappear next, but not np */
1362 if (--tp->refCount == 0 && (tp->states & ICL_SETF_DELETED))
1367 ReleaseWriteLock(&afs_icl_lock);
1372 afs_icl_AddLogToSet(struct afs_icl_set *setp, struct afs_icl_log *newlogp)
1377 ObtainWriteLock(&setp->lock, 207);
1378 for (i = 0; i < ICL_LOGSPERSET; i++) {
1379 if (!setp->logs[i]) {
1380 setp->logs[i] = newlogp;
1382 afs_icl_LogHold(newlogp);
1383 if (!(setp->states & ICL_SETF_FREED)) {
1384 /* bump up the number of sets using the log */
1385 afs_icl_LogUse(newlogp);
1390 ReleaseWriteLock(&setp->lock);
1395 afs_icl_SetSetStat(struct afs_icl_set *setp, int op)
1399 struct afs_icl_log *logp;
1401 ObtainWriteLock(&setp->lock, 208);
1403 case ICL_OP_SS_ACTIVATE: /* activate a log */
1405 * If we are not already active, see if we have released
1406 * our demand that the log be allocated (FREED set). If
1407 * we have, reassert our desire.
1409 if (!(setp->states & ICL_SETF_ACTIVE)) {
1410 if (setp->states & ICL_SETF_FREED) {
1411 /* have to reassert desire for logs */
1412 for (i = 0; i < ICL_LOGSPERSET; i++) {
1413 logp = setp->logs[i];
1415 afs_icl_LogHold(logp);
1416 afs_icl_LogUse(logp);
1417 afs_icl_LogRele(logp);
1420 setp->states &= ~ICL_SETF_FREED;
1422 setp->states |= ICL_SETF_ACTIVE;
1427 case ICL_OP_SS_DEACTIVATE: /* deactivate a log */
1428 /* this doesn't require anything beyond clearing the ACTIVE flag */
1429 setp->states &= ~ICL_SETF_ACTIVE;
1433 case ICL_OP_SS_FREE: /* deassert design for log */
1435 * if we are already in this state, do nothing; otherwise
1436 * deassert desire for log
1438 if (setp->states & ICL_SETF_ACTIVE)
1441 if (!(setp->states & ICL_SETF_FREED)) {
1442 for (i = 0; i < ICL_LOGSPERSET; i++) {
1443 logp = setp->logs[i];
1445 afs_icl_LogHold(logp);
1446 afs_icl_LogFreeUse(logp);
1447 afs_icl_LogRele(logp);
1450 setp->states |= ICL_SETF_FREED;
1459 ReleaseWriteLock(&setp->lock);