1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
*
* Copyright 2013 Nexenta Systems, Inc. All rights reserved.
*/
#ifndef _SYS_LOFI_H
#define _SYS_LOFI_H
#include <sys/types.h>
#include <sys/time.h>
#include <sys/taskq.h>
#include <sys/vtoc.h>
#include <sys/dkio.h>
#include <sys/vnode.h>
#include <sys/list.h>
#include <sys/crypto/api.h>
#include <sys/zone.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* /dev names:
* /dev/lofictl - master control device
* /dev/lofi - block devices, named by minor number
* /dev/rlofi - character devices, named by minor number
*/
#define LOFI_DRIVER_NAME "lofi"
#define LOFI_CTL_NODE "ctl"
#define LOFI_CTL_NAME LOFI_DRIVER_NAME LOFI_CTL_NODE
#define LOFI_BLOCK_NAME LOFI_DRIVER_NAME
#define LOFI_CHAR_NAME "r" LOFI_DRIVER_NAME
#define SEGHDR 1
#define COMPRESSED 1
#define UNCOMPRESSED 0
#define MAXALGLEN 36
/*
*
* Use is:
* ld = open("/dev/lofictl", O_RDWR | O_EXCL);
*
* lofi must be opened exclusively. Access is controlled by permissions on
* the device, which is 644 by default. Write-access is required for ioctls
* that change state, but only read-access is required for the ioctls that
* return information. Basically, only root can add and remove files, but
* non-root can look at the current lists.
*
* ioctl usage:
*
* kernel ioctls
*
* strcpy(li.li_filename, "somefilename");
* ioctl(ld, LOFI_MAP_FILE, &li);
* newminor = li.li_minor;
*
* strcpy(li.li_filename, "somefilename");
* ioctl(ld, LOFI_UNMAP_FILE, &li);
*
* strcpy(li.li_filename, "somefilename");
* li.li_minor = minor_number;
* ioctl(ld, LOFI_MAP_FILE_MINOR, &li);
*
* li.li_minor = minor_number;
* ioctl(ld, LOFI_UNMAP_FILE_MINOR, &li);
*
* li.li_minor = minor_number;
* ioctl(ld, LOFI_GET_FILENAME, &li);
* filename = li.li_filename;
* encrypted = li.li_crypto_enabled;
*
* strcpy(li.li_filename, "somefilename");
* ioctl(ld, LOFI_GET_MINOR, &li);
* minor = li.li_minor;
*
* li.li_minor = 0;
* ioctl(ld, LOFI_GET_MAXMINOR, &li);
* maxminor = li.li_minor;
*
* strcpy(li.li_filename, "somefilename");
* li.li_minor = 0;
* ioctl(ld, LOFI_CHECK_COMPRESSED, &li);
*
* If the 'li_force' flag is set for any of the LOFI_UNMAP_* commands, then if
* the device is busy, the underlying vnode will be closed, and any subsequent
* operations will fail. It will behave as if the device had been forcibly
* removed, so the DKIOCSTATE ioctl will return DKIO_DEV_GONE. When the device
* is last closed, it will be torn down.
*
* If the 'li_cleanup' flag is set for any of the LOFI_UNMAP_* commands, then
* if the device is busy, it is marked for removal at the next time it is
* no longer held open by anybody. When the device is last closed, it will be
* torn down.
*
* Oh, and last but not least: these ioctls are totally private and only
* for use by lofiadm(1M).
*
*/
typedef enum iv_method {
IVM_NONE, /* no iv needed, iv is null */
IVM_ENC_BLKNO /* iv is logical block no. encrypted */
} iv_method_t;
struct lofi_ioctl {
uint32_t li_minor;
boolean_t li_force;
boolean_t li_cleanup;
boolean_t li_readonly;
char li_filename[MAXPATHLEN];
/* the following fields are required for compression support */
char li_algorithm[MAXALGLEN];
/* the following fields are required for encryption support */
boolean_t li_crypto_enabled;
crypto_mech_name_t li_cipher; /* for data */
uint32_t li_key_len; /* for data */
char li_key[56]; /* for data: max 448-bit Blowfish key */
crypto_mech_name_t li_iv_cipher; /* for iv derivation */
uint32_t li_iv_len; /* for iv derivation */
iv_method_t li_iv_type; /* for iv derivation */
};
#define LOFI_IOC_BASE (('L' << 16) | ('F' << 8))
#define LOFI_MAP_FILE (LOFI_IOC_BASE | 0x01)
#define LOFI_MAP_FILE_MINOR (LOFI_IOC_BASE | 0x02)
#define LOFI_UNMAP_FILE (LOFI_IOC_BASE | 0x03)
#define LOFI_UNMAP_FILE_MINOR (LOFI_IOC_BASE | 0x04)
#define LOFI_GET_FILENAME (LOFI_IOC_BASE | 0x05)
#define LOFI_GET_MINOR (LOFI_IOC_BASE | 0x06)
#define LOFI_GET_MAXMINOR (LOFI_IOC_BASE | 0x07)
#define LOFI_CHECK_COMPRESSED (LOFI_IOC_BASE | 0x08)
/*
* file types that might be usable with lofi, maybe. Only regular
* files are documented though.
*/
#define S_ISLOFIABLE(mode) \
(S_ISREG(mode) || S_ISBLK(mode) || S_ISCHR(mode))
#if defined(_KERNEL)
/*
* Cache decompressed data segments for the compressed lofi images.
*
* To avoid that we have to decompress data of a compressed
* segment multiple times when accessing parts of the segment's
* data we cache the uncompressed data, using a simple linked list.
*/
struct lofi_comp_cache {
list_node_t lc_list; /* linked list */
uchar_t *lc_data; /* decompressed segment data */
uint64_t lc_index; /* segment index */
};
#define V_ISLOFIABLE(vtype) \
((vtype == VREG) || (vtype == VBLK) || (vtype == VCHR))
/*
* Pre-allocated memory buffers for the purpose of compression
*/
struct compbuf {
void *buf;
uint32_t bufsize;
int inuse;
};
/*
* Need exactly 6 bytes to identify encrypted lofi image
*/
extern const char lofi_crypto_magic[6];
#define LOFI_CRYPTO_MAGIC { 'C', 'F', 'L', 'O', 'F', 'I' }
#define LOFI_CRYPTO_VERSION ((uint16_t)0)
#define LOFI_CRYPTO_DATA_SECTOR ((uint32_t)16) /* for version 0 */
/*
* Crypto metadata for encrypted lofi images
* The fields here only satisfy initial implementation requirements.
*/
struct crypto_meta {
char magic[6]; /* LOFI_CRYPTO_MAGIC */
uint16_t version; /* version of encrypted lofi */
char reserved1[96]; /* future use */
uint32_t data_sector; /* start of data area */
char pad[404]; /* end on DEV_BSIZE bdry */
/* second header block is not defined at this time */
};
struct lofi_state {
vnode_t *ls_vp; /* open real vnode */
vnode_t *ls_stacked_vp; /* open vnode */
kmutex_t ls_vp_lock; /* protects ls_vp */
kcondvar_t ls_vp_cv; /* signal changes to ls_vp */
uint32_t ls_vp_iocount; /* # pending I/O requests */
boolean_t ls_vp_closereq; /* force close requested */
u_offset_t ls_vp_size;
uint32_t ls_blk_open;
uint32_t ls_chr_open;
uint32_t ls_lyr_open_count;
int ls_openflag;
boolean_t ls_cleanup; /* cleanup on close */
boolean_t ls_readonly;
taskq_t *ls_taskq;
kstat_t *ls_kstat;
kmutex_t ls_kstat_lock;
struct dk_geom ls_dkg;
struct vtoc ls_vtoc;
struct dk_cinfo ls_ci;
zone_ref_t ls_zone;
list_node_t ls_list; /* all lofis */
dev_t ls_dev; /* this node's dev_t */
/* the following fields are required for compression support */
int ls_comp_algorithm_index; /* idx into compress_table */
char ls_comp_algorithm[MAXALGLEN];
uint32_t ls_uncomp_seg_sz; /* sz of uncompressed segment */
uint32_t ls_comp_index_sz; /* number of index entries */
uint32_t ls_comp_seg_shift; /* exponent for byte shift */
uint32_t ls_uncomp_last_seg_sz; /* sz of last uncomp segment */
uint64_t ls_comp_offbase; /* offset of actual compressed data */
uint64_t *ls_comp_seg_index; /* array of index entries */
caddr_t ls_comp_index_data; /* index pages loaded from file */
uint32_t ls_comp_index_data_sz;
u_offset_t ls_vp_comp_size; /* actual compressed file size */
/* pre-allocated list of buffers for compressed segment data */
kmutex_t ls_comp_bufs_lock;
struct compbuf *ls_comp_bufs;
/* lock and anchor for compressed segment caching */
kmutex_t ls_comp_cache_lock; /* protects ls_comp_cache */
list_t ls_comp_cache; /* cached decompressed segs */
uint32_t ls_comp_cache_count;
/* the following fields are required for encryption support */
boolean_t ls_crypto_enabled;
u_offset_t ls_crypto_offset; /* crypto meta size */
struct crypto_meta ls_crypto;
crypto_mechanism_t ls_mech; /* for data encr/decr */
crypto_key_t ls_key; /* for data encr/decr */
crypto_mechanism_t ls_iv_mech; /* for iv derivation */
size_t ls_iv_len; /* for iv derivation */
iv_method_t ls_iv_type; /* for iv derivation */
kmutex_t ls_crypto_lock;
crypto_ctx_template_t ls_ctx_tmpl;
};
#endif /* _KERNEL */
/*
* Common signature for all lofi compress functions
*/
typedef int lofi_compress_func_t(void *src, size_t srclen, void *dst,
size_t *destlen, int level);
/*
* Information about each compression function
*/
typedef struct lofi_compress_info {
lofi_compress_func_t *l_decompress;
lofi_compress_func_t *l_compress;
int l_level;
char *l_name; /* algorithm name */
} lofi_compress_info_t;
enum lofi_compress {
LOFI_COMPRESS_GZIP = 0,
LOFI_COMPRESS_GZIP_6 = 1,
LOFI_COMPRESS_GZIP_9 = 2,
LOFI_COMPRESS_LZMA = 3,
LOFI_COMPRESS_FUNCTIONS
};
#ifdef __cplusplus
}
#endif
#endif /* _SYS_LOFI_H */
|
