xref: /netbsd-src/usr.sbin/fstyp/apfs.c (revision a4a6d5326269481245746ed1bf886dfc3c02aaed)
1*a4a6d532Stkusumi /*	$NetBSD: apfs.c,v 1.1 2019/12/27 11:15:06 tkusumi Exp $	*/
2*a4a6d532Stkusumi /*
3*a4a6d532Stkusumi  * Copyright (c) 2019 Conrad Meyer <cem@FreeBSD.org>.  All rights reserved.
4*a4a6d532Stkusumi  *
5*a4a6d532Stkusumi  * Redistribution and use in source and binary forms, with or without
6*a4a6d532Stkusumi  * modification, are permitted provided that the following conditions
7*a4a6d532Stkusumi  * are met:
8*a4a6d532Stkusumi  * 1. Redistributions of source code must retain the above copyright
9*a4a6d532Stkusumi  *    notice, this list of conditions and the following disclaimer.
10*a4a6d532Stkusumi  * 2. Redistributions in binary form must reproduce the above copyright
11*a4a6d532Stkusumi  *    notice, this list of conditions and the following disclaimer in the
12*a4a6d532Stkusumi  *    documentation and/or other materials provided with the distribution.
13*a4a6d532Stkusumi  *
14*a4a6d532Stkusumi  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*a4a6d532Stkusumi  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*a4a6d532Stkusumi  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*a4a6d532Stkusumi  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*a4a6d532Stkusumi  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*a4a6d532Stkusumi  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*a4a6d532Stkusumi  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*a4a6d532Stkusumi  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*a4a6d532Stkusumi  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*a4a6d532Stkusumi  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*a4a6d532Stkusumi  * SUCH DAMAGE.
25*a4a6d532Stkusumi  */
26*a4a6d532Stkusumi #include <sys/cdefs.h>
27*a4a6d532Stkusumi __RCSID("$NetBSD: apfs.c,v 1.1 2019/12/27 11:15:06 tkusumi Exp $");
28*a4a6d532Stkusumi 
29*a4a6d532Stkusumi #include <assert.h>
30*a4a6d532Stkusumi #include <err.h>
31*a4a6d532Stkusumi #include <errno.h>
32*a4a6d532Stkusumi #include <stdbool.h>
33*a4a6d532Stkusumi #include <stdint.h>
34*a4a6d532Stkusumi #include <stdio.h>
35*a4a6d532Stkusumi #include <stdlib.h>
36*a4a6d532Stkusumi #include <string.h>
37*a4a6d532Stkusumi 
38*a4a6d532Stkusumi #include "fstyp.h"
39*a4a6d532Stkusumi 
40*a4a6d532Stkusumi /*
41*a4a6d532Stkusumi  * This really detects the container format, which might be best supported by
42*a4a6d532Stkusumi  * geom_part or a special GEOM class.
43*a4a6d532Stkusumi  *
44*a4a6d532Stkusumi  * https://developer.apple.com/support/downloads/Apple-File-System-Reference.pdf
45*a4a6d532Stkusumi  */
46*a4a6d532Stkusumi 
47*a4a6d532Stkusumi #define	NX_CKSUM_SZ		8
48*a4a6d532Stkusumi 
49*a4a6d532Stkusumi typedef uint64_t nx_oid_t;
50*a4a6d532Stkusumi 
51*a4a6d532Stkusumi typedef uint64_t nx_xid_t;
52*a4a6d532Stkusumi 
53*a4a6d532Stkusumi struct nx_obj {
54*a4a6d532Stkusumi 	uint8_t		o_cksum[NX_CKSUM_SZ];	/* Fletcher 64 */
55*a4a6d532Stkusumi 	nx_oid_t	o_oid;
56*a4a6d532Stkusumi 	nx_xid_t	o_xid;
57*a4a6d532Stkusumi 	uint32_t	o_type;
58*a4a6d532Stkusumi 	uint32_t	o_subtype;
59*a4a6d532Stkusumi };
60*a4a6d532Stkusumi 
61*a4a6d532Stkusumi /* nx_obj::o_oid */
62*a4a6d532Stkusumi #define	OID_NX_SUPERBLOCK	1
63*a4a6d532Stkusumi 
64*a4a6d532Stkusumi /* nx_obj::o_type: */
65*a4a6d532Stkusumi #define	OBJECT_TYPE_MASK		0x0000ffff
66*a4a6d532Stkusumi #define	OBJECT_TYPE_NX_SUPERBLOCK	0x00000001
67*a4a6d532Stkusumi #define	OBJECT_TYPE_FLAGS_MASK		0xffff0000
68*a4a6d532Stkusumi #define	OBJ_STORAGETYPE_MASK		0xc0000000
69*a4a6d532Stkusumi #define	OBJECT_TYPE_FLAGS_DEFINED_MASK	0xf8000000
70*a4a6d532Stkusumi #define	OBJ_STORAGE_VIRTUAL		0x00000000
71*a4a6d532Stkusumi #define	OBJ_STORAGE_EPHEMERAL		0x80000000
72*a4a6d532Stkusumi #define	OBJ_STORAGE_PHYSICAL		0x40000000
73*a4a6d532Stkusumi #define	OBJ_NOHEADER			0x20000000
74*a4a6d532Stkusumi #define	OBJ_ENCRYPTED			0x10000000
75*a4a6d532Stkusumi #define	OBJ_NONPERSISTENT		0x08000000
76*a4a6d532Stkusumi 
77*a4a6d532Stkusumi struct nx_superblock {
78*a4a6d532Stkusumi 	struct nx_obj	nx_o;
79*a4a6d532Stkusumi 	char		nx_magic[4];
80*a4a6d532Stkusumi 	/* ... other stuff that doesn't matter */
81*a4a6d532Stkusumi };
82*a4a6d532Stkusumi 
83*a4a6d532Stkusumi int
fstyp_apfs(FILE * fp,char * label,size_t size)84*a4a6d532Stkusumi fstyp_apfs(FILE *fp, char *label, size_t size)
85*a4a6d532Stkusumi {
86*a4a6d532Stkusumi 	struct nx_superblock *csb;
87*a4a6d532Stkusumi 	int retval;
88*a4a6d532Stkusumi 
89*a4a6d532Stkusumi 	retval = 1;
90*a4a6d532Stkusumi 	csb = read_buf(fp, 0, sizeof(*csb));
91*a4a6d532Stkusumi 	if (csb == NULL)
92*a4a6d532Stkusumi 		goto fail;
93*a4a6d532Stkusumi 
94*a4a6d532Stkusumi 	/* Ideally, checksum the SB here. */
95*a4a6d532Stkusumi 	if (strncmp(csb->nx_magic, "NXSB", 4) != 0 ||
96*a4a6d532Stkusumi 	    csb->nx_o.o_oid != OID_NX_SUPERBLOCK ||
97*a4a6d532Stkusumi 	    (csb->nx_o.o_type & OBJECT_TYPE_MASK) != OBJECT_TYPE_NX_SUPERBLOCK)
98*a4a6d532Stkusumi 		goto fail;
99*a4a6d532Stkusumi 
100*a4a6d532Stkusumi 	retval = 0;
101*a4a6d532Stkusumi 
102*a4a6d532Stkusumi 	/* No label support yet. */
103*a4a6d532Stkusumi 
104*a4a6d532Stkusumi fail:
105*a4a6d532Stkusumi 	free(csb);
106*a4a6d532Stkusumi 	return (retval);
107*a4a6d532Stkusumi }
108