Adjust permissions of various files.
[dragonfly.git] / sbin / hammer / hammer.h
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
35 #ifndef HAMMER_HAMMER_H_
36 #define HAMMER_HAMMER_H_
37
38 #include "hammer_util.h"
39
40 /*
41  * pidfile management - common definitions so code is more robust
42  */
43 #define PIDFILE_BUFSIZE 512
44 static const char pidfile_loc[] = "/var/run";
45
46 /*
47  * WARNING: Do not make the SNAPSHOTS_BASE "/var/snapshots" because
48  * it will interfere with the older HAMMER VERS < 3 snapshots directory
49  * for the /var PFS.
50  */
51 #define SNAPSHOTS_BASE  "/var/hammer"   /* HAMMER VERS >= 3 */
52
53 extern int RecurseOpt;
54 extern int VerboseOpt;
55 extern int QuietOpt;
56 extern int TwoWayPipeOpt;
57 extern int TimeoutOpt;
58 extern int DelayOpt;
59 extern char *SshPort;
60 extern int CompressOpt;
61 extern int ForceYesOpt;
62 extern int RunningIoctl;
63 extern int DidInterrupt;
64 extern int ForceOpt;
65 extern int BulkOpt;
66 extern int AllPFS;
67 extern uint64_t BandwidthOpt;
68 extern uint64_t SplitupOpt;
69 extern uint64_t MemoryLimit;
70 extern const char *SplitupOptStr;
71 extern const char *CyclePath;
72 extern const char *ScoreBoardFile;
73 extern const char *RestrictTarget;
74
75 void hammer_cmd_synctid(char **av, int ac);
76 void hammer_cmd_pseudofs_status(char **av, int ac);
77 void hammer_cmd_pseudofs_create(char **av, int ac, int is_slave);
78 void hammer_cmd_pseudofs_update(char **av, int ac);
79 void hammer_cmd_pseudofs_upgrade(char **av, int ac);
80 void hammer_cmd_pseudofs_downgrade(char **av, int ac);
81 void hammer_cmd_pseudofs_destroy(char **av, int ac);
82 void hammer_cmd_softprune(char **av, int ac, int everything_opt);
83 void hammer_cmd_config(char **av, int ac);
84 void hammer_cmd_viconfig(char **av, int ac);
85 void hammer_cmd_cleanup(char **av, int ac);
86 void hammer_cmd_abort_cleanup(char **av, int ac);
87 void hammer_cmd_info(char **av, int ac);
88 void hammer_cmd_sshremote(const char *cmd, const char *target) __dead2;
89 void hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase);
90 void hammer_cmd_snapls(char **av, int ac);
91 void hammer_cmd_snaprm(char **av, int ac);
92 void hammer_cmd_snapshot(char **av, int ac);
93 void hammer_cmd_bstats(char **av, int ac) __dead2;
94 void hammer_cmd_iostats(char **av, int ac) __dead2;
95 void hammer_cmd_stats(char **av, int ac) __dead2;
96 void hammer_cmd_history(const char *offset_str, char **av, int ac);
97 void hammer_cmd_rebalance(char **av, int ac);
98 void hammer_cmd_reblock(char **av, int ac, int flags);
99 void hammer_cmd_mirror_read(char **av, int ac, int streaming);
100 void hammer_cmd_mirror_write(char **av, int ac);
101 void hammer_cmd_mirror_copy(char **av, int ac, int streaming);
102 void hammer_cmd_mirror_dump(char **av, int ac);
103 void hammer_cmd_dedup_simulate(char **av, int ac);
104 void hammer_cmd_dedup(char **av, int ac);
105 void hammer_cmd_get_version(char **av, int ac);
106 void hammer_cmd_set_version(char **av, int ac);
107 void hammer_cmd_volume_add(char **av, int ac);
108 void hammer_cmd_volume_del(char **av, int ac);
109 void hammer_cmd_volume_list(char **av, int ac);
110 void hammer_cmd_volume_blkdevs(char **av, int ac);
111 void hammer_cmd_show(const char *arg, int filter, int obfuscate, int indent);
112 void hammer_cmd_show_undo(void);
113 void hammer_cmd_recover(char **av, int ac);
114 void hammer_cmd_blockmap(void);
115 void hammer_cmd_checkmap(void);
116 void hammer_cmd_strip(void);
117
118 void hammer_get_cycle(hammer_base_elm_t base, hammer_tid_t *tidp);
119 void hammer_set_cycle(hammer_base_elm_t base, hammer_tid_t tid);
120 void hammer_reset_cycle(void);
121
122 void clrpfs(struct hammer_ioc_pseudofs_rw *pfs, hammer_pseudofs_data_t pfsd,
123         int pfs_id);
124 int getpfs(struct hammer_ioc_pseudofs_rw *pfs, const char *path);
125 void relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs);
126 void dump_pfsd(hammer_pseudofs_data_t, int);
127 int hammer_softprune_testdir(const char *dirname);
128
129 #endif /* !HAMMER_HAMMER_H_ */