g_gate.h

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10

    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  */
   81 struct 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, ...) \
  106     _GEOM_DEBUG("GEOM_GATE", g_gate_debug, (lvl), NULL, __VA_ARGS__)
  107 #define G_GATE_LOGREQ(lvl, bp, ...) \
  108     _GEOM_DEBUG("GEOM_GATE", g_gate_debug, (lvl), (bp), __VA_ARGS__)
  109 #endif  /* !_KERNEL */
  110 
  111 struct g_gate_ctl_create {
  112         u_int   gctl_version;
  113         off_t   gctl_mediasize;
  114         u_int   gctl_sectorsize;
  115         u_int   gctl_flags;
  116         u_int   gctl_maxcount;
  117         u_int   gctl_timeout;
  118         char    gctl_name[NAME_MAX];
  119         char    gctl_info[G_GATE_INFOSIZE];
  120         char    gctl_readprov[NAME_MAX];
  121         off_t   gctl_readoffset;
  122         int     gctl_unit;      /* in/out */
  123 };
  124 
  125 #define GG_MODIFY_MEDIASIZE     0x01
  126 #define GG_MODIFY_INFO          0x02
  127 #define GG_MODIFY_READPROV      0x04
  128 #define GG_MODIFY_READOFFSET    0x08
  129 struct g_gate_ctl_modify {
  130         u_int           gctl_version;
  131         int             gctl_unit;
  132         uint32_t        gctl_modify;
  133         off_t           gctl_mediasize;
  134         char            gctl_info[G_GATE_INFOSIZE];
  135         char            gctl_readprov[NAME_MAX];
  136         off_t           gctl_readoffset;
  137 };
  138 
  139 struct g_gate_ctl_destroy {
  140         u_int   gctl_version;
  141         int     gctl_unit;
  142         int     gctl_force;
  143         char    gctl_name[NAME_MAX];
  144 };
  145 
  146 struct g_gate_ctl_cancel {
  147         u_int           gctl_version;
  148         int             gctl_unit;
  149         uintptr_t       gctl_seq;
  150         char            gctl_name[NAME_MAX];
  151 };
  152 
  153 struct g_gate_ctl_io {
  154         u_int            gctl_version;
  155         int              gctl_unit;
  156         uintptr_t        gctl_seq;
  157         u_int            gctl_cmd;
  158         off_t            gctl_offset;
  159         off_t            gctl_length;
  160         void            *gctl_data;
  161         int              gctl_error;
  162 };
  163 #endif  /* !_G_GATE_H_ */

Cache object: 925bef78c95bb600742d534fe85930cb

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.

FreeBSD/Linux Kernel Cross Reference sys/geom/gate/g_gate.h

FreeBSD/Linux Kernel Cross Reference
sys/geom/gate/g_gate.h