xref: /freebsd/sys/fs/ext2fs/ext2_inode_cnv.c (revision 47dd1d1b619cc035b82b49a91a25544309ff95ae)
1 /*-
2  * SPDX-License-Identifier: MIT-CMU
3  *
4  * Copyright (c) 1995 The University of Utah and
5  * the Computer Systems Laboratory at the University of Utah (CSL).
6  * All rights reserved.
7  *
8  * Permission to use, copy, modify and distribute this software is hereby
9  * granted provided that (1) source code retains these copyright, permission,
10  * and disclaimer notices, and (2) redistributions including binaries
11  * reproduce the notices in supporting documentation, and (3) all advertising
12  * materials mentioning features or use of this software display the following
13  * acknowledgement: ``This product includes software developed by the
14  * Computer Systems Laboratory at the University of Utah.''
15  *
16  * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
17  * IS" CONDITION.  THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
18  * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
19  *
20  * CSL requests users of this software to return to csl-dist@cs.utah.edu any
21  * improvements that they make and grant CSL redistribution rights.
22  *
23  *      Utah $Hdr$
24  * $FreeBSD$
25  */
26 
27 /*
28  * routines to convert on disk ext2 inodes into inodes and back
29  */
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/endian.h>
33 #include <sys/lock.h>
34 #include <sys/stat.h>
35 #include <sys/vnode.h>
36 
37 #include <fs/ext2fs/ext2fs.h>
38 #include <fs/ext2fs/fs.h>
39 #include <fs/ext2fs/inode.h>
40 #include <fs/ext2fs/ext2fs.h>
41 #include <fs/ext2fs/ext2_dinode.h>
42 #include <fs/ext2fs/ext2_extern.h>
43 
44 #define XTIME_TO_NSEC(x)	((x & EXT3_NSEC_MASK) >> 2)
45 #define NSEC_TO_XTIME(t)	(le32toh(t << 2) & EXT3_NSEC_MASK)
46 
47 #ifdef EXT2FS_DEBUG
48 void
49 ext2_print_inode(struct inode *in)
50 {
51 	int i;
52 	struct ext4_extent_header *ehp;
53 	struct ext4_extent *ep;
54 
55 	printf("Inode: %5ju", (uintmax_t)in->i_number);
56 	printf(	/* "Inode: %5d" */
57 	    " Type: %10s Mode: 0x%o Flags: 0x%x  Version: %d acl: 0x%lx\n",
58 	    "n/a", in->i_mode, in->i_flags, in->i_gen, in->i_facl);
59 	printf("User: %5u Group: %5u  Size: %ju\n",
60 	    in->i_uid, in->i_gid, (uintmax_t)in->i_size);
61 	printf("Links: %3d Blockcount: %ju\n",
62 	    in->i_nlink, (uintmax_t)in->i_blocks);
63 	printf("ctime: 0x%x", in->i_ctime);
64 	printf("atime: 0x%x", in->i_atime);
65 	printf("mtime: 0x%x", in->i_mtime);
66 	if (E2DI_HAS_XTIME(in))
67 		printf("crtime %#x ", in->i_birthtime);
68 	if (in->i_flag & IN_E4EXTENTS) {
69 		printf("Extents:\n");
70 		ehp = (struct ext4_extent_header *)in->i_db;
71 		printf("Header (magic 0x%x entries %d max %d depth %d gen %d)\n",
72 		    ehp->eh_magic, ehp->eh_ecount, ehp->eh_max, ehp->eh_depth,
73 		    ehp->eh_gen);
74 		ep = (struct ext4_extent *)(char *)(ehp + 1);
75 		printf("Index (blk %d len %d start_lo %d start_hi %d)\n", ep->e_blk,
76 		    ep->e_len, ep->e_start_lo, ep->e_start_hi);
77 		printf("\n");
78 	} else {
79 		printf("BLOCKS:");
80 		for (i = 0; i < (in->i_blocks <= 24 ? (in->i_blocks + 1) / 2 : 12); i++)
81 			printf("  %d", in->i_db[i]);
82 		printf("\n");
83 	}
84 }
85 #endif	/* EXT2FS_DEBUG */
86 
87 /*
88  *	raw ext2 inode to inode
89  */
90 int
91 ext2_ei2i(struct ext2fs_dinode *ei, struct inode *ip)
92 {
93 	struct m_ext2fs *fs;
94 	const static struct ext2fs_dinode ei_zero;
95 
96 	fs = ip->i_e2fs;
97 	ip->i_nlink = ei->e2di_nlink;
98 	/*
99 	 * Godmar thinks - if the link count is zero, then the inode is
100 	 * unused - according to ext2 standards. Ufs marks this fact by
101 	 * setting i_mode to zero - why ? I can see that this might lead to
102 	 * problems in an undelete.
103 	 */
104 	ip->i_mode = ei->e2di_nlink ? ei->e2di_mode : 0;
105 	ip->i_size = ei->e2di_size;
106 	if (S_ISREG(ip->i_mode))
107 		ip->i_size |= ((u_int64_t)ei->e2di_size_high) << 32;
108 	ip->i_atime = ei->e2di_atime;
109 	ip->i_mtime = ei->e2di_mtime;
110 	ip->i_ctime = ei->e2di_ctime;
111 	if (E2DI_HAS_XTIME(ip)) {
112 		ip->i_atimensec = XTIME_TO_NSEC(ei->e2di_atime_extra);
113 		ip->i_mtimensec = XTIME_TO_NSEC(ei->e2di_mtime_extra);
114 		ip->i_ctimensec = XTIME_TO_NSEC(ei->e2di_ctime_extra);
115 		ip->i_birthtime = ei->e2di_crtime;
116 		ip->i_birthnsec = XTIME_TO_NSEC(ei->e2di_crtime_extra);
117 	}
118 	ip->i_flags = 0;
119 	ip->i_flags |= (ei->e2di_flags & EXT2_APPEND) ? SF_APPEND : 0;
120 	ip->i_flags |= (ei->e2di_flags & EXT2_IMMUTABLE) ? SF_IMMUTABLE : 0;
121 	ip->i_flags |= (ei->e2di_flags & EXT2_NODUMP) ? UF_NODUMP : 0;
122 	ip->i_flag |= (ei->e2di_flags & EXT3_INDEX) ? IN_E3INDEX : 0;
123 	ip->i_flag |= (ei->e2di_flags & EXT4_EXTENTS) ? IN_E4EXTENTS : 0;
124 	ip->i_blocks = ei->e2di_nblock;
125 	ip->i_facl = ei->e2di_facl;
126 	if (E2DI_HAS_HUGE_FILE(ip)) {
127 		ip->i_blocks |= (uint64_t)ei->e2di_nblock_high << 32;
128 		ip->i_facl |= (uint64_t)ei->e2di_facl_high << 32;
129 		if (ei->e2di_flags & EXT4_HUGE_FILE)
130 			ip->i_blocks = fsbtodb(ip->i_e2fs, ip->i_blocks);
131 	}
132 	ip->i_gen = ei->e2di_gen;
133 	ip->i_uid = ei->e2di_uid;
134 	ip->i_gid = ei->e2di_gid;
135 	ip->i_uid |= (uint32_t)ei->e2di_uid_high << 16;
136 	ip->i_gid |= (uint32_t)ei->e2di_gid_high << 16;
137 
138 	memcpy(ip->i_data, ei->e2di_blocks, sizeof(ei->e2di_blocks));
139 
140 	if (EXT2_HAS_RO_COMPAT_FEATURE(fs, EXT2F_ROCOMPAT_METADATA_CKSUM) &&
141 	    memcmp(ei, &ei_zero, EXT2_INODE_SIZE(fs)))
142 		return (ext2_ei_csum_verify(ip, ei));
143 
144 	return (0);
145 }
146 
147 /*
148  *	inode to raw ext2 inode
149  */
150 int
151 ext2_i2ei(struct inode *ip, struct ext2fs_dinode *ei)
152 {
153 	struct m_ext2fs *fs;
154 
155 	fs = ip->i_e2fs;
156 	ei->e2di_mode = ip->i_mode;
157 	ei->e2di_nlink = ip->i_nlink;
158 	/*
159 	 * Godmar thinks: if dtime is nonzero, ext2 says this inode has been
160 	 * deleted, this would correspond to a zero link count
161 	 */
162 	ei->e2di_dtime = ei->e2di_nlink ? 0 : ip->i_mtime;
163 	ei->e2di_size = ip->i_size;
164 	if (S_ISREG(ip->i_mode))
165 		ei->e2di_size_high = ip->i_size >> 32;
166 	ei->e2di_atime = ip->i_atime;
167 	ei->e2di_mtime = ip->i_mtime;
168 	ei->e2di_ctime = ip->i_ctime;
169 	if (E2DI_HAS_XTIME(ip)) {
170 		ei->e2di_ctime_extra = NSEC_TO_XTIME(ip->i_ctimensec);
171 		ei->e2di_mtime_extra = NSEC_TO_XTIME(ip->i_mtimensec);
172 		ei->e2di_atime_extra = NSEC_TO_XTIME(ip->i_atimensec);
173 		ei->e2di_crtime = ip->i_birthtime;
174 		ei->e2di_crtime_extra = NSEC_TO_XTIME(ip->i_birthnsec);
175 	}
176 	ei->e2di_flags = 0;
177 	ei->e2di_flags |= (ip->i_flags & SF_APPEND) ? EXT2_APPEND : 0;
178 	ei->e2di_flags |= (ip->i_flags & SF_IMMUTABLE) ? EXT2_IMMUTABLE : 0;
179 	ei->e2di_flags |= (ip->i_flags & UF_NODUMP) ? EXT2_NODUMP : 0;
180 	ei->e2di_flags |= (ip->i_flag & IN_E3INDEX) ? EXT3_INDEX : 0;
181 	ei->e2di_flags |= (ip->i_flag & IN_E4EXTENTS) ? EXT4_EXTENTS : 0;
182 	if (ip->i_blocks > ~0U &&
183 	    !EXT2_HAS_RO_COMPAT_FEATURE(fs, EXT2F_ROCOMPAT_HUGE_FILE)) {
184 		ext2_fserr(fs, ip->i_uid, "i_blocks value is out of range");
185 		return (EIO);
186 	}
187 	if (ip->i_blocks <= 0xffffffffffffULL) {
188 		ei->e2di_nblock = ip->i_blocks & 0xffffffff;
189 		ei->e2di_nblock_high = ip->i_blocks >> 32 & 0xffff;
190 	} else {
191 		ei->e2di_flags |= EXT4_HUGE_FILE;
192 		ei->e2di_nblock = dbtofsb(fs, ip->i_blocks);
193 		ei->e2di_nblock_high = dbtofsb(fs, ip->i_blocks) >> 32 & 0xffff;
194 	}
195 	ei->e2di_facl = ip->i_facl & 0xffffffff;
196 	ei->e2di_facl_high = ip->i_facl >> 32 & 0xffff;
197 	ei->e2di_gen = ip->i_gen;
198 	ei->e2di_uid = ip->i_uid & 0xffff;
199 	ei->e2di_uid_high = ip->i_uid >> 16 & 0xffff;
200 	ei->e2di_gid = ip->i_gid & 0xffff;
201 	ei->e2di_gid_high = ip->i_gid >> 16 & 0xffff;
202 
203 	memcpy(ei->e2di_blocks, ip->i_data, sizeof(ei->e2di_blocks));
204 
205 	/* Set inode csum */
206 	ext2_ei_csum_set(ip, ei);
207 
208 	return (0);
209 }
210