bsd/isofs/cd9660/cd9660_node.c

   1 /*
   2  * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*      $NetBSD: cd9660_node.c,v 1.13 1994/12/24 15:30:07 cgd Exp $     */
  29
  30 /*-
  31  * Copyright (c) 1982, 1986, 1989, 1994
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * This code is derived from software contributed to Berkeley
  35  * by Pace Willisson (pace@blitz.com).  The Rock Ridge Extension
  36  * Support code is derived from software contributed to Berkeley
  37  * by Atsushi Murai (amurai@spec.co.jp).
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *      This product includes software developed by the University of
  50  *      California, Berkeley and its contributors.
  51  * 4. Neither the name of the University nor the names of its contributors
  52  *    may be used to endorse or promote products derived from this software
  53  *    without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  *
  67  *      @(#)cd9660_node.c       8.5 (Berkeley) 12/5/94
  68
  69
  70
  71  * HISTORY
  72  * 22-Jan-98    radar 1669467 - ISO 9660 CD support - jwc
  73  * 17-Feb-98    radar 1669467 - changed lock protocols to use the lock manager - chw
  74
  75  */
  76
  77 #include <sys/param.h>
  78 #include <sys/systm.h>
  79 #include <sys/mount.h>
  80 #include <sys/proc.h>
  81 #include <sys/file.h>
  82 #include <sys/buf.h>
  83 #include <sys/vnode.h>
  84 #include <sys/kernel.h>
  85 #include <sys/malloc.h>
  86 #include <sys/stat.h>
  87 #include <sys/lock.h>
  88 #include <sys/namei.h>
  89
  90 #include <isofs/cd9660/iso.h>
  91 #include <isofs/cd9660/cd9660_node.h>
  92 #include <isofs/cd9660/iso_rrip.h>
  93 #include <isofs/cd9660/cd9660_mount.h>
  94
  95 /*
  96  * Structures associated with iso_node caching.
  97  */
  98 struct iso_node **isohashtbl;
  99 u_long isohash;
 100 #define INOHASH(device, inum)   (((device) + ((inum)>>12)) & isohash)
 101
 102 #ifdef ISODEVMAP
 103 struct iso_node **idvhashtbl;
 104 u_long idvhash;
 105 #define DNOHASH(device, inum)   (((device) + ((inum)>>12)) & idvhash)
 106 #endif
 107
 108 /* defined in bsd/vfs/vfs_subr.c */
 109 extern int prtactive;   /* 1 => print out reclaim of active vnodes */
 110
 111 extern u_char isonullname[];
 112 /*
 113  * Initialize hash links for inodes and dnodes.
 114  */
 115 int
 116 cd9660_init(__unused struct vfsconf *cp)
 117 {
 118
 119         isohashtbl = hashinit(desiredvnodes, M_ISOFSMNT, &isohash);
 120 #ifdef ISODEVMAP
 121         idvhashtbl = hashinit(desiredvnodes / 8, M_ISOFSMNT, &idvhash);
 122 #endif
 123     return 0;
 124 }
 125
 126 #ifdef ISODEVMAP
 127 /*
 128  * Enter a new node into the device hash list
 129  */
 130 struct iso_dnode *
 131 iso_dmap(dev_t device, ino_t inum, int create)
 132 {
 133         register struct iso_dnode **dpp, *dp, *dq;
 134
 135         dpp = &idvhashtbl[DNOHASH(device, inum)];
 136         for (dp = *dpp;; dp = dp->d_next) {
 137                 if (dp == NULL)
 138                         return (NULL);
 139                 if (inum == dp->i_number && device == dp->i_dev)
 140                         return (dp);
 141
 142         if (!create)
 143                 return (NULL);
 144
 145         MALLOC(dp, struct iso_dnode *, sizeof(struct iso_dnode), M_CACHE,
 146                M_WAITOK);
 147         dp->i_dev = dev;
 148         dp->i_number = ino;
 149
 150         if (dq = *dpp)
 151                 dq->d_prev = dp->d_next;
 152         dp->d_next = dq;
 153         dp->d_prev = dpp;
 154         *dpp = dp;
 155
 156         return (dp);
 157 }
 158
 159 void
 160 iso_dunmap(dev_t device)
 161 {
 162         struct iso_dnode **dpp, *dp, *dq;
 163
 164         for (dpp = idvhashtbl; dpp <= idvhashtbl + idvhash; dpp++) {
 165                 for (dp = *dpp; dp != NULL; dp = dq)
 166                         dq = dp->d_next;
 167                         if (device == dp->i_dev) {
 168                                 if (dq)
 169                                         dq->d_prev = dp->d_prev;
 170                                 *dp->d_prev = dq;
 171                                 FREE(dp, M_CACHE);
 172                         }
 173                 }
 174         }
 175 }
 176 #endif
 177
 178 /*
 179  * Use the device/inum pair to find the incore inode, and return a pointer
 180  * to it. If it is in core, but locked, wait for it.
 181  */
 182 struct vnode *
 183 cd9660_ihashget(dev_t device, ino_t inum, struct proc *p)
 184 {
 185         register struct iso_node *ip;
 186         struct vnode *vp;
 187         uint32_t vid;
 188
 189 retry:
 190         for (ip = isohashtbl[INOHASH(device, inum)]; ip; ip = ip->i_next) {
 191                 if (inum == ip->i_number && device == ip->i_dev) {
 192
 193                         if (ISSET(ip->i_flag, ISO_INALLOC)) {
 194                                 /*
 195                                  * inode is being created... wait for it
 196                                  * to be ready for consumption
 197                                  */
 198                                 SET(ip->i_flag, ISO_INWALLOC);
 199                                 tsleep((caddr_t)ip, PINOD, "cd9960_ihashget", 0);
 200                                 goto retry;
 201                         }
 202                         vp = ITOV(ip);
 203                         /*
 204                          * the vid needs to be grabbed before we drop
 205                          * lock protecting the hash
 206                          */
 207                         vid = vnode_vid(vp);
 208
 209                         /*
 210                          * we currently depend on running under the FS funnel
 211                          * when we do proper locking and advertise ourselves
 212                          * as thread safe, we'll need a lock to protect the
 213                          * hash lookup... this is where we would drop it
 214                          */
 215                         if (vnode_getwithvid(vp, vid)) {
 216                                 /*
 217                                  * If vnode is being reclaimed, or has
 218                                  * already changed identity, no need to wait
 219                                  */
 220                                 return (NULL);
 221                         }
 222                         return (vp);
 223                 }
 224         }
 225         return (NULL);
 226 }
 227
 228 /*
 229  * Insert the inode into the hash table, and return it locked.
 230  */
 231 void
 232 cd9660_ihashins(struct iso_node *ip)
 233 {
 234         struct iso_node **ipp, *iq;
 235
 236         /* lock the inode, then put it on the appropriate hash list */
 237
 238         ipp = &isohashtbl[INOHASH(ip->i_dev, ip->i_number)];
 239         if ((iq = *ipp))
 240                 iq->i_prev = &ip->i_next;
 241         ip->i_next = iq;
 242         ip->i_prev = ipp;
 243         *ipp = ip;
 244 }
 245
 246 /*
 247  * Remove the inode from the hash table.
 248  */
 249 void
 250 cd9660_ihashrem(register struct iso_node *ip)
 251 {
 252         register struct iso_node *iq;
 253
 254         if ((iq = ip->i_next))
 255                 iq->i_prev = ip->i_prev;
 256         *ip->i_prev = iq;
 257 #if 1 /* was ifdef DIAGNOSTIC */
 258         ip->i_next = NULL;
 259         ip->i_prev = NULL;
 260 #endif
 261 }
 262
 263 /*
 264  * Last reference to an inode... if we're done with
 265  * it, go ahead and recycle it for other use
 266  */
 267 int
 268 cd9660_inactive(struct vnop_inactive_args *ap)
 269 {
 270         vnode_t vp = ap->a_vp;
 271         struct iso_node *ip = VTOI(vp);
 272
 273         /*
 274          * If we are done with the inode, reclaim it
 275          * so that it can be reused immediately.
 276          */
 277         if (ip->inode.iso_mode == 0)
 278                 vnode_recycle(vp);
 279
 280         return 0;
 281 }
 282
 283 /*
 284  * Reclaim an inode so that it can be used for other purposes.
 285  */
 286 int
 287 cd9660_reclaim(struct vnop_reclaim_args *ap)
 288 {
 289         vnode_t vp = ap->a_vp;
 290         struct iso_node *ip = VTOI(vp);
 291
 292         vnode_removefsref(vp);
 293         /*
 294          * Remove the inode from its hash chain.
 295          */
 296         cd9660_ihashrem(ip);
 297
 298         if (ip->i_devvp) {
 299                 vnode_t devvp = ip->i_devvp;
 300                 ip->i_devvp = NULL;
 301                 vnode_rele(devvp);
 302         }
 303         vnode_clearfsnode(vp);
 304
 305         if (ip->i_namep != isonullname)
 306                 FREE(ip->i_namep, M_TEMP);
 307         if (ip->i_riff != NULL)
 308                 FREE(ip->i_riff, M_TEMP);
 309         FREE_ZONE(ip, sizeof(struct iso_node), M_ISOFSNODE);
 310
 311         return (0);
 312 }
 313
 314 /*
 315  * File attributes
 316  */
 317 void
 318 cd9660_defattr(struct iso_directory_record *isodir, struct iso_node *inop,
 319                 struct buf *bp)
 320 {
 321         struct buf *bp2 = NULL;
 322         struct iso_mnt *imp;
 323         struct iso_extended_attributes *ap = NULL;
 324         int off;
 325
 326         if ( isonum_711(isodir->flags) & directoryBit ) {
 327                 inop->inode.iso_mode = S_IFDIR;
 328                 /*
 329                  * If we return 2, fts() will assume there are no subdirectories
 330                  * (just links for the path and .), so instead we return 1.
 331                  */
 332                 inop->inode.iso_links = 1;
 333         } else {
 334                 inop->inode.iso_mode = S_IFREG;
 335                 inop->inode.iso_links = 1;
 336         }
 337         if (!bp
 338             && ((imp = inop->i_mnt)->im_flags & ISOFSMNT_EXTATT)
 339             && (off = isonum_711(isodir->ext_attr_length))) {
 340                 cd9660_blkatoff(ITOV(inop), (off_t)-(off << imp->im_bshift), NULL, &bp2);
 341                 bp = bp2;
 342         }
 343         if (bp) {
 344                 ap = (struct iso_extended_attributes *)buf_dataptr(bp);
 345
 346                 if (isonum_711(ap->version) == 1) {
 347                         if (!(ap->perm[0]&0x40))
 348                                 inop->inode.iso_mode |= VEXEC >> 6;
 349                         if (!(ap->perm[0]&0x10))
 350                                 inop->inode.iso_mode |= VREAD >> 6;
 351                         if (!(ap->perm[0]&4))
 352                                 inop->inode.iso_mode |= VEXEC >> 3;
 353                         if (!(ap->perm[0]&1))
 354                                 inop->inode.iso_mode |= VREAD >> 3;
 355                         if (!(ap->perm[1]&0x40))
 356                                 inop->inode.iso_mode |= VEXEC;
 357                         if (!(ap->perm[1]&0x10))
 358                                 inop->inode.iso_mode |= VREAD;
 359                         inop->inode.iso_uid = isonum_723(ap->owner); /* what about 0? */
 360                         inop->inode.iso_gid = isonum_723(ap->group); /* what about 0? */
 361                 } else
 362                         ap = NULL;
 363         }
 364         if (!ap) {
 365                 inop->inode.iso_mode |= VREAD|VWRITE|VEXEC|(VREAD|VEXEC)>>3|(VREAD|VEXEC)>>6;
 366                 inop->inode.iso_uid = ISO_UNKNOWNUID;
 367                 inop->inode.iso_gid = ISO_UNKNOWNGID;
 368         }
 369         if (bp2)
 370                 buf_brelse(bp2);
 371 }
 372
 373 /*
 374  * Time stamps
 375  */
 376 void
 377 cd9660_deftstamp(struct iso_directory_record *isodir, struct iso_node *inop,
 378                 struct buf *bp)
 379 {
 380         struct buf *bp2 = NULL;
 381         struct iso_mnt *imp;
 382         struct iso_extended_attributes *ap = NULL;
 383         int off;
 384
 385         if (!bp
 386             && ((imp = inop->i_mnt)->im_flags & ISOFSMNT_EXTATT)
 387             && (off = isonum_711(isodir->ext_attr_length)))
 388         {
 389                 cd9660_blkatoff(ITOV(inop), (off_t)-(off << imp->im_bshift), NULL, &bp2);
 390                 bp = bp2;
 391         }
 392         if (bp) {
 393                 ap = (struct iso_extended_attributes *)buf_dataptr(bp);
 394
 395                 if (isonum_711(ap->version) == 1) {
 396                         if (!cd9660_tstamp_conv17(ap->ftime,&inop->inode.iso_atime))
 397                                 cd9660_tstamp_conv17(ap->ctime,&inop->inode.iso_atime);
 398                         if (!cd9660_tstamp_conv17(ap->ctime,&inop->inode.iso_ctime))
 399                                 inop->inode.iso_ctime = inop->inode.iso_atime;
 400                         if (!cd9660_tstamp_conv17(ap->mtime,&inop->inode.iso_mtime))
 401                                 inop->inode.iso_mtime = inop->inode.iso_ctime;
 402                 } else
 403                         ap = NULL;
 404         }
 405         if (!ap) {
 406                 cd9660_tstamp_conv7(isodir->date,&inop->inode.iso_ctime);
 407                 inop->inode.iso_atime = inop->inode.iso_ctime;
 408                 inop->inode.iso_mtime = inop->inode.iso_ctime;
 409         }
 410         if (bp2)
 411                 buf_brelse(bp2);
 412 }
 413
 414 int
 415 cd9660_tstamp_conv7(u_char *pi, struct timespec *pu)
 416 {
 417         int crtime, days;
 418         int y, m, d, hour, minute, second, mytz;
 419
 420         y = pi[0] + 1900;
 421         m = pi[1];
 422         d = pi[2];
 423         hour = pi[3];
 424         minute = pi[4];
 425         second = pi[5];
 426         mytz = pi[6];
 427
 428         if (y < 1970) {
 429                 pu->tv_sec  = 0;
 430                 pu->tv_nsec = 0;
 431                 return 0;
 432         } else {
 433 #ifdef  ORIGINAL
 434                 /* computes day number relative to Sept. 19th,1989 */
 435                 /* don't even *THINK* about changing formula. It works! */
 436                 days = 367*(y-1980)-7*(y+(m+9)/12)/4-3*((y+(m-9)/7)/100+1)/4+275*m/9+d-100;
 437 #else
 438                 /*
 439                  * Changed :-) to make it relative to Jan. 1st, 1970
 440                  * and to disambiguate negative division
 441                  */
 442                 days = 367*(y-1960)-7*(y+(m+9)/12)/4-3*((y+(m+9)/12-1)/100+1)/4+275*m/9+d-239;
 443 #endif
 444                 crtime = ((((days * 24) + hour) * 60 + minute) * 60) + second;
 445
 446                 /* timezone offset is unreliable on some disks */
 447                 if (-48 <= mytz && mytz <= 52)
 448                         crtime -= mytz * 15 * 60;
 449         }
 450         pu->tv_sec  = crtime;
 451         pu->tv_nsec = 0;
 452         return 1;
 453 }
 454
 455 static u_int
 456 cd9660_chars2ui(u_char *begin, int len)
 457 {
 458         u_int rc;
 459
 460         for (rc = 0; --len >= 0;) {
 461                 rc *= 10;
 462                 rc += *begin++ - '0';
 463         }
 464         return rc;
 465 }
 466
 467 int
 468 cd9660_tstamp_conv17(u_char *pi, struct timespec *pu)
 469 {
 470         u_char buf[7];
 471
 472         /* year:"0001"-"9999" -> -1900  */
 473         buf[0] = cd9660_chars2ui(pi,4) - 1900;
 474
 475         /* month: " 1"-"12"      -> 1 - 12 */
 476         buf[1] = cd9660_chars2ui(pi + 4,2);
 477
 478         /* day:   " 1"-"31"      -> 1 - 31 */
 479         buf[2] = cd9660_chars2ui(pi + 6,2);
 480
 481         /* hour:  " 0"-"23"      -> 0 - 23 */
 482         buf[3] = cd9660_chars2ui(pi + 8,2);
 483
 484         /* minute:" 0"-"59"      -> 0 - 59 */
 485         buf[4] = cd9660_chars2ui(pi + 10,2);
 486
 487         /* second:" 0"-"59"      -> 0 - 59 */
 488         buf[5] = cd9660_chars2ui(pi + 12,2);
 489
 490         /* difference of GMT */
 491         buf[6] = pi[16];
 492
 493         return cd9660_tstamp_conv7(buf,pu);
 494 }
 495
 496 ino_t
 497 isodirino(struct iso_directory_record *isodir, struct iso_mnt *imp)
 498 {
 499         ino_t ino;
 500
 501         ino = (isonum_733(isodir->extent) + isonum_711(isodir->ext_attr_length))
 502               << imp->im_bshift;
 503         return (ino);
 504 }