1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 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 29 #ifndef _GGATE_H_ 30 #define _GGATE_H_ 31 32 #include <sys/endian.h> 33 #include <stdarg.h> 34 35 #define G_GATE_PORT 3080 36 37 #define G_GATE_RCVBUF 131072 38 #define G_GATE_SNDBUF 131072 39 #define G_GATE_QUEUE_SIZE 1024 40 #define G_GATE_TIMEOUT 0 41 42 #define GGATE_MAGIC "GEOM_GATE " 43 #define GGATE_VERSION 0 44 45 #define GGATE_FLAG_RDONLY 0x0001 46 #define GGATE_FLAG_WRONLY 0x0002 47 /* 48 * If neither the GGATE_FLAG_SEND nor the GGATE_FLAG_RECV flag is 49 * set - this is initial connection. 50 * If GGATE_FLAG_SEND flag is set - this is socket to send data. 51 * If GGATE_FLAG_RECV flag is set - this is socket to receive data. 52 */ 53 #define GGATE_FLAG_SEND 0x0004 54 #define GGATE_FLAG_RECV 0x0008 55 56 #define GGATE_CMD_READ 0 57 #define GGATE_CMD_WRITE 1 58 #define GGATE_CMD_FLUSH 3 59 60 extern int g_gate_devfd; 61 extern int g_gate_verbose; 62 63 extern int nagle; 64 extern unsigned rcvbuf, sndbuf; 65 66 struct g_gate_version { 67 char gv_magic[16]; 68 uint16_t gv_version; 69 uint16_t gv_error; 70 } __packed; 71 72 /* Client's initial packet. */ 73 struct g_gate_cinit { 74 char gc_path[PATH_MAX + 1]; 75 uint64_t gc_flags; 76 uint16_t gc_nconn; 77 uint32_t gc_token; 78 } __packed; 79 80 /* Server's initial packet. */ 81 struct g_gate_sinit { 82 uint8_t gs_flags; 83 uint64_t gs_mediasize; 84 uint32_t gs_sectorsize; 85 uint16_t gs_error; 86 } __packed; 87 88 /* Control struct. */ 89 struct g_gate_hdr { 90 uint8_t gh_cmd; /* command */ 91 uint64_t gh_offset; /* device offset */ 92 uint32_t gh_length; /* size of block */ 93 uint64_t gh_seq; /* request number */ 94 uint16_t gh_error; /* error value (0 if ok) */ 95 } __packed; 96 97 void g_gate_vlog(int priority, const char *message, va_list ap); 98 void g_gate_log(int priority, const char *message, ...); 99 void g_gate_xvlog(const char *message, va_list ap) __dead2; 100 void g_gate_xlog(const char *message, ...) __dead2; 101 off_t g_gate_mediasize(int fd); 102 unsigned g_gate_sectorsize(int fd); 103 void g_gate_open_device(void); 104 void g_gate_close_device(void); 105 void g_gate_ioctl(unsigned long req, void *data); 106 void g_gate_destroy(int unit, int force); 107 void g_gate_load_module(void); 108 ssize_t g_gate_recv(int s, void *buf, size_t len, int flags); 109 ssize_t g_gate_send(int s, const void *buf, size_t len, int flags); 110 void g_gate_socket_settings(int sfd); 111 #ifdef LIBGEOM 112 void g_gate_list(int unit, int verbose); 113 #endif 114 in_addr_t g_gate_str2ip(const char *str); 115 116 /* 117 * g_gate_swap2h_* - functions swap bytes to host byte order (from big endian). 118 * g_gate_swap2n_* - functions swap bytes to network byte order (actually 119 * to big endian byte order). 120 */ 121 122 static __inline void 123 g_gate_swap2h_version(struct g_gate_version *ver) 124 { 125 126 ver->gv_version = be16toh(ver->gv_version); 127 ver->gv_error = be16toh(ver->gv_error); 128 } 129 130 static __inline void 131 g_gate_swap2n_version(struct g_gate_version *ver) 132 { 133 134 ver->gv_version = htobe16(ver->gv_version); 135 ver->gv_error = htobe16(ver->gv_error); 136 } 137 138 static __inline void 139 g_gate_swap2h_cinit(struct g_gate_cinit *cinit) 140 { 141 142 cinit->gc_flags = be64toh(cinit->gc_flags); 143 cinit->gc_nconn = be16toh(cinit->gc_nconn); 144 cinit->gc_token = be32toh(cinit->gc_token); 145 } 146 147 static __inline void 148 g_gate_swap2n_cinit(struct g_gate_cinit *cinit) 149 { 150 151 cinit->gc_flags = htobe64(cinit->gc_flags); 152 cinit->gc_nconn = htobe16(cinit->gc_nconn); 153 cinit->gc_token = htobe32(cinit->gc_token); 154 } 155 156 static __inline void 157 g_gate_swap2h_sinit(struct g_gate_sinit *sinit) 158 { 159 160 /* Swap only used fields. */ 161 sinit->gs_mediasize = be64toh(sinit->gs_mediasize); 162 sinit->gs_sectorsize = be32toh(sinit->gs_sectorsize); 163 sinit->gs_error = be16toh(sinit->gs_error); 164 } 165 166 static __inline void 167 g_gate_swap2n_sinit(struct g_gate_sinit *sinit) 168 { 169 170 /* Swap only used fields. */ 171 sinit->gs_mediasize = htobe64(sinit->gs_mediasize); 172 sinit->gs_sectorsize = htobe32(sinit->gs_sectorsize); 173 sinit->gs_error = htobe16(sinit->gs_error); 174 } 175 176 static __inline void 177 g_gate_swap2h_hdr(struct g_gate_hdr *hdr) 178 { 179 180 /* Swap only used fields. */ 181 hdr->gh_offset = be64toh(hdr->gh_offset); 182 hdr->gh_length = be32toh(hdr->gh_length); 183 hdr->gh_seq = be64toh(hdr->gh_seq); 184 hdr->gh_error = be16toh(hdr->gh_error); 185 } 186 187 static __inline void 188 g_gate_swap2n_hdr(struct g_gate_hdr *hdr) 189 { 190 191 /* Swap only used fields. */ 192 hdr->gh_offset = htobe64(hdr->gh_offset); 193 hdr->gh_length = htobe32(hdr->gh_length); 194 hdr->gh_seq = htobe64(hdr->gh_seq); 195 hdr->gh_error = htobe16(hdr->gh_error); 196 } 197 #endif /* _GGATE_H_ */ 198