1 /* $NetBSD: ufs.c,v 1.20 1998/03/01 07:15:39 ross Exp $ */
4 * Copyright (c) 2002 Networks Associates Technology, Inc.
7 * This software was developed for the FreeBSD Project by Marshall
8 * Kirk McKusick and Network Associates Laboratories, the Security
9 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
13 * Copyright (c) 1982, 1989, 1993
14 * The Regents of the University of California. All rights reserved.
16 * This code is derived from software contributed to Berkeley by
17 * The Mach Operating System project at Carnegie-Mellon University.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 * 3. Neither the name of the University nor the names of its contributors
28 * may be used to endorse or promote products derived from this software
29 * without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
32 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * Copyright (c) 1990, 1991 Carnegie Mellon University
45 * All Rights Reserved.
49 * Permission to use, copy, modify and distribute this software and its
50 * documentation is hereby granted, provided that both the copyright
51 * notice and this permission notice appear in all copies of the
52 * software, derivative works or modified versions, and any portions
53 * thereof, and that both notices appear in supporting documentation.
55 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
56 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
57 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
59 * Carnegie Mellon requests users of this software to return to
61 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
62 * School of Computer Science
63 * Carnegie Mellon University
64 * Pittsburgh PA 15213-3890
66 * any improvements or extensions that they make and grant Carnegie the
67 * rights to redistribute these changes.
70 #include <sys/cdefs.h>
73 * Stand-alone file reading package.
76 #include <sys/param.h>
77 #include <sys/disklabel.h>
79 #include <ufs/ufs/dinode.h>
80 #include <ufs/ufs/dir.h>
81 #include <ufs/ffs/fs.h>
85 static int ufs_open(const char *path
, struct open_file
*f
);
86 static int ufs_write(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
87 static int ufs_close(struct open_file
*f
);
88 static int ufs_read(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
89 static off_t
ufs_seek(struct open_file
*f
, off_t offset
, int where
);
90 static int ufs_stat(struct open_file
*f
, struct stat
*sb
);
91 static int ufs_readdir(struct open_file
*f
, struct dirent
*d
);
93 struct fs_ops ufs_fsops
= {
108 off_t f_seekp
; /* seek pointer */
109 struct fs
*f_fs
; /* pointer to super-block */
111 struct ufs1_dinode di1
;
112 struct ufs2_dinode di2
;
113 } f_di
; /* copy of on-disk inode */
114 int f_nindir
[NIADDR
];
115 /* number of blocks mapped by
116 indirect block at level i */
117 char *f_blk
[NIADDR
]; /* buffer for indirect block at
119 size_t f_blksize
[NIADDR
];
121 ufs2_daddr_t f_blkno
[NIADDR
];/* disk address of block in buffer */
122 ufs2_daddr_t f_buf_blkno
; /* block number of data block */
123 char *f_buf
; /* buffer for data block */
124 size_t f_buf_size
; /* size of data block */
126 #define DIP(fp, field) \
127 ((fp)->f_fs->fs_magic == FS_UFS1_MAGIC ? \
128 (fp)->f_di.di1.field : (fp)->f_di.di2.field)
130 static int read_inode(ino_t
, struct open_file
*);
131 static int block_map(struct open_file
*, ufs2_daddr_t
, ufs2_daddr_t
*);
132 static int buf_read_file(struct open_file
*, char **, size_t *);
133 static int buf_write_file(struct open_file
*, char *, size_t *);
134 static int search_directory(char *, struct open_file
*, ino_t
*);
137 * Read a new inode into a file structure.
140 read_inode(inumber
, f
)
144 struct file
*fp
= (struct file
*)f
->f_fsdata
;
145 struct fs
*fs
= fp
->f_fs
;
154 * Read inode and save it.
156 buf
= malloc(fs
->fs_bsize
);
158 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
, F_READ
,
159 fsbtodb(fs
, ino_to_fsba(fs
, inumber
)), fs
->fs_bsize
,
163 if (rsize
!= fs
->fs_bsize
) {
168 if (fp
->f_fs
->fs_magic
== FS_UFS1_MAGIC
)
169 fp
->f_di
.di1
= ((struct ufs1_dinode
*)buf
)
170 [ino_to_fsbo(fs
, inumber
)];
172 fp
->f_di
.di2
= ((struct ufs2_dinode
*)buf
)
173 [ino_to_fsbo(fs
, inumber
)];
176 * Clear out the old buffers
181 for (level
= 0; level
< NIADDR
; level
++)
182 fp
->f_blkno
[level
] = -1;
183 fp
->f_buf_blkno
= -1;
192 * Given an offset in a file, find the disk block number that
193 * contains that block.
196 block_map(f
, file_block
, disk_block_p
)
198 ufs2_daddr_t file_block
;
199 ufs2_daddr_t
*disk_block_p
; /* out */
201 struct file
*fp
= (struct file
*)f
->f_fsdata
;
202 struct fs
*fs
= fp
->f_fs
;
205 ufs2_daddr_t ind_block_num
;
209 * Index structure of an inode:
211 * di_db[0..NDADDR-1] hold block numbers for blocks
214 * di_ib[0] index block 0 is the single indirect block
215 * holds block numbers for blocks
216 * NDADDR .. NDADDR + NINDIR(fs)-1
218 * di_ib[1] index block 1 is the double indirect block
219 * holds block numbers for INDEX blocks for blocks
220 * NDADDR + NINDIR(fs) ..
221 * NDADDR + NINDIR(fs) + NINDIR(fs)**2 - 1
223 * di_ib[2] index block 2 is the triple indirect block
224 * holds block numbers for double-indirect
226 * NDADDR + NINDIR(fs) + NINDIR(fs)**2 ..
227 * NDADDR + NINDIR(fs) + NINDIR(fs)**2
228 * + NINDIR(fs)**3 - 1
231 if (file_block
< NDADDR
) {
233 *disk_block_p
= DIP(fp
, di_db
[file_block
]);
237 file_block
-= NDADDR
;
241 * nindir[1] = NINDIR**2
242 * nindir[2] = NINDIR**3
245 for (level
= 0; level
< NIADDR
; level
++) {
246 if (file_block
< fp
->f_nindir
[level
])
248 file_block
-= fp
->f_nindir
[level
];
250 if (level
== NIADDR
) {
251 /* Block number too high */
255 ind_block_num
= DIP(fp
, di_ib
[level
]);
257 for (; level
>= 0; level
--) {
258 if (ind_block_num
== 0) {
259 *disk_block_p
= 0; /* missing */
263 if (fp
->f_blkno
[level
] != ind_block_num
) {
264 if (fp
->f_blk
[level
] == NULL
)
266 malloc(fs
->fs_bsize
);
268 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
, F_READ
,
269 fsbtodb(fp
->f_fs
, ind_block_num
),
272 &fp
->f_blksize
[level
]);
275 if (fp
->f_blksize
[level
] != fs
->fs_bsize
)
277 fp
->f_blkno
[level
] = ind_block_num
;
281 idx
= file_block
/ fp
->f_nindir
[level
- 1];
282 file_block
%= fp
->f_nindir
[level
- 1];
286 if (fp
->f_fs
->fs_magic
== FS_UFS1_MAGIC
)
287 ind_block_num
= ((ufs1_daddr_t
*)fp
->f_blk
[level
])[idx
];
289 ind_block_num
= ((ufs2_daddr_t
*)fp
->f_blk
[level
])[idx
];
292 *disk_block_p
= ind_block_num
;
298 * Write a portion of a file from an internal buffer.
301 buf_write_file(f
, buf_p
, size_p
)
304 size_t *size_p
; /* out */
306 struct file
*fp
= (struct file
*)f
->f_fsdata
;
307 struct fs
*fs
= fp
->f_fs
;
309 ufs_lbn_t file_block
;
310 ufs2_daddr_t disk_block
;
315 * Calculate the starting block address and offset.
317 off
= blkoff(fs
, fp
->f_seekp
);
318 file_block
= lblkno(fs
, fp
->f_seekp
);
319 block_size
= sblksize(fs
, DIP(fp
, di_size
), file_block
);
321 rc
= block_map(f
, file_block
, &disk_block
);
326 /* Because we can't allocate space on the drive */
330 * Truncate buffer at end of file, and at the end of
333 if (*size_p
> DIP(fp
, di_size
) - fp
->f_seekp
)
334 *size_p
= DIP(fp
, di_size
) - fp
->f_seekp
;
335 if (*size_p
> block_size
- off
)
336 *size_p
= block_size
- off
;
339 * If we don't entirely occlude the block and it's not
340 * in memory already, read it in first.
342 if (((off
> 0) || (*size_p
+ off
< block_size
)) &&
343 (file_block
!= fp
->f_buf_blkno
)) {
345 if (fp
->f_buf
== NULL
)
346 fp
->f_buf
= malloc(fs
->fs_bsize
);
349 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
, F_READ
,
350 fsbtodb(fs
, disk_block
),
351 block_size
, fp
->f_buf
, &fp
->f_buf_size
);
355 fp
->f_buf_blkno
= file_block
;
359 * Copy the user data into the cached block.
361 bcopy(buf_p
, fp
->f_buf
+ off
, *size_p
);
364 * Write the block out to storage.
368 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
, F_WRITE
,
369 fsbtodb(fs
, disk_block
),
370 block_size
, fp
->f_buf
, &fp
->f_buf_size
);
375 * Read a portion of a file into an internal buffer. Return
376 * the location in the buffer and the amount in the buffer.
379 buf_read_file(f
, buf_p
, size_p
)
381 char **buf_p
; /* out */
382 size_t *size_p
; /* out */
384 struct file
*fp
= (struct file
*)f
->f_fsdata
;
385 struct fs
*fs
= fp
->f_fs
;
387 ufs_lbn_t file_block
;
388 ufs2_daddr_t disk_block
;
392 off
= blkoff(fs
, fp
->f_seekp
);
393 file_block
= lblkno(fs
, fp
->f_seekp
);
394 block_size
= sblksize(fs
, DIP(fp
, di_size
), file_block
);
396 if (file_block
!= fp
->f_buf_blkno
) {
397 if (fp
->f_buf
== NULL
)
398 fp
->f_buf
= malloc(fs
->fs_bsize
);
400 rc
= block_map(f
, file_block
, &disk_block
);
404 if (disk_block
== 0) {
405 bzero(fp
->f_buf
, block_size
);
406 fp
->f_buf_size
= block_size
;
409 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
,
410 F_READ
, fsbtodb(fs
, disk_block
),
411 block_size
, fp
->f_buf
, &fp
->f_buf_size
);
416 fp
->f_buf_blkno
= file_block
;
420 * Return address of byte in buffer corresponding to
421 * offset, and size of remainder of buffer after that
424 *buf_p
= fp
->f_buf
+ off
;
425 *size_p
= block_size
- off
;
428 * But truncate buffer at end of file.
430 if (*size_p
> DIP(fp
, di_size
) - fp
->f_seekp
)
431 *size_p
= DIP(fp
, di_size
) - fp
->f_seekp
;
437 * Search a directory for a name and return its
441 search_directory(name
, f
, inumber_p
)
444 ino_t
*inumber_p
; /* out */
446 struct file
*fp
= (struct file
*)f
->f_fsdata
;
454 length
= strlen(name
);
457 while (fp
->f_seekp
< DIP(fp
, di_size
)) {
458 rc
= buf_read_file(f
, &buf
, &buf_size
);
462 dp
= (struct direct
*)buf
;
463 edp
= (struct direct
*)(buf
+ buf_size
);
465 if (dp
->d_ino
== (ino_t
)0)
467 namlen
= dp
->d_namlen
;
468 if (namlen
== length
&&
469 !strcmp(name
, dp
->d_name
)) {
471 *inumber_p
= dp
->d_ino
;
475 dp
= (struct direct
*)((char *)dp
+ dp
->d_reclen
);
477 fp
->f_seekp
+= buf_size
;
482 static int sblock_try
[] = SBLOCKSEARCH
;
494 ino_t inumber
, parent_inumber
;
500 char namebuf
[MAXPATHLEN
+1];
504 /* allocate file system specific data structure */
505 fp
= malloc(sizeof(struct file
));
506 bzero(fp
, sizeof(struct file
));
507 f
->f_fsdata
= (void *)fp
;
509 /* allocate space and read super block */
510 fs
= malloc(SBLOCKSIZE
);
514 * Try reading the superblock in each of its possible locations.
516 for (i
= 0; sblock_try
[i
] != -1; i
++) {
517 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
, F_READ
,
518 sblock_try
[i
] / DEV_BSIZE
, SBLOCKSIZE
,
519 (char *)fs
, &buf_size
);
522 if ((fs
->fs_magic
== FS_UFS1_MAGIC
||
523 (fs
->fs_magic
== FS_UFS2_MAGIC
&&
524 fs
->fs_sblockloc
== sblock_try
[i
])) &&
525 buf_size
== SBLOCKSIZE
&&
526 fs
->fs_bsize
<= MAXBSIZE
&&
527 fs
->fs_bsize
>= sizeof(struct fs
))
530 if (sblock_try
[i
] == -1) {
535 * Calculate indirect block levels.
542 for (level
= 0; level
< NIADDR
; level
++) {
544 fp
->f_nindir
[level
] = mult
;
549 if ((rc
= read_inode(inumber
, f
)) != 0)
552 cp
= path
= strdup(upath
);
560 * Remove extra separators
568 * Check that current node is a directory.
570 if ((DIP(fp
, di_mode
) & IFMT
) != IFDIR
) {
576 * Get next component of path name.
582 while ((c
= *cp
) != '\0' && c
!= '/') {
583 if (++len
> UFS_MAXNAMLEN
) {
593 * Look up component in current directory.
594 * Save directory inumber in case we find a
597 parent_inumber
= inumber
;
598 rc
= search_directory(ncp
, f
, &inumber
);
604 * Open next component.
606 if ((rc
= read_inode(inumber
, f
)) != 0)
610 * Check for symbolic link.
612 if ((DIP(fp
, di_mode
) & IFMT
) == IFLNK
) {
613 int link_len
= DIP(fp
, di_size
);
618 if (link_len
+ len
> MAXPATHLEN
||
619 ++nlinks
> MAXSYMLINKS
) {
624 bcopy(cp
, &namebuf
[link_len
], len
+ 1);
626 if (link_len
< fs
->fs_maxsymlinklen
) {
627 if (fp
->f_fs
->fs_magic
== FS_UFS1_MAGIC
)
628 cp
= (caddr_t
)(fp
->f_di
.di1
.di_db
);
630 cp
= (caddr_t
)(fp
->f_di
.di2
.di_db
);
631 bcopy(cp
, namebuf
, (unsigned) link_len
);
634 * Read file for symbolic link
637 ufs2_daddr_t disk_block
;
638 struct fs
*fs
= fp
->f_fs
;
641 buf
= malloc(fs
->fs_bsize
);
642 rc
= block_map(f
, (ufs2_daddr_t
)0, &disk_block
);
647 rc
= (f
->f_dev
->dv_strategy
)(f
->f_devdata
,
648 F_READ
, fsbtodb(fs
, disk_block
),
649 fs
->fs_bsize
, buf
, &buf_size
);
653 bcopy((char *)buf
, namebuf
, (unsigned)link_len
);
657 * If relative pathname, restart at parent directory.
658 * If absolute pathname, restart at root.
662 inumber
= parent_inumber
;
664 inumber
= (ino_t
)ROOTINO
;
666 if ((rc
= read_inode(inumber
, f
)) != 0)
672 * Found terminal component.
694 struct file
*fp
= (struct file
*)f
->f_fsdata
;
697 f
->f_fsdata
= (void *)0;
698 if (fp
== (struct file
*)0)
701 for (level
= 0; level
< NIADDR
; level
++) {
702 if (fp
->f_blk
[level
])
703 free(fp
->f_blk
[level
]);
713 * Copy a portion of a file into kernel memory.
714 * Cross block boundaries when necessary.
717 ufs_read(f
, start
, size
, resid
)
721 size_t *resid
; /* out */
723 struct file
*fp
= (struct file
*)f
->f_fsdata
;
731 if (fp
->f_seekp
>= DIP(fp
, di_size
))
734 rc
= buf_read_file(f
, &buf
, &buf_size
);
739 if (csize
> buf_size
)
742 bcopy(buf
, addr
, csize
);
744 fp
->f_seekp
+= csize
;
754 * Write to a portion of an already allocated file.
755 * Cross block boundaries when necessary. Can not
759 ufs_write(f
, start
, size
, resid
)
763 size_t *resid
; /* out */
765 struct file
*fp
= (struct file
*)f
->f_fsdata
;
771 while ((size
!= 0) && (csize
!= 0)) {
772 if (fp
->f_seekp
>= DIP(fp
, di_size
))
775 if (csize
>= 512) csize
= 512; /* XXX */
777 rc
= buf_write_file(f
, addr
, &csize
);
781 fp
->f_seekp
+= csize
;
791 ufs_seek(f
, offset
, where
)
796 struct file
*fp
= (struct file
*)f
->f_fsdata
;
800 fp
->f_seekp
= offset
;
803 fp
->f_seekp
+= offset
;
806 fp
->f_seekp
= DIP(fp
, di_size
) - offset
;
812 return (fp
->f_seekp
);
820 struct file
*fp
= (struct file
*)f
->f_fsdata
;
822 /* only important stuff */
823 sb
->st_mode
= DIP(fp
, di_mode
);
824 sb
->st_uid
= DIP(fp
, di_uid
);
825 sb
->st_gid
= DIP(fp
, di_gid
);
826 sb
->st_size
= DIP(fp
, di_size
);
831 ufs_readdir(struct open_file
*f
, struct dirent
*d
)
833 struct file
*fp
= (struct file
*)f
->f_fsdata
;
840 * assume that a directory entry will not be split across blocks
843 if (fp
->f_seekp
>= DIP(fp
, di_size
))
845 error
= buf_read_file(f
, &buf
, &buf_size
);
848 dp
= (struct direct
*)buf
;
849 fp
->f_seekp
+= dp
->d_reclen
;
850 if (dp
->d_ino
== (ino_t
)0)
853 d
->d_type
= 0; /* illumos ufs does not have type in direct */
854 strcpy(d
->d_name
, dp
->d_name
);