Whamcloud - gitweb
e4fdeee6d915305b1dffed832428c2b4bae4311e
[tools/e2fsprogs.git] / debugfs / set_fields.c
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
42 static struct ext2_super_block set_sb;
43 static struct ext2_inode set_inode;
44 static struct ext2_group_desc set_gd;
45 static dgrp_t set_bg;
46 static ext2_ino_t set_ino;
47 static int array_idx;
48
49 #define FLAG_ARRAY      0x0001
50
51 struct 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
60 static errcode_t parse_uint(struct field_set_info *info, char *arg);
61 static errcode_t parse_int(struct field_set_info *info, char *arg);
62 static errcode_t parse_string(struct field_set_info *info, char *arg);
63 static errcode_t parse_uuid(struct field_set_info *info, char *arg);
64 static errcode_t parse_hashalg(struct field_set_info *info, char *arg);
65 static errcode_t parse_time(struct field_set_info *info, char *arg);
66 static errcode_t parse_bmap(struct field_set_info *info, char *arg);
67 static errcode_t parse_gd_csum(struct field_set_info *info, char *arg);
68
69 static 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_cluster_size", &set_sb.s_log_cluster_size, 4, parse_int },
78         { "blocks_per_group", &set_sb.s_blocks_per_group, 4, parse_uint },
79         { "clusters_per_group", &set_sb.s_clusters_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         { "snapshot_inum", &set_sb.s_snapshot_inum, 4, parse_uint },
138         { "snapshot_id", &set_sb.s_snapshot_id, 4, parse_uint },
139         { "snapshot_r_blocks_count", &set_sb.s_snapshot_r_blocks_count, 8, 
140           parse_uint },
141         { "snapshot_list", &set_sb.s_snapshot_list, 4, parse_uint },
142         { "mount_opts",  &set_sb.s_mount_opts, 64, parse_string },
143         { "usr_quota_inum", &set_sb.s_usr_quota_inum, 4, parse_uint },
144         { "grp_quota_inum", &set_sb.s_grp_quota_inum, 4, parse_uint },
145         { "overhead_blocks", &set_sb.s_overhead_blocks, 4, parse_uint },
146         { 0, 0, 0, 0 }
147 };
148
149 static struct field_set_info inode_fields[] = {
150         { "inodes_count", &set_sb.s_inodes_count, 4, parse_uint },
151         { "mode", &set_inode.i_mode, 2, parse_uint },
152         { "uid", &set_inode.i_uid, 2, parse_uint },
153         { "size", &set_inode.i_size, 4, parse_uint },
154         { "atime", &set_inode.i_atime, 4, parse_time },
155         { "ctime", &set_inode.i_ctime, 4, parse_time },
156         { "mtime", &set_inode.i_mtime, 4, parse_time },
157         { "dtime", &set_inode.i_dtime, 4, parse_time },
158         { "gid", &set_inode.i_gid, 2, parse_uint },
159         { "links_count", &set_inode.i_links_count, 2, parse_uint },
160         { "blocks", &set_inode.i_blocks, 4, parse_uint },
161         { "flags", &set_inode.i_flags, 4, parse_uint },
162         { "version", &set_inode.osd1.linux1.l_i_version, 4, parse_uint },
163         { "translator", &set_inode.osd1.hurd1.h_i_translator, 4, parse_uint },
164         { "block", &set_inode.i_block[0], 4, parse_uint, FLAG_ARRAY,
165           EXT2_NDIR_BLOCKS },
166         { "block[IND]", &set_inode.i_block[EXT2_IND_BLOCK], 4, parse_uint },
167         { "block[DIND]", &set_inode.i_block[EXT2_DIND_BLOCK], 4, parse_uint },
168         { "block[TIND]", &set_inode.i_block[EXT2_TIND_BLOCK], 4, parse_uint },
169         { "generation", &set_inode.i_generation, 4, parse_uint },
170         { "file_acl", &set_inode.i_file_acl, 4, parse_uint },
171         { "file_acl_high", &set_inode.osd2.linux2.l_i_file_acl_high, 2,
172           parse_uint },
173         { "dir_acl", &set_inode.i_dir_acl, 4, parse_uint },
174         { "size_high", &set_inode.i_size_high, 4, parse_uint },
175         { "faddr", &set_inode.i_faddr, 4, parse_uint },
176         { "blocks_hi", &set_inode.osd2.linux2.l_i_blocks_hi, 2, parse_uint },
177         { "frag", &set_inode.osd2.hurd2.h_i_frag, 1, parse_uint },
178         { "fsize", &set_inode.osd2.hurd2.h_i_fsize, 1, parse_uint },
179         { "uid_high", &set_inode.osd2.linux2.l_i_uid_high, 2, parse_uint },
180         { "gid_high", &set_inode.osd2.linux2.l_i_gid_high, 2, parse_uint },
181         { "author", &set_inode.osd2.hurd2.h_i_author, 4, parse_uint },
182         { "bmap", NULL, 4, parse_bmap, FLAG_ARRAY },
183         { 0, 0, 0, 0 }
184 };
185
186 static struct field_set_info ext2_bg_fields[] = {
187         { "block_bitmap", &set_gd.bg_block_bitmap, 4, parse_uint },
188         { "inode_bitmap", &set_gd.bg_inode_bitmap, 4, parse_uint },
189         { "inode_table", &set_gd.bg_inode_table, 4, parse_uint },
190         { "free_blocks_count", &set_gd.bg_free_blocks_count, 2, parse_uint },
191         { "free_inodes_count", &set_gd.bg_free_inodes_count, 2, parse_uint },
192         { "used_dirs_count", &set_gd.bg_used_dirs_count, 2, parse_uint },
193         { "flags", &set_gd.bg_flags, 2, parse_uint },
194         { "reserved", &set_gd.bg_reserved, 2, parse_uint, FLAG_ARRAY, 2 },
195         { "itable_unused", &set_gd.bg_itable_unused, 2, parse_uint },
196         { "checksum", &set_gd.bg_checksum, 2, parse_gd_csum },
197         { 0, 0, 0, 0 }
198 };
199
200
201 static struct field_set_info *find_field(struct field_set_info *fields,
202                                          char *field)
203 {
204         struct field_set_info *ss;
205         const char      *prefix;
206         char            *arg, *delim, *idx, *tmp;
207         int             prefix_len;
208
209         if (fields == super_fields)
210                 prefix = "s_";
211         else if (fields == inode_fields)
212                 prefix = "i_";
213         else
214                 prefix = "bg_";
215         prefix_len = strlen(prefix);
216         if (strncmp(field, prefix, prefix_len) == 0)
217                 field += prefix_len;
218
219         arg = malloc(strlen(field)+1);
220         if (!arg)
221                 return NULL;
222         strcpy(arg, field);
223
224         idx = strchr(arg, '[');
225         if (idx) {
226                 *idx++ = 0;
227                 delim = idx + strlen(idx) - 1;
228                 if (!*idx || *delim != ']')
229                         idx = 0;
230                 else
231                         *delim = 0;
232         }
233         /*
234          * Can we parse the number?
235          */
236         if (idx) {
237                 array_idx = strtol(idx, &tmp, 0);
238                 if (*tmp)
239                         idx = 0;
240         }
241
242         for (ss = fields ; ss->name ; ss++) {
243                 if (ss->flags & FLAG_ARRAY) {
244                         if (!idx || (strcmp(ss->name, arg) != 0))
245                                 continue;
246                         if (ss->max_idx > 0 && array_idx >= ss->max_idx)
247                                 continue;
248                 } else {
249                         if (strcmp(ss->name, field) != 0)
250                                 continue;
251                 }
252                 free(arg);
253                 return ss;
254         }
255         free(arg);
256         return NULL;
257 }
258
259 static errcode_t parse_uint(struct field_set_info *info, char *arg)
260 {
261         unsigned long long num, limit;
262         char *tmp;
263         union {
264                 __u64   *ptr64;
265                 __u32   *ptr32;
266                 __u16   *ptr16;
267                 __u8    *ptr8;
268         } u;
269
270         u.ptr8 = (__u8 *) info->ptr;
271         if (info->flags & FLAG_ARRAY)
272                 u.ptr8 += array_idx * info->size;
273
274         errno = 0;
275         num = STRTOULL(arg, &tmp, 0);
276         if (*tmp || errno) {
277                 fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
278                         arg, info->name);
279                 return EINVAL;
280         }
281         limit = ~0ULL >> ((8 - info->size) * 8);
282         if (num > limit) {
283                 fprintf(stderr, "Value '%s' exceeds field %s maximum %llu.\n",
284                         arg, info->name, limit);
285                 return EINVAL;
286         }
287         switch (info->size) {
288         case 8:
289                 *u.ptr64 = num;
290                 break;
291         case 4:
292                 *u.ptr32 = num;
293                 break;
294         case 2:
295                 *u.ptr16 = num;
296                 break;
297         case 1:
298                 *u.ptr8 = num;
299                 break;
300         }
301         return 0;
302 }
303
304 static errcode_t parse_int(struct field_set_info *info, char *arg)
305 {
306         long    num;
307         char *tmp;
308         __s32   *ptr32;
309         __s16   *ptr16;
310         __s8    *ptr8;
311
312         num = strtol(arg, &tmp, 0);
313         if (*tmp) {
314                 fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
315                         arg, info->name);
316                 return EINVAL;
317         }
318         switch (info->size) {
319         case 4:
320                 ptr32 = (__s32 *) info->ptr;
321                 *ptr32 = num;
322                 break;
323         case 2:
324                 ptr16 = (__s16 *) info->ptr;
325                 *ptr16 = num;
326                 break;
327         case 1:
328                 ptr8 = (__s8 *) info->ptr;
329                 *ptr8 = num;
330                 break;
331         }
332         return 0;
333 }
334
335 static errcode_t parse_string(struct field_set_info *info, char *arg)
336 {
337         char    *cp = (char *) info->ptr;
338
339         if (strlen(arg) >= info->size) {
340                 fprintf(stderr, "Error maximum size for %s is %d.\n",
341                         info->name, info->size);
342                 return EINVAL;
343         }
344         strcpy(cp, arg);
345         return 0;
346 }
347
348 static errcode_t parse_time(struct field_set_info *info, char *arg)
349 {
350         time_t          t;
351         __u32           *ptr32;
352
353         ptr32 = (__u32 *) info->ptr;
354
355         t = string_to_time(arg);
356
357         if (t == ((time_t) -1)) {
358                 fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
359                         arg, info->name);
360                 return EINVAL;
361         }
362         *ptr32 = t;
363         return 0;
364 }
365
366 static errcode_t parse_uuid(struct field_set_info *info, char *arg)
367 {
368         unsigned char * p = (unsigned char *) info->ptr;
369
370         if ((strcasecmp(arg, "null") == 0) ||
371             (strcasecmp(arg, "clear") == 0)) {
372                 uuid_clear(p);
373         } else if (strcasecmp(arg, "time") == 0) {
374                 uuid_generate_time(p);
375         } else if (strcasecmp(arg, "random") == 0) {
376                 uuid_generate(p);
377         } else if (uuid_parse(arg, p)) {
378                 fprintf(stderr, "Invalid UUID format: %s\n", arg);
379                 return EINVAL;
380         }
381         return 0;
382 }
383
384 static errcode_t parse_hashalg(struct field_set_info *info, char *arg)
385 {
386         int     hashv;
387         unsigned char   *p = (unsigned char *) info->ptr;
388
389         hashv = e2p_string2hash(arg);
390         if (hashv < 0) {
391                 fprintf(stderr, "Invalid hash algorithm: %s\n", arg);
392                 return EINVAL;
393         }
394         *p = hashv;
395         return 0;
396 }
397
398 static errcode_t parse_bmap(struct field_set_info *info, char *arg)
399 {
400         unsigned long   num;
401         blk_t           blk;
402         errcode_t       retval;
403         char            *tmp;
404
405         num = strtoul(arg, &tmp, 0);
406         if (*tmp) {
407                 fprintf(stderr, "Couldn't parse '%s' for field %s.\n",
408                         arg, info->name);
409                 return EINVAL;
410         }
411         blk = num;
412
413         retval = ext2fs_bmap(current_fs, set_ino, &set_inode, 0, BMAP_SET,
414                              array_idx, &blk);
415         if (retval) {
416                 com_err("set_inode", retval, "while setting block map");
417         }
418         return retval;
419 }
420
421 static errcode_t parse_gd_csum(struct field_set_info *info, char *arg)
422 {
423
424         if (strcmp(arg, "calc") == 0) {
425                 ext2fs_group_desc_csum_set(current_fs, set_bg);
426                 set_gd = current_fs->group_desc[set_bg];
427                 printf("Checksum set to 0x%04x\n",
428                        current_fs->group_desc[set_bg].bg_checksum);
429                 return 0;
430         }
431
432         return parse_uint(info, arg);
433 }
434
435 static void print_possible_fields(struct field_set_info *fields)
436 {
437         struct field_set_info *ss;
438         const char      *type, *cmd;
439         FILE *f;
440         char name[40], idx[40];
441
442         if (fields == super_fields) {
443                 type = "Superblock";
444                 cmd = "set_super_value";
445         } else if (fields == inode_fields) {
446                 type = "Inode";
447                 cmd = "set_inode";
448         } else {
449                 type = "Block group descriptor";
450                 cmd = "set_block_group";
451         }
452         f = open_pager();
453
454         fprintf(f, "%s fields supported by the %s command:\n", type, cmd);
455
456         for (ss = fields ; ss->name ; ss++) {
457                 type = "unknown";
458                 if (ss->func == parse_string)
459                         type = "string";
460                 else if (ss->func == parse_int)
461                         type = "integer";
462                 else if (ss->func == parse_uint)
463                         type = "unsigned integer";
464                 else if (ss->func == parse_uuid)
465                         type = "UUID";
466                 else if (ss->func == parse_hashalg)
467                         type = "hash algorithm";
468                 else if (ss->func == parse_time)
469                         type = "date/time";
470                 else if (ss->func == parse_bmap)
471                         type = "set physical->logical block map";
472                 strcpy(name, ss->name);
473                 if (ss->flags & FLAG_ARRAY) {
474                         if (ss->max_idx > 0)
475                                 sprintf(idx, "[%d]", ss->max_idx);
476                         else
477                                 strcpy(idx, "[]");
478                         strcat(name, idx);
479                 }
480                 fprintf(f, "\t%-20s\t%s\n", name, type);
481         }
482         close_pager(f);
483 }
484
485
486 void do_set_super(int argc, char *argv[])
487 {
488         const char *usage = "<field> <value>\n"
489                 "\t\"set_super_value -l\" will list the names of "
490                 "superblock fields\n\twhich can be set.";
491         static struct field_set_info *ss;
492
493         if ((argc == 2) && !strcmp(argv[1], "-l")) {
494                 print_possible_fields(super_fields);
495                 return;
496         }
497
498         if (common_args_process(argc, argv, 3, 3, "set_super_value",
499                                 usage, CHECK_FS_RW))
500                 return;
501
502         if ((ss = find_field(super_fields, argv[1])) == 0) {
503                 com_err(argv[0], 0, "invalid field specifier: %s", argv[1]);
504                 return;
505         }
506         set_sb = *current_fs->super;
507         if (ss->func(ss, argv[2]) == 0) {
508                 *current_fs->super = set_sb;
509                 ext2fs_mark_super_dirty(current_fs);
510         }
511 }
512
513 void do_set_inode(int argc, char *argv[])
514 {
515         const char *usage = "<inode> <field> <value>\n"
516                 "\t\"set_inode_field -l\" will list the names of "
517                 "the fields in an ext2 inode\n\twhich can be set.";
518         static struct field_set_info *ss;
519
520         if ((argc == 2) && !strcmp(argv[1], "-l")) {
521                 print_possible_fields(inode_fields);
522                 return;
523         }
524
525         if (common_args_process(argc, argv, 4, 4, "set_inode",
526                                 usage, CHECK_FS_RW))
527                 return;
528
529         if ((ss = find_field(inode_fields, argv[2])) == 0) {
530                 com_err(argv[0], 0, "invalid field specifier: %s", argv[2]);
531                 return;
532         }
533
534         set_ino = string_to_inode(argv[1]);
535         if (!set_ino)
536                 return;
537
538         if (debugfs_read_inode(set_ino, &set_inode, argv[1]))
539                 return;
540
541         if (ss->func(ss, argv[3]) == 0) {
542                 if (debugfs_write_inode(set_ino, &set_inode, argv[1]))
543                         return;
544         }
545 }
546
547 void do_set_block_group_descriptor(int argc, char *argv[])
548 {
549         const char *usage = "<bg number> <field> <value>\n"
550                 "\t\"set_block_group_descriptor -l\" will list the names of "
551                 "the fields in a block group descriptor\n\twhich can be set.";
552         struct field_set_info   *ss;
553         char                    *end;
554
555         if ((argc == 2) && !strcmp(argv[1], "-l")) {
556                 print_possible_fields(ext2_bg_fields);
557                 return;
558         }
559
560         if (common_args_process(argc, argv, 4, 4, "set_block_group_descriptor",
561                                 usage, CHECK_FS_RW))
562                 return;
563
564         set_bg = strtoul(argv[1], &end, 0);
565         if (*end) {
566                 com_err(argv[0], 0, "invalid block group number: %s", argv[1]);
567                 return;
568         }
569
570         if (set_bg >= current_fs->group_desc_count) {
571                 com_err(argv[0], 0, "block group number too big: %d", set_bg);
572                 return;
573         }
574
575
576         if ((ss = find_field(ext2_bg_fields, argv[2])) == 0) {
577                 com_err(argv[0], 0, "invalid field specifier: %s", argv[2]);
578                 return;
579         }
580
581         set_gd = current_fs->group_desc[set_bg];
582
583         if (ss->func(ss, argv[3]) == 0) {
584                 current_fs->group_desc[set_bg] = set_gd;
585                 ext2fs_mark_super_dirty(current_fs);
586         }
587 }