1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org> 5 * All rights reserved. 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 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _GGATE_H_ 32 #define _GGATE_H_ 33 34 #include <sys/endian.h> 35 #include <stdarg.h> 36 37 #define G_GATE_PORT 3080 38 39 #define G_GATE_RCVBUF 131072 40 #define G_GATE_SNDBUF 131072 41 #define G_GATE_QUEUE_SIZE 1024 42 #define G_GATE_TIMEOUT 0 43 44 #define GGATE_MAGIC "GEOM_GATE " 45 #define GGATE_VERSION 0 46 47 #define GGATE_FLAG_RDONLY 0x0001 48 #define GGATE_FLAG_WRONLY 0x0002 49 /* 50 * If neither the GGATE_FLAG_SEND nor the GGATE_FLAG_RECV flag is 51 * set - this is initial connection. 52 * If GGATE_FLAG_SEND flag is set - this is socket to send data. 53 * If GGATE_FLAG_RECV flag is set - this is socket to receive data. 54 */ 55 #define GGATE_FLAG_SEND 0x0004 56 #define GGATE_FLAG_RECV 0x0008 57 58 #define GGATE_CMD_READ 0 59 #define GGATE_CMD_WRITE 1 60 #define GGATE_CMD_FLUSH 3 61 62 extern int g_gate_devfd; 63 extern int g_gate_verbose; 64 65 extern int nagle; 66 extern unsigned rcvbuf, sndbuf; 67 68 struct g_gate_version { 69 char gv_magic[16]; 70 uint16_t gv_version; 71 uint16_t gv_error; 72 } __packed; 73 74 /* Client's initial packet. */ 75 struct g_gate_cinit { 76 char gc_path[PATH_MAX + 1]; 77 uint64_t gc_flags; 78 uint16_t gc_nconn; 79 uint32_t gc_token; 80 } __packed; 81 82 /* Server's initial packet. */ 83 struct g_gate_sinit { 84 uint8_t gs_flags; 85 uint64_t gs_mediasize; 86 uint32_t gs_sectorsize; 87 uint16_t gs_error; 88 } __packed; 89 90 /* Control struct. */ 91 struct g_gate_hdr { 92 uint8_t gh_cmd; /* command */ 93 uint64_t gh_offset; /* device offset */ 94 uint32_t gh_length; /* size of block */ 95 uint64_t gh_seq; /* request number */ 96 uint16_t gh_error; /* error value (0 if ok) */ 97 } __packed; 98 99 void g_gate_vlog(int priority, const char *message, va_list ap); 100 void g_gate_log(int priority, const char *message, ...); 101 void g_gate_xvlog(const char *message, va_list ap) __dead2; 102 void g_gate_xlog(const char *message, ...) __dead2; 103 off_t g_gate_mediasize(int fd); 104 unsigned g_gate_sectorsize(int fd); 105 void g_gate_open_device(void); 106 void g_gate_close_device(void); 107 void g_gate_ioctl(unsigned long req, void *data); 108 void g_gate_destroy(int unit, int force); 109 void g_gate_load_module(void); 110 ssize_t g_gate_recv(int s, void *buf, size_t len, int flags); 111 ssize_t g_gate_send(int s, const void *buf, size_t len, int flags); 112 void g_gate_socket_settings(int sfd); 113 #ifdef LIBGEOM 114 void g_gate_list(int unit, int verbose); 115 #endif 116 in_addr_t g_gate_str2ip(const char *str); 117 118 /* 119 * g_gate_swap2h_* - functions swap bytes to host byte order (from big endian). 120 * g_gate_swap2n_* - functions swap bytes to network byte order (actually 121 * to big endian byte order). 122 */ 123 124 static __inline void 125 g_gate_swap2h_version(struct g_gate_version *ver) 126 { 127 128 ver->gv_version = be16toh(ver->gv_version); 129 ver->gv_error = be16toh(ver->gv_error); 130 } 131 132 static __inline void 133 g_gate_swap2n_version(struct g_gate_version *ver) 134 { 135 136 ver->gv_version = htobe16(ver->gv_version); 137 ver->gv_error = htobe16(ver->gv_error); 138 } 139 140 static __inline void 141 g_gate_swap2h_cinit(struct g_gate_cinit *cinit) 142 { 143 144 cinit->gc_flags = be64toh(cinit->gc_flags); 145 cinit->gc_nconn = be16toh(cinit->gc_nconn); 146 cinit->gc_token = be32toh(cinit->gc_token); 147 } 148 149 static __inline void 150 g_gate_swap2n_cinit(struct g_gate_cinit *cinit) 151 { 152 153 cinit->gc_flags = htobe64(cinit->gc_flags); 154 cinit->gc_nconn = htobe16(cinit->gc_nconn); 155 cinit->gc_token = htobe32(cinit->gc_token); 156 } 157 158 static __inline void 159 g_gate_swap2h_sinit(struct g_gate_sinit *sinit) 160 { 161 162 /* Swap only used fields. */ 163 sinit->gs_mediasize = be64toh(sinit->gs_mediasize); 164 sinit->gs_sectorsize = be32toh(sinit->gs_sectorsize); 165 sinit->gs_error = be16toh(sinit->gs_error); 166 } 167 168 static __inline void 169 g_gate_swap2n_sinit(struct g_gate_sinit *sinit) 170 { 171 172 /* Swap only used fields. */ 173 sinit->gs_mediasize = htobe64(sinit->gs_mediasize); 174 sinit->gs_sectorsize = htobe32(sinit->gs_sectorsize); 175 sinit->gs_error = htobe16(sinit->gs_error); 176 } 177 178 static __inline void 179 g_gate_swap2h_hdr(struct g_gate_hdr *hdr) 180 { 181 182 /* Swap only used fields. */ 183 hdr->gh_offset = be64toh(hdr->gh_offset); 184 hdr->gh_length = be32toh(hdr->gh_length); 185 hdr->gh_seq = be64toh(hdr->gh_seq); 186 hdr->gh_error = be16toh(hdr->gh_error); 187 } 188 189 static __inline void 190 g_gate_swap2n_hdr(struct g_gate_hdr *hdr) 191 { 192 193 /* Swap only used fields. */ 194 hdr->gh_offset = htobe64(hdr->gh_offset); 195 hdr->gh_length = htobe32(hdr->gh_length); 196 hdr->gh_seq = htobe64(hdr->gh_seq); 197 hdr->gh_error = htobe16(hdr->gh_error); 198 } 199 #endif /* _GGATE_H_ */ 200