1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 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_SHSEC_H_
32#define	_G_SHSEC_H_
33
34#include <sys/endian.h>
35
36#define	G_SHSEC_CLASS_NAME	"SHSEC"
37
38#define	G_SHSEC_MAGIC		"GEOM::SHSEC"
39/*
40 * Version history:
41 * 0 - Initial version number.
42 * 1 - Added md_provsize field to metadata.
43 */
44#define	G_SHSEC_VERSION	1
45
46#ifdef _KERNEL
47#define	G_SHSEC_BFLAG_FIRST	0x1
48
49#define	G_SHSEC_DEBUG(lvl, ...) \
50    _GEOM_DEBUG("GEOM_SHSEC", g_shsec_debug, (lvl), NULL, __VA_ARGS__)
51#define	G_SHSEC_LOGREQ(lvl, bp, ...) \
52    _GEOM_DEBUG("GEOM_SHSEC", g_shsec_debug, (lvl), (bp), __VA_ARGS__)
53
54struct g_shsec_softc {
55	u_int		 sc_type;	/* provider type */
56	struct g_geom	*sc_geom;
57	struct g_provider *sc_provider;
58	uint32_t	 sc_id;		/* device unique ID */
59	struct g_consumer **sc_disks;
60	uint16_t	 sc_ndisks;
61};
62#define	sc_name	sc_geom->name
63#endif	/* _KERNEL */
64
65struct g_shsec_metadata {
66	char		md_magic[16];	/* Magic value. */
67	uint32_t	md_version;	/* Version number. */
68	char		md_name[16];	/* Stripe name. */
69	uint32_t	md_id;		/* Unique ID. */
70	uint16_t	md_no;		/* Disk number. */
71	uint16_t	md_all;		/* Number of all disks. */
72	char		md_provider[16]; /* Hardcoded provider. */
73	uint64_t	md_provsize;	/* Provider's size. */
74};
75static __inline void
76shsec_metadata_encode(const struct g_shsec_metadata *md, u_char *data)
77{
78
79	bcopy(md->md_magic, data, sizeof(md->md_magic));
80	le32enc(data + 16, md->md_version);
81	bcopy(md->md_name, data + 20, sizeof(md->md_name));
82	le32enc(data + 36, md->md_id);
83	le16enc(data + 40, md->md_no);
84	le16enc(data + 42, md->md_all);
85	bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
86	le64enc(data + 60, md->md_provsize);
87}
88static __inline void
89shsec_metadata_decode(const u_char *data, struct g_shsec_metadata *md)
90{
91
92	bcopy(data, md->md_magic, sizeof(md->md_magic));
93	md->md_version = le32dec(data + 16);
94	bcopy(data + 20, md->md_name, sizeof(md->md_name));
95	md->md_id = le32dec(data + 36);
96	md->md_no = le16dec(data + 40);
97	md->md_all = le16dec(data + 42);
98	bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
99	md->md_provsize = le64dec(data + 60);
100}
101#endif	/* _G_SHSEC_H_ */
102