3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2004,2005,2006,2007,2008 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
21 #include <grub/file.h>
23 #include <grub/misc.h>
24 #include <grub/disk.h>
26 #include <grub/types.h>
28 #define GRUB_JFS_MAX_SYMLNK_CNT 8
29 #define GRUB_JFS_FILETYPE_MASK 0170000
30 #define GRUB_JFS_FILETYPE_REG 0100000
31 #define GRUB_JFS_FILETYPE_LNK 0120000
32 #define GRUB_JFS_FILETYPE_DIR 0040000
34 #define GRUB_JFS_SBLOCK 64
35 #define GRUB_JFS_AGGR_INODE 2
36 #define GRUB_JFS_FS1_INODE_BLK 104
38 #define GRUB_JFS_TREE_LEAF 2
40 struct grub_jfs_sblock
42 /* The magic for JFS. It should contain the string "JFS1". */
43 grub_uint8_t magic
[4];
44 grub_uint32_t version
;
45 grub_uint64_t ag_size
;
47 /* The size of a filesystem block in bytes. XXX: currently only
50 grub_uint16_t log2_blksz
;
52 grub_uint8_t unused
[71];
53 grub_uint8_t volname
[11];
56 struct grub_jfs_extent
58 /* The length of the extent in filesystem blocks. */
62 /* The physical offset of the first block on the disk. */
65 } __attribute__ ((packed
));
69 grub_uint8_t unused
[3072];
70 struct grub_jfs_extent inodes
[128];
71 } __attribute__ ((packed
));
74 /* The head of the tree used to find extents. */
75 struct grub_jfs_treehead
85 grub_uint8_t unused2
[10];
86 } __attribute__ ((packed
));
88 /* A node in the extent tree. */
89 struct grub_jfs_tree_extent
94 /* The offset is the key used to lookup an extent. */
96 grub_uint32_t offset2
;
98 struct grub_jfs_extent extent
;
99 } __attribute__ ((packed
));
101 /* The tree of directory entries. */
102 struct grub_jfs_tree_dir
104 /* Pointers to the previous and next tree headers of other nodes on
111 /* The amount of dirents in this node. */
113 grub_uint8_t freecnt
;
114 grub_uint8_t freelist
;
115 grub_uint8_t maxslot
;
117 /* The location of the sorted array of pointers to dirents. */
119 grub_uint8_t unused
[10];
120 } __attribute__ ((packed
));
122 /* An internal node in the dirents tree. */
123 struct grub_jfs_internal_dirent
125 struct grub_jfs_extent ex
;
128 grub_uint16_t namepart
[11];
129 } __attribute__ ((packed
));
131 /* A leaf node in the dirents tree. */
132 struct grub_jfs_leaf_dirent
134 /* The inode for this dirent. */
138 /* The size of the name. */
140 grub_uint16_t namepart
[11];
142 } __attribute__ ((packed
));
144 /* A leaf in the dirents tree. This one is used if the previously
145 dirent was not big enough to store the name. */
146 struct grub_jfs_leaf_next_dirent
150 grub_uint16_t namepart
[15];
151 } __attribute__ ((packed
));
153 struct grub_jfs_inode
156 grub_uint32_t fileset
;
158 grub_uint8_t unused
[12];
160 grub_uint8_t unused2
[20];
162 grub_uint8_t unused3
[72];
163 grub_uint8_t unused4
[96];
167 /* The tree describing the extents of the file. */
168 struct __attribute__ ((packed
))
170 struct grub_jfs_treehead tree
;
171 struct grub_jfs_tree_extent extents
[16];
175 /* The tree describing the dirents. */
178 grub_uint8_t unused
[16];
181 /* Amount of dirents in this node. */
183 grub_uint8_t freecnt
;
184 grub_uint8_t freelist
;
185 grub_uint32_t idotdot
;
186 grub_uint8_t sorted
[8];
188 struct grub_jfs_leaf_dirent dirents
[8];
189 } dir
__attribute__ ((packed
));
193 grub_uint8_t unused
[32];
194 grub_uint8_t path
[128];
196 } __attribute__ ((packed
));
197 } __attribute__ ((packed
));
201 struct grub_jfs_sblock sblock
;
203 struct grub_jfs_inode fileset
;
204 struct grub_jfs_inode currinode
;
207 } __attribute__ ((packed
));
209 struct grub_jfs_diropen
214 struct grub_jfs_tree_dir header
;
215 struct grub_jfs_leaf_dirent dirent
[0];
216 struct grub_jfs_leaf_next_dirent next_dirent
[0];
218 } *dirpage
__attribute__ ((packed
));
219 struct grub_jfs_data
*data
;
220 struct grub_jfs_inode
*inode
;
223 struct grub_jfs_leaf_dirent
*leaf
;
224 struct grub_jfs_leaf_next_dirent
*next_leaf
;
226 /* The filename and inode of the last read dirent. */
229 } __attribute__ ((packed
));
233 static grub_dl_t my_mod
;
236 static grub_err_t
grub_jfs_lookup_symlink (struct grub_jfs_data
*data
, int ino
);
238 /* Get the block number for the block BLK in the node INODE in the
239 mounted filesystem DATA. */
241 grub_jfs_blkno (struct grub_jfs_data
*data
, struct grub_jfs_inode
*inode
,
244 auto int getblk (struct grub_jfs_treehead
*treehead
,
245 struct grub_jfs_tree_extent
*extents
);
247 int getblk (struct grub_jfs_treehead
*treehead
,
248 struct grub_jfs_tree_extent
*extents
)
253 for (i
= 0; i
< grub_le_to_cpu16 (treehead
->count
) - 2; i
++)
255 if (treehead
->flags
& GRUB_JFS_TREE_LEAF
)
257 /* Read the leafnode. */
258 if (grub_le_to_cpu32 (extents
[i
].offset2
) <= blk
259 && ((grub_le_to_cpu16 (extents
[i
].extent
.length
))
260 + (extents
[i
].extent
.length2
<< 8)
261 + grub_le_to_cpu32 (extents
[i
].offset2
)) > blk
)
262 return (blk
- grub_le_to_cpu32 (extents
[i
].offset2
)
263 + grub_le_to_cpu32 (extents
[i
].extent
.blk2
));
266 if (blk
>= grub_le_to_cpu32 (extents
[i
].offset2
))
274 struct grub_jfs_treehead treehead
;
275 struct grub_jfs_tree_extent extents
[254];
278 if (grub_disk_read (data
->disk
,
279 grub_le_to_cpu32 (extents
[found
].extent
.blk2
)
280 << (grub_le_to_cpu16 (data
->sblock
.log2_blksz
)
281 - GRUB_DISK_SECTOR_BITS
), 0,
282 sizeof (tree
), (char *) &tree
))
285 return getblk (&tree
.treehead
, &tree
.extents
[0]);
291 return getblk (&inode
->file
.tree
, &inode
->file
.extents
[0]);
296 grub_jfs_read_inode (struct grub_jfs_data
*data
, int ino
,
297 struct grub_jfs_inode
*inode
)
299 struct grub_jfs_iag iag
;
300 int iagnum
= ino
/ 4096;
301 int inoext
= (ino
% 4096) / 32;
302 int inonum
= (ino
% 4096) % 32;
303 grub_uint32_t iagblk
;
304 grub_uint32_t inoblk
;
306 iagblk
= grub_jfs_blkno (data
, &data
->fileset
, iagnum
+ 1);
310 /* Read in the IAG. */
311 if (grub_disk_read (data
->disk
,
312 iagblk
<< (grub_le_to_cpu16 (data
->sblock
.log2_blksz
)
313 - GRUB_DISK_SECTOR_BITS
), 0,
314 sizeof (struct grub_jfs_iag
), (char *) &iag
))
317 inoblk
= grub_le_to_cpu32 (iag
.inodes
[inoext
].blk2
);
318 inoblk
<<= (grub_le_to_cpu16 (data
->sblock
.log2_blksz
)
319 - GRUB_DISK_SECTOR_BITS
);
322 if (grub_disk_read (data
->disk
, inoblk
, 0,
323 sizeof (struct grub_jfs_inode
), (char *) inode
))
330 static struct grub_jfs_data
*
331 grub_jfs_mount (grub_disk_t disk
)
333 struct grub_jfs_data
*data
= 0;
335 data
= grub_malloc (sizeof (struct grub_jfs_data
));
339 /* Read the superblock. */
340 if (grub_disk_read (disk
, GRUB_JFS_SBLOCK
, 0,
341 sizeof (struct grub_jfs_sblock
), (char *) &data
->sblock
))
344 if (grub_strncmp ((char *) (data
->sblock
.magic
), "JFS1", 4))
346 grub_error (GRUB_ERR_BAD_FS
, "not a jfs filesystem");
354 /* Read the inode of the first fileset. */
355 if (grub_disk_read (data
->disk
, GRUB_JFS_FS1_INODE_BLK
, 0,
356 sizeof (struct grub_jfs_inode
), (char *) &data
->fileset
))
364 if (grub_errno
== GRUB_ERR_OUT_OF_RANGE
)
365 grub_error (GRUB_ERR_BAD_FS
, "not a jfs filesystem");
371 static struct grub_jfs_diropen
*
372 grub_jfs_opendir (struct grub_jfs_data
*data
, struct grub_jfs_inode
*inode
)
374 struct grub_jfs_internal_dirent
*de
;
375 struct grub_jfs_diropen
*diro
;
378 de
= (struct grub_jfs_internal_dirent
*) inode
->dir
.dirents
;
380 if (!((grub_le_to_cpu32 (inode
->mode
)
381 & GRUB_JFS_FILETYPE_MASK
) == GRUB_JFS_FILETYPE_DIR
))
383 grub_error (GRUB_ERR_BAD_FILE_TYPE
, "not a directory");
387 diro
= grub_malloc (sizeof (struct grub_jfs_diropen
));
395 /* Check if the entire tree is contained within the inode. */
396 if (inode
->file
.tree
.flags
& GRUB_JFS_TREE_LEAF
)
398 diro
->leaf
= inode
->dir
.dirents
;
399 diro
->next_leaf
= (struct grub_jfs_leaf_next_dirent
*) de
;
400 diro
->sorted
= (char *) (inode
->dir
.header
.sorted
);
401 diro
->count
= inode
->dir
.header
.count
;
407 diro
->dirpage
= grub_malloc (grub_le_to_cpu32 (data
->sblock
.blksz
));
414 blk
= grub_le_to_cpu32 (de
[inode
->dir
.header
.sorted
[0]].ex
.blk2
);
415 blk
<<= (grub_le_to_cpu16 (data
->sblock
.log2_blksz
) - GRUB_DISK_SECTOR_BITS
);
417 /* Read in the nodes until we are on the leaf node level. */
421 if (grub_disk_read (data
->disk
, blk
, 0,
422 grub_le_to_cpu32 (data
->sblock
.blksz
),
423 diro
->dirpage
->sorted
))
425 grub_free (diro
->dirpage
);
430 de
= (struct grub_jfs_internal_dirent
*) diro
->dirpage
->dirent
;
431 index
= diro
->dirpage
->sorted
[diro
->dirpage
->header
.sindex
* 32];
432 blk
= (grub_le_to_cpu32 (de
[index
].ex
.blk2
)
433 << (grub_le_to_cpu16 (data
->sblock
.log2_blksz
)
434 - GRUB_DISK_SECTOR_BITS
));
435 } while (!(diro
->dirpage
->header
.flags
& GRUB_JFS_TREE_LEAF
));
437 diro
->leaf
= diro
->dirpage
->dirent
;
438 diro
->next_leaf
= diro
->dirpage
->next_dirent
;
439 diro
->sorted
= &diro
->dirpage
->sorted
[diro
->dirpage
->header
.sindex
* 32];
440 diro
->count
= diro
->dirpage
->header
.count
;
447 grub_jfs_closedir (struct grub_jfs_diropen
*diro
)
451 grub_free (diro
->dirpage
);
456 /* Read in the next dirent from the directory described by DIRO. */
458 grub_jfs_getent (struct grub_jfs_diropen
*diro
)
461 struct grub_jfs_leaf_dirent
*leaf
;
462 struct grub_jfs_leaf_next_dirent
*next_leaf
;
465 grub_uint16_t filename
[255];
467 auto void addstr (grub_uint16_t
*uname
, int ulen
);
469 /* Add the unicode string to the utf16 filename buffer. */
470 void addstr (grub_uint16_t
*name
, int ulen
)
473 filename
[strpos
++] = *(name
++);
476 /* The last node, read in more. */
477 if (diro
->index
== diro
->count
)
481 /* If the inode contains the entry tree or if this was the last
482 node, there is nothing to read. */
483 if ((diro
->inode
->file
.tree
.flags
& GRUB_JFS_TREE_LEAF
)
484 || !grub_le_to_cpu64 (diro
->dirpage
->header
.nextb
))
485 return GRUB_ERR_OUT_OF_RANGE
;
487 next
= grub_le_to_cpu64 (diro
->dirpage
->header
.nextb
);
488 next
<<= (grub_le_to_cpu16 (diro
->data
->sblock
.log2_blksz
)
489 - GRUB_DISK_SECTOR_BITS
);
491 if (grub_disk_read (diro
->data
->disk
, next
, 0,
492 grub_le_to_cpu32 (diro
->data
->sblock
.blksz
),
493 diro
->dirpage
->sorted
))
496 diro
->leaf
= diro
->dirpage
->dirent
;
497 diro
->next_leaf
= diro
->dirpage
->next_dirent
;
498 diro
->sorted
= &diro
->dirpage
->sorted
[diro
->dirpage
->header
.sindex
* 32];
499 diro
->count
= diro
->dirpage
->header
.count
;
503 leaf
= &diro
->leaf
[(int) diro
->sorted
[diro
->index
]];
504 next_leaf
= &diro
->next_leaf
[diro
->index
];
510 return grub_jfs_getent (diro
);
513 addstr (leaf
->namepart
, len
< 11 ? len
: 11);
514 diro
->ino
= grub_le_to_cpu32 (leaf
->inode
);
517 /* Move down to the leaf level. */
518 nextent
= leaf
->next
;
519 if (leaf
->next
!= 255)
522 next_leaf
= &diro
->next_leaf
[nextent
];
523 addstr (next_leaf
->namepart
, len
< 15 ? len
: 15 );
526 nextent
= next_leaf
->next
;
527 } while (next_leaf
->next
!= 255 && len
> 0);
531 /* Convert the temporary UTF16 filename to UTF8. */
532 *grub_utf16_to_utf8 ((grub_uint8_t
*) (diro
->name
), filename
, strpos
) = '\0';
538 /* Read LEN bytes from the file described by DATA starting with byte
539 POS. Return the amount of read bytes in READ. */
541 grub_jfs_read_file (struct grub_jfs_data
*data
,
542 void NESTED_FUNC_ATTR (*read_hook
) (grub_disk_addr_t sector
,
543 unsigned offset
, unsigned length
),
544 int pos
, grub_size_t len
, char *buf
)
549 /* Adjust len so it we can't read past the end of the file. */
550 if (len
> data
->currinode
.size
)
551 len
= data
->currinode
.size
;
553 blockcnt
= ((len
+ pos
+ grub_le_to_cpu32 (data
->sblock
.blksz
) - 1)
554 / grub_le_to_cpu32 (data
->sblock
.blksz
));
556 for (i
= pos
/ grub_le_to_cpu32 (data
->sblock
.blksz
); i
< blockcnt
; i
++)
559 int blockoff
= pos
% grub_le_to_cpu32 (data
->sblock
.blksz
);
560 int blockend
= grub_le_to_cpu32 (data
->sblock
.blksz
);
564 blknr
= grub_jfs_blkno (data
, &data
->currinode
, i
);
569 if (i
== blockcnt
- 1)
571 blockend
= (len
+ pos
) % grub_le_to_cpu32 (data
->sblock
.blksz
);
574 blockend
= grub_le_to_cpu32 (data
->sblock
.blksz
);
578 if (i
== (pos
/ (int) grub_le_to_cpu32 (data
->sblock
.blksz
)))
580 skipfirst
= blockoff
;
581 blockend
-= skipfirst
;
584 data
->disk
->read_hook
= read_hook
;
585 grub_disk_read (data
->disk
,
586 blknr
<< (grub_le_to_cpu16 (data
->sblock
.log2_blksz
)
587 - GRUB_DISK_SECTOR_BITS
),
588 skipfirst
, blockend
, buf
);
590 data
->disk
->read_hook
= 0;
594 buf
+= grub_le_to_cpu32 (data
->sblock
.blksz
) - skipfirst
;
601 /* Find the file with the pathname PATH on the filesystem described by
604 grub_jfs_find_file (struct grub_jfs_data
*data
, const char *path
)
606 char fpath
[grub_strlen (path
)];
609 unsigned int pos
= 0;
610 struct grub_jfs_diropen
*diro
;
612 grub_strncpy (fpath
, path
, grub_strlen (path
) + 1);
614 if (grub_jfs_read_inode (data
, GRUB_JFS_AGGR_INODE
, &data
->currinode
))
617 /* Skip the first slashes. */
625 /* Extract the actual part from the pathname. */
626 next
= grub_strchr (name
, '/');
635 diro
= grub_jfs_opendir (data
, &data
->currinode
);
641 if (grub_strlen (name
) == 0)
642 return GRUB_ERR_NONE
;
644 if (grub_jfs_getent (diro
) == GRUB_ERR_OUT_OF_RANGE
)
647 /* Check if the current direntry matches the current part of the
649 if (!grub_strcmp (name
, diro
->name
))
652 int dirino
= grub_le_to_cpu32 (data
->currinode
.inode
);
654 grub_jfs_closedir (diro
);
657 if (grub_jfs_read_inode (data
, ino
, &data
->currinode
))
660 /* Check if this is a symlink. */
661 if ((grub_le_to_cpu32 (data
->currinode
.mode
)
662 & GRUB_JFS_FILETYPE_MASK
) == GRUB_JFS_FILETYPE_LNK
)
664 grub_jfs_lookup_symlink (data
, dirino
);
675 next
= grub_strchr (name
, '/');
682 /* Open this directory for reading dirents. */
683 diro
= grub_jfs_opendir (data
, &data
->currinode
);
691 grub_jfs_closedir (diro
);
692 grub_error (GRUB_ERR_FILE_NOT_FOUND
, "file not found");
698 grub_jfs_lookup_symlink (struct grub_jfs_data
*data
, int ino
)
700 int size
= grub_le_to_cpu64 (data
->currinode
.size
);
701 char symlink
[size
+ 1];
703 if (++data
->linknest
> GRUB_JFS_MAX_SYMLNK_CNT
)
704 return grub_error (GRUB_ERR_SYMLINK_LOOP
, "too deep nesting of symlinks");
707 grub_strncpy (symlink
, (char *) (data
->currinode
.symlink
.path
), 128);
708 else if (grub_jfs_read_file (data
, 0, 0, size
, symlink
) < 0)
711 symlink
[size
] = '\0';
713 /* The symlink is an absolute path, go back to the root inode. */
714 if (symlink
[0] == '/')
717 /* Now load in the old inode. */
718 if (grub_jfs_read_inode (data
, ino
, &data
->currinode
))
721 grub_jfs_find_file (data
, symlink
);
723 grub_error (grub_errno
, "Can not follow symlink `%s'.", symlink
);
730 grub_jfs_dir (grub_device_t device
, const char *path
,
731 int (*hook
) (const char *filename
, int dir
))
733 struct grub_jfs_data
*data
= 0;
734 struct grub_jfs_diropen
*diro
= 0;
737 grub_dl_ref (my_mod
);
740 data
= grub_jfs_mount (device
->disk
);
744 if (grub_jfs_find_file (data
, path
))
747 diro
= grub_jfs_opendir (data
, &data
->currinode
);
751 /* Iterate over the dirents in the directory that was found. */
752 while (grub_jfs_getent (diro
) != GRUB_ERR_OUT_OF_RANGE
)
754 struct grub_jfs_inode inode
;
757 if (grub_jfs_read_inode (data
, diro
->ino
, &inode
))
760 isdir
= (grub_le_to_cpu32 (inode
.mode
)
761 & GRUB_JFS_FILETYPE_MASK
) == GRUB_JFS_FILETYPE_DIR
;
762 if (hook (diro
->name
, isdir
))
766 /* XXX: GRUB_ERR_OUT_OF_RANGE is used for the last dirent. */
767 if (grub_errno
== GRUB_ERR_OUT_OF_RANGE
)
771 grub_jfs_closedir (diro
);
775 grub_dl_unref (my_mod
);
782 /* Open a file named NAME and initialize FILE. */
784 grub_jfs_open (struct grub_file
*file
, const char *name
)
786 struct grub_jfs_data
*data
;
789 grub_dl_ref (my_mod
);
792 data
= grub_jfs_mount (file
->device
->disk
);
796 grub_jfs_find_file (data
, name
);
800 /* It is only possible for open regular files. */
801 if (! ((grub_le_to_cpu32 (data
->currinode
.mode
)
802 & GRUB_JFS_FILETYPE_MASK
) == GRUB_JFS_FILETYPE_REG
))
804 grub_error (GRUB_ERR_BAD_FILE_TYPE
, "not a regular file");
809 file
->size
= grub_le_to_cpu64 (data
->currinode
.size
);
816 grub_dl_unref (my_mod
);
826 grub_jfs_read (grub_file_t file
, char *buf
, grub_size_t len
)
828 struct grub_jfs_data
*data
=
829 (struct grub_jfs_data
*) file
->data
;
831 return grub_jfs_read_file (data
, file
->read_hook
, file
->offset
, len
, buf
);
836 grub_jfs_close (grub_file_t file
)
838 grub_free (file
->data
);
841 grub_dl_unref (my_mod
);
844 return GRUB_ERR_NONE
;
849 grub_jfs_label (grub_device_t device
, char **label
)
851 struct grub_jfs_data
*data
;
852 data
= grub_jfs_mount (device
->disk
);
855 *label
= grub_strndup ((char *) (data
->sblock
.volname
), 11);
863 static struct grub_fs grub_jfs_fs
=
867 .open
= grub_jfs_open
,
868 .read
= grub_jfs_read
,
869 .close
= grub_jfs_close
,
870 .label
= grub_jfs_label
,
876 grub_fs_register (&grub_jfs_fs
);
884 grub_fs_unregister (&grub_jfs_fs
);