- sync usage() to man
[dragonfly.git] / sbin / hammer / hammer.c
1 /*
2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sbin/hammer/hammer.c,v 1.43 2008/10/08 21:01:54 thomas Exp $
35  */
36
37 #include "hammer.h"
38 #include <signal.h>
39 #include <math.h>
40
41 static void hammer_parsedevs(const char *blkdevs);
42 static void sigalrm(int signo);
43 static void usage(int exit_code);
44
45 int RecurseOpt;
46 int VerboseOpt;
47 int QuietOpt;
48 int NoSyncOpt;
49 int TwoWayPipeOpt;
50 int TimeoutOpt;
51 int DelayOpt = 5;
52 u_int64_t BandwidthOpt;
53 const char *CyclePath;
54 const char *LinkPath;
55
56 int
57 main(int ac, char **av)
58 {
59         char *blkdevs = NULL;
60         char *ptr;
61         u_int32_t status;
62         int ch;
63
64         while ((ch = getopt(ac, av, "b:c:dhf:i:qrs:t:v2")) != -1) {
65                 switch(ch) {
66                 case '2':
67                         TwoWayPipeOpt = 1;
68                         break;
69                 case 'b':
70                         BandwidthOpt = strtoull(optarg, &ptr, 0);
71                         switch(*ptr) {
72                         case 'g':
73                         case 'G':
74                                 BandwidthOpt *= 1024;
75                                 /* fall through */
76                         case 'm':
77                         case 'M':
78                                 BandwidthOpt *= 1024;
79                                 /* fall through */
80                         case 'k':
81                         case 'K':
82                                 BandwidthOpt *= 1024;
83                                 break;
84                         default:
85                                 usage(1);
86                         }
87                         break;
88                 case 'c':
89                         CyclePath = optarg;
90                         break;
91                 case 'd':
92                         ++DebugOpt;
93                         break;
94                 case 'h':
95                         usage(0);
96                         /* not reached */
97                 case 'i':
98                         DelayOpt = strtol(optarg, NULL, 0);
99                         break;
100                 case 'r':
101                         RecurseOpt = 1;
102                         break;
103                 case 'f':
104                         blkdevs = optarg;
105                         break;
106                 case 's':
107                         LinkPath = optarg;
108                         break;
109                 case 't':
110                         TimeoutOpt = strtol(optarg, NULL, 0);
111                         break;
112                 case 'v':
113                         if (QuietOpt > 0)
114                                 --QuietOpt;
115                         else
116                                 ++VerboseOpt;
117                         break;
118                 case 'q':
119                         if (VerboseOpt > 0)
120                                 --VerboseOpt;
121                         else
122                                 ++QuietOpt;
123                         break;
124                 default:
125                         usage(1);
126                         /* not reached */
127                 }
128         }
129         ac -= optind;
130         av += optind;
131         if (ac < 1) {
132                 usage(1);
133                 /* not reached */
134         }
135
136         signal(SIGALRM, sigalrm);
137
138         if (strcmp(av[0], "synctid") == 0) {
139                 hammer_cmd_synctid(av + 1, ac - 1);
140                 exit(0);
141         }
142         if (strcmp(av[0], "namekey") == 0) {
143                 int64_t key;
144
145                 if (av[1] == NULL)
146                         usage(1);
147                 key = (int64_t)(crc32(av[1], strlen(av[1])) & 0x7FFFFFFF) << 32;
148                 if (key == 0)
149                         key |= 0x100000000LL;
150                 printf("0x%016llx\n", key);
151                 exit(0);
152         }
153         if (strcmp(av[0], "namekey32") == 0) {
154                 int32_t key;
155
156                 if (av[1] == NULL)
157                         usage(1);
158                 key = crc32(av[1], strlen(av[1])) & 0x7FFFFFFF;
159                 if (key == 0)
160                         ++key;
161                 printf("0x%08x\n", key);
162                 exit(0);
163         }
164         if (strcmp(av[0], "pfs-status") == 0) {
165                 hammer_cmd_pseudofs_status(av + 1, ac - 1);
166                 exit(0);
167         }
168         if (strcmp(av[0], "pfs-master") == 0) {
169                 hammer_cmd_pseudofs_create(av + 1, ac - 1, 0);
170                 exit(0);
171         }
172         if (strcmp(av[0], "pfs-slave") == 0) {
173                 hammer_cmd_pseudofs_create(av + 1, ac - 1, 1);
174                 exit(0);
175         }
176         if (strcmp(av[0], "pfs-update") == 0) {
177                 hammer_cmd_pseudofs_update(av + 1, ac - 1);
178                 exit(0);
179         }
180         if (strcmp(av[0], "pfs-upgrade") == 0) {
181                 hammer_cmd_pseudofs_upgrade(av + 1, ac - 1);
182                 exit(0);
183         }
184         if (strcmp(av[0], "pfs-downgrade") == 0) {
185                 hammer_cmd_pseudofs_downgrade(av + 1, ac - 1);
186                 exit(0);
187         }
188         if (strcmp(av[0], "pfs-destroy") == 0) {
189                 hammer_cmd_pseudofs_destroy(av + 1, ac - 1);
190                 exit(0);
191         }
192         if (strcmp(av[0], "status") == 0) {
193                 hammer_cmd_status(av + 1, ac - 1);
194                 exit(0);
195         }
196         if (strcmp(av[0], "prune") == 0) {
197                 hammer_cmd_softprune(av + 1, ac - 1, 0);
198                 exit(0);
199         }
200         if (strcmp(av[0], "cleanup") == 0) {
201                 hammer_cmd_cleanup(av + 1, ac - 1);
202                 exit(0);
203         }
204         if (strcmp(av[0], "prune-everything") == 0) {
205                 hammer_cmd_softprune(av + 1, ac - 1, 1);
206                 exit(0);
207         }
208         if (strcmp(av[0], "snapshot") == 0) {
209                 hammer_cmd_snapshot(av + 1, ac - 1);
210                 exit(0);
211         }
212         if (strcmp(av[0], "bstats") == 0) {
213                 hammer_cmd_bstats(av + 1, ac - 1);
214                 exit(0);
215         }
216         if (strcmp(av[0], "iostats") == 0) {
217                 hammer_cmd_iostats(av + 1, ac - 1);
218                 exit(0);
219         }
220
221         if (strncmp(av[0], "history", 7) == 0) {
222                 hammer_cmd_history(av[0] + 7, av + 1, ac - 1);
223                 exit(0);
224         }
225         if (strncmp(av[0], "reblock", 7) == 0) {
226                 signal(SIGINT, sigalrm);
227                 if (strcmp(av[0], "reblock") == 0)
228                         hammer_cmd_reblock(av + 1, ac - 1, -1);
229                 else if (strcmp(av[0], "reblock-btree") == 0)
230                         hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_BTREE);
231                 else if (strcmp(av[0], "reblock-inodes") == 0)
232                         hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_INODES);
233                 else if (strcmp(av[0], "reblock-dirs") == 0)
234                         hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_DIRS);
235                 else if (strcmp(av[0], "reblock-data") == 0)
236                         hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_DATA);
237                 else
238                         usage(1);
239                 exit(0);
240         }
241         if (strncmp(av[0], "mirror", 6) == 0) {
242                 if (strcmp(av[0], "mirror-read") == 0)
243                         hammer_cmd_mirror_read(av + 1, ac - 1, 0);
244                 else if (strcmp(av[0], "mirror-read-stream") == 0)
245                         hammer_cmd_mirror_read(av + 1, ac - 1, 1);
246                 else if (strcmp(av[0], "mirror-write") == 0)
247                         hammer_cmd_mirror_write(av + 1, ac - 1);
248                 else if (strcmp(av[0], "mirror-copy") == 0)
249                         hammer_cmd_mirror_copy(av + 1, ac - 1, 0);
250                 else if (strcmp(av[0], "mirror-stream") == 0)
251                         hammer_cmd_mirror_copy(av + 1, ac - 1, 1);
252                 else if (strcmp(av[0], "mirror-dump") == 0)
253                         hammer_cmd_mirror_dump();
254                 else
255                         usage(1);
256                 exit(0);
257         }
258
259         uuid_name_lookup(&Hammer_FSType, "DragonFly HAMMER", &status);
260         if (status != uuid_s_ok) {
261                 errx(1, "uuids file does not have the DragonFly "
262                         "HAMMER filesystem type");
263         }
264
265         if (strcmp(av[0], "show") == 0) {
266                 hammer_off_t node_offset = (hammer_off_t)-1;
267
268                 hammer_parsedevs(blkdevs);
269                 if (ac > 1)
270                         sscanf(av[1], "%llx", &node_offset);
271                 hammer_cmd_show(node_offset, 0, NULL, NULL);
272                 exit(0);
273         }
274         if (strcmp(av[0], "blockmap") == 0) {
275                 hammer_parsedevs(blkdevs);
276                 hammer_cmd_blockmap();
277                 exit(0);
278         }
279         usage(1);
280         /* not reached */
281         return(0);
282 }
283
284 static
285 void
286 hammer_parsedevs(const char *blkdevs)
287 {
288         char *copy;
289         char *volname;
290
291         if (blkdevs == NULL) {
292                 errx(1, "A -f blkdev[:blkdev]* specification is required "
293                         "for this command");
294         }
295
296         copy = strdup(blkdevs);
297         while ((volname = copy) != NULL) {
298                 if ((copy = strchr(copy, ':')) != NULL)
299                         *copy++ = 0;
300                 setup_volume(-1, volname, 0, O_RDONLY);
301         }
302 }
303
304 static
305 void
306 sigalrm(int signo __unused)
307 {
308         /* do nothing (interrupts HAMMER ioctl) */
309 }
310
311 static
312 void
313 usage(int exit_code)
314 {
315         fprintf(stderr, 
316                 "hammer -h\n"
317                 "hammer [-2qrv] [-b bandwidth] [-c cyclefile] [-f blkdev[:blkdev]*]\n"
318                 "       [-i delay ] [-t seconds] command [argument ...]\n"
319                 "hammer synctid <filesystem> [quick]\n"
320                 "hammer bstats [interval]\n"
321                 "hammer iostats [interval]\n"
322                 "hammer history[@offset[,len]] <file> ...\n"
323                 "hammer -f blkdev[:blkdev]* [-r] show [offset]\n"
324 #if 0
325                 "hammer -f blkdev[:blkdev]* blockmap\n"
326 #endif
327                 "hammer namekey[32] <path>\n"
328                 "hammer cleanup [<filesystem> ...]\n"
329                 "hammer snapshot [<filesystem>] <snapshot-dir>\n"
330                 "hammer prune <softlink-dir>\n"
331                 "hammer prune-everything <filesystem>\n"
332                 "hammer reblock[-btree/inodes/dirs/data] "
333                         "<filesystem> [fill_percentage]\n"
334                 "hammer pfs-status <dirpath> ...\n"
335                 "hammer pfs-master <dirpath> [options]\n"
336                 "hammer pfs-slave <dirpath> [options]\n"
337                 "hammer pfs-update <dirpath> [options]\n"
338                 "hammer pfs-upgrade <dirpath>\n"
339                 "hammer pfs-downgrade <dirpath>\n"
340                 "hammer pfs-destroy <dirpath>\n"
341                 "hammer mirror-read <filesystem> [begin-tid]\n"
342                 "hammer mirror-read-stream <filesystem> [begin-tid]\n"
343                 "hammer mirror-write <filesystem>\n"
344                 "hammer mirror-dump\n"
345                 "hammer mirror-copy [[user@]host:]<filesystem>"
346                                   " [[user@]host:]<filesystem>\n"
347                 "hammer mirror-stream [[user@]host:]<filesystem>"
348                                     " [[user@]host:]<filesystem>\n"
349         );
350         exit(exit_code);
351 }
352