source: mainline/uspace/lib/device/include/hr.h@ 2192a01

Last change on this file since 2192a01 was 2192a01, checked in by Miroslav Cimerman <mc@…>, 5 weeks ago

hr: basic Linux Multiple Device RAID format support
  • Property mode set to 100644
File size: 4.6 KB
Line 
1/*
2 * Copyright (c) 2025 Miroslav Cimerman
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 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libdevice
30 * @{
31 */
32/**
33 * @file
34 */
35
36#ifndef LIBDEVICE_HR_H
37#define LIBDEVICE_HR_H
38
39#include <async.h>
40#include <errno.h>
41#include <loc.h>
42
43/* for now */
44#define HR_MAX_EXTENTS 4
45#define HR_MAX_HOTSPARES HR_MAX_EXTENTS
46
47#define HR_DEVNAME_LEN 32
48
49typedef enum hr_level {
50 HR_LVL_0 = 0x00, /* striping, no redundancy */
51 HR_LVL_1 = 0x01, /* n-way mirroring */
52 HR_LVL_4 = 0x04, /* dedicated parity */
53 HR_LVL_5 = 0x05, /* distributed parity */
54 HR_LVL_UNKNOWN = 0xFF
55} hr_level_t;
56
57typedef enum hr_layout {
58 HR_LAYOUT_NONE = 0,
59 HR_LAYOUT_RAID4_0, /* RAID-4 Non-Rotating Parity 0 */
60 HR_LAYOUT_RAID4_N, /* RAID-4 Non-Rotating Parity N */
61 HR_LAYOUT_RAID5_0R, /* RAID-5 Rotating Parity 0 with Data Restart */
62 HR_LAYOUT_RAID5_NR, /* RAID-5 Rotating Parity N with Data Restart */
63 HR_LAYOUT_RAID5_NC /* RAID-5 Rotating Parity N with Data Continuation */
64} hr_layout_t;
65
66typedef enum hr_vol_state {
67 HR_VOL_NONE = 0, /* Unknown/None */
68 HR_VOL_OPTIMAL, /* optimal */
69 HR_VOL_FAULTY, /* unusable */
70 HR_VOL_DEGRADED, /* not optimal */
71 HR_VOL_REBUILD /* rebuild in progress */
72} hr_vol_state_t;
73
74typedef enum hr_ext_state {
75 HR_EXT_NONE = 0, /* unknown/none state */
76 HR_EXT_INVALID, /* working but not consistent */
77 HR_EXT_ONLINE, /* ok */
78 HR_EXT_MISSING, /* offline */
79 HR_EXT_FAILED,
80 HR_EXT_REBUILD,
81 HR_EXT_HOTSPARE
82} hr_ext_state_t;
83
84typedef enum {
85 HR_METADATA_NATIVE = 0,
86 HR_METADATA_GEOM_MIRROR,
87 HR_METADATA_GEOM_STRIPE,
88 HR_METADATA_SOFTRAID,
89 HR_METADATA_MD,
90 HR_METADATA_LAST_DUMMY
91} hr_metadata_type_t;
92
93typedef struct hr {
94 async_sess_t *sess;
95} hr_t;
96
97typedef struct hr_config {
98 char devname[HR_DEVNAME_LEN];
99 service_id_t devs[HR_MAX_EXTENTS];
100 size_t dev_no;
101 hr_level_t level;
102} hr_config_t;
103
104typedef struct hr_extent {
105 service_id_t svc_id;
106 hr_ext_state_t state;
107} hr_extent_t;
108
109typedef struct hr_pair_vol_state {
110 service_id_t svc_id;
111 hr_vol_state_t state;
112} hr_pair_vol_state_t;
113
114typedef struct hr_vol_info {
115 char devname[HR_DEVNAME_LEN];
116 service_id_t svc_id;
117 hr_level_t level;
118 hr_extent_t extents[HR_MAX_EXTENTS];
119 hr_extent_t hotspares[HR_MAX_HOTSPARES];
120 size_t extent_no;
121 size_t hotspare_no;
122 uint64_t data_blkno;
123 uint64_t rebuild_blk;
124 uint32_t strip_size;
125 size_t bsize;
126 hr_vol_state_t state;
127 hr_layout_t layout;
128 hr_metadata_type_t meta_type;
129 /* TODO: add rebuild pos */
130} hr_vol_info_t;
131
132extern errno_t hr_sess_init(hr_t **);
133extern void hr_sess_destroy(hr_t *);
134extern errno_t hr_create(hr_t *, hr_config_t *);
135extern errno_t hr_assemble(hr_t *, hr_config_t *, size_t *);
136extern errno_t hr_auto_assemble(hr_t *, size_t *);
137extern errno_t hr_stop(hr_t *, const char *);
138extern errno_t hr_stop_all(hr_t *);
139extern errno_t hr_fail_extent(hr_t *, const char *, unsigned long);
140extern errno_t hr_add_hotspare(hr_t *, const char *, const char *);
141extern errno_t hr_get_vol_states(hr_t *, hr_pair_vol_state_t **, size_t *);
142extern errno_t hr_get_vol_info(hr_t *, service_id_t, hr_vol_info_t *);
143extern const char *hr_get_vol_state_str(hr_vol_state_t);
144extern const char *hr_get_ext_state_str(hr_ext_state_t);
145extern const char *hr_get_layout_str(hr_layout_t);
146extern const char *hr_get_level_str(hr_level_t);
147extern const char *hr_get_metadata_type_str(hr_metadata_type_t);
148
149#endif
150
151/** @}
152 */
Note: See TracBrowser for help on using the repository browser.