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>
21 #include "h/sysmacros.h"
26 #if defined(AFS_AIX_ENV) || defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_LINUX20_ENV)
29 #if !defined(AFS_SUN5_ENV) && !defined(AFS_LINUX20_ENV)
33 #if defined(AFS_SUN56_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_FBSD_ENV) || defined(AFS_DARWIN80_ENV)
34 #include "afs/sysincludes.h"
36 #if !defined(AFS_SGI64_ENV) && !defined(AFS_DARWIN60_ENV)
38 #endif /* AFS_SGI64_ENV */
41 #include <sys/mount.h>
42 #include <sys/vnode.h>
43 #include <ufs/inode.h>
45 #if !defined(AFS_SUN5_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_HPUX110_ENV)
48 #ifndef AFS_LINUX20_ENV
49 #include "netinet/in.h"
53 /* These are needed because afs_prototypes.h is not included here */
55 extern void *DRead(struct dcache *adc, int page);
56 extern void *DNew(struct dcache *adc, int page);
58 #else /* !defined(UKERNEL) */
60 #include "afs/sysincludes.h"
63 /* These are needed because afs_prototypes.h is not included here */
64 extern void *DRead(register afs_int32 *fid, register int page);
65 extern void *DNew(register afs_int32 *fid, register int page);
67 #endif /* !defined(UKERNEL) */
68 #include "afs/afs_osi.h"
72 #ifdef AFS_LINUX20_ENV
76 /* generic renaming */
77 #define NameBlobs afs_dir_NameBlobs
78 #define GetBlob afs_dir_GetBlob
79 #define Create afs_dir_Create
80 #define Length afs_dir_Length
81 #define Delete afs_dir_Delete
82 #define MakeDir afs_dir_MakeDir
83 #define Lookup afs_dir_Lookup
84 #define LookupOffset afs_dir_LookupOffset
85 #define EnumerateDir afs_dir_EnumerateDir
86 #define IsEmpty afs_dir_IsEmpty
87 #define InverseLookup afs_dir_InverseLookup
89 #if defined(AFS_DISCON_ENV)
90 #define ChangeFid afs_dir_ChangeFid
98 # include <sys/types.h>
102 #include <winsock2.h>
104 #include <netinet/in.h>
112 /* Local static prototypes */
113 static struct DirEntry *FindItem(void *dir, char *ename,
114 unsigned short **previtem);
118 NameBlobs(char *name)
119 { /* Find out how many entries are required to store a name. */
121 i = strlen(name) + 1;
122 return 1 + ((i + 15) >> 5);
125 /* Create an entry in a file. Dir is a file representation, while entry is a string name. */
128 Create(void *dir, char *entry, void *voidfid)
130 afs_int32 *vfid = (afs_int32 *) voidfid;
133 register struct DirEntry *ep;
134 unsigned short *pp = NULL;
135 register struct DirHeader *dhp;
137 /* check name quality */
140 /* First check if file already exists. */
141 ep = FindItem(dir, entry, &pp);
143 DRelease((struct buffer *)ep, 0);
144 DRelease((struct buffer *)pp, 0);
147 blobs = NameBlobs(entry); /* number of entries required */
148 firstelt = FindBlobs(dir, blobs);
150 return EFBIG; /* directory is full */
151 /* First, we fill in the directory entry. */
152 ep = GetBlob(dir, firstelt);
156 ep->fid.vnode = htonl(vfid[1]);
157 ep->fid.vunique = htonl(vfid[2]);
158 strcpy(ep->name, entry);
159 /* Now we just have to thread it on the hash table list. */
160 dhp = (struct DirHeader *)DRead(dir, 0);
162 DRelease((struct buffer *)ep, 1);
166 ep->next = dhp->hashTable[i];
167 dhp->hashTable[i] = htons(firstelt);
168 DRelease((struct buffer *)dhp, 1);
169 DRelease((struct buffer *)ep, 1);
177 struct DirHeader *dhp;
178 dhp = (struct DirHeader *)DRead(dir, 0);
181 if (dhp->header.pgcount != 0)
182 ctr = ntohs(dhp->header.pgcount);
184 /* old style, count the pages */
186 for (i = 0; i < MAXPAGES; i++)
187 if (dhp->alloMap[i] != EPP)
190 DRelease((struct buffer *)dhp, 0);
191 return ctr * AFS_PAGESIZE;
195 Delete(void *dir, char *entry)
197 /* Delete an entry from a directory, including update of all free entry descriptors. */
199 register struct DirEntry *firstitem;
200 unsigned short *previtem;
201 firstitem = FindItem(dir, entry, &previtem);
204 *previtem = firstitem->next;
205 DRelease((struct buffer *)previtem, 1);
206 index = DVOffset(firstitem) / 32;
207 nitems = NameBlobs(firstitem->name);
208 DRelease((struct buffer *)firstitem, 0);
209 FreeBlobs(dir, index, nitems);
214 FindBlobs(void *dir, int nblobs)
216 /* Find a bunch of contiguous entries; at least nblobs in a row. */
217 register int i, j, k;
219 register struct DirHeader *dhp;
220 struct PageHeader *pp;
223 dhp = (struct DirHeader *)DRead(dir, 0); /* read the dir header in first. */
226 for (i = 0; i < BIGMAXPAGES; i++) {
227 if (i >= MAXPAGES || dhp->alloMap[i] >= nblobs) {
228 /* if page could contain enough entries */
229 /* If there are EPP free entries, then the page is not even allocated. */
231 /* this pages exists past the end of the old-style dir */
232 pgcount = ntohs(dhp->header.pgcount);
235 dhp->header.pgcount = htons(pgcount);
237 if (i > pgcount - 1) {
238 /* this page is bigger than last allocated page */
240 dhp->header.pgcount = htons(i + 1);
242 } else if (dhp->alloMap[i] == EPP) {
243 /* Add the page to the directory. */
245 dhp->alloMap[i] = EPP - 1;
246 dhp->header.pgcount = htons(i + 1);
248 pp = (struct PageHeader *)DRead(dir, i); /* read the page in. */
250 DRelease((struct buffer *)dhp, 1);
253 for (j = 0; j <= EPP - nblobs; j++) {
255 for (k = 0; k < nblobs; k++)
256 if ((pp->freebitmap[(j + k) >> 3] >> ((j + k) & 7)) & 1) {
265 /* Here we have the first index in j. We update the allocation maps
266 * and free up any resources we've got allocated. */
268 dhp->alloMap[i] -= nblobs;
269 DRelease((struct buffer *)dhp, 1);
270 for (k = 0; k < nblobs; k++)
271 pp->freebitmap[(j + k) >> 3] |= 1 << ((j + k) & 7);
272 DRelease((struct buffer *)pp, 1);
275 DRelease((struct buffer *)pp, 0); /* This dir page is unchanged. */
278 /* If we make it here, the directory is full. */
279 DRelease((struct buffer *)dhp, 1);
284 AddPage(void *dir, int pageno)
285 { /* Add a page to a directory. */
287 register struct PageHeader *pp;
289 pp = (struct PageHeader *)DNew(dir, pageno); /* Get a new buffer labelled dir,pageno */
290 pp->tag = htons(1234);
293 pp->freecount = EPP - 1; /* The first dude is already allocated */
294 pp->freebitmap[0] = 0x01;
295 for (i = 1; i < EPP / 8; i++) /* It's a constant */
296 pp->freebitmap[i] = 0;
297 DRelease((struct buffer *)pp, 1);
300 /* Free a whole bunch of directory entries. */
303 FreeBlobs(void *dir, register int firstblob, int nblobs)
307 struct DirHeader *dhp;
308 struct PageHeader *pp;
309 page = firstblob / EPP;
310 firstblob -= EPP * page; /* convert to page-relative entry */
311 dhp = (struct DirHeader *)DRead(dir, 0);
315 dhp->alloMap[page] += nblobs;
316 DRelease((struct buffer *)dhp, 1);
317 pp = (struct PageHeader *)DRead(dir, page);
319 for (i = 0; i < nblobs; i++)
320 pp->freebitmap[(firstblob + i) >> 3] &=
321 ~(1 << ((firstblob + i) & 7));
322 DRelease((struct buffer *)pp, 1);
326 * Format an empty directory properly. Note that the first 13 entries in a
327 * directory header page are allocated, 1 to the page header, 4 to the
328 * allocation map and 8 to the hash table.
331 MakeDir(void *dir, afs_int32 * me, afs_int32 * parent)
334 register struct DirHeader *dhp;
335 dhp = (struct DirHeader *)DNew(dir, 0);
336 dhp->header.pgcount = htons(1);
337 dhp->header.tag = htons(1234);
338 dhp->header.freecount = (EPP - DHE - 1);
339 dhp->header.freebitmap[0] = 0xff;
340 dhp->header.freebitmap[1] = 0x1f;
341 for (i = 2; i < EPP / 8; i++)
342 dhp->header.freebitmap[i] = 0;
343 dhp->alloMap[0] = (EPP - DHE - 1);
344 for (i = 1; i < MAXPAGES; i++)
345 dhp->alloMap[i] = EPP;
346 for (i = 0; i < NHASHENT; i++)
347 dhp->hashTable[i] = 0;
348 DRelease((struct buffer *)dhp, 1);
349 Create(dir, ".", me);
350 Create(dir, "..", parent); /* Virtue is its own .. */
354 /* Look up a file name in directory. */
357 Lookup(void *dir, char *entry, void *voidfid)
359 afs_int32 *fid = (afs_int32 *) voidfid;
360 register struct DirEntry *firstitem;
361 unsigned short *previtem;
363 firstitem = FindItem(dir, entry, &previtem);
366 DRelease((struct buffer *)previtem, 0);
367 fid[1] = ntohl(firstitem->fid.vnode);
368 fid[2] = ntohl(firstitem->fid.vunique);
369 DRelease((struct buffer *)firstitem, 0);
373 /* Look up a file name in directory. */
376 LookupOffset(void *dir, char *entry, void *voidfid, long *offsetp)
378 afs_int32 *fid = (afs_int32 *) voidfid;
379 register struct DirEntry *firstitem;
380 unsigned short *previtem;
382 firstitem = FindItem(dir, entry, &previtem);
385 DRelease((struct buffer *)previtem, 0);
386 fid[1] = ntohl(firstitem->fid.vnode);
387 fid[2] = ntohl(firstitem->fid.vunique);
389 *offsetp = DVOffset(firstitem);
390 DRelease((struct buffer *)firstitem, 0);
395 EnumerateDir(void *dir, int (*hookproc) (void *dir, char *name,
396 afs_int32 vnode, afs_int32 unique),
399 /* Enumerate the contents of a directory.
400 * Break when hook function returns non 0.
404 register struct DirHeader *dhp;
405 register struct DirEntry *ep;
408 dhp = (struct DirHeader *)DRead(dir, 0);
410 return EIO; /* first page should be there */
412 for (i = 0; i < NHASHENT; i++) {
413 /* For each hash chain, enumerate everyone on the list. */
414 num = ntohs(dhp->hashTable[i]);
416 /* Walk down the hash table list. */
418 ep = GetBlob(dir, num);
421 /* we failed, return why */
422 DRelease((struct buffer *)dhp, 0);
428 num = ntohs(ep->next);
429 code = (*hookproc) (hook, ep->name, ntohl(ep->fid.vnode),
430 ntohl(ep->fid.vunique));
431 DRelease((struct buffer *)ep, 0);
436 DRelease((struct buffer *)dhp, 0);
443 /* Enumerate the contents of a directory. */
446 register struct DirHeader *dhp;
447 register struct DirEntry *ep;
448 dhp = (struct DirHeader *)DRead(dir, 0);
451 for (i = 0; i < NHASHENT; i++) {
452 /* For each hash chain, enumerate everyone on the list. */
453 num = ntohs(dhp->hashTable[i]);
455 /* Walk down the hash table list. */
456 ep = GetBlob(dir, num);
459 if (strcmp(ep->name, "..") && strcmp(ep->name, ".")) {
460 DRelease((struct buffer *)ep, 0);
461 DRelease((struct buffer *)dhp, 0);
464 num = ntohs(ep->next);
465 DRelease((struct buffer *)ep, 0);
468 DRelease((struct buffer *)dhp, 0);
473 GetBlob(void *dir, afs_int32 blobno)
475 /* Return a pointer to an entry, given its number. */
477 ep = DRead(dir, blobno >> LEPP);
480 return (struct DirEntry *)(((long)ep) + 32 * (blobno & (EPP - 1)));
484 DirHash(register char *string)
486 /* Hash a string to a number between 0 and NHASHENT. */
487 register unsigned char tc;
491 while ((tc = (*string++))) {
495 tval = hval & (NHASHENT - 1);
498 else if (hval >= 1<<31)
499 tval = NHASHENT - tval;
503 static struct DirEntry *
504 FindItem(void *dir, char *ename, unsigned short **previtem)
506 /* Find a directory entry, given its name. This entry returns a pointer to a locked buffer, and a pointer to a locked buffer (in previtem) referencing the found item (to aid the delete code). If no entry is found, however, no items are left locked, and a null pointer is returned instead. */
508 register struct DirHeader *dhp;
509 register unsigned short *lp;
510 register struct DirEntry *tp;
512 dhp = (struct DirHeader *)DRead(dir, 0);
515 if (dhp->hashTable[i] == 0) {
517 DRelease((struct buffer *)dhp, 0);
520 tp = GetBlob(dir, (u_short) ntohs(dhp->hashTable[i]));
522 DRelease((struct buffer *)dhp, 0);
525 lp = &(dhp->hashTable[i]);
527 /* Look at each hash conflict entry. */
528 if (!strcmp(ename, tp->name)) {
529 /* Found our entry. */
533 DRelease((struct buffer *)lp, 0);
536 /* The end of the line */
537 DRelease((struct buffer *)lp, 0); /* Release all locks. */
540 tp = GetBlob(dir, (u_short) ntohs(tp->next));
542 DRelease((struct buffer *)lp, 0);
548 static struct DirEntry *
549 FindFid (void *dir, afs_uint32 vnode, afs_uint32 unique)
551 /* Find a directory entry, given the vnode and uniquifier of a object.
552 * This entry returns a pointer to a locked buffer. If no entry is found,
553 * however, no items are left locked, and a null pointer is returned
557 register struct DirHeader *dhp;
558 register unsigned short *lp;
559 register struct DirEntry *tp;
560 dhp = (struct DirHeader *) DRead(dir,0);
562 for (i=0; i<NHASHENT; i++) {
563 if (dhp->hashTable[i] != 0) {
564 tp = GetBlob(dir,(u_short)ntohs(dhp->hashTable[i]));
565 if (!tp) { /* should not happen */
570 if (vnode == ntohl(tp->fid.vnode)
571 && unique == ntohl(tp->fid.vunique)) {
578 tp = GetBlob(dir,(u_short)ntohs(tp->next));
585 return (struct DirEntry *)0;
589 InverseLookup (void *dir, afs_uint32 vnode, afs_uint32 unique, char *name,
592 /* Look for the name pointing to given vnode and unique in a directory */
593 register struct DirEntry *entry;
596 entry = FindFid(dir, vnode, unique);
599 if (strlen(entry->name) >= length)
602 strcpy(name, entry->name);
607 #if defined(AFS_DISCON_ENV)
609 * Change an entry fid.
612 * \param entry The entry name.
613 * \param old_fid The old find in MKFid format (host order).
614 * It can be omitted if you don't need a safety check...
615 * \param new_fid The new find in MKFid format (host order).
617 int ChangeFid(void *dir,
622 struct DirEntry *firstitem;
623 unsigned short *previtem;
624 struct MKFid *fid_old = (struct MKFid *) old_fid;
625 struct MKFid *fid_new = (struct MKFid *) new_fid;
628 firstitem = FindItem(dir, entry, &previtem);
629 if (firstitem == 0) {
632 DRelease(previtem, 1);
635 ((htonl(fid_old->vnode) == firstitem->fid.vnode) &&
636 (htonl(fid_old->vunique) == firstitem->fid.vunique))) {
638 firstitem->fid.vnode = htonl(fid_new->vnode);
639 firstitem->fid.vunique = htonl(fid_new->vunique);
642 DRelease(firstitem, 1);