85d5101f40e8653d193d32e4304390aa5902c9f5
[sven/exfatprogs.git] / dump / dump.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *   Copyright (C) 2021 Namjae Jeon <linkinjeon@kernel.org>
4  */
5
6 #include <stdio.h>
7 #include <stdlib.h>
8 #include <string.h>
9 #include <unistd.h>
10 #include <getopt.h>
11 #include <errno.h>
12 #include <locale.h>
13 #include <inttypes.h>
14
15 #include "exfat_ondisk.h"
16 #include "libexfat.h"
17
18 #define EXFAT_MIN_SECT_SIZE_BITS                9
19 #define EXFAT_MAX_SECT_SIZE_BITS                12
20 #define BITS_PER_BYTE                           8
21 #define BITS_PER_BYTE_MASK                      0x7
22
23 static const unsigned char used_bit[] = {
24         0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4, 1, 2, 2, 3,/*  0 ~  19*/
25         2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5, 1, 2, 2, 3, 2, 3, 3, 4,/* 20 ~  39*/
26         2, 3, 3, 4, 3, 4, 4, 5, 2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5,/* 40 ~  59*/
27         4, 5, 5, 6, 1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5,/* 60 ~  79*/
28         2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6, 2, 3, 3, 4,/* 80 ~  99*/
29         3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6, 3, 4, 4, 5, 4, 5, 5, 6,/*100 ~ 119*/
30         4, 5, 5, 6, 5, 6, 6, 7, 1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4,/*120 ~ 139*/
31         3, 4, 4, 5, 2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,/*140 ~ 159*/
32         2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6, 3, 4, 4, 5,/*160 ~ 179*/
33         4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7, 2, 3, 3, 4, 3, 4, 4, 5,/*180 ~ 199*/
34         3, 4, 4, 5, 4, 5, 5, 6, 3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6,/*200 ~ 219*/
35         5, 6, 6, 7, 3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7,/*220 ~ 239*/
36         4, 5, 5, 6, 5, 6, 6, 7, 5, 6, 6, 7, 6, 7, 7, 8             /*240 ~ 255*/
37 };
38
39 static void usage(void)
40 {
41         fprintf(stderr, "Usage: dump.exfat\n");
42         fprintf(stderr, "\t-V | --version                        Show version\n");
43         fprintf(stderr, "\t-h | --help                           Show help\n");
44
45         exit(EXIT_FAILURE);
46 }
47
48 static struct option opts[] = {
49         {"version",             no_argument,            NULL,   'V' },
50         {"help",                no_argument,            NULL,   'h' },
51         {"?",                   no_argument,            NULL,   '?' },
52         {NULL,                  0,                      NULL,    0  }
53 };
54
55 static unsigned int exfat_count_used_clusters(unsigned char *bitmap,
56                 unsigned long long bitmap_len)
57 {
58         unsigned int count = 0;
59         unsigned long long i;
60
61         for (i = 0; i < bitmap_len; i++)
62                 count += used_bit[bitmap[i]];
63
64         return count;
65 }
66
67 static int exfat_show_ondisk_all_info(struct exfat_blk_dev *bd)
68 {
69         struct pbr *ppbr;
70         struct bsx64 *pbsx;
71         struct exfat_dentry *ed;
72         unsigned int root_clu_off, bitmap_clu_off, bitmap_clu;
73         unsigned int total_clus, used_clus, clu_offset, root_clu;
74         unsigned long long bitmap_len;
75         int ret;
76         unsigned char *bitmap;
77         char *volume_label;
78
79         ppbr = malloc(bd->sector_size);
80         if (!ppbr) {
81                 exfat_err("Cannot allocate pbr: out of memory\n");
82                 return -ENOMEM;
83         }
84
85         /* read main boot sector */
86         ret = exfat_read_sector(bd, (char *)ppbr, BOOT_SEC_IDX);
87         if (ret < 0) {
88                 exfat_err("main boot sector read failed\n");
89                 ret = -EIO;
90                 goto free_ppbr;
91         }
92
93         pbsx = &ppbr->bsx;
94
95         if (pbsx->sect_size_bits < EXFAT_MIN_SECT_SIZE_BITS ||
96             pbsx->sect_size_bits > EXFAT_MAX_SECT_SIZE_BITS) {
97                 exfat_err("bogus sector size bits : %u\n",
98                                 pbsx->sect_size_bits);
99                 ret = -EINVAL;
100                 goto free_ppbr;
101         }
102
103         if (pbsx->sect_per_clus_bits > 25 - pbsx->sect_size_bits) {
104                 exfat_err("bogus sectors bits per cluster : %u\n",
105                                 pbsx->sect_per_clus_bits);
106                 ret = -EINVAL;
107                 goto free_ppbr;
108         }
109
110         if (bd->sector_size != 1 << pbsx->sect_size_bits) {
111                 exfat_err("bogus sector size : %u (sector size bits : %u)\n",
112                                 bd->sector_size, pbsx->sect_size_bits);
113                 ret = -EINVAL;
114                 goto free_ppbr;
115         }
116
117         clu_offset = le32_to_cpu(pbsx->clu_offset);
118         total_clus = le32_to_cpu(pbsx->clu_count);
119         root_clu = le32_to_cpu(pbsx->root_cluster);
120
121         exfat_info("-------------- Dump Boot sector region --------------\n");
122         exfat_info("Volume Length(sectors): \t\t%" PRIu64 "\n",
123                         le64_to_cpu(pbsx->vol_length));
124         exfat_info("FAT Offset(sector offset): \t\t%u\n",
125                         le32_to_cpu(pbsx->fat_offset));
126         exfat_info("FAT Length(sectors): \t\t\t%u\n",
127                         le32_to_cpu(pbsx->fat_length));
128         exfat_info("Cluster Heap Offset (sector offset): \t%u\n", clu_offset);
129         exfat_info("Cluster Count: \t\t\t\t%u\n", total_clus);
130         exfat_info("Root Cluster (cluster offset): \t\t%u\n", root_clu);
131         exfat_info("Volume Serial: \t\t\t\t0x%x\n", le32_to_cpu(pbsx->vol_serial));
132         exfat_info("Sector Size Bits: \t\t\t%u\n", pbsx->sect_size_bits);
133         exfat_info("Sector per Cluster bits: \t\t%u\n\n", pbsx->sect_per_clus_bits);
134
135         bd->cluster_size =
136                 1 << (pbsx->sect_per_clus_bits + pbsx->sect_size_bits);
137         root_clu_off = exfat_clus_to_blk_dev_off(bd, clu_offset, root_clu);
138
139         ed = malloc(sizeof(struct exfat_dentry)*3);
140         if (!ed) {
141                 exfat_err("failed to allocate memory\n");
142                 ret = -ENOMEM;
143                 goto free_ppbr;
144         }
145
146         ret = exfat_read(bd->dev_fd, ed, sizeof(struct exfat_dentry)*3,
147                         root_clu_off);
148         if (ret < 0) {
149                 exfat_err("bitmap entry read failed: %d\n", errno);
150                 ret = -EIO;
151                 goto free_entry;
152         }
153
154         volume_label = exfat_conv_volume_label(&ed[0]);
155         if (!volume_label) {
156                 ret = -EINVAL;
157                 goto free_entry;
158         }
159
160         bitmap_clu = le32_to_cpu(ed[1].bitmap_start_clu);
161         bitmap_clu_off = exfat_clus_to_blk_dev_off(bd, clu_offset,
162                         bitmap_clu);
163         bitmap_len = le64_to_cpu(ed[1].bitmap_size);
164
165         exfat_info("----------------- Dump Root entries -----------------\n");
166         exfat_info("Volume entry type: \t\t\t0x%x\n", ed[0].type);
167         exfat_info("Volume label: \t\t\t\t%s\n", volume_label);
168         exfat_info("Volume label character count: \t\t%u\n", ed[0].vol_char_cnt);
169
170         exfat_info("Bitmap entry type: \t\t\t0x%x\n", ed[1].type);
171         exfat_info("Bitmap start cluster: \t\t\t%x\n", bitmap_clu);
172         exfat_info("Bitmap size: \t\t\t\t%llu\n", bitmap_len);
173
174         exfat_info("Upcase table entry type: \t\t0x%x\n", ed[2].type);
175         exfat_info("Upcase table start cluster: \t\t%x\n",
176                         le32_to_cpu(ed[2].upcase_start_clu));
177         exfat_info("Upcase table size: \t\t\t%" PRIu64 "\n\n",
178                         le64_to_cpu(ed[2].upcase_size));
179
180         bitmap = malloc(bitmap_len);
181         if (!bitmap) {
182                 exfat_err("bitmap allocation failed\n");
183                 ret = -ENOMEM;
184                 goto free_volume_label;
185         }
186
187         ret = exfat_read(bd->dev_fd, bitmap, bitmap_len, bitmap_clu_off);
188         if (ret < 0) {
189                 exfat_err("bitmap entry read failed: %d\n", errno);
190                 ret = -EIO;
191                 free(bitmap);
192                 goto free_volume_label;
193         }
194
195         total_clus = le32_to_cpu(pbsx->clu_count);
196         used_clus = exfat_count_used_clusters(bitmap, bitmap_len);
197
198         exfat_info("---------------- Show the statistics ----------------\n");
199         exfat_info("Cluster size:  \t\t\t\t%u\n", bd->cluster_size);
200         exfat_info("Total Clusters: \t\t\t%u\n", total_clus);
201         exfat_info("Free Clusters: \t\t\t\t%u\n", total_clus-used_clus);
202         ret = 0;
203
204         free(bitmap);
205
206 free_volume_label:
207         free(volume_label);
208 free_entry:
209         free(ed);
210 free_ppbr:
211         free(ppbr);
212         return ret;
213 }
214
215 int main(int argc, char *argv[])
216 {
217         int c;
218         int ret = EXIT_FAILURE;
219         struct exfat_blk_dev bd;
220         struct exfat_user_input ui;
221         bool version_only = false;
222
223         init_user_input(&ui);
224
225         if (!setlocale(LC_CTYPE, ""))
226                 exfat_err("failed to init locale/codeset\n");
227
228         opterr = 0;
229         while ((c = getopt_long(argc, argv, "iVh", opts, NULL)) != EOF)
230                 switch (c) {
231                 case 'V':
232                         version_only = true;
233                         break;
234                 case '?':
235                 case 'h':
236                 default:
237                         usage();
238         }
239
240         show_version();
241         if (version_only)
242                 exit(EXIT_FAILURE);
243
244         if (argc < 2)
245                 usage();
246
247         memset(ui.dev_name, 0, sizeof(ui.dev_name));
248         snprintf(ui.dev_name, sizeof(ui.dev_name), "%s", argv[1]);
249
250         ret = exfat_get_blk_dev_info(&ui, &bd);
251         if (ret < 0)
252                 goto out;
253
254         ret = exfat_show_ondisk_all_info(&bd);
255         close(bd.dev_fd);
256
257 out:
258         return ret;
259 }