2 * Copyright (c) 2001, 2002 Scott Long <scottl@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 /* Implement the VFS side of things */
33 * Ok, here's how it goes. The UDF specs are pretty clear on how each data
34 * structure is made up, but not very clear on how they relate to each other.
35 * Here is the skinny... This demostrates a filesystem with one file in the
36 * root directory. Subdirectories are treated just as normal files, but they
37 * have File Id Descriptors of their children as their file data. As for the
38 * Anchor Volume Descriptor Pointer, it can exist in two of the following three
39 * places: sector 256, sector n (the max sector of the disk), or sector
40 * n - 256. It's a pretty good bet that one will exist at sector 256 though.
41 * One caveat is unclosed CD media. For that, sector 256 cannot be written,
42 * so the Anchor Volume Descriptor Pointer can exist at sector 512 until the
47 * n: Anchor Volume Descriptor Pointer
50 * |-->Main Volume Descriptor Sequence
53 * | |-->Logical Volume Descriptor
55 * |-->Partition Descriptor |
58 * |-->Fileset Descriptor
61 * |-->Root Dir File Entry
73 #include <sys/types.h>
74 #include <sys/param.h>
75 #include <sys/systm.h>
80 #include <sys/dirent.h>
81 #include <sys/fcntl.h>
82 #include <sys/iconv.h>
83 #include <sys/kernel.h>
84 #include <sys/malloc.h>
85 #include <sys/mount.h>
86 #include <sys/namei.h>
89 #include <sys/queue.h>
90 #include <sys/vnode.h>
91 #include <sys/endian.h>
93 #include <geom/geom.h>
94 #include <geom/geom_vfs.h>
98 #include <fs/udf/ecma167-udf.h>
99 #include <fs/udf/osta.h>
100 #include <fs/udf/udf.h>
101 #include <fs/udf/udf_mount.h>
103 static MALLOC_DEFINE(M_UDFMOUNT, "udf_mount", "UDF mount structure");
104 MALLOC_DEFINE(M_UDFFENTRY, "udf_fentry", "UDF file entry structure");
106 struct iconv_functions *udf_iconv = NULL;
109 uma_zone_t udf_zone_trans = NULL;
110 uma_zone_t udf_zone_node = NULL;
111 uma_zone_t udf_zone_ds = NULL;
113 static vfs_init_t udf_init;
114 static vfs_uninit_t udf_uninit;
115 static vfs_mount_t udf_mount;
116 static vfs_root_t udf_root;
117 static vfs_statfs_t udf_statfs;
118 static vfs_unmount_t udf_unmount;
119 static vfs_fhtovp_t udf_fhtovp;
121 static int udf_find_partmaps(struct udf_mnt *, struct logvol_desc *);
123 static struct vfsops udf_vfsops = {
124 .vfs_fhtovp = udf_fhtovp,
125 .vfs_init = udf_init,
126 .vfs_mount = udf_mount,
127 .vfs_root = udf_root,
128 .vfs_statfs = udf_statfs,
129 .vfs_uninit = udf_uninit,
130 .vfs_unmount = udf_unmount,
131 .vfs_vget = udf_vget,
133 VFS_SET(udf_vfsops, udf, VFCF_READONLY);
135 MODULE_VERSION(udf, 1);
137 static int udf_mountfs(struct vnode *, struct mount *, struct thread *);
140 udf_init(struct vfsconf *foo)
144 * This code used to pre-allocate a certain number of pages for each
145 * pool, reducing the need to grow the zones later on. UMA doesn't
146 * advertise any such functionality, unfortunately =-<
148 udf_zone_trans = uma_zcreate("UDF translation buffer, zone", MAXNAMLEN *
149 sizeof(unicode_t), NULL, NULL, NULL, NULL, 0, 0);
151 udf_zone_node = uma_zcreate("UDF Node zone", sizeof(struct udf_node),
152 NULL, NULL, NULL, NULL, 0, 0);
154 udf_zone_ds = uma_zcreate("UDF Dirstream zone",
155 sizeof(struct udf_dirstream), NULL, NULL, NULL, NULL, 0, 0);
157 if ((udf_zone_node == NULL) || (udf_zone_trans == NULL) ||
158 (udf_zone_ds == NULL)) {
159 printf("Cannot create allocation zones.\n");
167 udf_uninit(struct vfsconf *foo)
170 if (udf_zone_trans != NULL) {
171 uma_zdestroy(udf_zone_trans);
172 udf_zone_trans = NULL;
175 if (udf_zone_node != NULL) {
176 uma_zdestroy(udf_zone_node);
177 udf_zone_node = NULL;
180 if (udf_zone_ds != NULL) {
181 uma_zdestroy(udf_zone_ds);
189 udf_mount(struct mount *mp, struct thread *td)
191 struct vnode *devvp; /* vnode of the mount device */
192 struct udf_mnt *imp = 0;
193 struct vfsoptlist *opts;
194 char *fspec, *cs_disk, *cs_local;
195 int error, len, *udf_flags;
196 struct nameidata nd, *ndp = &nd;
198 opts = mp->mnt_optnew;
201 * Unconditionally mount as read-only.
204 mp->mnt_flag |= MNT_RDONLY;
208 * No root filesystem support. Probably not a big deal, since the
209 * bootloader doesn't understand UDF.
211 if (mp->mnt_flag & MNT_ROOTFS)
215 error = vfs_getopt(opts, "from", (void **)&fspec, &len);
216 if (!error && fspec[len - 1] != '\0')
219 if (mp->mnt_flag & MNT_UPDATE) {
223 /* Check that the mount device exists */
226 NDINIT(ndp, LOOKUP, FOLLOW | LOCKLEAF, UIO_SYSSPACE, fspec, td);
227 if ((error = namei(ndp)))
229 NDFREE(ndp, NDF_ONLY_PNBUF);
232 if (vn_isdisk(devvp, &error) == 0) {
237 /* Check the access rights on the mount device */
238 error = VOP_ACCESS(devvp, VREAD, td->td_ucred, td);
240 error = priv_check(td, PRIV_VFS_MOUNT_PERM);
246 if ((error = udf_mountfs(devvp, mp, td))) {
251 imp = VFSTOUDFFS(mp);
254 error = vfs_getopt(opts, "flags", (void **)&udf_flags, &len);
255 if (error || len != sizeof(int))
257 imp->im_flags = *udf_flags;
259 if (imp->im_flags & UDFMNT_KICONV && udf_iconv) {
261 error = vfs_getopt(opts, "cs_disk", (void **)&cs_disk, &len);
262 if (!error && cs_disk[len - 1] != '\0')
265 error = vfs_getopt(opts, "cs_local", (void **)&cs_local, &len);
266 if (!error && cs_local[len - 1] != '\0')
268 udf_iconv->open(cs_local, cs_disk, &imp->im_d2l);
270 udf_iconv->open(cs_disk, cs_local, &imp->im_l2d);
274 vfs_mountedfrom(mp, fspec);
279 * Check the descriptor tag for both the correct id and correct checksum.
280 * Return zero if all is good, EINVAL if not.
283 udf_checktag(struct desc_tag *tag, uint16_t id)
286 uint8_t i, cksum = 0;
288 itag = (uint8_t *)tag;
290 if (le16toh(tag->id) != id)
293 for (i = 0; i < 16; i++)
294 cksum = cksum + itag[i];
295 cksum = cksum - itag[4];
297 if (cksum == tag->cksum)
304 udf_mountfs(struct vnode *devvp, struct mount *mp, struct thread *td)
306 struct buf *bp = NULL;
308 struct anchor_vdp avdp;
309 struct udf_mnt *udfmp = NULL;
310 struct part_desc *pd;
311 struct logvol_desc *lvd;
312 struct fileset_desc *fsd;
313 struct file_entry *root_fentry;
314 uint32_t sector, size, mvds_start, mvds_end;
315 uint32_t logical_secsize;
316 uint32_t fsd_offset = 0;
317 uint16_t part_num = 0, fsd_part = 0;
319 int logvol_found = 0, part_found = 0, fsd_found = 0;
321 struct g_consumer *cp;
328 error = g_vfs_open(devvp, &cp, "udf", 0);
331 VOP_UNLOCK(devvp, 0, td);
335 bo = &devvp->v_bufobj;
337 if (devvp->v_rdev->si_iosize_max != 0)
338 mp->mnt_iosize_max = devvp->v_rdev->si_iosize_max;
339 if (mp->mnt_iosize_max > MAXPHYS)
340 mp->mnt_iosize_max = MAXPHYS;
342 /* XXX: should be M_WAITOK */
343 MALLOC(udfmp, struct udf_mnt *, sizeof(struct udf_mnt), M_UDFMOUNT,
346 printf("Cannot allocate UDF mount struct\n");
351 mp->mnt_data = (qaddr_t)udfmp;
352 mp->mnt_stat.f_fsid.val[0] = dev2udev(devvp->v_rdev);
353 mp->mnt_stat.f_fsid.val[1] = mp->mnt_vfc->vfc_typenum;
355 mp->mnt_flag |= MNT_LOCAL;
356 mp->mnt_kern_flag |= MNTK_MPSAFE | MNTK_LOOKUP_SHARED;
358 udfmp->im_mountp = mp;
360 udfmp->im_devvp = devvp;
361 udfmp->im_d2l = NULL;
366 udfmp->im_l2d = NULL;
369 * The UDF specification defines a logical sectorsize of 2048
372 logical_secsize = 2048;
374 if (((logical_secsize % cp->provider->sectorsize) != 0) ||
375 (logical_secsize < cp->provider->sectorsize)) {
380 bsize = cp->provider->sectorsize;
383 * Get the Anchor Volume Descriptor Pointer from sector 256.
384 * XXX Should also check sector n - 256, n, and 512.
387 if ((error = bread(devvp, sector * btodb(logical_secsize), bsize,
390 if ((error = udf_checktag((struct desc_tag *)bp->b_data, TAGID_ANCHOR)))
393 bcopy(bp->b_data, &avdp, sizeof(struct anchor_vdp));
398 * Extract the Partition Descriptor and Logical Volume Descriptor
399 * from the Volume Descriptor Sequence.
400 * XXX Should we care about the partition type right now?
401 * XXX What about multiple partitions?
403 mvds_start = le32toh(avdp.main_vds_ex.loc);
404 mvds_end = mvds_start + (le32toh(avdp.main_vds_ex.len) - 1) / bsize;
405 for (sector = mvds_start; sector < mvds_end; sector++) {
406 if ((error = bread(devvp, sector * btodb(logical_secsize),
407 bsize, NOCRED, &bp)) != 0) {
408 printf("Can't read sector %d of VDS\n", sector);
411 lvd = (struct logvol_desc *)bp->b_data;
412 if (!udf_checktag(&lvd->tag, TAGID_LOGVOL)) {
413 udfmp->bsize = le32toh(lvd->lb_size);
414 udfmp->bmask = udfmp->bsize - 1;
415 udfmp->bshift = ffs(udfmp->bsize) - 1;
416 fsd_part = le16toh(lvd->_lvd_use.fsd_loc.loc.part_num);
417 fsd_offset = le32toh(lvd->_lvd_use.fsd_loc.loc.lb_num);
418 if (udf_find_partmaps(udfmp, lvd))
422 pd = (struct part_desc *)bp->b_data;
423 if (!udf_checktag(&pd->tag, TAGID_PARTITION)) {
425 part_num = le16toh(pd->part_num);
426 udfmp->part_len = le32toh(pd->part_len);
427 udfmp->part_start = le32toh(pd->start_loc);
432 if ((part_found) && (logvol_found))
436 if (!part_found || !logvol_found) {
441 if (fsd_part != part_num) {
442 printf("FSD does not lie within the partition!\n");
449 * Grab the Fileset Descriptor
450 * Thanks to Chuck McCrobie <mccrobie@cablespeed.com> for pointing
451 * me in the right direction here.
453 sector = udfmp->part_start + fsd_offset;
454 if ((error = RDSECTOR(devvp, sector, udfmp->bsize, &bp)) != 0) {
455 printf("Cannot read sector %d of FSD\n", sector);
458 fsd = (struct fileset_desc *)bp->b_data;
459 if (!udf_checktag(&fsd->tag, TAGID_FSD)) {
461 bcopy(&fsd->rootdir_icb, &udfmp->root_icb,
462 sizeof(struct long_ad));
469 printf("Couldn't find the fsd\n");
475 * Find the file entry for the root directory.
477 sector = le32toh(udfmp->root_icb.loc.lb_num) + udfmp->part_start;
478 size = le32toh(udfmp->root_icb.len);
479 if ((error = udf_readdevblks(udfmp, sector, size, &bp)) != 0) {
480 printf("Cannot read sector %d\n", sector);
484 root_fentry = (struct file_entry *)bp->b_data;
485 if ((error = udf_checktag(&root_fentry->tag, TAGID_FENTRY))) {
486 printf("Invalid root file entry!\n");
497 FREE(udfmp, M_UDFMOUNT);
512 udf_unmount(struct mount *mp, int mntflags, struct thread *td)
514 struct udf_mnt *udfmp;
515 int error, flags = 0;
517 udfmp = VFSTOUDFFS(mp);
519 if (mntflags & MNT_FORCE)
522 if ((error = vflush(mp, 0, flags, td)))
525 if (udfmp->im_flags & UDFMNT_KICONV && udf_iconv) {
527 udf_iconv->close(udfmp->im_d2l);
530 udf_iconv->close(udfmp->im_l2d);
536 g_vfs_close(udfmp->im_cp, td);
539 vrele(udfmp->im_devvp);
540 dev_rel(udfmp->im_dev);
542 if (udfmp->s_table != NULL)
543 FREE(udfmp->s_table, M_UDFMOUNT);
545 FREE(udfmp, M_UDFMOUNT);
547 mp->mnt_data = (qaddr_t)0;
549 mp->mnt_flag &= ~MNT_LOCAL;
556 udf_root(struct mount *mp, int flags, struct vnode **vpp, struct thread *td)
558 struct udf_mnt *udfmp;
561 udfmp = VFSTOUDFFS(mp);
563 id = udf_getid(&udfmp->root_icb);
565 return (udf_vget(mp, id, flags, vpp));
569 udf_statfs(struct mount *mp, struct statfs *sbp, struct thread *td)
571 struct udf_mnt *udfmp;
573 udfmp = VFSTOUDFFS(mp);
575 sbp->f_bsize = udfmp->bsize;
576 sbp->f_iosize = udfmp->bsize;
577 sbp->f_blocks = udfmp->part_len;
586 udf_vget(struct mount *mp, ino_t ino, int flags, struct vnode **vpp)
590 struct udf_mnt *udfmp;
593 struct udf_node *unode;
594 struct file_entry *fe;
595 int error, sector, size;
597 error = vfs_hash_get(mp, ino, flags, curthread, vpp, NULL, NULL);
598 if (error || *vpp != NULL)
602 * We must promote to an exclusive lock for vnode creation. This
603 * can happen if lookup is passed LOCKSHARED.
605 if ((flags & LK_TYPE_MASK) == LK_SHARED) {
606 flags &= ~LK_TYPE_MASK;
607 flags |= LK_EXCLUSIVE;
611 * We do not lock vnode creation as it is believed to be too
612 * expensive for such rare case as simultaneous creation of vnode
613 * for same ino by different processes. We just allow them to race
614 * and check later to decide who wins. Let the race begin!
618 udfmp = VFSTOUDFFS(mp);
620 unode = uma_zalloc(udf_zone_node, M_WAITOK | M_ZERO);
622 if ((error = udf_allocv(mp, &vp, td))) {
623 printf("Error from udf_allocv\n");
624 uma_zfree(udf_zone_node, unode);
629 unode->hash_id = ino;
630 unode->udfmp = udfmp;
633 lockmgr(vp->v_vnlock, LK_EXCLUSIVE, NULL, td);
634 error = insmntque(vp, mp);
636 uma_zfree(udf_zone_node, unode);
639 error = vfs_hash_insert(vp, ino, flags, td, vpp, NULL, NULL);
640 if (error || *vpp != NULL)
644 * Copy in the file entry. Per the spec, the size can only be 1 block.
646 sector = ino + udfmp->part_start;
647 devvp = udfmp->im_devvp;
648 if ((error = RDSECTOR(devvp, sector, udfmp->bsize, &bp)) != 0) {
649 printf("Cannot read sector %d\n", sector);
657 fe = (struct file_entry *)bp->b_data;
658 if (udf_checktag(&fe->tag, TAGID_FENTRY)) {
659 printf("Invalid file entry!\n");
666 size = UDF_FENTRY_SIZE + le32toh(fe->l_ea) + le32toh(fe->l_ad);
667 MALLOC(unode->fentry, struct file_entry *, size, M_UDFFENTRY,
669 if (unode->fentry == NULL) {
670 printf("Cannot allocate file entry block\n");
678 bcopy(bp->b_data, unode->fentry, size);
683 switch (unode->fentry->icbtag.file_type) {
701 vp->v_op = &udf_fifoops;
711 if (vp->v_type != VFIFO)
714 if (ino == udf_getid(&udfmp->root_icb))
715 vp->v_vflag |= VV_ROOT;
723 udf_fhtovp(struct mount *mp, struct fid *fhp, struct vnode **vpp)
731 ifhp = (struct ifid *)fhp;
733 if ((error = VFS_VGET(mp, ifhp->ifid_ino, LK_EXCLUSIVE, &nvp)) != 0) {
739 fsize = le64toh(np->fentry->inf_len);
742 vnode_create_vobject(*vpp, fsize, curthread);
747 udf_find_partmaps(struct udf_mnt *udfmp, struct logvol_desc *lvd)
749 struct part_map_spare *pms;
750 struct regid *pmap_id;
752 unsigned char regid_id[UDF_REGID_ID_SIZE + 1];
753 int i, k, ptype, psize, error;
754 uint8_t *pmap = (uint8_t *) &lvd->maps[0];
756 for (i = 0; i < le32toh(lvd->n_pm); i++) {
759 if (((ptype != 1) && (ptype != 2)) ||
760 ((psize != UDF_PMAP_TYPE1_SIZE) &&
761 (psize != UDF_PMAP_TYPE2_SIZE))) {
762 printf("Invalid partition map found\n");
767 /* Type 1 map. We don't care */
768 pmap += UDF_PMAP_TYPE1_SIZE;
772 /* Type 2 map. Gotta find out the details */
773 pmap_id = (struct regid *)&pmap[4];
774 bzero(®id_id[0], UDF_REGID_ID_SIZE);
775 bcopy(&pmap_id->id[0], ®id_id[0], UDF_REGID_ID_SIZE);
777 if (bcmp(®id_id[0], "*UDF Sparable Partition",
778 UDF_REGID_ID_SIZE)) {
779 printf("Unsupported partition map: %s\n", ®id_id[0]);
783 pms = (struct part_map_spare *)pmap;
784 pmap += UDF_PMAP_TYPE2_SIZE;
785 MALLOC(udfmp->s_table, struct udf_sparing_table *,
786 le32toh(pms->st_size), M_UDFMOUNT, M_NOWAIT | M_ZERO);
787 if (udfmp->s_table == NULL)
790 /* Calculate the number of sectors per packet. */
791 /* XXX Logical or physical? */
792 udfmp->p_sectors = le16toh(pms->packet_len) / udfmp->bsize;
795 * XXX If reading the first Sparing Table fails, should look
798 if ((error = udf_readdevblks(udfmp, le32toh(pms->st_loc[0]),
799 le32toh(pms->st_size), &bp)) != 0) {
802 printf("Failed to read Sparing Table at sector %d\n",
803 le32toh(pms->st_loc[0]));
804 FREE(udfmp->s_table, M_UDFMOUNT);
807 bcopy(bp->b_data, udfmp->s_table, le32toh(pms->st_size));
810 if (udf_checktag(&udfmp->s_table->tag, 0)) {
811 printf("Invalid sparing table found\n");
812 FREE(udfmp->s_table, M_UDFMOUNT);
816 /* See how many valid entries there are here. The list is
817 * supposed to be sorted. 0xfffffff0 and higher are not valid
819 for (k = 0; k < le16toh(udfmp->s_table->rt_l); k++) {
820 udfmp->s_table_entries = k;
821 if (le32toh(udfmp->s_table->entries[k].org) >=