2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/vfs/hammer/hammer_ioctl.c,v 1.32 2008/11/13 02:23:29 dillon Exp $
39 static int hammer_ioc_gethistory(hammer_transaction_t trans, hammer_inode_t ip,
40 struct hammer_ioc_history *hist);
41 static int hammer_ioc_synctid(hammer_transaction_t trans, hammer_inode_t ip,
42 struct hammer_ioc_synctid *std);
43 static int hammer_ioc_get_version(hammer_transaction_t trans,
45 struct hammer_ioc_version *ver);
46 static int hammer_ioc_set_version(hammer_transaction_t trans,
48 struct hammer_ioc_version *ver);
49 static int hammer_ioc_get_info(hammer_transaction_t trans,
50 struct hammer_ioc_info *info);
55 hammer_ioctl(hammer_inode_t ip, u_long com, caddr_t data, int fflag,
58 struct hammer_transaction trans;
61 error = priv_check_cred(cred, PRIV_HAMMER_IOCTL, 0);
63 hammer_start_transaction(&trans, ip->hmp);
68 error = hammer_ioc_prune(&trans, ip,
69 (struct hammer_ioc_prune *)data);
72 case HAMMERIOC_GETHISTORY:
73 error = hammer_ioc_gethistory(&trans, ip,
74 (struct hammer_ioc_history *)data);
76 case HAMMERIOC_REBLOCK:
78 error = hammer_ioc_reblock(&trans, ip,
79 (struct hammer_ioc_reblock *)data);
82 case HAMMERIOC_REBALANCE:
84 error = hammer_ioc_rebalance(&trans, ip,
85 (struct hammer_ioc_rebalance *)data);
88 case HAMMERIOC_SYNCTID:
89 error = hammer_ioc_synctid(&trans, ip,
90 (struct hammer_ioc_synctid *)data);
92 case HAMMERIOC_GET_PSEUDOFS:
93 error = hammer_ioc_get_pseudofs(&trans, ip,
94 (struct hammer_ioc_pseudofs_rw *)data);
96 case HAMMERIOC_SET_PSEUDOFS:
98 error = hammer_ioc_set_pseudofs(&trans, ip, cred,
99 (struct hammer_ioc_pseudofs_rw *)data);
102 case HAMMERIOC_UPG_PSEUDOFS:
104 error = hammer_ioc_upgrade_pseudofs(&trans, ip,
105 (struct hammer_ioc_pseudofs_rw *)data);
108 case HAMMERIOC_DGD_PSEUDOFS:
110 error = hammer_ioc_downgrade_pseudofs(&trans, ip,
111 (struct hammer_ioc_pseudofs_rw *)data);
114 case HAMMERIOC_RMR_PSEUDOFS:
116 error = hammer_ioc_destroy_pseudofs(&trans, ip,
117 (struct hammer_ioc_pseudofs_rw *)data);
120 case HAMMERIOC_WAI_PSEUDOFS:
122 error = hammer_ioc_wait_pseudofs(&trans, ip,
123 (struct hammer_ioc_pseudofs_rw *)data);
126 case HAMMERIOC_MIRROR_READ:
128 error = hammer_ioc_mirror_read(&trans, ip,
129 (struct hammer_ioc_mirror_rw *)data);
132 case HAMMERIOC_MIRROR_WRITE:
134 error = hammer_ioc_mirror_write(&trans, ip,
135 (struct hammer_ioc_mirror_rw *)data);
138 case HAMMERIOC_GET_VERSION:
139 error = hammer_ioc_get_version(&trans, ip,
140 (struct hammer_ioc_version *)data);
142 case HAMMERIOC_GET_INFO:
143 error = hammer_ioc_get_info(&trans,
144 (struct hammer_ioc_info *)data);
146 case HAMMERIOC_SET_VERSION:
148 error = hammer_ioc_set_version(&trans, ip,
149 (struct hammer_ioc_version *)data);
152 case HAMMERIOC_EXPAND:
154 error = hammer_ioc_expand(&trans, ip,
155 (struct hammer_ioc_expand *)data);
163 hammer_done_transaction(&trans);
168 * Iterate through an object's inode or an object's records and record
171 static void add_history(hammer_inode_t ip, struct hammer_ioc_history *hist,
172 hammer_btree_elm_t elm);
176 hammer_ioc_gethistory(hammer_transaction_t trans, hammer_inode_t ip,
177 struct hammer_ioc_history *hist)
179 struct hammer_cursor cursor;
180 hammer_btree_elm_t elm;
184 * Validate the structure and initialize for return.
186 if (hist->beg_tid > hist->end_tid)
188 if (hist->head.flags & HAMMER_IOC_HISTORY_ATKEY) {
189 if (hist->key > hist->nxt_key)
193 hist->obj_id = ip->obj_id;
195 hist->nxt_tid = hist->end_tid;
196 hist->head.flags &= ~HAMMER_IOC_HISTORY_NEXT_TID;
197 hist->head.flags &= ~HAMMER_IOC_HISTORY_NEXT_KEY;
198 hist->head.flags &= ~HAMMER_IOC_HISTORY_EOF;
199 hist->head.flags &= ~HAMMER_IOC_HISTORY_UNSYNCED;
200 if ((ip->flags & HAMMER_INODE_MODMASK) &
201 ~(HAMMER_INODE_ATIME | HAMMER_INODE_MTIME)) {
202 hist->head.flags |= HAMMER_IOC_HISTORY_UNSYNCED;
206 * Setup the cursor. We can't handle undeletable records
207 * (create_tid of 0) at the moment. A create_tid of 0 has
208 * a special meaning and cannot be specified in the cursor.
210 error = hammer_init_cursor(trans, &cursor, &ip->cache[0], NULL);
212 hammer_done_cursor(&cursor);
216 cursor.key_beg.obj_id = hist->obj_id;
217 cursor.key_beg.create_tid = hist->beg_tid;
218 cursor.key_beg.delete_tid = 0;
219 cursor.key_beg.obj_type = 0;
220 if (cursor.key_beg.create_tid == HAMMER_MIN_TID)
221 cursor.key_beg.create_tid = 1;
223 cursor.key_end.obj_id = hist->obj_id;
224 cursor.key_end.create_tid = hist->end_tid;
225 cursor.key_end.delete_tid = 0;
226 cursor.key_end.obj_type = 0;
228 cursor.flags |= HAMMER_CURSOR_END_EXCLUSIVE;
230 if (hist->head.flags & HAMMER_IOC_HISTORY_ATKEY) {
232 * key-range within the file. For a regular file the
233 * on-disk key represents BASE+LEN, not BASE, so the
234 * first possible record containing the offset 'key'
235 * has an on-disk key of (key + 1).
237 cursor.key_beg.key = hist->key;
238 cursor.key_end.key = HAMMER_MAX_KEY;
239 cursor.key_beg.localization = ip->obj_localization +
240 HAMMER_LOCALIZE_MISC;
241 cursor.key_end.localization = ip->obj_localization +
242 HAMMER_LOCALIZE_MISC;
244 switch(ip->ino_data.obj_type) {
245 case HAMMER_OBJTYPE_REGFILE:
246 ++cursor.key_beg.key;
247 cursor.key_beg.rec_type = HAMMER_RECTYPE_DATA;
249 case HAMMER_OBJTYPE_DIRECTORY:
250 cursor.key_beg.rec_type = HAMMER_RECTYPE_DIRENTRY;
251 cursor.key_beg.localization =
252 hammer_dir_localization(ip);
253 cursor.key_end.localization =
254 hammer_dir_localization(ip);
256 case HAMMER_OBJTYPE_DBFILE:
257 cursor.key_beg.rec_type = HAMMER_RECTYPE_DB;
263 cursor.key_end.rec_type = cursor.key_beg.rec_type;
268 cursor.key_beg.key = 0;
269 cursor.key_end.key = 0;
270 cursor.key_beg.rec_type = HAMMER_RECTYPE_INODE;
271 cursor.key_end.rec_type = HAMMER_RECTYPE_INODE;
272 cursor.key_beg.localization = ip->obj_localization +
273 HAMMER_LOCALIZE_INODE;
274 cursor.key_end.localization = ip->obj_localization +
275 HAMMER_LOCALIZE_INODE;
278 error = hammer_btree_first(&cursor);
280 elm = &cursor.node->ondisk->elms[cursor.index];
282 add_history(ip, hist, elm);
283 if (hist->head.flags & (HAMMER_IOC_HISTORY_NEXT_TID |
284 HAMMER_IOC_HISTORY_NEXT_KEY |
285 HAMMER_IOC_HISTORY_EOF)) {
288 error = hammer_btree_iterate(&cursor);
290 if (error == ENOENT) {
291 hist->head.flags |= HAMMER_IOC_HISTORY_EOF;
294 hammer_done_cursor(&cursor);
299 * Add the scanned element to the ioctl return structure. Some special
300 * casing is required for regular files to accomodate how data ranges are
304 add_history(hammer_inode_t ip, struct hammer_ioc_history *hist,
305 hammer_btree_elm_t elm)
309 if (elm->base.btype != HAMMER_BTREE_TYPE_RECORD)
311 if ((hist->head.flags & HAMMER_IOC_HISTORY_ATKEY) &&
312 ip->ino_data.obj_type == HAMMER_OBJTYPE_REGFILE) {
316 if (hist->nxt_key > elm->leaf.base.key - elm->leaf.data_len &&
317 hist->key < elm->leaf.base.key - elm->leaf.data_len) {
318 hist->nxt_key = elm->leaf.base.key - elm->leaf.data_len;
320 if (hist->nxt_key > elm->leaf.base.key)
321 hist->nxt_key = elm->leaf.base.key;
324 * Record is beyond MAXPHYS, there won't be any more records
325 * in the iteration covering the requested offset (key).
327 if (elm->leaf.base.key >= MAXPHYS &&
328 elm->leaf.base.key - MAXPHYS > hist->key) {
329 hist->head.flags |= HAMMER_IOC_HISTORY_NEXT_KEY;
333 * Data-range of record does not cover the key.
335 if (elm->leaf.base.key - elm->leaf.data_len > hist->key)
338 } else if (hist->head.flags & HAMMER_IOC_HISTORY_ATKEY) {
342 if (hist->nxt_key > elm->leaf.base.key &&
343 hist->key < elm->leaf.base.key) {
344 hist->nxt_key = elm->leaf.base.key;
348 * Record is beyond the requested key.
350 if (elm->leaf.base.key > hist->key)
351 hist->head.flags |= HAMMER_IOC_HISTORY_NEXT_KEY;
355 * Add create_tid if it is in-bounds.
359 elm->leaf.base.create_tid != hist->hist_ary[i - 1].tid) &&
360 elm->leaf.base.create_tid >= hist->beg_tid &&
361 elm->leaf.base.create_tid < hist->end_tid) {
362 if (hist->count == HAMMER_MAX_HISTORY_ELMS) {
363 hist->nxt_tid = elm->leaf.base.create_tid;
364 hist->head.flags |= HAMMER_IOC_HISTORY_NEXT_TID;
367 hist->hist_ary[i].tid = elm->leaf.base.create_tid;
368 hist->hist_ary[i].time32 = elm->leaf.create_ts;
373 * Add delete_tid if it is in-bounds. Note that different portions
374 * of the history may have overlapping data ranges with different
375 * delete_tid's. If this case occurs the delete_tid may match the
376 * create_tid of a following record. XXX
382 if (elm->leaf.base.delete_tid &&
383 elm->leaf.base.delete_tid >= hist->beg_tid &&
384 elm->leaf.base.delete_tid < hist->end_tid) {
385 if (i == HAMMER_MAX_HISTORY_ELMS) {
386 hist->nxt_tid = elm->leaf.base.delete_tid;
387 hist->head.flags |= HAMMER_IOC_HISTORY_NEXT_TID;
390 hist->hist_ary[i].tid = elm->leaf.base.delete_tid;
391 hist->hist_ary[i].time32 = elm->leaf.delete_ts;
397 * Acquire synchronization TID
401 hammer_ioc_synctid(hammer_transaction_t trans, hammer_inode_t ip,
402 struct hammer_ioc_synctid *std)
404 hammer_mount_t hmp = ip->hmp;
408 case HAMMER_SYNCTID_NONE:
409 std->tid = hmp->flusher.tid; /* inaccurate */
411 case HAMMER_SYNCTID_ASYNC:
412 hammer_queue_inodes_flusher(hmp, MNT_NOWAIT);
413 hammer_flusher_async(hmp, NULL);
414 std->tid = hmp->flusher.tid; /* inaccurate */
416 case HAMMER_SYNCTID_SYNC1:
417 hammer_queue_inodes_flusher(hmp, MNT_WAIT);
418 hammer_flusher_sync(hmp);
419 std->tid = hmp->flusher.tid;
421 case HAMMER_SYNCTID_SYNC2:
422 hammer_queue_inodes_flusher(hmp, MNT_WAIT);
423 hammer_flusher_sync(hmp);
424 std->tid = hmp->flusher.tid;
425 hammer_flusher_sync(hmp);
435 * Retrieve version info.
437 * Load min_version, wip_version, and max_versino. If cur_version is passed
438 * as 0 then load the current version into cur_version. Load the description
439 * for cur_version into the description array.
441 * Returns 0 on success, EINVAL if cur_version is non-zero and set to an
446 hammer_ioc_get_version(hammer_transaction_t trans, hammer_inode_t ip,
447 struct hammer_ioc_version *ver)
451 ver->min_version = HAMMER_VOL_VERSION_MIN;
452 ver->wip_version = HAMMER_VOL_VERSION_WIP;
453 ver->max_version = HAMMER_VOL_VERSION_MAX;
454 if (ver->cur_version == 0)
455 ver->cur_version = trans->hmp->version;
456 switch(ver->cur_version) {
458 ksnprintf(ver->description, sizeof(ver->description),
459 "2.0 - First HAMMER release");
462 ksnprintf(ver->description, sizeof(ver->description),
463 "2.3 - New directory entry layout");
466 ksnprintf(ver->description, sizeof(ver->description),
479 hammer_ioc_set_version(hammer_transaction_t trans, hammer_inode_t ip,
480 struct hammer_ioc_version *ver)
482 struct hammer_cursor cursor;
483 hammer_volume_t volume;
486 if (ver->cur_version < trans->hmp->version)
488 if (ver->cur_version == trans->hmp->version)
490 if (ver->cur_version > HAMMER_VOL_VERSION_MAX)
492 if (trans->hmp->ronly)
496 * Update the root volume header and the version cached in
497 * the hammer_mount structure.
499 error = hammer_init_cursor(trans, &cursor, NULL, NULL);
502 hammer_sync_lock_sh(trans);
504 volume = hammer_get_root_volume(cursor.trans->hmp, &error);
505 KKASSERT(error == 0);
506 hammer_modify_volume_field(cursor.trans, volume, vol_version);
507 volume->ondisk->vol_version = ver->cur_version;
508 cursor.trans->hmp->version = ver->cur_version;
509 hammer_modify_volume_done(volume);
510 hammer_rel_volume(volume, 0);
512 hammer_sync_unlock(trans);
514 ver->head.error = error;
515 hammer_done_cursor(&cursor);
524 hammer_ioc_get_info(hammer_transaction_t trans, struct hammer_ioc_info *info) {
526 struct hammer_volume_ondisk *od = trans->hmp->rootvol->ondisk;
527 struct hammer_mount *hm = trans->hmp;
529 /* Fill the structure with the necessary information */
530 _hammer_checkspace(hm, HAMMER_CHKSPC_WRITE, &info->rsvbigblocks);
531 info->rsvbigblocks = info->rsvbigblocks >> HAMMER_LARGEBLOCK_BITS;
532 strlcpy(info->vol_name, od->vol_name, sizeof(od->vol_name));
534 info->vol_fsid = hm->fsid;
535 info->vol_fstype = od->vol_fstype;
536 info->version = hm->version;
538 info->inodes = od->vol0_stat_inodes;
539 info->bigblocks = od->vol0_stat_bigblocks;
540 info->freebigblocks = od->vol0_stat_freebigblocks;
541 info->nvolumes = hm->nvolumes;