1 /* btrfs.c - B-tree file system. */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2010 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>
27 #include <grub/lib/crc.h>
28 #include <grub/deflate.h>
30 #define GRUB_BTRFS_SIGNATURE "_BHRfS_M"
32 typedef grub_uint8_t grub_btrfs_checksum_t
[0x20];
33 typedef grub_uint16_t grub_btrfs_uuid_t
[8];
35 struct grub_btrfs_device
37 grub_uint64_t device_id
;
38 grub_uint8_t dummy
[0x62 - 8];
39 } __attribute__ ((packed
));
41 struct grub_btrfs_superblock
43 grub_btrfs_checksum_t checksum
;
44 grub_btrfs_uuid_t uuid
;
45 grub_uint8_t dummy
[0x10];
46 grub_uint8_t signature
[sizeof (GRUB_BTRFS_SIGNATURE
) - 1];
47 grub_uint64_t generation
;
48 grub_uint64_t root_tree
;
49 grub_uint64_t chunk_tree
;
50 grub_uint8_t dummy2
[0x20];
51 grub_uint64_t root_dir_objectid
;
52 grub_uint8_t dummy3
[0x41];
53 struct grub_btrfs_device this_device
;
55 grub_uint8_t dummy4
[0x100];
56 grub_uint8_t bootstrap_mapping
[0x800];
57 } __attribute__ ((packed
));
61 grub_btrfs_checksum_t checksum
;
62 grub_btrfs_uuid_t uuid
;
63 grub_uint8_t dummy
[0x30];
66 } __attribute__ ((packed
));
68 struct grub_btrfs_device_desc
74 struct grub_btrfs_data
76 struct grub_btrfs_superblock sblock
;
80 struct grub_btrfs_device_desc
*devices_attached
;
81 unsigned n_devices_attached
;
82 unsigned n_devices_allocated
;
84 /* Cached extent data. */
85 grub_uint64_t extstart
;
87 grub_uint64_t exttree
;
89 struct grub_btrfs_extent_data
*extent
;
94 grub_uint64_t object_id
;
95 #define GRUB_BTRFS_ITEM_TYPE_INODE_ITEM 0x01
96 #define GRUB_BTRFS_ITEM_TYPE_DIR_ITEM 0x54
97 #define GRUB_BTRFS_ITEM_TYPE_EXTENT_ITEM 0x6c
98 #define GRUB_BTRFS_ITEM_TYPE_ROOT_ITEM 0x84
99 #define GRUB_BTRFS_ITEM_TYPE_DEVICE 0xd8
100 #define GRUB_BTRFS_ITEM_TYPE_CHUNK 0xe4
102 grub_uint64_t offset
;
103 } __attribute__ ((packed
));
105 struct grub_btrfs_chunk_item
109 grub_uint64_t stripe_length
;
111 #define GRUB_BTRFS_CHUNK_TYPE_BITS_DONTCARE 0x07
112 #define GRUB_BTRFS_CHUNK_TYPE_SINGLE 0x00
113 #define GRUB_BTRFS_CHUNK_TYPE_RAID0 0x08
114 #define GRUB_BTRFS_CHUNK_TYPE_RAID1 0x10
115 #define GRUB_BTRFS_CHUNK_TYPE_DUPLICATED 0x20
116 #define GRUB_BTRFS_CHUNK_TYPE_RAID10 0x40
117 grub_uint8_t dummy2
[0xc];
118 grub_uint16_t nstripes
;
119 grub_uint16_t nsubstripes
;
120 } __attribute__ ((packed
));
122 struct grub_btrfs_chunk_stripe
124 grub_uint64_t device_id
;
125 grub_uint64_t offset
;
126 grub_btrfs_uuid_t device_uuid
;
127 } __attribute__ ((packed
));
129 struct grub_btrfs_leaf_node
131 struct grub_btrfs_key key
;
132 grub_uint32_t offset
;
134 } __attribute__ ((packed
));
136 struct grub_btrfs_internal_node
138 struct grub_btrfs_key key
;
141 } __attribute__ ((packed
));
143 struct grub_btrfs_dir_item
145 struct grub_btrfs_key key
;
146 grub_uint8_t dummy
[8];
149 #define GRUB_BTRFS_DIR_ITEM_TYPE_REGULAR 1
150 #define GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY 2
151 #define GRUB_BTRFS_DIR_ITEM_TYPE_SYMLINK 7
154 } __attribute__ ((packed
));
156 struct grub_btrfs_leaf_descriptor
161 grub_disk_addr_t addr
;
168 struct grub_btrfs_root_item
170 grub_uint8_t dummy
[0xb0];
175 struct grub_btrfs_time
178 grub_uint32_t nanosec
;
179 } __attribute__ ((aligned(4)));
181 struct grub_btrfs_inode
183 grub_uint8_t dummy1
[0x10];
185 grub_uint8_t dummy2
[0x70];
186 struct grub_btrfs_time mtime
;
187 } __attribute__ ((packed
));
189 struct grub_btrfs_extent_data
193 grub_uint8_t compression
;
194 grub_uint8_t encryption
;
195 grub_uint16_t encoding
;
203 grub_uint64_t compressed_size
;
204 grub_uint64_t offset
;
207 } __attribute__ ((packed
));
209 #define GRUB_BTRFS_EXTENT_INLINE 0
210 #define GRUB_BTRFS_EXTENT_REGULAR 1
212 #define GRUB_BTRFS_COMPRESSION_NONE 0
213 #define GRUB_BTRFS_COMPRESSION_ZLIB 1
215 #define GRUB_BTRFS_OBJECT_ID_CHUNK 0x100
217 static grub_disk_addr_t superblock_sectors
[] = { 64 * 2, 64 * 1024 * 2,
219 1048576ULL * 1048576ULL * 2 };
222 grub_btrfs_read_logical (struct grub_btrfs_data
*data
,
223 grub_disk_addr_t addr
, void *buf
, grub_size_t size
);
226 read_sblock (grub_disk_t disk
, struct grub_btrfs_superblock
*sb
)
229 grub_err_t err
= GRUB_ERR_NONE
;
230 for (i
= 0; i
< ARRAY_SIZE (superblock_sectors
); i
++)
232 struct grub_btrfs_superblock sblock
;
233 err
= grub_disk_read (disk
, superblock_sectors
[i
], 0,
234 sizeof (sblock
), &sblock
);
235 if (err
== GRUB_ERR_OUT_OF_RANGE
)
238 if (grub_memcmp ((char *) sblock
.signature
, GRUB_BTRFS_SIGNATURE
,
239 sizeof (GRUB_BTRFS_SIGNATURE
) - 1) != 0)
241 if (i
== 0 || grub_le_to_cpu64 (sblock
.generation
)
242 > grub_le_to_cpu64 (sb
->generation
))
243 grub_memcpy (sb
, &sblock
, sizeof (sblock
));
246 if ((err
== GRUB_ERR_OUT_OF_RANGE
|| !err
) && i
== 0)
247 return grub_error (GRUB_ERR_BAD_FS
, "not a Btrfs filesystem");
249 if (err
== GRUB_ERR_OUT_OF_RANGE
)
250 grub_errno
= err
= GRUB_ERR_NONE
;
256 key_cmp (const struct grub_btrfs_key
*a
, const struct grub_btrfs_key
*b
)
258 if (grub_cpu_to_le64 (a
->object_id
) < grub_cpu_to_le64 (b
->object_id
))
260 if (grub_cpu_to_le64 (a
->object_id
) > grub_cpu_to_le64 (b
->object_id
))
263 if (a
->type
< b
->type
)
265 if (a
->type
> b
->type
)
268 if (grub_cpu_to_le64 (a
->offset
) < grub_cpu_to_le64 (b
->offset
))
270 if (grub_cpu_to_le64 (a
->offset
) > grub_cpu_to_le64 (b
->offset
))
276 free_iterator (struct grub_btrfs_leaf_descriptor
*desc
)
278 grub_free (desc
->data
);
282 save_ref (struct grub_btrfs_leaf_descriptor
*desc
,
283 grub_disk_addr_t addr
, unsigned i
, unsigned m
, int l
)
286 if (desc
->allocated
< desc
->depth
)
289 desc
->allocated
*= 2;
290 newdata
= grub_realloc (desc
->data
, sizeof (desc
->data
[0])
294 desc
->data
= newdata
;
296 desc
->data
[desc
->depth
- 1].addr
= addr
;
297 desc
->data
[desc
->depth
- 1].iter
= i
;
298 desc
->data
[desc
->depth
- 1].maxiter
= m
;
299 desc
->data
[desc
->depth
- 1].leaf
= l
;
300 return GRUB_ERR_NONE
;
304 next (struct grub_btrfs_data
*data
,
305 struct grub_btrfs_leaf_descriptor
*desc
,
306 grub_disk_addr_t
*outaddr
, grub_size_t
*outsize
,
307 struct grub_btrfs_key
*key_out
)
310 struct grub_btrfs_leaf_node leaf
;
312 for (; desc
->depth
> 0; desc
->depth
--)
314 desc
->data
[desc
->depth
- 1].iter
++;
315 if (desc
->data
[desc
->depth
- 1].iter
316 < desc
->data
[desc
->depth
- 1].maxiter
)
319 if (desc
->depth
== 0)
321 while (!desc
->data
[desc
->depth
- 1].leaf
)
323 struct grub_btrfs_internal_node node
;
324 struct btrfs_header head
;
326 err
= grub_btrfs_read_logical (data
, desc
->data
[desc
->depth
- 1].iter
328 + sizeof (struct btrfs_header
)
329 + desc
->data
[desc
->depth
- 1].addr
, &node
,
334 err
= grub_btrfs_read_logical (data
, grub_le_to_cpu64 (node
.addr
), &head
,
339 save_ref (desc
, grub_le_to_cpu64 (node
.addr
), 0,
340 grub_le_to_cpu32 (head
.nitems
), !head
.level
);
342 err
= grub_btrfs_read_logical (data
, desc
->data
[desc
->depth
- 1].iter
344 + sizeof (struct btrfs_header
)
345 + desc
->data
[desc
->depth
- 1].addr
, &leaf
,
349 *outsize
= grub_le_to_cpu32 (leaf
.size
);
350 *outaddr
= desc
->data
[desc
->depth
- 1].addr
+ sizeof (struct btrfs_header
)
351 + grub_le_to_cpu32 (leaf
.offset
);
357 lower_bound (struct grub_btrfs_data
*data
,
358 const struct grub_btrfs_key
*key_in
,
359 struct grub_btrfs_key
*key_out
,
360 grub_disk_addr_t root
,
361 grub_disk_addr_t
*outaddr
, grub_size_t
*outsize
,
362 struct grub_btrfs_leaf_descriptor
*desc
)
364 grub_disk_addr_t addr
= root
;
369 desc
->allocated
= 16;
371 desc
->data
= grub_malloc (sizeof (desc
->data
[0]) * desc
->allocated
);
376 grub_dprintf ("btrfs",
377 "retrieving %" PRIxGRUB_UINT64_T
378 " %x %" PRIxGRUB_UINT64_T
"\n",
379 key_in
->object_id
, key_in
->type
, key_in
->offset
);
384 struct btrfs_header head
;
388 /* FIXME: preread few nodes into buffer. */
389 err
= grub_btrfs_read_logical (data
, addr
, &head
, sizeof (head
));
392 addr
+= sizeof (head
);
396 struct grub_btrfs_internal_node node
, node_last
;
398 grub_memset (&node_last
, 0, sizeof (node_last
));
399 for (i
= 0; i
< grub_le_to_cpu32 (head
.nitems
); i
++)
401 err
= grub_btrfs_read_logical (data
, addr
+ i
* sizeof (node
),
402 &node
, sizeof (node
));
406 grub_dprintf ("btrfs",
407 "internal node (depth %d) %" PRIxGRUB_UINT64_T
408 " %x %" PRIxGRUB_UINT64_T
"\n", depth
,
409 node
.key
.object_id
, node
.key
.type
, node
.key
.offset
);
411 if (key_cmp (&node
.key
, key_in
) == 0)
415 err
= save_ref (desc
, addr
- sizeof (head
), i
,
416 grub_le_to_cpu32 (head
.nitems
), 0);
419 addr
= grub_le_to_cpu64 (node
.addr
);
422 if (key_cmp (&node
.key
, key_in
) > 0)
431 err
= save_ref (desc
, addr
- sizeof (head
), i
- 1,
432 grub_le_to_cpu32 (head
.nitems
), 0);
435 addr
= grub_le_to_cpu64 (node_last
.addr
);
440 grub_memset (key_out
, 0, sizeof (*key_out
));
442 return save_ref (desc
, addr
- sizeof (head
), -1,
443 grub_le_to_cpu32 (head
.nitems
), 0);
444 return GRUB_ERR_NONE
;
448 struct grub_btrfs_leaf_node leaf
, leaf_last
;
450 for (i
= 0; i
< grub_le_to_cpu32 (head
.nitems
); i
++)
452 err
= grub_btrfs_read_logical (data
, addr
+ i
* sizeof (leaf
),
453 &leaf
, sizeof (leaf
));
457 grub_dprintf ("btrfs",
458 "leaf (depth %d) %" PRIxGRUB_UINT64_T
459 " %x %" PRIxGRUB_UINT64_T
"\n", depth
,
460 leaf
.key
.object_id
, leaf
.key
.type
, leaf
.key
.offset
);
462 if (key_cmp (&leaf
.key
, key_in
) == 0)
464 grub_memcpy (key_out
, &leaf
.key
, sizeof(*key_out
));
465 *outsize
= grub_le_to_cpu32 (leaf
.size
);
466 *outaddr
= addr
+ grub_le_to_cpu32 (leaf
.offset
);
468 return save_ref (desc
, addr
- sizeof (head
), i
,
469 grub_le_to_cpu32 (head
.nitems
), 1);
470 return GRUB_ERR_NONE
;
473 if (key_cmp (&leaf
.key
, key_in
) > 0)
482 grub_memcpy (key_out
, &leaf_last
.key
, sizeof(*key_out
));
483 *outsize
= grub_le_to_cpu32 (leaf_last
.size
);
484 *outaddr
= addr
+ grub_le_to_cpu32 (leaf_last
.offset
);
486 return save_ref (desc
, addr
- sizeof (head
), i
- 1,
487 grub_le_to_cpu32 (head
.nitems
), 1);
488 return GRUB_ERR_NONE
;
492 grub_memset (key_out
, 0, sizeof (*key_out
));
494 return save_ref (desc
, addr
- sizeof (head
), -1,
495 grub_le_to_cpu32 (head
.nitems
), 1);
496 return GRUB_ERR_NONE
;
502 find_device (struct grub_btrfs_data
*data
, grub_uint64_t id
,
505 grub_device_t dev_found
= NULL
;
506 auto int hook (const char *name
);
507 int hook (const char *name
)
511 struct grub_btrfs_superblock sb
;
512 dev
= grub_device_open (name
);
517 grub_device_close (dev
);
520 err
= read_sblock (dev
->disk
, &sb
);
521 if (err
== GRUB_ERR_BAD_FS
)
523 grub_device_close (dev
);
524 grub_errno
= GRUB_ERR_NONE
;
529 grub_device_close (dev
);
533 if (grub_memcmp (data
->sblock
.uuid
, sb
.uuid
, sizeof (sb
.uuid
)) != 0
534 || sb
.this_device
.device_id
!= id
)
536 grub_device_close (dev
);
546 for (i
= 0; i
< data
->n_devices_attached
; i
++)
547 if (id
== data
->devices_attached
[i
].id
)
548 return data
->devices_attached
[i
].dev
;
550 grub_device_iterate (hook
);
553 grub_error (GRUB_ERR_BAD_FS
, "couldn't find a member device");
556 data
->n_devices_attached
++;
557 if (data
->n_devices_attached
> data
->n_devices_allocated
)
560 data
->n_devices_allocated
= 2 * data
->n_devices_attached
+ 1;
561 data
->devices_attached
562 = grub_realloc (tmp
= data
->devices_attached
,
563 data
->n_devices_allocated
564 * sizeof (data
->devices_attached
[0]));
565 if (!data
->devices_attached
)
567 grub_device_close (dev_found
);
568 data
->devices_attached
= tmp
;
572 data
->devices_attached
[data
->n_devices_attached
- 1].id
= id
;
573 data
->devices_attached
[data
->n_devices_attached
- 1].dev
= dev_found
;
578 grub_btrfs_read_logical (struct grub_btrfs_data
*data
,
579 grub_disk_addr_t addr
,
580 void *buf
, grub_size_t size
)
585 struct grub_btrfs_key
*key
;
586 struct grub_btrfs_chunk_item
*chunk
;
589 struct grub_btrfs_key key_out
;
592 grub_dprintf ("btrfs", "searching for laddr %" PRIxGRUB_UINT64_T
"\n",
594 for (ptr
= data
->sblock
.bootstrap_mapping
;
595 ptr
< data
->sblock
.bootstrap_mapping
596 + sizeof (data
->sblock
.bootstrap_mapping
)
597 - sizeof (struct grub_btrfs_key
);
600 key
= (struct grub_btrfs_key
*) ptr
;
601 if (key
->type
!= GRUB_BTRFS_ITEM_TYPE_CHUNK
)
603 chunk
= (struct grub_btrfs_chunk_item
*) (key
+ 1);
604 grub_dprintf ("btrfs", "%" PRIxGRUB_UINT64_T
" %" PRIxGRUB_UINT64_T
" \n",
605 grub_le_to_cpu64 (key
->offset
),
606 grub_le_to_cpu64 (chunk
->size
));
607 if (grub_le_to_cpu64 (key
->offset
) <= addr
608 && addr
< grub_le_to_cpu64 (key
->offset
)
609 + grub_le_to_cpu64 (chunk
->size
))
611 ptr
+= sizeof (*key
) + sizeof (*chunk
)
612 + sizeof (struct grub_btrfs_chunk_stripe
)
613 * grub_le_to_cpu16 (chunk
->nstripes
);
615 struct grub_btrfs_key key_in
;
617 grub_disk_addr_t chaddr
;
618 key_in
.object_id
= GRUB_BTRFS_OBJECT_ID_CHUNK
;
619 key_in
.type
= GRUB_BTRFS_ITEM_TYPE_CHUNK
;
620 key_in
.offset
= addr
;
621 err
= lower_bound (data
, &key_in
, &key_out
,
622 grub_le_to_cpu64 (data
->sblock
.chunk_tree
),
623 &chaddr
, &chsize
, NULL
);
627 if (key
->type
!= GRUB_BTRFS_ITEM_TYPE_CHUNK
628 || !(grub_le_to_cpu64 (key
->offset
) <= addr
))
629 return grub_error (GRUB_ERR_BAD_FS
,
630 "couldn't find the chunk descriptor");
632 chunk
= grub_malloc (chsize
);
637 err
= grub_btrfs_read_logical (data
, chaddr
, chunk
, chsize
);
646 grub_uint32_t stripen
;
647 grub_uint32_t stripe_offset
;
648 grub_uint64_t off
= addr
- grub_le_to_cpu64 (key
->offset
);
649 unsigned redundancy
= 1;
652 grub_dprintf ("btrfs", "chunk 0x%" PRIxGRUB_UINT64_T
653 "+0x%" PRIxGRUB_UINT64_T
654 " (%d stripes (%d substripes) of %"
655 PRIxGRUB_UINT64_T
")\n",
656 grub_le_to_cpu64 (key
->offset
),
657 grub_le_to_cpu64 (chunk
->size
),
658 grub_le_to_cpu16 (chunk
->nstripes
),
659 grub_le_to_cpu16 (chunk
->nsubstripes
),
660 grub_le_to_cpu64 (chunk
->stripe_length
));
662 switch (grub_le_to_cpu64 (chunk
->type
)
663 & ~GRUB_BTRFS_CHUNK_TYPE_BITS_DONTCARE
)
665 case GRUB_BTRFS_CHUNK_TYPE_SINGLE
:
667 grub_uint32_t stripe_length
;
668 stripe_length
= grub_divmod64 (grub_le_to_cpu64 (chunk
->size
),
669 grub_le_to_cpu16 (chunk
->nstripes
),
671 stripen
= grub_divmod64 (off
, stripe_length
, &stripe_offset
);
672 csize
= (stripen
+ 1) * stripe_length
- off
;
675 case GRUB_BTRFS_CHUNK_TYPE_DUPLICATED
:
676 case GRUB_BTRFS_CHUNK_TYPE_RAID1
:
680 csize
= grub_le_to_cpu64 (chunk
->size
) - off
;
684 case GRUB_BTRFS_CHUNK_TYPE_RAID0
:
686 grub_uint64_t middle
, high
;
688 middle
= grub_divmod64 (off
,
689 grub_le_to_cpu64 (chunk
->stripe_length
),
692 high
= grub_divmod64 (middle
, grub_le_to_cpu16 (chunk
->nstripes
),
694 stripe_offset
= low
+ grub_le_to_cpu64 (chunk
->stripe_length
)
696 csize
= grub_le_to_cpu64 (chunk
->stripe_length
) - low
;
699 case GRUB_BTRFS_CHUNK_TYPE_RAID10
:
701 grub_uint64_t middle
, high
;
703 middle
= grub_divmod64 (off
,
704 grub_le_to_cpu64 (chunk
->stripe_length
),
707 high
= grub_divmod64 (middle
,
708 grub_le_to_cpu16 (chunk
->nsubstripes
),
710 stripen
*= grub_le_to_cpu16 (chunk
->nstripes
)
711 / grub_le_to_cpu16 (chunk
->nsubstripes
);
712 redundancy
= grub_le_to_cpu16 (chunk
->nstripes
)
713 / grub_le_to_cpu16 (chunk
->nsubstripes
);
714 stripe_offset
= low
+ grub_le_to_cpu64 (chunk
->stripe_length
)
716 csize
= grub_le_to_cpu64 (chunk
->stripe_length
) - low
;
720 return grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET
,
721 "unsupported RAID flags %" PRIxGRUB_UINT64_T
,
722 grub_le_to_cpu64 (chunk
->type
));
725 return grub_error (GRUB_ERR_BAD_FS
,
726 "couldn't find the chunk descriptor");
727 if ((grub_size_t
) csize
> size
)
730 for (j
= 0; j
< 2; j
++)
732 for (i
= 0; i
< redundancy
; i
++)
734 struct grub_btrfs_chunk_stripe
*stripe
;
735 grub_disk_addr_t paddr
;
737 stripe
= (struct grub_btrfs_chunk_stripe
*) (chunk
+ 1);
738 /* Right now the redundancy handling is easy.
739 With RAID5-like it will be more difficult. */
740 stripe
+= stripen
+ i
;
742 paddr
= stripe
->offset
+ stripe_offset
;
744 grub_dprintf ("btrfs", "chunk 0x%" PRIxGRUB_UINT64_T
745 "+0x%" PRIxGRUB_UINT64_T
" (%d stripes (%d substripes) of %"
746 PRIxGRUB_UINT64_T
") stripe %" PRIxGRUB_UINT32_T
747 " maps to 0x%" PRIxGRUB_UINT64_T
"\n",
748 grub_le_to_cpu64 (key
->offset
),
749 grub_le_to_cpu64 (chunk
->size
),
750 grub_le_to_cpu16 (chunk
->nstripes
),
751 grub_le_to_cpu16 (chunk
->nsubstripes
),
752 grub_le_to_cpu64 (chunk
->stripe_length
),
753 stripen
, stripe
->offset
);
754 grub_dprintf ("btrfs", "reading paddr 0x%" PRIxGRUB_UINT64_T
755 " for laddr 0x%" PRIxGRUB_UINT64_T
"\n", paddr
,
758 dev
= find_device (data
, stripe
->device_id
, j
);
762 grub_errno
= GRUB_ERR_NONE
;
766 err
= grub_disk_read (dev
->disk
, paddr
>> GRUB_DISK_SECTOR_BITS
,
767 paddr
& (GRUB_DISK_SECTOR_SIZE
- 1),
771 grub_errno
= GRUB_ERR_NONE
;
777 return grub_errno
= err
;
780 buf
= (grub_uint8_t
*) buf
+ csize
;
785 return GRUB_ERR_NONE
;
788 static struct grub_btrfs_data
*
789 grub_btrfs_mount (grub_device_t dev
)
791 struct grub_btrfs_data
*data
;
796 grub_error (GRUB_ERR_BAD_FS
, "not BtrFS");
800 data
= grub_zalloc (sizeof (*data
));
804 err
= read_sblock (dev
->disk
, &data
->sblock
);
811 data
->n_devices_allocated
= 16;
812 data
->devices_attached
= grub_malloc (sizeof (data
->devices_attached
[0])
813 * data
->n_devices_allocated
);
814 if (!data
->devices_attached
)
819 data
->n_devices_attached
= 1;
820 data
->devices_attached
[0].dev
= dev
;
821 data
->devices_attached
[0].id
= data
->sblock
.this_device
.device_id
;
827 grub_btrfs_unmount (struct grub_btrfs_data
*data
)
830 /* The device 0 is closed one layer upper. */
831 for (i
= 1; i
< data
->n_devices_attached
; i
++)
832 grub_device_close (data
->devices_attached
[i
].dev
);
833 grub_free (data
->devices_attached
);
834 grub_free (data
->extent
);
839 grub_btrfs_read_inode (struct grub_btrfs_data
*data
,
840 struct grub_btrfs_inode
*inode
, grub_uint64_t num
,
843 struct grub_btrfs_key key_in
, key_out
;
844 grub_disk_addr_t elemaddr
;
845 grub_size_t elemsize
;
848 key_in
.object_id
= num
;
849 key_in
.type
= GRUB_BTRFS_ITEM_TYPE_INODE_ITEM
;
852 err
= lower_bound (data
, &key_in
, &key_out
, tree
,
853 &elemaddr
, &elemsize
, NULL
);
856 if (num
!= key_out
.object_id
857 || key_out
.type
!= GRUB_BTRFS_ITEM_TYPE_INODE_ITEM
)
858 return grub_error (GRUB_ERR_BAD_FS
, "inode not found");
860 return grub_btrfs_read_logical (data
, elemaddr
, inode
, sizeof (*inode
));
864 grub_btrfs_extent_read (struct grub_btrfs_data
*data
,
865 grub_uint64_t ino
, grub_uint64_t tree
,
866 grub_off_t pos0
, char *buf
, grub_size_t len
)
868 grub_off_t pos
= pos0
;
874 if (!data
->extent
|| data
->extstart
> pos
|| data
->extino
!= ino
875 || data
->exttree
!= tree
876 || grub_le_to_cpu64 (data
->extent
->size
) + data
->extstart
<= pos
)
878 struct grub_btrfs_key key_in
, key_out
;
879 grub_disk_addr_t elemaddr
;
880 grub_size_t elemsize
;
881 grub_free (data
->extent
);
882 key_in
.object_id
= ino
;
883 key_in
.type
= GRUB_BTRFS_ITEM_TYPE_EXTENT_ITEM
;
884 key_in
.offset
= grub_cpu_to_le64 (pos
);
885 err
= lower_bound (data
, &key_in
, &key_out
, tree
,
886 &elemaddr
, &elemsize
, NULL
);
889 if (key_out
.object_id
!= ino
890 || key_out
.type
!= GRUB_BTRFS_ITEM_TYPE_EXTENT_ITEM
)
892 grub_error (GRUB_ERR_BAD_FS
, "extent not found");
895 data
->extstart
= grub_le_to_cpu64 (key_out
.offset
);
896 data
->extsize
= elemsize
;
897 data
->extent
= grub_malloc (elemsize
);
899 data
->exttree
= tree
;
903 err
= grub_btrfs_read_logical (data
, elemaddr
,
904 data
->extent
, elemsize
);
907 if (grub_le_to_cpu64 (data
->extent
->size
) + data
->extstart
<= pos
)
908 return grub_error (GRUB_ERR_BAD_FS
, "extent not found");
909 grub_dprintf ("btrfs", "extent 0x%" PRIxGRUB_UINT64_T
"+0x%"
910 PRIxGRUB_UINT64_T
"\n",
911 grub_le_to_cpu64 (key_out
.offset
),
912 grub_le_to_cpu64 (data
->extent
->size
));
914 csize
= grub_le_to_cpu64 (data
->extent
->size
)
915 + grub_le_to_cpu64 (data
->extstart
) - pos
;
916 extoff
= pos
- data
->extstart
;
920 if (data
->extent
->encryption
)
922 grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET
,
923 "encryption not supported");
927 if (data
->extent
->compression
!= GRUB_BTRFS_COMPRESSION_NONE
928 && data
->extent
->compression
!= GRUB_BTRFS_COMPRESSION_ZLIB
)
930 grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET
,
931 "compression type 0x%x not supported",
932 data
->extent
->compression
);
936 if (data
->extent
->encoding
)
938 grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET
,
939 "encoding not supported");
943 switch (data
->extent
->type
)
945 case GRUB_BTRFS_EXTENT_INLINE
:
946 if (data
->extent
->compression
== GRUB_BTRFS_COMPRESSION_ZLIB
)
948 if (grub_zlib_decompress (data
->extent
->inl
, data
->extsize
-
949 ((grub_uint8_t
*) data
->extent
->inl
950 - (grub_uint8_t
*) data
->extent
),
952 != (grub_ssize_t
) csize
)
956 grub_memcpy (buf
, data
->extent
->inl
+ extoff
, csize
);
958 case GRUB_BTRFS_EXTENT_REGULAR
:
959 if (!data
->extent
->laddr
)
961 grub_memset (buf
, 0, csize
);
964 if (data
->extent
->compression
== GRUB_BTRFS_COMPRESSION_ZLIB
)
968 zsize
= grub_le_to_cpu64 (data
->extent
->compressed_size
);
969 tmp
= grub_malloc (zsize
);
972 err
= grub_btrfs_read_logical (data
,
973 grub_le_to_cpu64 (data
->extent
->laddr
),
980 if (grub_zlib_decompress (tmp
, zsize
, extoff
981 + grub_le_to_cpu64 (data
->extent
->offset
),
982 buf
, csize
) != (grub_ssize_t
) csize
)
990 err
= grub_btrfs_read_logical (data
,
991 grub_le_to_cpu64 (data
->extent
->laddr
)
992 + grub_le_to_cpu64 (data
->extent
->offset
)
999 grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET
,
1000 "unsupported extent type 0x%x", data
->extent
->type
);
1011 find_path (struct grub_btrfs_data
*data
,
1012 const char *path
, struct grub_btrfs_key
*key
,
1013 grub_uint64_t
*tree
, grub_uint8_t
*type
)
1015 const char *slash
= path
;
1017 grub_disk_addr_t elemaddr
;
1018 grub_size_t elemsize
;
1019 grub_size_t allocated
= 0;
1020 struct grub_btrfs_dir_item
*direl
= NULL
;
1021 struct grub_btrfs_key key_out
;
1024 grub_size_t ctokenlen
;
1025 char *path_alloc
= NULL
;
1026 unsigned symlinks_max
= 32;
1028 *type
= GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
;
1029 *tree
= data
->sblock
.root_tree
;
1030 key
->object_id
= data
->sblock
.root_dir_objectid
;
1031 key
->type
= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
;
1039 while (path
[0] == '/')
1043 slash
= grub_strchr (path
, '/');
1045 slash
= path
+ grub_strlen (path
);
1047 ctokenlen
= slash
- path
;
1052 ctokenlen
= sizeof ("default") - 1;
1055 if (*type
!= GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
)
1057 grub_free (path_alloc
);
1058 return grub_error (GRUB_ERR_BAD_FILE_TYPE
, "not a directory");
1061 key
->type
= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
;
1062 key
->offset
= grub_cpu_to_le64 (~grub_getcrc32c (1, ctoken
, ctokenlen
));
1064 err
= lower_bound (data
, key
, &key_out
, *tree
,
1065 &elemaddr
, &elemsize
, NULL
);
1069 grub_free (path_alloc
);
1072 if (key_cmp (key
, &key_out
) != 0)
1075 grub_free (path_alloc
);
1076 return grub_error (GRUB_ERR_FILE_NOT_FOUND
, "file not found");
1079 struct grub_btrfs_dir_item
*cdirel
;
1080 if (elemsize
> allocated
)
1082 allocated
= 2 * elemsize
;
1084 direl
= grub_malloc (allocated
+ 1);
1087 grub_free (path_alloc
);
1092 err
= grub_btrfs_read_logical (data
, elemaddr
, direl
, elemsize
);
1096 grub_free (path_alloc
);
1100 for (cdirel
= direl
;
1101 (grub_uint8_t
*) cdirel
- (grub_uint8_t
*) direl
1102 < (grub_ssize_t
) elemsize
;
1103 cdirel
= (void *) ((grub_uint8_t
*) (direl
+ 1)
1104 + grub_le_to_cpu16 (cdirel
->n
)
1105 + grub_le_to_cpu16 (cdirel
->m
)))
1107 if (ctokenlen
== grub_le_to_cpu16 (cdirel
->n
)
1108 && grub_memcmp (cdirel
->name
, ctoken
, ctokenlen
) == 0)
1111 if ((grub_uint8_t
*) cdirel
- (grub_uint8_t
*) direl
1112 >= (grub_ssize_t
) elemsize
)
1115 grub_free (path_alloc
);
1116 return grub_error (GRUB_ERR_FILE_NOT_FOUND
, "file not found");
1122 if (cdirel
->type
== GRUB_BTRFS_DIR_ITEM_TYPE_SYMLINK
)
1124 struct grub_btrfs_inode inode
;
1126 if (--symlinks_max
== 0)
1129 grub_free (path_alloc
);
1130 return grub_error (GRUB_ERR_SYMLINK_LOOP
,
1131 "too deep nesting of symlinks");
1134 err
= grub_btrfs_read_inode (data
, &inode
,
1135 cdirel
->key
.object_id
, *tree
);
1139 grub_free (path_alloc
);
1142 tmp
= grub_malloc (grub_le_to_cpu64 (inode
.size
)
1143 + grub_strlen (path
) + 1);
1147 grub_free (path_alloc
);
1151 if (grub_btrfs_extent_read (data
, cdirel
->key
.object_id
,
1153 grub_le_to_cpu64 (inode
.size
))
1154 != (grub_ssize_t
) grub_le_to_cpu64 (inode
.size
))
1157 grub_free (path_alloc
);
1161 grub_memcpy (tmp
+ grub_le_to_cpu64 (inode
.size
), path
,
1162 grub_strlen (path
) + 1);
1163 grub_free (path_alloc
);
1164 path
= path_alloc
= tmp
;
1167 *type
= GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
;
1168 *tree
= data
->sblock
.root_tree
;
1169 key
->object_id
= data
->sblock
.root_dir_objectid
;
1170 key
->type
= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
;
1176 *type
= cdirel
->type
;
1178 switch (cdirel
->key
.type
)
1180 case GRUB_BTRFS_ITEM_TYPE_ROOT_ITEM
:
1182 struct grub_btrfs_root_item ri
;
1183 err
= lower_bound (data
, &cdirel
->key
, &key_out
,
1184 data
->sblock
.root_tree
,
1185 &elemaddr
, &elemsize
, NULL
);
1189 grub_free (path_alloc
);
1192 if (cdirel
->key
.object_id
!= key_out
.object_id
1193 || cdirel
->key
.type
!= key_out
.type
)
1196 grub_free (path_alloc
);
1197 return grub_error (GRUB_ERR_FILE_NOT_FOUND
, "file not found");
1199 err
= grub_btrfs_read_logical (data
, elemaddr
,
1204 grub_free (path_alloc
);
1207 key
->type
= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
;
1209 key
->object_id
= GRUB_BTRFS_OBJECT_ID_CHUNK
;
1210 *tree
= grub_le_to_cpu64 (ri
.tree
);
1213 case GRUB_BTRFS_ITEM_TYPE_INODE_ITEM
:
1214 if (*slash
&& *type
== GRUB_BTRFS_DIR_ITEM_TYPE_REGULAR
)
1217 grub_free (path_alloc
);
1218 return grub_error (GRUB_ERR_FILE_NOT_FOUND
, "file not found");
1221 if (*type
== GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
)
1222 key
->type
= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
;
1225 grub_free (path_alloc
);
1227 return grub_error (GRUB_ERR_BAD_FS
, "unrecognised object type 0x%x",
1233 return GRUB_ERR_NONE
;
1237 grub_btrfs_dir (grub_device_t device
, const char *path
,
1238 int (*hook
) (const char *filename
,
1239 const struct grub_dirhook_info
*info
))
1241 struct grub_btrfs_data
*data
= grub_btrfs_mount (device
);
1242 struct grub_btrfs_key key_in
, key_out
;
1244 grub_disk_addr_t elemaddr
;
1245 grub_size_t elemsize
;
1246 grub_size_t allocated
= 0;
1247 struct grub_btrfs_dir_item
*direl
= NULL
;
1248 struct grub_btrfs_leaf_descriptor desc
;
1256 err
= find_path (data
, path
, &key_in
, &tree
, &type
);
1259 if (type
!= GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
)
1260 return grub_error (GRUB_ERR_BAD_FILE_TYPE
, "not a directory");
1262 err
= lower_bound (data
, &key_in
, &key_out
, tree
,
1263 &elemaddr
, &elemsize
, &desc
);
1266 if (key_out
.type
!= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
1267 || key_out
.object_id
!= key_in
.object_id
)
1269 r
= next (data
, &desc
, &elemaddr
, &elemsize
, &key_out
);
1272 free_iterator (&desc
);
1278 struct grub_btrfs_dir_item
*cdirel
;
1279 if (key_out
.type
!= GRUB_BTRFS_ITEM_TYPE_DIR_ITEM
1280 || key_out
.object_id
!= key_in
.object_id
)
1285 if (elemsize
> allocated
)
1287 allocated
= 2 * elemsize
;
1289 direl
= grub_malloc (allocated
+ 1);
1292 free_iterator (&desc
);
1297 err
= grub_btrfs_read_logical (data
, elemaddr
, direl
, elemsize
);
1301 for (cdirel
= direl
;
1302 (grub_uint8_t
*) cdirel
- (grub_uint8_t
*) direl
1303 < (grub_ssize_t
) elemsize
;
1304 cdirel
= (void *) ((grub_uint8_t
*) (direl
+ 1)
1305 + grub_le_to_cpu16 (cdirel
->n
)
1306 + grub_le_to_cpu16 (cdirel
->m
)))
1309 struct grub_btrfs_inode inode
;
1310 struct grub_dirhook_info info
;
1311 err
= grub_btrfs_read_inode (data
, &inode
, cdirel
->key
.object_id
,
1313 grub_memset (&info
, 0, sizeof (info
));
1315 grub_errno
= GRUB_ERR_NONE
;
1318 info
.mtime
= inode
.mtime
.sec
;
1321 c
= cdirel
->name
[grub_le_to_cpu16 (cdirel
->n
)];
1322 cdirel
->name
[grub_le_to_cpu16 (cdirel
->n
)] = 0;
1323 info
.dir
= (cdirel
->type
== GRUB_BTRFS_DIR_ITEM_TYPE_DIRECTORY
);
1324 if (hook (cdirel
->name
, &info
))
1326 cdirel
->name
[grub_le_to_cpu16 (cdirel
->n
)] = c
;
1328 r
= next (data
, &desc
, &elemaddr
, &elemsize
, &key_out
);
1335 free_iterator (&desc
);
1336 grub_btrfs_unmount (data
);
1342 grub_btrfs_open (struct grub_file
*file
, const char *name
)
1344 struct grub_btrfs_data
*data
= grub_btrfs_mount (file
->device
);
1346 struct grub_btrfs_inode inode
;
1348 struct grub_btrfs_key key_in
;
1353 err
= find_path (data
, name
, &key_in
, &data
->tree
, &type
);
1356 grub_btrfs_unmount (data
);
1359 if (type
!= GRUB_BTRFS_DIR_ITEM_TYPE_REGULAR
)
1361 grub_btrfs_unmount (data
);
1362 return grub_error (GRUB_ERR_BAD_FILE_TYPE
, "not a regular file");
1365 data
->inode
= key_in
.object_id
;
1366 err
= grub_btrfs_read_inode (data
, &inode
, data
->inode
, data
->tree
);
1369 grub_btrfs_unmount (data
);
1374 file
->size
= grub_le_to_cpu64 (inode
.size
);
1380 grub_btrfs_close (grub_file_t file
)
1382 grub_btrfs_unmount (file
->data
);
1384 return GRUB_ERR_NONE
;
1388 grub_btrfs_read (grub_file_t file
, char *buf
, grub_size_t len
)
1390 struct grub_btrfs_data
*data
= file
->data
;
1392 return grub_btrfs_extent_read (data
, data
->inode
,
1393 data
->tree
, file
->offset
, buf
, len
);
1397 grub_btrfs_uuid (grub_device_t device
, char **uuid
)
1399 struct grub_btrfs_data
*data
;
1403 data
= grub_btrfs_mount (device
);
1407 *uuid
= grub_xasprintf ("%04x%04x-%04x-%04x-%04x-%04x%04x%04x",
1408 grub_be_to_cpu16 (data
->sblock
.uuid
[0]),
1409 grub_be_to_cpu16 (data
->sblock
.uuid
[1]),
1410 grub_be_to_cpu16 (data
->sblock
.uuid
[2]),
1411 grub_be_to_cpu16 (data
->sblock
.uuid
[3]),
1412 grub_be_to_cpu16 (data
->sblock
.uuid
[4]),
1413 grub_be_to_cpu16 (data
->sblock
.uuid
[5]),
1414 grub_be_to_cpu16 (data
->sblock
.uuid
[6]),
1415 grub_be_to_cpu16 (data
->sblock
.uuid
[7]));
1417 grub_btrfs_unmount (data
);
1423 grub_btrfs_label (grub_device_t device
, char **label
)
1425 struct grub_btrfs_data
*data
;
1429 data
= grub_btrfs_mount (device
);
1433 *label
= grub_strndup (data
->sblock
.label
, sizeof (data
->sblock
.label
));
1435 grub_btrfs_unmount (data
);
1440 static struct grub_fs grub_btrfs_fs
=
1443 .dir
= grub_btrfs_dir
,
1444 .open
= grub_btrfs_open
,
1445 .read
= grub_btrfs_read
,
1446 .close
= grub_btrfs_close
,
1447 .uuid
= grub_btrfs_uuid
,
1448 .label
= grub_btrfs_label
,
1451 GRUB_MOD_INIT(btrfs
)
1453 grub_fs_register (&grub_btrfs_fs
);
1456 GRUB_MOD_FINI(btrfs
)
1458 grub_fs_unregister (&grub_btrfs_fs
);