hammer2 - Flesh out span code, API cleanups
[dragonfly.git] / sbin / hammer2 / subs.c
1 /*
2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@dragonflybsd.org>
6  * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35
36 #include "hammer2.h"
37
38 /*
39  * Obtain a file descriptor that the caller can execute ioctl()'s on.
40  */
41 int
42 hammer2_ioctl_handle(const char *sel_path)
43 {
44         struct hammer2_ioc_version info;
45         int fd;
46
47         if (sel_path == NULL)
48                 sel_path = ".";
49
50         fd = open(sel_path, O_RDONLY, 0);
51         if (fd < 0) {
52                 fprintf(stderr, "hammer2: Unable to open %s: %s\n",
53                         sel_path, strerror(errno));
54                 return(-1);
55         }
56         if (ioctl(fd, HAMMER2IOC_VERSION_GET, &info) < 0) {
57                 fprintf(stderr, "hammer2: '%s' is not a hammer2 filesystem\n",
58                         sel_path);
59                 close(fd);
60                 return(-1);
61         }
62         return (fd);
63 }
64
65 /*
66  * Execute the specified function as a detached independent process/daemon,
67  * unless we are in debug mode.  If we are in debug mode the function is
68  * executed as a pthread in the current process.
69  */
70 void
71 hammer2_demon(void *(*func)(void *), void *arg)
72 {
73         pthread_t thread = NULL;
74         pid_t pid;
75         int ttyfd;
76
77         /*
78          * Do not disconnect in debug mode
79          */
80         if (DebugOpt) {
81                 pthread_create(&thread, NULL, func, arg);
82                 NormalExit = 0;
83                 return;
84         }
85
86         /*
87          * Otherwise disconnect us.  Double-fork to get rid of the ppid
88          * association and disconnect the TTY.
89          */
90         if ((pid = fork()) < 0) {
91                 fprintf(stderr, "hammer2: fork(): %s\n", strerror(errno));
92                 exit(1);
93         }
94         if (pid > 0) {
95                 while (waitpid(pid, NULL, 0) != pid)
96                         ;
97                 return;         /* parent returns */
98         }
99
100         /*
101          * Get rid of the TTY/session before double-forking to finish off
102          * the ppid.
103          */
104         ttyfd = open("/dev/null", O_RDWR);
105         if (ttyfd >= 0) {
106                 if (ttyfd != 0)
107                         dup2(ttyfd, 0);
108                 if (ttyfd != 1)
109                         dup2(ttyfd, 1);
110                 if (ttyfd != 2)
111                         dup2(ttyfd, 2);
112                 if (ttyfd > 2)
113                         close(ttyfd);
114         }
115
116         ttyfd = open("/dev/tty", O_RDWR);
117         if (ttyfd >= 0) {
118                 ioctl(ttyfd, TIOCNOTTY, 0);
119                 close(ttyfd);
120         }
121         setsid();
122
123         /*
124          * Second fork to disconnect ppid (the original parent waits for
125          * us to exit).
126          */
127         if ((pid = fork()) < 0) {
128                 _exit(2);
129         }
130         if (pid > 0)
131                 _exit(0);
132
133         /*
134          * The double child
135          */
136         setsid();
137         pthread_create(&thread, NULL, func, arg);
138         pthread_exit(NULL);
139         _exit(2);       /* NOT REACHED */
140 }
141
142 /*
143  * This swaps endian for a hammer2_msg_hdr.  Note that the extended
144  * header is not adjusted, just the core header.
145  */
146 void
147 hammer2_bswap_head(hammer2_msg_hdr_t *head)
148 {
149         head->magic     = bswap16(head->magic);
150         head->reserved02 = bswap16(head->reserved02);
151         head->salt      = bswap32(head->salt);
152
153         head->msgid     = bswap64(head->msgid);
154         head->spanid    = bswap64(head->spanid);
155
156         head->cmd       = bswap32(head->cmd);
157         head->aux_crc   = bswap32(head->aux_crc);
158         head->aux_bytes = bswap32(head->aux_bytes);
159         head->error     = bswap32(head->error);
160         head->aux_descr = bswap64(head->aux_descr);
161         head->reserved30= bswap64(head->reserved30);
162         head->reserved38= bswap32(head->reserved38);
163         head->hdr_crc   = bswap32(head->hdr_crc);
164 }
165
166 const char *
167 hammer2_time64_to_str(uint64_t htime64, char **strp)
168 {
169         struct tm *tp;
170         time_t t;
171
172         if (*strp) {
173                 free(*strp);
174                 *strp = NULL;
175         }
176         *strp = malloc(64);
177         t = htime64 / 1000000;
178         tp = localtime(&t);
179         strftime(*strp, 64, "%d-%b-%Y %H:%M:%S", tp);
180         return (*strp);
181 }
182
183 const char *
184 hammer2_uuid_to_str(uuid_t *uuid, char **strp)
185 {
186         uint32_t status;
187         if (*strp) {
188                 free(*strp);
189                 *strp = NULL;
190         }
191         uuid_to_string(uuid, strp, &status);
192         return (*strp);
193 }
194
195 const char *
196 hammer2_iptype_to_str(uint8_t type)
197 {
198         switch(type) {
199         case HAMMER2_OBJTYPE_UNKNOWN:
200                 return("UNKNOWN");
201         case HAMMER2_OBJTYPE_DIRECTORY:
202                 return("DIR");
203         case HAMMER2_OBJTYPE_REGFILE:
204                 return("FILE");
205         case HAMMER2_OBJTYPE_FIFO:
206                 return("FIFO");
207         case HAMMER2_OBJTYPE_CDEV:
208                 return("CDEV");
209         case HAMMER2_OBJTYPE_BDEV:
210                 return("BDEV");
211         case HAMMER2_OBJTYPE_SOFTLINK:
212                 return("SOFTLINK");
213         case HAMMER2_OBJTYPE_HARDLINK:
214                 return("HARDLINK");
215         case HAMMER2_OBJTYPE_SOCKET:
216                 return("SOCKET");
217         case HAMMER2_OBJTYPE_WHITEOUT:
218                 return("WHITEOUT");
219         default:
220                 return("ILLEGAL");
221         }
222 }
223
224 const char *
225 hammer2_pfstype_to_str(uint8_t type)
226 {
227         switch(type) {
228         case HAMMER2_PFSTYPE_NONE:
229                 return("NONE");
230         case HAMMER2_PFSTYPE_ADMIN:
231                 return("ADMIN");
232         case HAMMER2_PFSTYPE_CACHE:
233                 return("CACHE");
234         case HAMMER2_PFSTYPE_COPY:
235                 return("COPY");
236         case HAMMER2_PFSTYPE_SLAVE:
237                 return("SLAVE");
238         case HAMMER2_PFSTYPE_SOFT_SLAVE:
239                 return("SOFT_SLAVE");
240         case HAMMER2_PFSTYPE_SOFT_MASTER:
241                 return("SOFT_MASTER");
242         case HAMMER2_PFSTYPE_MASTER:
243                 return("MASTER");
244         default:
245                 return("ILLEGAL");
246         }
247 }
248
249 const char *
250 sizetostr(hammer2_off_t size)
251 {
252         static char buf[32];
253
254         if (size < 1024 / 2) {
255                 snprintf(buf, sizeof(buf), "%6.2f", (double)size);
256         } else if (size < 1024 * 1024 / 2) {
257                 snprintf(buf, sizeof(buf), "%6.2fKB",
258                         (double)size / 1024);
259         } else if (size < 1024 * 1024 * 1024LL / 2) {
260                 snprintf(buf, sizeof(buf), "%6.2fMB",
261                         (double)size / (1024 * 1024));
262         } else if (size < 1024 * 1024 * 1024LL * 1024LL / 2) {
263                 snprintf(buf, sizeof(buf), "%6.2fGB",
264                         (double)size / (1024 * 1024 * 1024LL));
265         } else {
266                 snprintf(buf, sizeof(buf), "%6.2fTB",
267                         (double)size / (1024 * 1024 * 1024LL * 1024LL));
268         }
269         return(buf);
270 }
271
272 /*
273  * Allocation wrappers give us shims for possible future use
274  */
275 void *
276 hammer2_alloc(size_t bytes)
277 {
278         void *ptr;
279
280         ptr = malloc(bytes);
281         assert(ptr);
282         bzero(ptr, bytes);
283         return (ptr);
284 }
285
286 void
287 hammer2_free(void *ptr)
288 {
289         free(ptr);
290 }