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 hr
|
---|
30 | * @{
|
---|
31 | */
|
---|
32 | /**
|
---|
33 | * @file
|
---|
34 | */
|
---|
35 |
|
---|
36 | #ifndef _HR_VAR_H
|
---|
37 | #define _HR_VAR_H
|
---|
38 |
|
---|
39 | #include <adt/list.h>
|
---|
40 | #include <bd_srv.h>
|
---|
41 | #include <errno.h>
|
---|
42 | #include <fibril_synch.h>
|
---|
43 | #include <hr.h>
|
---|
44 | #include <stdatomic.h>
|
---|
45 |
|
---|
46 | #include "fge.h"
|
---|
47 | #include "superblock.h"
|
---|
48 |
|
---|
49 | #define NAME "hr"
|
---|
50 | #define HR_STRIP_SIZE DATA_XFER_LIMIT
|
---|
51 |
|
---|
52 | struct hr_volume;
|
---|
53 | typedef struct hr_volume hr_volume_t;
|
---|
54 | typedef struct hr_metadata hr_metadata_t;
|
---|
55 | typedef struct hr_superblock_ops hr_superblock_ops_t;
|
---|
56 |
|
---|
57 | typedef struct hr_ops {
|
---|
58 | errno_t (*create)(hr_volume_t *);
|
---|
59 | errno_t (*init)(hr_volume_t *);
|
---|
60 | void (*status_event)(hr_volume_t *);
|
---|
61 | errno_t (*add_hotspare)(hr_volume_t *, service_id_t);
|
---|
62 | } hr_ops_t;
|
---|
63 |
|
---|
64 | typedef struct hr_volume {
|
---|
65 | link_t lvolumes; /* link to all volumes list */
|
---|
66 | hr_ops_t hr_ops; /* level init and create fcns */
|
---|
67 | bd_srvs_t hr_bds; /* block interface to the vol */
|
---|
68 | service_id_t svc_id; /* service id */
|
---|
69 |
|
---|
70 | fibril_mutex_t lock; /* XXX: gone after para */
|
---|
71 | list_t range_lock_list; /* list of range locks */
|
---|
72 | fibril_mutex_t range_lock_list_lock; /* range locks list lock */
|
---|
73 | hr_fpool_t *fge; /* fibril pool */
|
---|
74 |
|
---|
75 | void *in_mem_md;
|
---|
76 | fibril_mutex_t md_lock; /* lock protecting in_mem_md */
|
---|
77 |
|
---|
78 | hr_superblock_ops_t *meta_ops;
|
---|
79 |
|
---|
80 | /* invariants */
|
---|
81 | size_t extent_no; /* number of extents */
|
---|
82 | size_t bsize; /* block size */
|
---|
83 | uint64_t truncated_blkno; /* blkno per extent */
|
---|
84 | uint64_t data_blkno; /* no. of user usable blocks */
|
---|
85 | uint64_t data_offset; /* user data offset in blocks */
|
---|
86 | uint32_t strip_size; /* strip size */
|
---|
87 | hr_level_t level; /* volume level */
|
---|
88 | uint8_t layout; /* RAID Level Qualifier */
|
---|
89 | char devname[HR_DEVNAME_LEN];
|
---|
90 |
|
---|
91 | hr_extent_t extents[HR_MAX_EXTENTS];
|
---|
92 | fibril_rwlock_t extents_lock; /* extent service id lock */
|
---|
93 |
|
---|
94 | size_t hotspare_no; /* no. of available hotspares */
|
---|
95 | hr_extent_t hotspares[HR_MAX_HOTSPARES];
|
---|
96 | fibril_mutex_t hotspare_lock; /* lock protecting hotspares */
|
---|
97 |
|
---|
98 | fibril_rwlock_t states_lock; /* states lock */
|
---|
99 |
|
---|
100 | _Atomic bool state_dirty; /* dirty state */
|
---|
101 |
|
---|
102 | /* XXX: atomic_uint_least64_t? */
|
---|
103 | _Atomic uint64_t rebuild_blk; /* rebuild position */
|
---|
104 | _Atomic int open_cnt; /* open/close() counter */
|
---|
105 | hr_vol_status_t status; /* volume status */
|
---|
106 | void (*state_callback)(hr_volume_t *, size_t, errno_t);
|
---|
107 | } hr_volume_t;
|
---|
108 |
|
---|
109 | typedef enum {
|
---|
110 | HR_BD_SYNC,
|
---|
111 | HR_BD_READ,
|
---|
112 | HR_BD_WRITE
|
---|
113 | } hr_bd_op_type_t;
|
---|
114 |
|
---|
115 | /* macros for hr_metadata_save() */
|
---|
116 | #define WITH_STATE_CALLBACK true
|
---|
117 | #define NO_STATE_CALLBACK false
|
---|
118 |
|
---|
119 | typedef struct hr_range_lock {
|
---|
120 | link_t link;
|
---|
121 | fibril_mutex_t lock;
|
---|
122 | hr_volume_t *vol; /* back-pointer to volume */
|
---|
123 | uint64_t off; /* start of the range */
|
---|
124 | uint64_t len; /* length of the range */
|
---|
125 |
|
---|
126 | size_t pending; /* prot. by vol->range_lock_list_lock */
|
---|
127 | bool ignore; /* prot. by vol->range_lock_list_lock */
|
---|
128 | } hr_range_lock_t;
|
---|
129 |
|
---|
130 | extern errno_t hr_raid0_create(hr_volume_t *);
|
---|
131 | extern errno_t hr_raid1_create(hr_volume_t *);
|
---|
132 | extern errno_t hr_raid5_create(hr_volume_t *);
|
---|
133 |
|
---|
134 | extern errno_t hr_raid0_init(hr_volume_t *);
|
---|
135 | extern errno_t hr_raid1_init(hr_volume_t *);
|
---|
136 | extern errno_t hr_raid5_init(hr_volume_t *);
|
---|
137 |
|
---|
138 | extern void hr_raid0_status_event(hr_volume_t *);
|
---|
139 | extern void hr_raid1_status_event(hr_volume_t *);
|
---|
140 | extern void hr_raid5_status_event(hr_volume_t *);
|
---|
141 |
|
---|
142 | extern errno_t hr_raid1_add_hotspare(hr_volume_t *, service_id_t);
|
---|
143 | extern errno_t hr_raid5_add_hotspare(hr_volume_t *, service_id_t);
|
---|
144 |
|
---|
145 | #endif
|
---|
146 |
|
---|
147 | /** @}
|
---|
148 | */
|
---|