g_stripe.h revision 133373 
1/*-
2 * Copyright (c) 2003 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: head/sys/geom/stripe/g_stripe.h 133373 2004-08-09 11:29:42Z pjd $
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 */
43#define	G_STRIPE_VERSION	2
44
45#ifdef _KERNEL
46#define	G_STRIPE_TYPE_MANUAL	0
47#define	G_STRIPE_TYPE_AUTOMATIC	1
48
49#define	G_STRIPE_DEBUG(lvl, ...)	do {				\
50	if (g_stripe_debug >= (lvl)) {					\
51		printf("GEOM_STRIPE");					\
52		if (g_stripe_debug > 0)					\
53			printf("[%u]", lvl);				\
54		printf(": ");						\
55		printf(__VA_ARGS__);					\
56		printf("\n");						\
57	}								\
58} while (0)
59#define	G_STRIPE_LOGREQ(bp, ...)	do {				\
60	if (g_stripe_debug >= 2) {					\
61		printf("GEOM_STRIPE[2]: ");				\
62		printf(__VA_ARGS__);					\
63		printf(" ");						\
64		g_print_bio(bp);					\
65		printf("\n");						\
66	}								\
67} while (0)
68
69struct g_stripe_softc {
70	u_int		 sc_type;	/* provider type */
71	struct g_geom	*sc_geom;
72	struct g_provider *sc_provider;
73	uint32_t	 sc_id;		/* stripe unique ID */
74	struct g_consumer **sc_disks;
75	uint16_t	 sc_ndisks;
76	uint32_t	 sc_stripesize;
77	uint32_t	 sc_stripebits;
78};
79#define	sc_name	sc_geom->name
80#endif	/* _KERNEL */
81
82struct g_stripe_metadata {
83	char		md_magic[16];	/* Magic value. */
84	uint32_t	md_version;	/* Version number. */
85	char		md_name[16];	/* Stripe name. */
86	uint32_t	md_id;		/* Unique ID. */
87	uint16_t	md_no;		/* Disk number. */
88	uint16_t	md_all;		/* Number of all disks. */
89	uint32_t	md_stripesize;	/* Stripe size. */
90	char		md_provider[16]; /* Hardcoded provider. */
91};
92static __inline void
93stripe_metadata_encode(const struct g_stripe_metadata *md, u_char *data)
94{
95
96	bcopy(md->md_magic, data, sizeof(md->md_magic));
97	le32enc(data + 16, md->md_version);
98	bcopy(md->md_name, data + 20, sizeof(md->md_name));
99	le32enc(data + 36, md->md_id);
100	le16enc(data + 40, md->md_no);
101	le16enc(data + 42, md->md_all);
102	le32enc(data + 44, md->md_stripesize);
103	bcopy(md->md_provider, data + 48, sizeof(md->md_provider));
104}
105static __inline void
106stripe_metadata_decode(const u_char *data, struct g_stripe_metadata *md)
107{
108
109	bcopy(data, md->md_magic, sizeof(md->md_magic));
110	md->md_version = le32dec(data + 16);
111	bcopy(data + 20, md->md_name, sizeof(md->md_name));
112	md->md_id = le32dec(data + 36);
113	md->md_no = le16dec(data + 40);
114	md->md_all = le16dec(data + 42);
115	md->md_stripesize = le32dec(data + 44);
116	bcopy(data + 48, md->md_provider, sizeof(md->md_provider));
117}
118
119#ifndef BITCOUNT
120#define	BITCOUNT(x)	(((BX_(x) + (BX_(x) >> 4)) & 0x0F0F0F0F) % 255)
121#define	BX_(x)		((x) - (((x) >> 1) & 0x77777777) -		\
122			 (((x) >> 2) & 0x33333333) - (((x) >> 3) & 0x11111111))
123#endif
124
125#endif	/* _G_STRIPE_H_ */
126