1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2004-2005 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 _G_STRIPE_H_
30 #define _G_STRIPE_H_
31
32 #include <sys/endian.h>
33
34 #define G_STRIPE_CLASS_NAME "STRIPE"
35
36 #define G_STRIPE_MAGIC "GEOM::STRIPE"
37 /*
38 * Version history:
39 * 0 - Initial version number.
40 * 1 - Added 'stop' command for gstripe(8).
41 * 2 - Added md_provider field to metadata and '-h' option for gstripe(8).
42 * 3 - Added md_provsize field to metadata.
43 */
44 #define G_STRIPE_VERSION 3
45
46 #ifdef _KERNEL
47 #define G_STRIPE_TYPE_MANUAL 0
48 #define G_STRIPE_TYPE_AUTOMATIC 1
49
50 #define G_STRIPE_FLAG_CANDELETE 0x00000001UL
51
52 #define G_STRIPE_DEBUG(lvl, ...) \
53 _GEOM_DEBUG("GEOM_STRIPE", g_stripe_debug, (lvl), NULL, __VA_ARGS__)
54 #define G_STRIPE_LOGREQ(bp, ...) \
55 _GEOM_DEBUG("GEOM_STRIPE", g_stripe_debug, 2, (bp), __VA_ARGS__)
56
57 struct g_stripe_softc {
58 u_int sc_type; /* provider type */
59 struct g_geom *sc_geom;
60 struct g_provider *sc_provider;
61 uint32_t sc_id; /* stripe unique ID */
62 struct g_consumer **sc_disks;
63 uint16_t sc_ndisks;
64 off_t sc_stripesize;
65 uint32_t sc_stripebits;
66 struct mtx sc_lock;
67 int sc_flags;
68 };
69 #define sc_name sc_geom->name
70 #endif /* _KERNEL */
71
72 struct g_stripe_metadata {
73 char md_magic[16]; /* Magic value. */
74 uint32_t md_version; /* Version number. */
75 char md_name[16]; /* Stripe name. */
76 uint32_t md_id; /* Unique ID. */
77 uint16_t md_no; /* Disk number. */
78 uint16_t md_all; /* Number of all disks. */
79 uint32_t md_stripesize; /* Stripe size. */
80 char md_provider[16]; /* Hardcoded provider. */
81 uint64_t md_provsize; /* Provider's size. */
82 };
83 static __inline void
stripe_metadata_encode(const struct g_stripe_metadata * md,u_char * data)84 stripe_metadata_encode(const struct g_stripe_metadata *md, u_char *data)
85 {
86
87 bcopy(md->md_magic, data, sizeof(md->md_magic));
88 le32enc(data + 16, md->md_version);
89 bcopy(md->md_name, data + 20, sizeof(md->md_name));
90 le32enc(data + 36, md->md_id);
91 le16enc(data + 40, md->md_no);
92 le16enc(data + 42, md->md_all);
93 le32enc(data + 44, md->md_stripesize);
94 bcopy(md->md_provider, data + 48, sizeof(md->md_provider));
95 le64enc(data + 64, md->md_provsize);
96 }
97 static __inline void
stripe_metadata_decode(const u_char * data,struct g_stripe_metadata * md)98 stripe_metadata_decode(const u_char *data, struct g_stripe_metadata *md)
99 {
100
101 bcopy(data, md->md_magic, sizeof(md->md_magic));
102 md->md_version = le32dec(data + 16);
103 bcopy(data + 20, md->md_name, sizeof(md->md_name));
104 md->md_id = le32dec(data + 36);
105 md->md_no = le16dec(data + 40);
106 md->md_all = le16dec(data + 42);
107 md->md_stripesize = le32dec(data + 44);
108 bcopy(data + 48, md->md_provider, sizeof(md->md_provider));
109 md->md_provsize = le64dec(data + 64);
110 }
111
112 #endif /* _G_STRIPE_H_ */
113