-
-
Notifications
You must be signed in to change notification settings - Fork 34
/
apfs_raw.h
1562 lines (1350 loc) · 40.2 KB
/
apfs_raw.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* SPDX-License-Identifier: GPL-2.0-only */
/*
* Copyright (C) 2019 Ernesto A. Fernández <[email protected]>
*
* Definitions for all on-disk data structures.
*/
#ifndef _APFS_RAW_H
#define _APFS_RAW_H
#include <linux/types.h>
#include <linux/uuid.h>
/* Object identifiers constants */
#define APFS_OID_NX_SUPERBLOCK 1
#define APFS_OID_INVALID 0ULL
#define APFS_OID_RESERVED_COUNT 1024
/* Object type masks */
#define APFS_OBJECT_TYPE_MASK 0x0000ffff
#define APFS_OBJECT_TYPE_FLAGS_MASK 0xffff0000
#define APFS_OBJ_STORAGETYPE_MASK 0xc0000000
#define APFS_OBJECT_TYPE_FLAGS_DEFINED_MASK 0xf8000000
/* Object types */
#define APFS_OBJECT_TYPE_NX_SUPERBLOCK 0x00000001
#define APFS_OBJECT_TYPE_BTREE 0x00000002
#define APFS_OBJECT_TYPE_BTREE_NODE 0x00000003
#define APFS_OBJECT_TYPE_SPACEMAN 0x00000005
#define APFS_OBJECT_TYPE_SPACEMAN_CAB 0x00000006
#define APFS_OBJECT_TYPE_SPACEMAN_CIB 0x00000007
#define APFS_OBJECT_TYPE_SPACEMAN_BITMAP 0x00000008
#define APFS_OBJECT_TYPE_SPACEMAN_FREE_QUEUE 0x00000009
#define APFS_OBJECT_TYPE_EXTENT_LIST_TREE 0x0000000a
#define APFS_OBJECT_TYPE_OMAP 0x0000000b
#define APFS_OBJECT_TYPE_CHECKPOINT_MAP 0x0000000c
#define APFS_OBJECT_TYPE_FS 0x0000000d
#define APFS_OBJECT_TYPE_FSTREE 0x0000000e
#define APFS_OBJECT_TYPE_BLOCKREFTREE 0x0000000f
#define APFS_OBJECT_TYPE_SNAPMETATREE 0x00000010
#define APFS_OBJECT_TYPE_NX_REAPER 0x00000011
#define APFS_OBJECT_TYPE_NX_REAP_LIST 0x00000012
#define APFS_OBJECT_TYPE_OMAP_SNAPSHOT 0x00000013
#define APFS_OBJECT_TYPE_EFI_JUMPSTART 0x00000014
#define APFS_OBJECT_TYPE_FUSION_MIDDLE_TREE 0x00000015
#define APFS_OBJECT_TYPE_NX_FUSION_WBC 0x00000016
#define APFS_OBJECT_TYPE_NX_FUSION_WBC_LIST 0x00000017
#define APFS_OBJECT_TYPE_ER_STATE 0x00000018
#define APFS_OBJECT_TYPE_GBITMAP 0x00000019
#define APFS_OBJECT_TYPE_GBITMAP_TREE 0x0000001a
#define APFS_OBJECT_TYPE_GBITMAP_BLOCK 0x0000001b
#define APFS_OBJECT_TYPE_ER_RECOVERY_BLOCK 0x0000001c
#define APFS_OBJECT_TYPE_SNAP_META_EXT 0x0000001d
#define APFS_OBJECT_TYPE_INTEGRITY_META 0x0000001e
#define APFS_OBJECT_TYPE_FEXT_TREE 0x0000001f
#define APFS_OBJECT_TYPE_RESERVED_20 0x00000020
#define APFS_OBJECT_TYPE_INVALID 0x00000000
#define APFS_OBJECT_TYPE_TEST 0x000000ff
/* Object type flags */
#define APFS_OBJ_VIRTUAL 0x00000000
#define APFS_OBJ_EPHEMERAL 0x80000000
#define APFS_OBJ_PHYSICAL 0x40000000
#define APFS_OBJ_NOHEADER 0x20000000
#define APFS_OBJ_ENCRYPTED 0x10000000
#define APFS_OBJ_NONPERSISTENT 0x08000000
#define APFS_MAX_CKSUM_SIZE 8
/*
* On-disk representation of an APFS object
*/
struct apfs_obj_phys {
/*00*/ __le64 o_cksum; /* Fletcher checksum */
__le64 o_oid; /* Object-id */
/*10*/ __le64 o_xid; /* Transaction ID */
__le32 o_type; /* Object type */
__le32 o_subtype; /* Object subtype */
} __packed;
/* Flags for the object map structure */
#define APFS_OMAP_MANUALLY_MANAGED 0x00000001
#define APFS_OMAP_ENCRYPTING 0x00000002
#define APFS_OMAP_DECRYPTING 0x00000004
#define APFS_OMAP_KEYROLLING 0x00000008
#define APFS_OMAP_CRYPTO_GENERATION 0x00000010
#define APFS_OMAP_FLAGS_VALID_MASK (APFS_OMAP_MANUALLY_MANAGED \
| APFS_OMAP_ENCRYPTING \
| APFS_OMAP_DECRYPTING \
| APFS_OMAP_KEYROLLING \
| APFS_OMAP_CRYPTO_GENERATION)
/*
* On-disk representation of an object map
*/
struct apfs_omap_phys {
/*00*/ struct apfs_obj_phys om_o;
/*20*/ __le32 om_flags;
__le32 om_snap_count;
__le32 om_tree_type;
__le32 om_snapshot_tree_type;
/*30*/ __le64 om_tree_oid;
__le64 om_snapshot_tree_oid;
/*40*/ __le64 om_most_recent_snap;
__le64 om_pending_revert_min;
__le64 om_pending_revert_max;
} __packed;
/* Object map value flags */
#define APFS_OMAP_VAL_DELETED 0x00000001
#define APFS_OMAP_VAL_SAVED 0x00000002
#define APFS_OMAP_VAL_ENCRYPTED 0x00000004
#define APFS_OMAP_VAL_NOHEADER 0x00000008
#define APFS_OMAP_VAL_CRYPTO_GENERATION 0x00000010
#define APFS_OMAP_VAL_FLAGS_VALID_MASK (APFS_OMAP_VAL_DELETED \
| APFS_OMAP_VAL_SAVED \
| APFS_OMAP_VAL_ENCRYPTED \
| APFS_OMAP_VAL_NOHEADER \
| APFS_OMAP_VAL_CRYPTO_GENERATION)
/*
* Structure of a value in an object map B-tree
*/
struct apfs_omap_val {
__le32 ov_flags;
__le32 ov_size;
__le64 ov_paddr;
} __packed;
/*
* Structure of a value in an omap's snapshot tree
*/
struct apfs_omap_snapshot {
__le32 oms_flags;
__le32 oms_pad;
__le64 oms_oid;
} __packed;
/* B-tree node flags */
#define APFS_BTNODE_ROOT 0x0001
#define APFS_BTNODE_LEAF 0x0002
#define APFS_BTNODE_FIXED_KV_SIZE 0x0004
#define APFS_BTNODE_CHECK_KOFF_INVAL 0x8000
#define APFS_BTNODE_MASK 0x0007 /* Valid on-disk flags */
/* B-tree location constants */
#define APFS_BTOFF_INVALID 0xffff
/*
* Structure storing a location inside a B-tree node
*/
struct apfs_nloc {
__le16 off;
__le16 len;
} __packed;
/*
* Structure storing the location of a key/value pair within a B-tree node
*/
struct apfs_kvloc {
struct apfs_nloc k;
struct apfs_nloc v;
} __packed;
/*
* Structure storing the location of a key/value pair within a B-tree node
* having fixed-size key and value (flag APFS_BTNODE_FIXED_KV_SIZE is present)
*/
struct apfs_kvoff {
__le16 k;
__le16 v;
} __packed;
/*
* On-disk representation of a B-tree node
*/
struct apfs_btree_node_phys {
/*00*/ struct apfs_obj_phys btn_o;
/*20*/ __le16 btn_flags;
__le16 btn_level;
__le32 btn_nkeys;
/*28*/ struct apfs_nloc btn_table_space;
struct apfs_nloc btn_free_space;
struct apfs_nloc btn_key_free_list;
struct apfs_nloc btn_val_free_list;
/*38*/ __le64 btn_data[];
} __packed;
/* B-tree info flags */
#define APFS_BTREE_UINT64_KEYS 0x00000001
#define APFS_BTREE_SEQUENTIAL_INSERT 0x00000002
#define APFS_BTREE_ALLOW_GHOSTS 0x00000004
#define APFS_BTREE_EPHEMERAL 0x00000008
#define APFS_BTREE_PHYSICAL 0x00000010
#define APFS_BTREE_NONPERSISTENT 0x00000020
#define APFS_BTREE_KV_NONALIGNED 0x00000040
#define APFS_BTREE_FLAGS_VALID_MASK (APFS_BTREE_UINT64_KEYS \
| APFS_BTREE_SEQUENTIAL_INSERT \
| APFS_BTREE_ALLOW_GHOSTS \
| APFS_BTREE_EPHEMERAL \
| APFS_BTREE_PHYSICAL \
| APFS_BTREE_NONPERSISTENT \
| APFS_BTREE_KV_NONALIGNED)
/*
* Structure used to store information about a B-tree that won't change
* over time
*/
struct apfs_btree_info_fixed {
__le32 bt_flags;
__le32 bt_node_size;
__le32 bt_key_size;
__le32 bt_val_size;
} __packed;
/*
* Structure used to store information about a B-tree (located at the end of
* a B-tree root node block)
*/
struct apfs_btree_info {
struct apfs_btree_info_fixed bt_fixed;
__le32 bt_longest_key; /* Longest key ever stored */
__le32 bt_longest_val; /* Longest value ever stored */
__le64 bt_key_count;
__le64 bt_node_count;
} __packed;
/*
* Structure of the value of a directory entry. This is the data in
* the catalog nodes for record type APFS_TYPE_DIR_REC.
*/
struct apfs_drec_val {
__le64 file_id;
__le64 date_added;
__le16 flags;
u8 xfields[];
} __packed;
/* Physical extent records */
#define APFS_PEXT_LEN_MASK 0x0fffffffffffffffULL
#define APFS_PEXT_KIND_MASK 0xf000000000000000ULL
#define APFS_PEXT_KIND_SHIFT 60
/* The kind of a physical extent record */
enum {
APFS_KIND_ANY = 0,
APFS_KIND_NEW = 1,
APFS_KIND_UPDATE = 2,
APFS_KIND_DEAD = 3,
APFS_KIND_UPDATE_REFCNT = 4,
APFS_KIND_INVALID = 255 /* This is weird, won't fit in 4 bits */
};
#define APFS_OWNING_OBJ_ID_INVALID (~0ULL)
#define APFS_OWNING_OBJ_ID_UNKNOWN (~1ULL)
/*
* Structure of a physical extent record
*/
struct apfs_phys_ext_val {
__le64 len_and_kind;
__le64 owning_obj_id;
__le32 refcnt;
} __packed;
/* File extent records */
#define APFS_FILE_EXTENT_LEN_MASK 0x00ffffffffffffffULL
#define APFS_FILE_EXTENT_FLAG_MASK 0xff00000000000000ULL
#define APFS_FILE_EXTENT_FLAG_SHIFT 56
#define APFS_FILE_EXTENT_CRYPTO_FLAG 0x01 /* Made-up name */
#define APFS_FILE_EXTENT_PREALLOCATED 0x02 /* Made-up name */
#define APFS_VALID_FILE_EXTENT_FLAGS (APFS_FILE_EXTENT_CRYPTO_FLAG \
| APFS_FILE_EXTENT_PREALLOCATED)
/*
* Put a bound on maximum file size so that a growing truncation will always
* produce a single hole extent, even if 64k block sizes were in use. Larger
* file sizes could be supported with multiple extents of course, but it takes
* some work and I don't see the point.
*/
#define APFS_MAX_FILE_SIZE 0x00ffffffffff0000ULL
/*
* Structure of a file extent record
*/
struct apfs_file_extent_val {
__le64 len_and_flags;
__le64 phys_block_num;
__le64 crypto_id;
} __packed;
/*
* Structure of a data stream record
*/
struct apfs_dstream_id_val {
__le32 refcnt;
} __packed;
#define APFS_CP_MAX_WRAPPEDKEYSIZE 128
/*
* Structure used to store the encryption state for PFKs
*/
struct apfs_wrapped_crypto_state {
__le16 major_version;
__le16 minor_version;
__le32 cpflags;
__le32 persistent_class;
__le32 key_os_version;
__le16 key_revision;
__le16 key_len;
u8 persistent_key[];
} __packed;
/*
* Structure of a crypto state record
*/
struct apfs_crypto_state_val {
__le32 refcnt;
struct apfs_wrapped_crypto_state state;
} __packed;
/* Inode numbers for special inodes */
#define APFS_INVALID_INO_NUM 0
#define APFS_ROOT_DIR_PARENT 1 /* Root directory parent */
#define APFS_ROOT_DIR_INO_NUM 2 /* Root directory */
#define APFS_PRIV_DIR_INO_NUM 3 /* Private directory */
#define APFS_SNAP_DIR_INO_NUM 6 /* Snapshots metadata */
#define APFS_PURGEABLE_DIR_INO_NUM 7 /* Parent of purgeable files */
/* Smallest inode number available for user content */
#define APFS_MIN_USER_INO_NUM 16
#define APFS_UNIFIED_ID_SPACE_MARK 0x0800000000000000
/* Inode internal flags */
#define APFS_INODE_IS_APFS_PRIVATE 0x00000001
#define APFS_INODE_MAINTAIN_DIR_STATS 0x00000002
#define APFS_INODE_DIR_STATS_ORIGIN 0x00000004
#define APFS_INODE_PROT_CLASS_EXPLICIT 0x00000008
#define APFS_INODE_WAS_CLONED 0x00000010
#define APFS_INODE_FLAG_UNUSED 0x00000020
#define APFS_INODE_HAS_SECURITY_EA 0x00000040
#define APFS_INODE_BEING_TRUNCATED 0x00000080
#define APFS_INODE_HAS_FINDER_INFO 0x00000100
#define APFS_INODE_IS_SPARSE 0x00000200
#define APFS_INODE_WAS_EVER_CLONED 0x00000400
#define APFS_INODE_ACTIVE_FILE_TRIMMED 0x00000800
#define APFS_INODE_PINNED_TO_MAIN 0x00001000
#define APFS_INODE_PINNED_TO_TIER2 0x00002000
#define APFS_INODE_HAS_RSRC_FORK 0x00004000
#define APFS_INODE_NO_RSRC_FORK 0x00008000
#define APFS_INODE_ALLOCATION_SPILLEDOVER 0x00010000
#define APFS_INODE_FAST_PROMOTE 0x00020000
#define APFS_INODE_HAS_UNCOMPRESSED_SIZE 0x00040000
#define APFS_INODE_IS_PURGEABLE 0x00080000
#define APFS_INODE_WANTS_TO_BE_PURGEABLE 0x00100000
#define APFS_INODE_IS_SYNC_ROOT 0x00200000
#define APFS_INODE_SNAPSHOT_COW_EXEMPTION 0x00400000
/* This flag is not documented */
#define APFS_INODE_HAS_PURGEABLE_FLAGS 0x02000000
/* Masks for internal flags */
#define APFS_VALID_INTERNAL_INODE_FLAGS (APFS_INODE_IS_APFS_PRIVATE \
| APFS_INODE_MAINTAIN_DIR_STATS \
| APFS_INODE_DIR_STATS_ORIGIN \
| APFS_INODE_PROT_CLASS_EXPLICIT \
| APFS_INODE_WAS_CLONED \
| APFS_INODE_HAS_SECURITY_EA \
| APFS_INODE_BEING_TRUNCATED \
| APFS_INODE_HAS_FINDER_INFO \
| APFS_INODE_IS_SPARSE \
| APFS_INODE_WAS_EVER_CLONED \
| APFS_INODE_ACTIVE_FILE_TRIMMED \
| APFS_INODE_PINNED_TO_MAIN \
| APFS_INODE_PINNED_TO_TIER2 \
| APFS_INODE_HAS_RSRC_FORK \
| APFS_INODE_NO_RSRC_FORK \
| APFS_INODE_ALLOCATION_SPILLEDOVER \
| APFS_INODE_FAST_PROMOTE \
| APFS_INODE_HAS_UNCOMPRESSED_SIZE \
| APFS_INODE_IS_PURGEABLE \
| APFS_INODE_WANTS_TO_BE_PURGEABLE \
| APFS_INODE_IS_SYNC_ROOT \
| APFS_INODE_SNAPSHOT_COW_EXEMPTION \
| APFS_INODE_HAS_PURGEABLE_FLAGS)
#define APFS_INODE_INHERITED_INTERNAL_FLAGS (APFS_INODE_MAINTAIN_DIR_STATS)
#define APFS_INDOE_CLONED_INTERNAL_FLAGS (APFS_INODE_HAS_RSRC_FORK \
| APFS_INODE_NO_RSRC_FORK \
| APFS_INODE_HAS_FINDER_INFO)
#define APFS_INODE_PINNED_MASK (APFS_INODE_PINNED_TO_MAIN \
| APFS_INODE_PINNED_TO_TIER2)
/* BSD flags */
#define APFS_INOBSD_NODUMP 0x00000001
#define APFS_INOBSD_IMMUTABLE 0x00000002
#define APFS_INOBSD_APPEND 0x00000004
#define APFS_INOBSD_COMPRESSED 0x00000020
/*
* Structure of an inode as stored as a B-tree value
*/
struct apfs_inode_val {
/*00*/ __le64 parent_id;
__le64 private_id;
/*10*/ __le64 create_time;
__le64 mod_time;
__le64 change_time;
__le64 access_time;
/*30*/ __le64 internal_flags;
union {
__le32 nchildren;
__le32 nlink;
};
__le32 default_protection_class;
/*40*/ __le32 write_generation_counter;
__le32 bsd_flags;
__le32 owner;
__le32 group;
/*50*/ __le16 mode;
__le16 pad1;
__le64 uncompressed_size;
/*5C*/ u8 xfields[];
} __packed;
/* Extended field types for dentries */
#define APFS_DREC_EXT_TYPE_SIBLING_ID 1
/* Extended field types for inodes */
#define APFS_INO_EXT_TYPE_SNAP_XID 1
#define APFS_INO_EXT_TYPE_DELTA_TREE_OID 2
#define APFS_INO_EXT_TYPE_DOCUMENT_ID 3
#define APFS_INO_EXT_TYPE_NAME 4
#define APFS_INO_EXT_TYPE_PREV_FSIZE 5
#define APFS_INO_EXT_TYPE_RESERVED_6 6
#define APFS_INO_EXT_TYPE_FINDER_INFO 7
#define APFS_INO_EXT_TYPE_DSTREAM 8
#define APFS_INO_EXT_TYPE_RESERVED_9 9
#define APFS_INO_EXT_TYPE_DIR_STATS_KEY 10
#define APFS_INO_EXT_TYPE_FS_UUID 11
#define APFS_INO_EXT_TYPE_RESERVED_12 12
#define APFS_INO_EXT_TYPE_SPARSE_BYTES 13
#define APFS_INO_EXT_TYPE_RDEV 14
#define APFS_INO_EXT_TYPE_PURGEABLE_FLAGS 15
#define APFS_INO_EXT_TYPE_ORIG_SYNC_ROOT_ID 16
/* Extended field flags */
#define APFS_XF_DATA_DEPENDENT 0x01
#define APFS_XF_DO_NOT_COPY 0x02
#define APFS_XF_RESERVED_4 0x04
#define APFS_XF_CHILDREN_INHERIT 0x08
#define APFS_XF_USER_FIELD 0x10
#define APFS_XF_SYSTEM_FIELD 0x20
#define APFS_XF_RESERVED_40 0x40
#define APFS_XF_RESERVED_80 0x80
/* Constants for extended fields */
#define APFS_MIN_DOC_ID 3 /* Smallest not reserved document id */
/*
* Structure used to store the number and size of an xfield collection. The
* official reference seems to be wrong about @xf_used_data: it's the size of
* the xfield values alone, without the metadata.
*/
struct apfs_xf_blob {
__le16 xf_num_exts;
__le16 xf_used_data;
u8 xf_data[];
} __packed;
/*
* Structure used to describe an extended field
*/
struct apfs_x_field {
u8 x_type;
u8 x_flags;
__le16 x_size;
} __packed;
/*
* Structure used to store information about a data stream
*/
struct apfs_dstream {
__le64 size;
__le64 alloced_size;
__le64 default_crypto_id;
__le64 total_bytes_written;
__le64 total_bytes_read;
} __packed;
/*
* Structure used to store directory information
*/
struct apfs_dir_stats_val {
__le64 num_children;
__le64 total_size;
__le64 chained_key;
__le64 gen_count;
} __packed;
/*
* Structure of the value for a sibling link record. These are used to
* list the hard links for a given inode.
*/
struct apfs_sibling_val {
__le64 parent_id;
__le16 name_len;
u8 name[];
} __packed;
/*
* Structure of the value for a sibling map record. No idea what these are for.
*/
struct apfs_sibling_map_val {
__le64 file_id;
} __packed;
/*
* Structure of a key in an object map B-tree
*/
struct apfs_omap_key {
__le64 ok_oid;
__le64 ok_xid;
} __packed;
/*
* Structure of a key in a free-space queue b-tree
*/
struct apfs_spaceman_free_queue_key {
__le64 sfqk_xid;
__le64 sfqk_paddr;
} __packed;
/* Catalog records types */
enum {
APFS_TYPE_ANY = 0,
APFS_TYPE_SNAP_METADATA = 1,
APFS_TYPE_EXTENT = 2,
APFS_TYPE_INODE = 3,
APFS_TYPE_XATTR = 4,
APFS_TYPE_SIBLING_LINK = 5,
APFS_TYPE_DSTREAM_ID = 6,
APFS_TYPE_CRYPTO_STATE = 7,
APFS_TYPE_FILE_EXTENT = 8,
APFS_TYPE_DIR_REC = 9,
APFS_TYPE_DIR_STATS = 10,
APFS_TYPE_SNAP_NAME = 11,
APFS_TYPE_SIBLING_MAP = 12,
APFS_TYPE_MAX_VALID = 12,
APFS_TYPE_MAX = 15,
APFS_TYPE_INVALID = 15,
};
/* Bit masks for the 'obj_id_and_type' field of a key header */
#define APFS_OBJ_ID_MASK 0x0fffffffffffffffULL
#define APFS_OBJ_TYPE_MASK 0xf000000000000000ULL
#define APFS_OBJ_TYPE_SHIFT 60
/* Key header for filesystem-object keys */
struct apfs_key_header {
__le64 obj_id_and_type;
} __packed;
/*
* Structure of the key for a physical extent record
*/
struct apfs_phys_ext_key {
struct apfs_key_header hdr;
} __packed;
/*
* Structure of the key for an inode record
*/
struct apfs_inode_key {
struct apfs_key_header hdr;
} __packed;
/*
* Structure of the key for a file extent record
*/
struct apfs_file_extent_key {
struct apfs_key_header hdr;
__le64 logical_addr;
} __packed;
/*
* Structure of the key for a data stream record
*/
struct apfs_dstream_id_key {
struct apfs_key_header hdr;
} __packed;
/*
* Structure of the key for a crypto state record
*/
struct apfs_crypto_state_key {
struct apfs_key_header hdr;
} __packed;
/* Bit masks for the 'name_len_and_hash' field of a directory entry */
#define APFS_DREC_LEN_MASK 0x000003ff
#define APFS_DREC_HASH_MASK 0xfffffc00
#define APFS_DREC_HASH_SHIFT 10
/* We could support bigger filenames, but I don't know if Linux allows it */
#define APFS_NAME_LEN NAME_MAX
/* Bit masks for the 'type' field of a directory entry */
enum {
APFS_DREC_TYPE_MASK = 0x000f,
APFS_DREC_RESERVED_10 = 0x0010,
/* These flags are not documented */
APFS_DREC_PURGEABLE_2 = 0x0200,
APFS_DREC_PURGEABLE_8 = 0x0800,
};
#define APFS_DREC_PURGEABLE (APFS_DREC_PURGEABLE_2 | APFS_DREC_PURGEABLE_8)
/*
* Structure of the key for a directory entry - no hash, used on normalization
* sensitive volumes
*/
struct apfs_drec_key {
struct apfs_key_header hdr;
__le16 name_len;
u8 name[];
} __packed;
/*
* Structure of the key for a directory entry, including a precomputed
* hash of its name
*/
struct apfs_drec_hashed_key {
struct apfs_key_header hdr;
__le32 name_len_and_hash;
u8 name[];
} __packed;
/*
* Structure of the key for an extended attributes record
*/
struct apfs_xattr_key {
struct apfs_key_header hdr;
__le16 name_len;
u8 name[];
} __packed;
/*
* Structure of the key for a snapshot metadata record
*/
struct apfs_snap_metadata_key {
struct apfs_key_header hdr;
} __packed;
/* The snapshot name headers always have this placeholder object id */
#define APFS_SNAP_NAME_OBJ_ID (~0ULL & APFS_OBJ_ID_MASK)
/*
* Structure of the key for a snapshot name record
*/
struct apfs_snap_name_key {
struct apfs_key_header hdr;
__le16 name_len;
u8 name[];
} __packed;
/*
* Structure of the key for a sibling link record
*/
struct apfs_sibling_link_key {
struct apfs_key_header hdr;
__le64 sibling_id;
} __packed;
/*
* Structure of the key for a siblink map record
*/
struct apfs_sibling_map_key {
struct apfs_key_header hdr;
} __packed;
/*
* On-disk allocation info for a chunk of blocks
*/
struct apfs_chunk_info {
__le64 ci_xid;
__le64 ci_addr;
__le32 ci_block_count;
__le32 ci_free_count;
__le64 ci_bitmap_addr;
} __packed;
/* Constants for the chunk info block */
#define APFS_CI_COUNT_MASK 0x000FFFFF
#define APFS_CI_COUNT_RESERVED_MASK 0xFFF00000
/*
* Structure of a block with an array of chunk allocation info structures
*/
struct apfs_chunk_info_block {
struct apfs_obj_phys cib_o;
__le32 cib_index;
__le32 cib_chunk_info_count;
struct apfs_chunk_info cib_chunk_info[];
} __packed;
/*
* Structure of a block with an array of addresses to chunk information blocks
*/
struct apfs_cib_addr_block {
struct apfs_obj_phys cab_o;
__le32 cab_index;
__le32 cab_cib_count;
__le64 cab_cib_addr[];
} __packed;
/*
* On-disk structure for a free queue
*/
struct apfs_spaceman_free_queue {
__le64 sfq_count;
__le64 sfq_tree_oid;
__le64 sfq_oldest_xid;
__le16 sfq_tree_node_limit;
__le16 sfq_pad16;
__le32 sfq_pad32;
__le64 sfq_reserved;
} __packed;
/* Indexes for a free queue array */
enum {
APFS_SFQ_IP = 0,
APFS_SFQ_MAIN = 1,
APFS_SFQ_TIER2 = 2,
APFS_SFQ_COUNT = 3
};
/*
* On-disk structure for device allocation information
*/
struct apfs_spaceman_device {
__le64 sm_block_count;
__le64 sm_chunk_count;
__le32 sm_cib_count;
__le32 sm_cab_count;
__le64 sm_free_count;
__le32 sm_addr_offset;
__le32 sm_reserved;
__le64 sm_reserved2;
} __packed;
/* Indexes for a device array */
enum {
APFS_SD_MAIN = 0,
APFS_SD_TIER2 = 1,
APFS_SD_COUNT = 2
};
/*
* On-disk structure to describe allocation zone boundaries
*/
struct apfs_spaceman_allocation_zone_boundaries {
__le64 saz_zone_start;
__le64 saz_zone_end;
} __packed;
/* Allocation zone constants */
#define APFS_SM_ALLOCZONE_INVALID_END_BOUNDARY 0
#define APFS_SM_ALLOCZONE_NUM_PREVIOUS_BOUNDARIES 7
struct apfs_spaceman_allocation_zone_info_phys {
struct apfs_spaceman_allocation_zone_boundaries saz_current_boundaries;
struct apfs_spaceman_allocation_zone_boundaries
saz_previous_boundaries[APFS_SM_ALLOCZONE_NUM_PREVIOUS_BOUNDARIES];
__le16 saz_zone_id;
__le16 saz_previous_boundary_index;
__le32 saz_reserved;
} __packed;
/* Datazone constants */
#define APFS_SM_DATAZONE_ALLOCZONE_COUNT 8
struct apfs_spaceman_datazone_info_phys {
struct apfs_spaceman_allocation_zone_info_phys
sdz_allocation_zones[APFS_SD_COUNT][APFS_SM_DATAZONE_ALLOCZONE_COUNT];
} __packed;
/* Internal-pool bitmap constants */
#define APFS_SPACEMAN_IP_BM_TX_MULTIPLIER 16
#define APFS_SPACEMAN_IP_BM_INDEX_INVALID 0xFFFF
#define APFS_SPACEMAN_IP_BM_BLOCK_COUNT_MAX 0xFFFE
/* Space manager flags */
#define APFS_SM_FLAG_VERSIONED 0x00000001
#define APFS_SM_FLAGS_VALID_MASK APFS_SM_FLAG_VERSIONED
/*
* On-disk structure for the space manager
*/
struct apfs_spaceman_phys {
struct apfs_obj_phys sm_o;
__le32 sm_block_size;
__le32 sm_blocks_per_chunk;
__le32 sm_chunks_per_cib;
__le32 sm_cibs_per_cab;
struct apfs_spaceman_device sm_dev[APFS_SD_COUNT];
__le32 sm_flags;
__le32 sm_ip_bm_tx_multiplier;
__le64 sm_ip_block_count;
__le32 sm_ip_bm_size_in_blocks;
__le32 sm_ip_bm_block_count;
__le64 sm_ip_bm_base;
__le64 sm_ip_base;
__le64 sm_fs_reserve_block_count;
__le64 sm_fs_reserve_alloc_count;
struct apfs_spaceman_free_queue sm_fq[APFS_SFQ_COUNT];
__le16 sm_ip_bm_free_head;
__le16 sm_ip_bm_free_tail;
__le32 sm_ip_bm_xid_offset;
__le32 sm_ip_bitmap_offset;
__le32 sm_ip_bm_free_next_offset;
__le32 sm_version;
__le32 sm_struct_size;
struct apfs_spaceman_datazone_info_phys sm_datazone;
} __packed;
/*
* Structure used to store a range of physical blocks
*/
struct apfs_prange {
__le64 pr_start_paddr;
__le64 pr_block_count;
} __packed;
/* Reaper flags */
#define APFS_NR_BHM_FLAG 0x00000001
#define APFS_NR_CONTINUE 0x00000002
#define APFS_NR_FLAGS_VALID_MASK (APFS_NR_BHM_FLAG | APFS_NR_CONTINUE)
/*
* On-disk reaper structure
*/
struct apfs_nx_reaper_phys {
struct apfs_obj_phys nr_o;
__le64 nr_next_reap_id;
__le64 nr_completed_id;
__le64 nr_head;
__le64 nr_tail;
__le32 nr_flags;
__le32 nr_rlcount;
__le32 nr_type;
__le32 nr_size;
__le64 nr_fs_oid;
__le64 nr_oid;
__le64 nr_xid;
__le32 nr_nrle_flags;
__le32 nr_state_buffer_size;
u8 nr_state_buffer[];
} __packed;
struct apfs_nx_reap_list_entry {
__le32 nrle_next;
__le32 nrle_flags;
__le32 nrle_type;
__le32 nrle_size;
__le64 nrle_fs_oid;
__le64 nrle_oid;
__le64 nrle_xid;
} __packed;
struct apfs_nx_reap_list_phys {
struct apfs_obj_phys nrl_o;
__le64 nrl_next;
__le32 nrl_flags;
__le32 nrl_max;
__le32 nrl_count;
__le32 nrl_first;
__le32 nrl_last;
__le32 nrl_free;
struct apfs_nx_reap_list_entry nrl_entries[];
} __packed;
/* EFI constants */
#define APFS_NX_EFI_JUMPSTART_MAGIC 0x5244534A
#define APFS_NX_EFI_JUMPSTART_VERSION 1
/*
* Information about the embedded EFI driver
*/
struct apfs_nx_efi_jumpstart {
struct apfs_obj_phys nej_o;
__le32 nej_magic;
__le32 nej_version;
__le32 nej_efi_file_len;
__le32 nej_num_extents;
__le64 nej_reserved[16];
struct apfs_prange nej_rec_extents[];
} __packed;
/* Main container */
/* Container constants */
#define APFS_NX_MAGIC 0x4253584E
#define APFS_NX_BLOCK_NUM 0
#define APFS_NX_MAX_FILE_SYSTEMS 100
#define APFS_NX_EPH_INFO_COUNT 4
#define APFS_NX_EPH_MIN_BLOCK_COUNT 8
#define APFS_NX_MAX_FILE_SYSTEM_EPH_STRUCTS 4
#define APFS_NX_TX_MIN_CHECKPOINT_COUNT 4
#define APFS_NX_EPH_INFO_VERSION_1 1
/* Container flags */
#define APFS_NX_RESERVED_1 0x00000001LL
#define APFS_NX_RESERVED_2 0x00000002LL
#define APFS_NX_CRYPTO_SW 0x00000004LL
#define APFS_NX_FLAGS_VALID_MASK (APFS_NX_RESERVED_1 \
| APFS_NX_RESERVED_2 \
| APFS_NX_CRYPTO_SW)
/* Optional container feature flags */
#define APFS_NX_FEATURE_DEFRAG 0x0000000000000001ULL
#define APFS_NX_FEATURE_LCFD 0x0000000000000002ULL
#define APFS_NX_SUPPORTED_FEATURES_MASK (APFS_NX_FEATURE_DEFRAG | \
APFS_NX_FEATURE_LCFD)
/* Read-only compatible container feature flags */
#define APFS_NX_SUPPORTED_ROCOMPAT_MASK (0x0ULL)
/* Incompatible container feature flags */
#define APFS_NX_INCOMPAT_VERSION1 0x0000000000000001ULL
#define APFS_NX_INCOMPAT_VERSION2 0x0000000000000002ULL
#define APFS_NX_INCOMPAT_FUSION 0x0000000000000100ULL
#define APFS_NX_SUPPORTED_INCOMPAT_MASK (APFS_NX_INCOMPAT_VERSION2 \
| APFS_NX_INCOMPAT_FUSION)
/* Block and container sizes */
#define APFS_NX_MINIMUM_BLOCK_SIZE 4096
#define APFS_NX_DEFAULT_BLOCK_SIZE 4096
#define APFS_NX_MAXIMUM_BLOCK_SIZE 65536
#define APFS_NX_MINIMUM_CONTAINER_SIZE 1048576
/* Indexes into a container superblock's array of counters */
enum {
APFS_NX_CNTR_OBJ_CKSUM_SET = 0,
APFS_NX_CNTR_OBJ_CKSUM_FAIL = 1,
APFS_NX_NUM_COUNTERS = 32
};
#if LINUX_VERSION_CODE < KERNEL_VERSION(4, 13, 0)
#define UUID_SIZE 16
#endif
/*
* On-disk representation of the container superblock
*/
struct apfs_nx_superblock {
/*00*/ struct apfs_obj_phys nx_o;
/*20*/ __le32 nx_magic;
__le32 nx_block_size;
__le64 nx_block_count;
/*30*/ __le64 nx_features;
__le64 nx_readonly_compatible_features;
__le64 nx_incompatible_features;
/*48*/ char nx_uuid[UUID_SIZE];
/*58*/ __le64 nx_next_oid;
__le64 nx_next_xid;
/*68*/ __le32 nx_xp_desc_blocks;
__le32 nx_xp_data_blocks;
/*70*/ __le64 nx_xp_desc_base;
__le64 nx_xp_data_base;
__le32 nx_xp_desc_next;
__le32 nx_xp_data_next;
/*88*/ __le32 nx_xp_desc_index;
__le32 nx_xp_desc_len;
__le32 nx_xp_data_index;
__le32 nx_xp_data_len;
/*98*/ __le64 nx_spaceman_oid;
__le64 nx_omap_oid;
__le64 nx_reaper_oid;
/*B0*/ __le32 nx_test_type;
__le32 nx_max_file_systems;
/*B8*/ __le64 nx_fs_oid[APFS_NX_MAX_FILE_SYSTEMS];
/*3D8*/ __le64 nx_counters[APFS_NX_NUM_COUNTERS];
/*4D8*/ struct apfs_prange nx_blocked_out_prange;
__le64 nx_evict_mapping_tree_oid;
/*4F0*/ __le64 nx_flags;
__le64 nx_efi_jumpstart;