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