g_concat.h revision 260385 
1/*-
2 * Copyright (c) 2004-2005 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: stable/10/sys/geom/concat/g_concat.h 260385 2014-01-07 01:32:23Z scottl $
27 */
28
29#ifndef	_G_CONCAT_H_
30#define	_G_CONCAT_H_
31
32#include <sys/endian.h>
33
34#define	G_CONCAT_CLASS_NAME	"CONCAT"
35
36#define	G_CONCAT_MAGIC		"GEOM::CONCAT"
37/*
38 * Version history:
39 * 1 - Initial version number.
40 * 2 - Added 'stop' command to gconcat(8).
41 * 3 - Added md_provider field to metadata and '-h' option to gconcat(8).
42 * 4 - Added md_provsize field to metadata.
43 */
44#define	G_CONCAT_VERSION	4
45
46#ifdef _KERNEL
47#define	G_CONCAT_TYPE_MANUAL	0
48#define	G_CONCAT_TYPE_AUTOMATIC	1
49
50#define	G_CONCAT_DEBUG(lvl, ...)	do {				\
51	if (g_concat_debug >= (lvl)) {					\
52		printf("GEOM_CONCAT");					\
53		if (g_concat_debug > 0)					\
54			printf("[%u]", lvl);				\
55		printf(": ");						\
56		printf(__VA_ARGS__);					\
57		printf("\n");						\
58	}								\
59} while (0)
60#define	G_CONCAT_LOGREQ(bp, ...)	do {				\
61	if (g_concat_debug >= 2) {					\
62		printf("GEOM_CONCAT[2]: ");				\
63		printf(__VA_ARGS__);					\
64		printf(" ");						\
65		g_print_bio(bp);					\
66		printf("\n");						\
67	}								\
68} while (0)
69
70struct g_concat_disk {
71	struct g_consumer	*d_consumer;
72	struct g_concat_softc	*d_softc;
73	off_t			 d_start;
74	off_t			 d_end;
75	int			 d_removed;
76};
77
78struct g_concat_softc {
79	u_int		 sc_type;	/* provider type */
80	struct g_geom	*sc_geom;
81	struct g_provider *sc_provider;
82	uint32_t	 sc_id;		/* concat unique ID */
83
84	struct g_concat_disk *sc_disks;
85	uint16_t	 sc_ndisks;
86	struct mtx	 sc_lock;
87};
88#define	sc_name	sc_geom->name
89#endif	/* _KERNEL */
90
91struct g_concat_metadata {
92	char		md_magic[16];	/* Magic value. */
93	uint32_t	md_version;	/* Version number. */
94	char		md_name[16];	/* Concat name. */
95	uint32_t	md_id;		/* Unique ID. */
96	uint16_t	md_no;		/* Disk number. */
97	uint16_t	md_all;		/* Number of all disks. */
98	char		md_provider[16]; /* Hardcoded provider. */
99	uint64_t	md_provsize;	/* Provider's size. */
100};
101static __inline void
102concat_metadata_encode(const struct g_concat_metadata *md, u_char *data)
103{
104
105	bcopy(md->md_magic, data, sizeof(md->md_magic));
106	le32enc(data + 16, md->md_version);
107	bcopy(md->md_name, data + 20, sizeof(md->md_name));
108	le32enc(data + 36, md->md_id);
109	le16enc(data + 40, md->md_no);
110	le16enc(data + 42, md->md_all);
111	bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
112	le64enc(data + 60, md->md_provsize);
113}
114static __inline void
115concat_metadata_decode(const u_char *data, struct g_concat_metadata *md)
116{
117
118	bcopy(data, md->md_magic, sizeof(md->md_magic));
119	md->md_version = le32dec(data + 16);
120	bcopy(data + 20, md->md_name, sizeof(md->md_name));
121	md->md_id = le32dec(data + 36);
122	md->md_no = le16dec(data + 40);
123	md->md_all = le16dec(data + 42);
124	bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
125	md->md_provsize = le64dec(data + 60);
126}
127#endif	/* _G_CONCAT_H_ */
128