1 /*- 2 * Copyright (c) 2004-2009 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _G_GATE_H_ 30 #define _G_GATE_H_ 31 32 #include <sys/param.h> 33 #include <sys/lock.h> 34 #include <sys/mutex.h> 35 #include <sys/queue.h> 36 37 #include <geom/geom.h> 38 39 #define G_GATE_CLASS_NAME "GATE" 40 #define G_GATE_PROVIDER_NAME "ggate" 41 #define G_GATE_MOD_NAME "ggate" 42 #define G_GATE_CTL_NAME "ggctl" 43 44 #define G_GATE_VERSION 2 45 46 /* 47 * Maximum number of request that can be stored in 48 * the queue when there are no workers. 49 */ 50 #define G_GATE_MAX_QUEUE_SIZE 4096 51 52 #define G_GATE_FLAG_READONLY 0x0001 53 #define G_GATE_FLAG_WRITEONLY 0x0002 54 #define G_GATE_FLAG_DESTROY 0x1000 55 #define G_GATE_USERFLAGS (G_GATE_FLAG_READONLY | G_GATE_FLAG_WRITEONLY) 56 57 /* 58 * Pick unit number automatically in /dev/ggate<unit>. 59 */ 60 #define G_GATE_UNIT_AUTO (-1) 61 /* 62 * Full provider name is given, so don't use ggate<unit>. 63 */ 64 #define G_GATE_NAME_GIVEN (-2) 65 66 #define G_GATE_CMD_CREATE _IOWR('m', 0, struct g_gate_ctl_create) 67 #define G_GATE_CMD_DESTROY _IOWR('m', 1, struct g_gate_ctl_destroy) 68 #define G_GATE_CMD_CANCEL _IOWR('m', 2, struct g_gate_ctl_cancel) 69 #define G_GATE_CMD_START _IOWR('m', 3, struct g_gate_ctl_io) 70 #define G_GATE_CMD_DONE _IOWR('m', 4, struct g_gate_ctl_io) 71 72 #define G_GATE_INFOSIZE 2048 73 74 #ifdef _KERNEL 75 /* 76 * 'P:' means 'Protected by'. 77 */ 78 struct g_gate_softc { 79 char *sc_name; /* P: (read-only) */ 80 int sc_unit; /* P: (read-only) */ 81 int sc_ref; /* P: g_gate_list_mtx */ 82 struct g_provider *sc_provider; /* P: (read-only) */ 83 uint32_t sc_flags; /* P: sc_queue_mtx */ 84 85 struct bio_queue_head sc_inqueue; /* P: sc_queue_mtx */ 86 struct bio_queue_head sc_outqueue; /* P: sc_queue_mtx */ 87 struct mtx sc_queue_mtx; 88 uint32_t sc_queue_count; /* P: sc_queue_mtx */ 89 uint32_t sc_queue_size; /* P: (read-only) */ 90 u_int sc_timeout; /* P: (read-only) */ 91 struct callout sc_callout; /* P: (modified only 92 from callout 93 thread) */ 94 uintptr_t sc_seq; /* P: (modified only 95 from g_down 96 thread) */ 97 LIST_ENTRY(g_gate_softc) sc_next; /* P: g_gate_list_mtx */ 98 char sc_info[G_GATE_INFOSIZE]; /* P: (read-only) */ 99 }; 100 101 #define G_GATE_DEBUG(lvl, ...) do { \ 102 if (g_gate_debug >= (lvl)) { \ 103 printf("GEOM_GATE"); \ 104 if (g_gate_debug > 0) \ 105 printf("[%u]", lvl); \ 106 printf(": "); \ 107 printf(__VA_ARGS__); \ 108 printf("\n"); \ 109 } \ 110 } while (0) 111 #define G_GATE_LOGREQ(lvl, bp, ...) do { \ 112 if (g_gate_debug >= (lvl)) { \ 113 printf("GEOM_GATE"); \ 114 if (g_gate_debug > 0) \ 115 printf("[%u]", lvl); \ 116 printf(": "); \ 117 printf(__VA_ARGS__); \ 118 printf(" "); \ 119 g_print_bio(bp); \ 120 printf("\n"); \ 121 } \ 122 } while (0) 123 #endif /* !_KERNEL */ 124 125 struct g_gate_ctl_create { 126 u_int gctl_version; 127 off_t gctl_mediasize; 128 u_int gctl_sectorsize; 129 u_int gctl_flags; 130 u_int gctl_maxcount; 131 u_int gctl_timeout; 132 char gctl_name[NAME_MAX]; 133 char gctl_info[G_GATE_INFOSIZE]; 134 int gctl_unit; /* in/out */ 135 }; 136 137 struct g_gate_ctl_destroy { 138 u_int gctl_version; 139 int gctl_unit; 140 int gctl_force; 141 char gctl_name[NAME_MAX]; 142 }; 143 144 struct g_gate_ctl_cancel { 145 u_int gctl_version; 146 int gctl_unit; 147 uintptr_t gctl_seq; 148 char gctl_name[NAME_MAX]; 149 }; 150 151 struct g_gate_ctl_io { 152 u_int gctl_version; 153 int gctl_unit; 154 uintptr_t gctl_seq; 155 u_int gctl_cmd; 156 off_t gctl_offset; 157 off_t gctl_length; 158 void *gctl_data; 159 int gctl_error; 160 }; 161 #endif /* !_G_GATE_H_ */ 162