set_fields.c revision b7c5b4030870b31d73019d9d9ec55d550772590b
1/*
2 * set_fields.c --- set a superblock value
3 *
4 * Copyright (C) 2000, 2001, 2002, 2003, 2004 by Theodore Ts'o.
5 *
6 * %Begin-Header%
7 * This file may be redistributed under the terms of the GNU Public
8 * License.
9 * %End-Header%
10 */
11
12#define _XOPEN_SOURCE 600 /* for inclusion of strptime() and strtoull */
13
14#ifdef HAVE_STRTOULL
15#define STRTOULL strtoull
16#else
17#define STRTOULL strtoul
18#endif
19
20#include <stdio.h>
21#include <unistd.h>
22#include <stdlib.h>
23#include <ctype.h>
24#include <string.h>
25#include <strings.h>
26#include <time.h>
27#include <sys/types.h>
28#include <sys/stat.h>
29#ifdef HAVE_ERRNO_H
30#include <errno.h>
31#endif
32#if HAVE_STRINGS_H
33#include <strings.h>
34#endif
35#include <fcntl.h>
36#include <utime.h>
37
38#include "debugfs.h"
39#include "uuid/uuid.h"
40#include "e2p/e2p.h"
41
42static struct ext2_super_block set_sb;
43static struct ext2_inode set_inode;
44static struct ext2_group_desc set_gd;
45static dgrp_t set_bg;
46static ext2_ino_t set_ino;
47static int array_idx;
48
49#define FLAG_ARRAY	0x0001
50
51struct field_set_info {
52	const char	*name;
53	void	*ptr;
54	unsigned int	size;
55	errcode_t (*func)(struct field_set_info *info, char *arg);
56	int flags;
57	int max_idx;
58};
59
60static errcode_t parse_uint(struct field_set_info *info, char *arg);
61static errcode_t parse_int(struct field_set_info *info, char *arg);
62static errcode_t parse_string(struct field_set_info *info, char *arg);
63static errcode_t parse_uuid(struct field_set_info *info, char *arg);
64static errcode_t parse_hashalg(struct field_set_info *info, char *arg);
65static errcode_t parse_time(struct field_set_info *info, char *arg);
66static errcode_t parse_bmap(struct field_set_info *info, char *arg);
67static errcode_t parse_gd_csum(struct field_set_info *info, char *arg);
68
69static struct field_set_info super_fields[] = {
70	{ "inodes_count", &set_sb.s_inodes_count, 4, parse_uint },
71	{ "blocks_count", &set_sb.s_blocks_count, 4, parse_uint },
72	{ "r_blocks_count", &set_sb.s_r_blocks_count, 4, parse_uint },
73	{ "free_blocks_count", &set_sb.s_free_blocks_count, 4, parse_uint },
74	{ "free_inodes_count", &set_sb.s_free_inodes_count, 4, parse_uint },
75	{ "first_data_block", &set_sb.s_first_data_block, 4, parse_uint },
76	{ "log_block_size", &set_sb.s_log_block_size, 4, parse_uint },
77	{ "log_frag_size", &set_sb.s_log_frag_size, 4, parse_int },
78	{ "blocks_per_group", &set_sb.s_blocks_per_group, 4, parse_uint },
79	{ "frags_per_group", &set_sb.s_frags_per_group, 4, parse_uint },
80	{ "inodes_per_group", &set_sb.s_inodes_per_group, 4, parse_uint },
81	{ "mtime", &set_sb.s_mtime, 4, parse_time },
82	{ "wtime", &set_sb.s_wtime, 4, parse_time },
83	{ "mnt_count", &set_sb.s_mnt_count, 2, parse_uint },
84	{ "max_mnt_count", &set_sb.s_max_mnt_count, 2, parse_int },
85	/* s_magic */
86	{ "state", &set_sb.s_state, 2, parse_uint },
87	{ "errors", &set_sb.s_errors, 2, parse_uint },
88	{ "minor_rev_level", &set_sb.s_minor_rev_level, 2, parse_uint },
89	{ "lastcheck", &set_sb.s_lastcheck, 4, parse_time },
90	{ "checkinterval", &set_sb.s_checkinterval, 4, parse_uint },
91	{ "creator_os", &set_sb.s_creator_os, 4, parse_uint },
92	{ "rev_level", &set_sb.s_rev_level, 4, parse_uint },
93	{ "def_resuid", &set_sb.s_def_resuid, 2, parse_uint },
94	{ "def_resgid", &set_sb.s_def_resgid, 2, parse_uint },
95	{ "first_ino", &set_sb.s_first_ino, 4, parse_uint },
96	{ "inode_size", &set_sb.s_inode_size, 2, parse_uint },
97	{ "block_group_nr", &set_sb.s_block_group_nr, 2, parse_uint },
98	{ "feature_compat", &set_sb.s_feature_compat, 4, parse_uint },
99	{ "feature_incompat", &set_sb.s_feature_incompat, 4, parse_uint },
100	{ "feature_ro_compat", &set_sb.s_feature_ro_compat, 4, parse_uint },
101	{ "uuid", &set_sb.s_uuid, 16, parse_uuid },
102	{ "volume_name",  &set_sb.s_volume_name, 16, parse_string },
103	{ "last_mounted",  &set_sb.s_last_mounted, 64, parse_string },
104	{ "lastcheck",  &set_sb.s_lastcheck, 4, parse_uint },
105	{ "algorithm_usage_bitmap", &set_sb.s_algorithm_usage_bitmap,
106		  4, parse_uint },
107	{ "prealloc_blocks", &set_sb.s_prealloc_blocks, 1, parse_uint },
108	{ "prealloc_dir_blocks", &set_sb.s_prealloc_dir_blocks, 1,
109		  parse_uint },
110	{ "reserved_gdt_blocks", &set_sb.s_reserved_gdt_blocks, 2,
111		  parse_uint },
112	{ "journal_uuid", &set_sb.s_journal_uuid, 16, parse_uuid },
113	{ "journal_inum", &set_sb.s_journal_inum, 4, parse_uint },
114	{ "journal_dev", &set_sb.s_journal_dev, 4, parse_uint },
115	{ "last_orphan", &set_sb.s_last_orphan, 4, parse_uint },
116	{ "hash_seed", &set_sb.s_hash_seed, 16, parse_uuid },
117	{ "def_hash_version", &set_sb.s_def_hash_version, 1, parse_hashalg },
118	{ "jnl_backup_type", &set_sb.s_jnl_backup_type, 1, parse_uint },
119	{ "desc_size", &set_sb.s_desc_size, 2, parse_uint },
120	{ "default_mount_opts", &set_sb.s_default_mount_opts, 4, parse_uint },
121	{ "first_meta_bg", &set_sb.s_first_meta_bg, 4, parse_uint },
122	{ "mkfs_time", &set_sb.s_mkfs_time, 4, parse_time },
123	{ "jnl_blocks", &set_sb.s_jnl_blocks[0], 4, parse_uint, FLAG_ARRAY,
124	  17 },
125	{ "blocks_count_hi", &set_sb.s_blocks_count_hi, 4, parse_uint },
126	{ "r_blocks_count_hi", &set_sb.s_r_blocks_count_hi, 4, parse_uint },
127	{ "min_extra_isize", &set_sb.s_min_extra_isize, 2, parse_uint },
128	{ "want_extra_isize", &set_sb.s_want_extra_isize, 2, parse_uint },
129	{ "flags", &set_sb.s_flags, 4, parse_uint },
130	{ "raid_stride", &set_sb.s_raid_stride, 2, parse_uint },
131	{ "min_extra_isize", &set_sb.s_min_extra_isize, 4, parse_uint },
132	{ "mmp_interval", &set_sb.s_mmp_interval, 2, parse_uint },
133	{ "mmp_block", &set_sb.s_mmp_block, 8, parse_uint },
134	{ "raid_stripe_width", &set_sb.s_raid_stripe_width, 4, parse_uint },
135	{ "log_groups_per_flex", &set_sb.s_log_groups_per_flex, 1, parse_uint },
136	{ "kbytes_written", &set_sb.s_kbytes_written, 8, parse_uint },
137	{ 0, 0, 0, 0 }
138};
139
140static struct field_set_info inode_fields[] = {
141	{ "inodes_count", &set_sb.s_inodes_count, 4, parse_uint },
142	{ "mode", &set_inode.i_mode, 2, parse_uint },
143	{ "uid", &set_inode.i_uid, 2, parse_uint },
144	{ "size", &set_inode.i_size, 4, parse_uint },
145	{ "atime", &set_inode.i_atime, 4, parse_time },
146	{ "ctime", &set_inode.i_ctime, 4, parse_time },
147	{ "mtime", &set_inode.i_mtime, 4, parse_time },
148	{ "dtime", &set_inode.i_dtime, 4, parse_time },
149	{ "gid", &set_inode.i_gid, 2, parse_uint },
150	{ "links_count", &set_inode.i_links_count, 2, parse_uint },
151	{ "blocks", &set_inode.i_blocks, 4, parse_uint },
152	{ "flags", &set_inode.i_flags, 4, parse_uint },
153	{ "version", &set_inode.osd1.linux1.l_i_version, 4, parse_uint },
154	{ "translator", &set_inode.osd1.hurd1.h_i_translator, 4, parse_uint },
155	{ "block", &set_inode.i_block[0], 4, parse_uint, FLAG_ARRAY,
156	  EXT2_NDIR_BLOCKS },
157	{ "block[IND]", &set_inode.i_block[EXT2_IND_BLOCK], 4, parse_uint },
158	{ "block[DIND]", &set_inode.i_block[EXT2_DIND_BLOCK], 4, parse_uint },
159	{ "block[TIND]", &set_inode.i_block[EXT2_TIND_BLOCK], 4, parse_uint },
160	{ "generation", &set_inode.i_generation, 4, parse_uint },
161	{ "file_acl", &set_inode.i_file_acl, 4, parse_uint },
162	{ "dir_acl", &set_inode.i_dir_acl, 4, parse_uint },
163	{ "size_high", &set_inode.i_size_high, 4, parse_uint },
164	{ "faddr", &set_inode.i_faddr, 4, parse_uint },
165	{ "blocks_hi", &set_inode.osd2.linux2.l_i_blocks_hi, 2, parse_uint },
166	{ "frag", &set_inode.osd2.hurd2.h_i_frag, 1, parse_uint },
167	{ "fsize", &set_inode.osd2.hurd2.h_i_fsize, 1, parse_uint },
168	{ "uid_high", &set_inode.osd2.linux2.l_i_uid_high, 2, parse_uint },
169	{ "gid_high", &set_inode.osd2.linux2.l_i_gid_high, 2, parse_uint },
170	{ "author", &set_inode.osd2.hurd2.h_i_author, 4, parse_uint },
171	{ "bmap", NULL, 4, parse_bmap, FLAG_ARRAY },
172	{ 0, 0, 0, 0 }
173};
174
175static struct field_set_info ext2_bg_fields[] = {
176	{ "block_bitmap", &set_gd.bg_block_bitmap, 4, parse_uint },
177	{ "inode_bitmap", &set_gd.bg_inode_bitmap, 4, parse_uint },
178	{ "inode_table", &set_gd.bg_inode_table, 4, parse_uint },
179	{ "free_blocks_count", &set_gd.bg_free_blocks_count, 2, parse_uint },
180	{ "free_inodes_count", &set_gd.bg_free_inodes_count, 2, parse_uint },
181	{ "used_dirs_count", &set_gd.bg_used_dirs_count, 2, parse_uint },
182	{ "flags", &set_gd.bg_flags, 2, parse_uint },
183	{ "reserved", &set_gd.bg_reserved, 2, parse_uint, FLAG_ARRAY, 2 },
184	{ "itable_unused", &set_gd.bg_itable_unused, 2, parse_uint },
185	{ "checksum", &set_gd.bg_checksum, 2, parse_gd_csum },
186	{ 0, 0, 0, 0 }
187};
188
189
190static struct field_set_info *find_field(struct field_set_info *fields,
191					 char *field)
192{
193	struct field_set_info *ss;
194	const char	*prefix;
195	char		*arg, *delim, *idx, *tmp;
196	int		prefix_len;
197
198	if (fields == super_fields)
199		prefix = "s_";
200	else if (fields == inode_fields)
201		prefix = "i_";
202	else
203		prefix = "bg_";
204	prefix_len = strlen(prefix);
205	if (strncmp(field, prefix, prefix_len) == 0)
206		field += prefix_len;
207
208	arg = malloc(strlen(field)+1);
209	if (!arg)
210		return NULL;
211	strcpy(arg, field);
212
213	idx = strchr(arg, '[');
214	if (idx) {
215		*idx++ = 0;
216		delim = idx + strlen(idx) - 1;
217		if (!*idx || *delim != ']')
218			idx = 0;
219		else
220			*delim = 0;
221	}
222	/*
223	 * Can we parse the number?
224	 */
225	if (idx) {
226		array_idx = strtol(idx, &tmp, 0);
227		if (*tmp)
228			idx = 0;
229	}
230
231	for (ss = fields ; ss->name ; ss++) {
232		if (ss->flags & FLAG_ARRAY) {
233			if (!idx || (strcmp(ss->name, arg) != 0))
234				continue;
235			if (ss->max_idx > 0 && array_idx >= ss->max_idx)
236				continue;
237		} else {
238			if (strcmp(ss->name, field) != 0)
239				continue;
240		}
241		return ss;
242	}
243
244	return NULL;
245}
246
247static errcode_t parse_uint(struct field_set_info *info, char *arg)
248{
249	unsigned long long num, limit;
250	char *tmp;
251	union {
252		__u64	*ptr64;
253		__u32	*ptr32;
254		__u16	*ptr16;
255		__u8	*ptr8;
256	} u;
257
258	u.ptr8 = (__u8 *) info->ptr;
259	if (info->flags & FLAG_ARRAY)
260		u.ptr8 += array_idx * info->size;
261
262	errno = 0;
263	num = STRTOULL(arg, &tmp, 0);
264	if (*tmp || errno) {
265		fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
266			arg, info->name);
267		return EINVAL;
268	}
269	limit = ~0ULL >> ((8 - info->size) * 8);
270	if (num > limit) {
271		fprintf(stderr, "Value '%s' exceeds field %s maximum %llu.\n",
272			arg, info->name, limit);
273		return EINVAL;
274	}
275	switch (info->size) {
276	case 8:
277		*u.ptr64 = num;
278		break;
279	case 4:
280		*u.ptr32 = num;
281		break;
282	case 2:
283		*u.ptr16 = num;
284		break;
285	case 1:
286		*u.ptr8 = num;
287		break;
288	}
289	return 0;
290}
291
292static errcode_t parse_int(struct field_set_info *info, char *arg)
293{
294	long	num;
295	char *tmp;
296	__s32	*ptr32;
297	__s16	*ptr16;
298	__s8	*ptr8;
299
300	num = strtol(arg, &tmp, 0);
301	if (*tmp) {
302		fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
303			arg, info->name);
304		return EINVAL;
305	}
306	switch (info->size) {
307	case 4:
308		ptr32 = (__s32 *) info->ptr;
309		*ptr32 = num;
310		break;
311	case 2:
312		ptr16 = (__s16 *) info->ptr;
313		*ptr16 = num;
314		break;
315	case 1:
316		ptr8 = (__s8 *) info->ptr;
317		*ptr8 = num;
318		break;
319	}
320	return 0;
321}
322
323static errcode_t parse_string(struct field_set_info *info, char *arg)
324{
325	char	*cp = (char *) info->ptr;
326
327	if (strlen(arg) >= info->size) {
328		fprintf(stderr, "Error maximum size for %s is %d.\n",
329			info->name, info->size);
330		return EINVAL;
331	}
332	strcpy(cp, arg);
333	return 0;
334}
335
336static errcode_t parse_time(struct field_set_info *info, char *arg)
337{
338	time_t		t;
339	__u32		*ptr32;
340
341	ptr32 = (__u32 *) info->ptr;
342
343	t = string_to_time(arg);
344
345	if (t == ((time_t) -1)) {
346		fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
347			arg, info->name);
348		return EINVAL;
349	}
350	*ptr32 = t;
351	return 0;
352}
353
354static errcode_t parse_uuid(struct field_set_info *info, char *arg)
355{
356	unsigned char *	p = (unsigned char *) info->ptr;
357
358	if ((strcasecmp(arg, "null") == 0) ||
359	    (strcasecmp(arg, "clear") == 0)) {
360		uuid_clear(p);
361	} else if (strcasecmp(arg, "time") == 0) {
362		uuid_generate_time(p);
363	} else if (strcasecmp(arg, "random") == 0) {
364		uuid_generate(p);
365	} else if (uuid_parse(arg, p)) {
366		fprintf(stderr, "Invalid UUID format: %s\n", arg);
367		return EINVAL;
368	}
369	return 0;
370}
371
372static errcode_t parse_hashalg(struct field_set_info *info, char *arg)
373{
374	int	hashv;
375	unsigned char	*p = (unsigned char *) info->ptr;
376
377	hashv = e2p_string2hash(arg);
378	if (hashv < 0) {
379		fprintf(stderr, "Invalid hash algorithm: %s\n", arg);
380		return EINVAL;
381	}
382	*p = hashv;
383	return 0;
384}
385
386static errcode_t parse_bmap(struct field_set_info *info, char *arg)
387{
388	unsigned long	num;
389	blk_t		blk;
390	errcode_t	retval;
391	char		*tmp;
392
393	num = strtoul(arg, &tmp, 0);
394	if (*tmp) {
395		fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
396			arg, info->name);
397		return EINVAL;
398	}
399	blk = num;
400
401	retval = ext2fs_bmap(current_fs, set_ino, &set_inode, 0, BMAP_SET,
402			     array_idx, &blk);
403	if (retval) {
404		com_err("set_inode", retval, "while setting block map");
405	}
406	return retval;
407}
408
409static errcode_t parse_gd_csum(struct field_set_info *info, char *arg)
410{
411
412	if (strcmp(arg, "calc") == 0) {
413		ext2fs_group_desc_csum_set(current_fs, set_bg);
414		set_gd = current_fs->group_desc[set_bg];
415		printf("Checksum set to 0x%04x\n",
416		       current_fs->group_desc[set_bg].bg_checksum);
417		return 0;
418	}
419
420	return parse_uint(info, arg);
421}
422
423static void print_possible_fields(struct field_set_info *fields)
424{
425	struct field_set_info *ss;
426	const char	*type, *cmd;
427	FILE *f;
428	char name[40], idx[40];
429
430	if (fields == super_fields) {
431		type = "Superblock";
432		cmd = "set_super_value";
433	} else if (fields == inode_fields) {
434		type = "Inode";
435		cmd = "set_inode";
436	} else {
437		type = "Block group descriptor";
438		cmd = "set_block_group";
439	}
440	f = open_pager();
441
442	fprintf(f, "%s fields supported by the %s command:\n", type, cmd);
443
444	for (ss = fields ; ss->name ; ss++) {
445		type = "unknown";
446		if (ss->func == parse_string)
447			type = "string";
448		else if (ss->func == parse_int)
449			type = "integer";
450		else if (ss->func == parse_uint)
451			type = "unsigned integer";
452		else if (ss->func == parse_uuid)
453			type = "UUID";
454		else if (ss->func == parse_hashalg)
455			type = "hash algorithm";
456		else if (ss->func == parse_time)
457			type = "date/time";
458		else if (ss->func == parse_bmap)
459			type = "set physical->logical block map";
460		strcpy(name, ss->name);
461		if (ss->flags & FLAG_ARRAY) {
462			if (ss->max_idx > 0)
463				sprintf(idx, "[%d]", ss->max_idx);
464			else
465				strcpy(idx, "[]");
466			strcat(name, idx);
467		}
468		fprintf(f, "\t%-20s\t%s\n", name, type);
469	}
470	close_pager(f);
471}
472
473
474void do_set_super(int argc, char *argv[])
475{
476	const char *usage = "<field> <value>\n"
477		"\t\"set_super_value -l\" will list the names of "
478		"superblock fields\n\twhich can be set.";
479	static struct field_set_info *ss;
480
481	if ((argc == 2) && !strcmp(argv[1], "-l")) {
482		print_possible_fields(super_fields);
483		return;
484	}
485
486	if (common_args_process(argc, argv, 3, 3, "set_super_value",
487				usage, CHECK_FS_RW))
488		return;
489
490	if ((ss = find_field(super_fields, argv[1])) == 0) {
491		com_err(argv[0], 0, "invalid field specifier: %s", argv[1]);
492		return;
493	}
494	set_sb = *current_fs->super;
495	if (ss->func(ss, argv[2]) == 0) {
496		*current_fs->super = set_sb;
497		ext2fs_mark_super_dirty(current_fs);
498	}
499}
500
501void do_set_inode(int argc, char *argv[])
502{
503	const char *usage = "<inode> <field> <value>\n"
504		"\t\"set_inode_field -l\" will list the names of "
505		"the fields in an ext2 inode\n\twhich can be set.";
506	static struct field_set_info *ss;
507
508	if ((argc == 2) && !strcmp(argv[1], "-l")) {
509		print_possible_fields(inode_fields);
510		return;
511	}
512
513	if (common_args_process(argc, argv, 4, 4, "set_inode",
514				usage, CHECK_FS_RW))
515		return;
516
517	if ((ss = find_field(inode_fields, argv[2])) == 0) {
518		com_err(argv[0], 0, "invalid field specifier: %s", argv[2]);
519		return;
520	}
521
522	set_ino = string_to_inode(argv[1]);
523	if (!set_ino)
524		return;
525
526	if (debugfs_read_inode(set_ino, &set_inode, argv[1]))
527		return;
528
529	if (ss->func(ss, argv[3]) == 0) {
530		if (debugfs_write_inode(set_ino, &set_inode, argv[1]))
531			return;
532	}
533}
534
535void do_set_block_group_descriptor(int argc, char *argv[])
536{
537	const char *usage = "<bg number> <field> <value>\n"
538		"\t\"set_block_group_descriptor -l\" will list the names of "
539		"the fields in a block group descriptor\n\twhich can be set.";
540	struct field_set_info	*ss;
541	char			*end;
542
543	if ((argc == 2) && !strcmp(argv[1], "-l")) {
544		print_possible_fields(ext2_bg_fields);
545		return;
546	}
547
548	if (common_args_process(argc, argv, 4, 4, "set_block_group_descriptor",
549				usage, CHECK_FS_RW))
550		return;
551
552	set_bg = strtoul(argv[1], &end, 0);
553	if (*end) {
554		com_err(argv[0], 0, "invalid block group number: %s", argv[1]);
555		return;
556	}
557
558	if (set_bg >= current_fs->group_desc_count) {
559		com_err(argv[0], 0, "block group number too big: %d", set_bg);
560		return;
561	}
562
563
564	if ((ss = find_field(ext2_bg_fields, argv[2])) == 0) {
565		com_err(argv[0], 0, "invalid field specifier: %s", argv[2]);
566		return;
567	}
568
569	set_gd = current_fs->group_desc[set_bg];
570
571	if (ss->func(ss, argv[3]) == 0) {
572		current_fs->group_desc[set_bg] = set_gd;
573		ext2fs_mark_super_dirty(current_fs);
574	}
575}
576