xref: /freebsd/stand/libsa/cd9660.c (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1 /*	$NetBSD: cd9660.c,v 1.5 1997/06/26 19:11:33 drochner Exp $	*/
2 
3 /*
4  * Copyright (C) 1996 Wolfgang Solfrank.
5  * Copyright (C) 1996 TooLs GmbH.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by TooLs GmbH.
19  * 4. The name of TooLs GmbH may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 /*
38  * Stand-alone ISO9660 file reading package.
39  *
40  * Note: This doesn't support Rock Ridge extensions, extended attributes,
41  * blocksizes other than 2048 bytes, multi-extent files, etc.
42  */
43 #include <sys/param.h>
44 #include <string.h>
45 #include <sys/dirent.h>
46 #include <fs/cd9660/iso.h>
47 #include <fs/cd9660/cd9660_rrip.h>
48 
49 #include "stand.h"
50 
51 #define	SUSP_CONTINUATION	"CE"
52 #define	SUSP_PRESENT		"SP"
53 #define	SUSP_STOP		"ST"
54 #define	SUSP_EXTREF		"ER"
55 #define	RRIP_NAME		"NM"
56 
57 typedef struct {
58 	ISO_SUSP_HEADER		h;
59 	u_char signature	[ISODCL (  5,    6)];
60 	u_char len_skp		[ISODCL (  7,    7)]; /* 711 */
61 } ISO_SUSP_PRESENT;
62 
63 static int	buf_read_file(struct open_file *f, char **buf_p,
64 		    size_t *size_p);
65 static int	cd9660_open(const char *path, struct open_file *f);
66 static int	cd9660_close(struct open_file *f);
67 static int	cd9660_read(struct open_file *f, void *buf, size_t size,
68 		    size_t *resid);
69 static off_t	cd9660_seek(struct open_file *f, off_t offset, int where);
70 static int	cd9660_stat(struct open_file *f, struct stat *sb);
71 static int	cd9660_readdir(struct open_file *f, struct dirent *d);
72 static int	dirmatch(struct open_file *f, const char *path,
73 		    struct iso_directory_record *dp, int use_rrip, int lenskip);
74 static int	rrip_check(struct open_file *f, struct iso_directory_record *dp,
75 		    int *lenskip);
76 static char	*rrip_lookup_name(struct open_file *f,
77 		    struct iso_directory_record *dp, int lenskip, size_t *len);
78 static ISO_SUSP_HEADER *susp_lookup_record(struct open_file *f,
79 		    const char *identifier, struct iso_directory_record *dp,
80 		    int lenskip);
81 
82 struct fs_ops cd9660_fsops = {
83 	"cd9660",
84 	cd9660_open,
85 	cd9660_close,
86 	cd9660_read,
87 	null_write,
88 	cd9660_seek,
89 	cd9660_stat,
90 	cd9660_readdir
91 };
92 
93 #define	F_ISDIR		0x0001		/* Directory */
94 #define	F_ROOTDIR	0x0002		/* Root directory */
95 #define	F_RR		0x0004		/* Rock Ridge on this volume */
96 
97 struct file {
98 	int 		f_flags;	/* file flags */
99 	off_t 		f_off;		/* Current offset within file */
100 	daddr_t 	f_bno;		/* Starting block number */
101 	off_t 		f_size;		/* Size of file */
102 	daddr_t		f_buf_blkno;	/* block number of data block */
103 	char		*f_buf;		/* buffer for data block */
104 	int		f_susp_skip;	/* len_skip for SUSP records */
105 };
106 
107 struct ptable_ent {
108 	char namlen	[ISODCL( 1, 1)];	/* 711 */
109 	char extlen	[ISODCL( 2, 2)];	/* 711 */
110 	char block	[ISODCL( 3, 6)];	/* 732 */
111 	char parent	[ISODCL( 7, 8)];	/* 722 */
112 	char name	[1];
113 };
114 #define	PTFIXSZ		8
115 #define	PTSIZE(pp)	roundup(PTFIXSZ + isonum_711((pp)->namlen), 2)
116 
117 #define	cdb2devb(bno)	((bno) * ISO_DEFAULT_BLOCK_SIZE / DEV_BSIZE)
118 
119 static ISO_SUSP_HEADER *
120 susp_lookup_record(struct open_file *f, const char *identifier,
121     struct iso_directory_record *dp, int lenskip)
122 {
123 	static char susp_buffer[ISO_DEFAULT_BLOCK_SIZE];
124 	ISO_SUSP_HEADER *sh;
125 	ISO_RRIP_CONT *shc;
126 	char *p, *end;
127 	int error;
128 	size_t read;
129 
130 	p = dp->name + isonum_711(dp->name_len) + lenskip;
131 	/* Names of even length have a padding byte after the name. */
132 	if ((isonum_711(dp->name_len) & 1) == 0)
133 		p++;
134 	end = (char *)dp + isonum_711(dp->length);
135 	while (p + 3 < end) {
136 		sh = (ISO_SUSP_HEADER *)p;
137 		if (bcmp(sh->type, identifier, 2) == 0)
138 			return (sh);
139 		if (bcmp(sh->type, SUSP_STOP, 2) == 0)
140 			return (NULL);
141 		if (bcmp(sh->type, SUSP_CONTINUATION, 2) == 0) {
142 			shc = (ISO_RRIP_CONT *)sh;
143 			error = f->f_dev->dv_strategy(f->f_devdata, F_READ,
144 			    cdb2devb(isonum_733(shc->location)),
145 			    ISO_DEFAULT_BLOCK_SIZE, susp_buffer, &read);
146 
147 			/* Bail if it fails. */
148 			if (error != 0 || read != ISO_DEFAULT_BLOCK_SIZE)
149 				return (NULL);
150 			p = susp_buffer + isonum_733(shc->offset);
151 			end = p + isonum_733(shc->length);
152 		} else {
153 			/* Ignore this record and skip to the next. */
154 			p += isonum_711(sh->length);
155 
156 			/* Avoid infinite loops with corrupted file systems */
157 			if (isonum_711(sh->length) == 0)
158 				return (NULL);
159 		}
160 	}
161 	return (NULL);
162 }
163 
164 static char *
165 rrip_lookup_name(struct open_file *f, struct iso_directory_record *dp,
166     int lenskip, size_t *len)
167 {
168 	ISO_RRIP_ALTNAME *p;
169 
170 	if (len == NULL)
171 		return (NULL);
172 
173 	p = (ISO_RRIP_ALTNAME *)susp_lookup_record(f, RRIP_NAME, dp, lenskip);
174 	if (p == NULL)
175 		return (NULL);
176 	switch (*p->flags) {
177 	case ISO_SUSP_CFLAG_CURRENT:
178 		*len = 1;
179 		return (".");
180 	case ISO_SUSP_CFLAG_PARENT:
181 		*len = 2;
182 		return ("..");
183 	case 0:
184 		*len = isonum_711(p->h.length) - 5;
185 		return ((char *)p + 5);
186 	default:
187 		/*
188 		 * We don't handle hostnames or continued names as they are
189 		 * too hard, so just bail and use the default name.
190 		 */
191 		return (NULL);
192 	}
193 }
194 
195 static int
196 rrip_check(struct open_file *f, struct iso_directory_record *dp, int *lenskip)
197 {
198 	ISO_SUSP_PRESENT *sp;
199 	ISO_RRIP_EXTREF *er;
200 	char *p;
201 
202 	/* First, see if we can find a SP field. */
203 	p = dp->name + isonum_711(dp->name_len);
204 	if (p > (char *)dp + isonum_711(dp->length))
205 		return (0);
206 	sp = (ISO_SUSP_PRESENT *)p;
207 	if (bcmp(sp->h.type, SUSP_PRESENT, 2) != 0)
208 		return (0);
209 	if (isonum_711(sp->h.length) != sizeof(ISO_SUSP_PRESENT))
210 		return (0);
211 	if (sp->signature[0] != 0xbe || sp->signature[1] != 0xef)
212 		return (0);
213 	*lenskip = isonum_711(sp->len_skp);
214 
215 	/*
216 	 * Now look for an ER field.  If RRIP is present, then there must
217 	 * be at least one of these.  It would be more pedantic to walk
218 	 * through the list of fields looking for a Rock Ridge ER field.
219 	 */
220 	er = (ISO_RRIP_EXTREF *)susp_lookup_record(f, SUSP_EXTREF, dp, 0);
221 	if (er == NULL)
222 		return (0);
223 	return (1);
224 }
225 
226 static int
227 dirmatch(struct open_file *f, const char *path, struct iso_directory_record *dp,
228     int use_rrip, int lenskip)
229 {
230 	size_t len;
231 	char *cp;
232 	int i, icase;
233 
234 	if (use_rrip)
235 		cp = rrip_lookup_name(f, dp, lenskip, &len);
236 	else
237 		cp = NULL;
238 	if (cp == NULL) {
239 		len = isonum_711(dp->name_len);
240 		cp = dp->name;
241 		icase = 1;
242 	} else
243 		icase = 0;
244 	for (i = len; --i >= 0; path++, cp++) {
245 		if (!*path || *path == '/')
246 			break;
247 		if (*path == *cp)
248 			continue;
249 		if (!icase && toupper(*path) == *cp)
250 			continue;
251 		return 0;
252 	}
253 	if (*path && *path != '/')
254 		return 0;
255 	/*
256 	 * Allow stripping of trailing dots and the version number.
257 	 * Note that this will find the first instead of the last version
258 	 * of a file.
259 	 */
260 	if (i >= 0 && (*cp == ';' || *cp == '.')) {
261 		/* This is to prevent matching of numeric extensions */
262 		if (*cp == '.' && cp[1] != ';')
263 			return 0;
264 		while (--i >= 0)
265 			if (*++cp != ';' && (*cp < '0' || *cp > '9'))
266 				return 0;
267 	}
268 	return 1;
269 }
270 
271 static int
272 cd9660_open(const char *path, struct open_file *f)
273 {
274 	struct file *fp = NULL;
275 	void *buf;
276 	struct iso_primary_descriptor *vd;
277 	size_t buf_size, read, dsize, off;
278 	daddr_t bno, boff;
279 	struct iso_directory_record rec;
280 	struct iso_directory_record *dp = NULL;
281 	int rc, first, use_rrip, lenskip;
282 
283 	/* First find the volume descriptor */
284 	buf = malloc(buf_size = ISO_DEFAULT_BLOCK_SIZE);
285 	vd = buf;
286 	for (bno = 16;; bno++) {
287 		twiddle(1);
288 		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ, cdb2devb(bno),
289 					ISO_DEFAULT_BLOCK_SIZE, buf, &read);
290 		if (rc)
291 			goto out;
292 		if (read != ISO_DEFAULT_BLOCK_SIZE) {
293 			rc = EIO;
294 			goto out;
295 		}
296 		rc = EINVAL;
297 		if (bcmp(vd->id, ISO_STANDARD_ID, sizeof vd->id) != 0)
298 			goto out;
299 		if (isonum_711(vd->type) == ISO_VD_END)
300 			goto out;
301 		if (isonum_711(vd->type) == ISO_VD_PRIMARY)
302 			break;
303 	}
304 	if (isonum_723(vd->logical_block_size) != ISO_DEFAULT_BLOCK_SIZE)
305 		goto out;
306 
307 	rec = *(struct iso_directory_record *) vd->root_directory_record;
308 	if (*path == '/') path++; /* eat leading '/' */
309 
310 	first = 1;
311 	use_rrip = 0;
312 	lenskip = 0;
313 	while (*path) {
314 		bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
315 		dsize = isonum_733(rec.size);
316 		off = 0;
317 		boff = 0;
318 
319 		while (off < dsize) {
320 			if ((off % ISO_DEFAULT_BLOCK_SIZE) == 0) {
321 				twiddle(1);
322 				rc = f->f_dev->dv_strategy
323 					(f->f_devdata, F_READ,
324 					 cdb2devb(bno + boff),
325 					 ISO_DEFAULT_BLOCK_SIZE,
326 					 buf, &read);
327 				if (rc)
328 					goto out;
329 				if (read != ISO_DEFAULT_BLOCK_SIZE) {
330 					rc = EIO;
331 					goto out;
332 				}
333 				boff++;
334 				dp = (struct iso_directory_record *) buf;
335 			}
336 			if (isonum_711(dp->length) == 0) {
337 			    /* skip to next block, if any */
338 			    off = boff * ISO_DEFAULT_BLOCK_SIZE;
339 			    continue;
340 			}
341 
342 			/* See if RRIP is in use. */
343 			if (first)
344 				use_rrip = rrip_check(f, dp, &lenskip);
345 
346 			if (dirmatch(f, path, dp, use_rrip,
347 			    first ? 0 : lenskip)) {
348 				first = 0;
349 				break;
350 			} else
351 				first = 0;
352 
353 			dp = (struct iso_directory_record *)
354 				((char *) dp + isonum_711(dp->length));
355 			/* If the new block has zero length, it is padding. */
356 			if (isonum_711(dp->length) == 0) {
357 				/* Skip to next block, if any. */
358 				off = boff * ISO_DEFAULT_BLOCK_SIZE;
359 				continue;
360 			}
361 			off += isonum_711(dp->length);
362 		}
363 		if (off >= dsize) {
364 			rc = ENOENT;
365 			goto out;
366 		}
367 
368 		rec = *dp;
369 		while (*path && *path != '/') /* look for next component */
370 			path++;
371 		if (*path) path++; /* skip '/' */
372 	}
373 
374 	/* allocate file system specific data structure */
375 	fp = malloc(sizeof(struct file));
376 	bzero(fp, sizeof(struct file));
377 	f->f_fsdata = (void *)fp;
378 
379 	if ((isonum_711(rec.flags) & 2) != 0) {
380 		fp->f_flags = F_ISDIR;
381 	}
382 	if (first) {
383 		fp->f_flags |= F_ROOTDIR;
384 
385 		/* Check for Rock Ridge since we didn't in the loop above. */
386 		bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
387 		twiddle(1);
388 		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ, cdb2devb(bno),
389 		    ISO_DEFAULT_BLOCK_SIZE, buf, &read);
390 		if (rc)
391 			goto out;
392 		if (read != ISO_DEFAULT_BLOCK_SIZE) {
393 			rc = EIO;
394 			goto out;
395 		}
396 		dp = (struct iso_directory_record *)buf;
397 		use_rrip = rrip_check(f, dp, &lenskip);
398 	}
399 	if (use_rrip) {
400 		fp->f_flags |= F_RR;
401 		fp->f_susp_skip = lenskip;
402 	}
403 	fp->f_off = 0;
404 	fp->f_bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
405 	fp->f_size = isonum_733(rec.size);
406 	free(buf);
407 
408 	return 0;
409 
410 out:
411 	if (fp)
412 		free(fp);
413 	free(buf);
414 
415 	return rc;
416 }
417 
418 static int
419 cd9660_close(struct open_file *f)
420 {
421 	struct file *fp = (struct file *)f->f_fsdata;
422 
423 	f->f_fsdata = NULL;
424 	free(fp);
425 
426 	return 0;
427 }
428 
429 static int
430 buf_read_file(struct open_file *f, char **buf_p, size_t *size_p)
431 {
432 	struct file *fp = (struct file *)f->f_fsdata;
433 	daddr_t blkno, blkoff;
434 	int rc = 0;
435 	size_t read;
436 
437 	blkno = fp->f_off / ISO_DEFAULT_BLOCK_SIZE + fp->f_bno;
438 	blkoff = fp->f_off % ISO_DEFAULT_BLOCK_SIZE;
439 
440 	if (blkno != fp->f_buf_blkno) {
441 		if (fp->f_buf == (char *)0)
442 			fp->f_buf = malloc(ISO_DEFAULT_BLOCK_SIZE);
443 
444 		twiddle(16);
445 		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ,
446 		    cdb2devb(blkno), ISO_DEFAULT_BLOCK_SIZE,
447 		    fp->f_buf, &read);
448 		if (rc)
449 			return (rc);
450 		if (read != ISO_DEFAULT_BLOCK_SIZE)
451 			return (EIO);
452 
453 		fp->f_buf_blkno = blkno;
454 	}
455 
456 	*buf_p = fp->f_buf + blkoff;
457 	*size_p = ISO_DEFAULT_BLOCK_SIZE - blkoff;
458 
459 	if (*size_p > fp->f_size - fp->f_off)
460 		*size_p = fp->f_size - fp->f_off;
461 	return (rc);
462 }
463 
464 static int
465 cd9660_read(struct open_file *f, void *start, size_t size, size_t *resid)
466 {
467 	struct file *fp = (struct file *)f->f_fsdata;
468 	char *buf, *addr;
469 	size_t buf_size, csize;
470 	int rc = 0;
471 
472 	addr = start;
473 	while (size) {
474 		if (fp->f_off < 0 || fp->f_off >= fp->f_size)
475 			break;
476 
477 		rc = buf_read_file(f, &buf, &buf_size);
478 		if (rc)
479 			break;
480 
481 		csize = size > buf_size ? buf_size : size;
482 		bcopy(buf, addr, csize);
483 
484 		fp->f_off += csize;
485 		addr += csize;
486 		size -= csize;
487 	}
488 	if (resid)
489 		*resid = size;
490 	return (rc);
491 }
492 
493 static int
494 cd9660_readdir(struct open_file *f, struct dirent *d)
495 {
496 	struct file *fp = (struct file *)f->f_fsdata;
497 	struct iso_directory_record *ep;
498 	size_t buf_size, reclen, namelen;
499 	int error = 0;
500 	int lenskip;
501 	char *buf, *name;
502 
503 again:
504 	if (fp->f_off >= fp->f_size)
505 		return (ENOENT);
506 	error = buf_read_file(f, &buf, &buf_size);
507 	if (error)
508 		return (error);
509 	ep = (struct iso_directory_record *)buf;
510 
511 	if (isonum_711(ep->length) == 0) {
512 		daddr_t blkno;
513 
514 		/* skip to next block, if any */
515 		blkno = fp->f_off / ISO_DEFAULT_BLOCK_SIZE;
516 		fp->f_off = (blkno + 1) * ISO_DEFAULT_BLOCK_SIZE;
517 		goto again;
518 	}
519 
520 	if (fp->f_flags & F_RR) {
521 		if (fp->f_flags & F_ROOTDIR && fp->f_off == 0)
522 			lenskip = 0;
523 		else
524 			lenskip = fp->f_susp_skip;
525 		name = rrip_lookup_name(f, ep, lenskip, &namelen);
526 	} else
527 		name = NULL;
528 	if (name == NULL) {
529 		namelen = isonum_711(ep->name_len);
530 		name = ep->name;
531 		if (namelen == 1) {
532 			if (ep->name[0] == 0)
533 				name = ".";
534 			else if (ep->name[0] == 1) {
535 				namelen = 2;
536 				name = "..";
537 			}
538 		}
539 	}
540 	reclen = sizeof(struct dirent) - (MAXNAMLEN+1) + namelen + 1;
541 	reclen = (reclen + 3) & ~3;
542 
543 	d->d_fileno = isonum_733(ep->extent);
544 	d->d_reclen = reclen;
545 	if (isonum_711(ep->flags) & 2)
546 		d->d_type = DT_DIR;
547 	else
548 		d->d_type = DT_REG;
549 	d->d_namlen = namelen;
550 
551 	bcopy(name, d->d_name, d->d_namlen);
552 	d->d_name[d->d_namlen] = 0;
553 
554 	fp->f_off += isonum_711(ep->length);
555 	return (0);
556 }
557 
558 static off_t
559 cd9660_seek(struct open_file *f, off_t offset, int where)
560 {
561 	struct file *fp = (struct file *)f->f_fsdata;
562 
563 	switch (where) {
564 	case SEEK_SET:
565 		fp->f_off = offset;
566 		break;
567 	case SEEK_CUR:
568 		fp->f_off += offset;
569 		break;
570 	case SEEK_END:
571 		fp->f_off = fp->f_size - offset;
572 		break;
573 	default:
574 		return -1;
575 	}
576 	return fp->f_off;
577 }
578 
579 static int
580 cd9660_stat(struct open_file *f, struct stat *sb)
581 {
582 	struct file *fp = (struct file *)f->f_fsdata;
583 
584 	/* only important stuff */
585 	sb->st_mode = S_IRUSR | S_IRGRP | S_IROTH;
586 	if (fp->f_flags & F_ISDIR)
587 		sb->st_mode |= S_IFDIR;
588 	else
589 		sb->st_mode |= S_IFREG;
590 	sb->st_uid = sb->st_gid = 0;
591 	sb->st_size = fp->f_size;
592 	return 0;
593 }
594