hammer2 - Early messaging infrastructure
[dragonfly.git] / sbin / hammer2 / hammer2.h
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 /*
37  * Rollup headers for hammer2 utility
38  */
39 #include <sys/types.h>
40 #include <sys/uio.h>
41 #include <sys/mount.h>
42 #include <sys/file.h>
43 #include <sys/socket.h>
44 #include <sys/time.h>
45 #include <sys/wait.h>
46 #include <sys/tty.h>
47 #include <sys/endian.h>
48
49 #include <netinet/in.h>
50 #include <netinet/tcp.h>
51 #include <arpa/inet.h>
52 #include <netdb.h>
53
54 #include <vfs/hammer2/hammer2_disk.h>
55 #include <vfs/hammer2/hammer2_mount.h>
56 #include <vfs/hammer2/hammer2_ioctl.h>
57 #include <vfs/hammer2/hammer2_network.h>
58
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <stdarg.h>
62 #include <stddef.h>
63
64 #include <errno.h>
65 #include <fcntl.h>
66 #include <signal.h>
67 #include <string.h>
68 #include <unistd.h>
69 #include <ctype.h>
70 #include <uuid.h>
71 #include <assert.h>
72 #include <pthread.h>
73 #include <poll.h>
74
75 #include "network.h"
76
77 extern int DebugOpt;
78 extern int NormalExit;
79
80 int hammer2_ioctl_handle(const char *sel_path);
81 void hammer2_demon(void *(*func)(void *), void *arg);
82 void hammer2_bswap_head(hammer2_msg_hdr_t *head);
83
84 int cmd_remote_connect(const char *sel_path, const char *url);
85 int cmd_remote_disconnect(const char *sel_path, const char *url);
86 int cmd_remote_status(const char *sel_path, int all_opt);
87
88 int cmd_pfs_list(const char *sel_path);
89 int cmd_pfs_create(const char *sel_path, const char *name,
90                         uint8_t pfs_type, const char *uuid_str);
91 int cmd_pfs_delete(const char *sel_path, const char *name);
92
93 int cmd_node(void);
94 int cmd_leaf(const char *sel_path);
95 int cmd_debug(void);
96
97 void hammer2_ioq_init(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq);
98 void hammer2_ioq_done(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq);
99 void hammer2_iocom_init(hammer2_iocom_t *iocom, int sock_fd, int alt_fd);
100 void hammer2_iocom_done(hammer2_iocom_t *iocom);
101 hammer2_msg_t *hammer2_iocom_allocmsg(hammer2_iocom_t *iocom,
102                         uint32_t cmd, int aux_size);
103 void hammer2_iocom_reallocmsg(hammer2_iocom_t *iocom, hammer2_msg_t *msg,
104                         int aux_size);
105 void hammer2_iocom_freemsg(hammer2_iocom_t *iocom, hammer2_msg_t *msg);
106
107 void hammer2_iocom_core(hammer2_iocom_t *iocom,
108                         void (*iocom_recvmsg)(hammer2_iocom_t *),
109                         void (*iocom_sendmsg)(hammer2_iocom_t *),
110                         void (*iocom_altmsg)(hammer2_iocom_t *));
111 hammer2_msg_t *hammer2_ioq_read(hammer2_iocom_t *iocon);
112 void hammer2_ioq_write(hammer2_iocom_t *iocon, hammer2_msg_t *msg);
113 void hammer2_ioq_reply(hammer2_iocom_t *iocom, hammer2_msg_t *msg);
114 void hammer2_ioq_reply_term(hammer2_iocom_t *iocom, hammer2_msg_t *msg,
115                         uint16_t error);
116 void hammer2_ioq_write_drain(hammer2_iocom_t *iocon);
117
118 void hammer2_debug_remote(hammer2_iocom_t *iocom, hammer2_msg_t *msg);
119 void iocom_printf(hammer2_iocom_t *iocom, hammer2_msg_t *msg,
120                         const char *ctl, ...);