1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2004-2009 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 _G_GATE_H_ 32#define _G_GATE_H_ 33 34#include <sys/param.h> 35#include <sys/lock.h> 36#include <sys/mutex.h> 37#include <sys/queue.h> 38 39#include <geom/geom.h> 40 41#define G_GATE_CLASS_NAME "GATE" 42#define G_GATE_PROVIDER_NAME "ggate" 43#define G_GATE_MOD_NAME "ggate" 44#define G_GATE_CTL_NAME "ggctl" 45 46#define G_GATE_VERSION 3 47 48/* 49 * Maximum number of request that can be stored in 50 * the queue when there are no workers. 51 */ 52#define G_GATE_MAX_QUEUE_SIZE 4096 53 54#define G_GATE_FLAG_READONLY 0x0001 55#define G_GATE_FLAG_WRITEONLY 0x0002 56#define G_GATE_FLAG_DESTROY 0x1000 57#define G_GATE_USERFLAGS (G_GATE_FLAG_READONLY | G_GATE_FLAG_WRITEONLY) 58 59/* 60 * Pick unit number automatically in /dev/ggate<unit>. 61 */ 62#define G_GATE_UNIT_AUTO (-1) 63/* 64 * Full provider name is given, so don't use ggate<unit>. 65 */ 66#define G_GATE_NAME_GIVEN (-2) 67 68#define G_GATE_CMD_CREATE _IOWR('m', 0, struct g_gate_ctl_create) 69#define G_GATE_CMD_MODIFY _IOWR('m', 1, struct g_gate_ctl_modify) 70#define G_GATE_CMD_DESTROY _IOWR('m', 2, struct g_gate_ctl_destroy) 71#define G_GATE_CMD_CANCEL _IOWR('m', 3, struct g_gate_ctl_cancel) 72#define G_GATE_CMD_START _IOWR('m', 4, struct g_gate_ctl_io) 73#define G_GATE_CMD_DONE _IOWR('m', 5, struct g_gate_ctl_io) 74 75#define G_GATE_INFOSIZE 2048 76 77#ifdef _KERNEL 78/* 79 * 'P:' means 'Protected by'. 80 */ 81struct g_gate_softc { 82 char *sc_name; /* P: (read-only) */ 83 int sc_unit; /* P: (read-only) */ 84 int sc_ref; /* P: g_gate_list_mtx */ 85 struct g_provider *sc_provider; /* P: (read-only) */ 86 uint32_t sc_flags; /* P: sc_queue_mtx */ 87 88 struct bio_queue_head sc_inqueue; /* P: sc_queue_mtx */ 89 struct bio_queue_head sc_outqueue; /* P: sc_queue_mtx */ 90 struct mtx sc_queue_mtx; 91 uint32_t sc_queue_count; /* P: sc_queue_mtx */ 92 uint32_t sc_queue_size; /* P: (read-only) */ 93 u_int sc_timeout; /* P: (read-only) */ 94 struct g_consumer *sc_readcons; /* P: sc_read_mtx */ 95 off_t sc_readoffset; /* P: sc_read_mtx */ 96 struct callout sc_callout; /* P: (modified only 97 from callout 98 thread) */ 99 uintptr_t sc_seq; /* P: sc_queue_mtx */ 100 LIST_ENTRY(g_gate_softc) sc_next; /* P: g_gate_list_mtx */ 101 char sc_info[G_GATE_INFOSIZE]; /* P: (read-only) */ 102 struct mtx sc_read_mtx; 103}; 104 105#define G_GATE_DEBUG(lvl, ...) do { \ 106 if (g_gate_debug >= (lvl)) { \ 107 printf("GEOM_GATE"); \ 108 if (g_gate_debug > 0) \ 109 printf("[%u]", lvl); \ 110 printf(": "); \ 111 printf(__VA_ARGS__); \ 112 printf("\n"); \ 113 } \ 114} while (0) 115#define G_GATE_LOGREQ(lvl, bp, ...) do { \ 116 if (g_gate_debug >= (lvl)) { \ 117 printf("GEOM_GATE"); \ 118 if (g_gate_debug > 0) \ 119 printf("[%u]", lvl); \ 120 printf(": "); \ 121 printf(__VA_ARGS__); \ 122 printf(" "); \ 123 g_print_bio(bp); \ 124 printf("\n"); \ 125 } \ 126} while (0) 127#endif /* !_KERNEL */ 128 129struct g_gate_ctl_create { 130 u_int gctl_version; 131 off_t gctl_mediasize; 132 u_int gctl_sectorsize; 133 u_int gctl_flags; 134 u_int gctl_maxcount; 135 u_int gctl_timeout; 136 char gctl_name[NAME_MAX]; 137 char gctl_info[G_GATE_INFOSIZE]; 138 char gctl_readprov[NAME_MAX]; 139 off_t gctl_readoffset; 140 int gctl_unit; /* in/out */ 141}; 142 143#define GG_MODIFY_MEDIASIZE 0x01 144#define GG_MODIFY_INFO 0x02 145#define GG_MODIFY_READPROV 0x04 146#define GG_MODIFY_READOFFSET 0x08 147struct g_gate_ctl_modify { 148 u_int gctl_version; 149 int gctl_unit; 150 uint32_t gctl_modify; 151 off_t gctl_mediasize; 152 char gctl_info[G_GATE_INFOSIZE]; 153 char gctl_readprov[NAME_MAX]; 154 off_t gctl_readoffset; 155}; 156 157struct g_gate_ctl_destroy { 158 u_int gctl_version; 159 int gctl_unit; 160 int gctl_force; 161 char gctl_name[NAME_MAX]; 162}; 163 164struct g_gate_ctl_cancel { 165 u_int gctl_version; 166 int gctl_unit; 167 uintptr_t gctl_seq; 168 char gctl_name[NAME_MAX]; 169}; 170 171struct g_gate_ctl_io { 172 u_int gctl_version; 173 int gctl_unit; 174 uintptr_t gctl_seq; 175 u_int gctl_cmd; 176 off_t gctl_offset; 177 off_t gctl_length; 178 void *gctl_data; 179 int gctl_error; 180}; 181#endif /* !_G_GATE_H_ */ 182