2 * Copyright (c) 2011-2013 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@dragonflybsd.org>
6 * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * WARNING! The ioctl functions which manipulate the connection state need
39 * to be able to run without deadlock on the volume's chain lock.
40 * Most of these functions use a separate lock.
45 static int hammer2_ioctl_version_get(hammer2_inode_t *ip, void *data);
46 static int hammer2_ioctl_recluster(hammer2_inode_t *ip, void *data);
47 static int hammer2_ioctl_remote_scan(hammer2_inode_t *ip, void *data);
48 static int hammer2_ioctl_remote_add(hammer2_inode_t *ip, void *data);
49 static int hammer2_ioctl_remote_del(hammer2_inode_t *ip, void *data);
50 static int hammer2_ioctl_remote_rep(hammer2_inode_t *ip, void *data);
51 static int hammer2_ioctl_socket_get(hammer2_inode_t *ip, void *data);
52 static int hammer2_ioctl_socket_set(hammer2_inode_t *ip, void *data);
53 static int hammer2_ioctl_pfs_get(hammer2_inode_t *ip, void *data);
54 static int hammer2_ioctl_pfs_lookup(hammer2_inode_t *ip, void *data);
55 static int hammer2_ioctl_pfs_create(hammer2_inode_t *ip, void *data);
56 static int hammer2_ioctl_pfs_snapshot(hammer2_inode_t *ip, void *data);
57 static int hammer2_ioctl_pfs_delete(hammer2_inode_t *ip, void *data);
58 static int hammer2_ioctl_inode_get(hammer2_inode_t *ip, void *data);
59 static int hammer2_ioctl_inode_set(hammer2_inode_t *ip, void *data);
60 //static int hammer2_ioctl_inode_comp_set(hammer2_inode_t *ip, void *data);
61 //static int hammer2_ioctl_inode_comp_rec_set(hammer2_inode_t *ip, void *data);
62 //static int hammer2_ioctl_inode_comp_rec_set2(hammer2_inode_t *ip, void *data);
65 hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data, int fflag,
71 * Standard root cred checks, will be selectively ignored below
72 * for ioctls that do not require root creds.
74 error = priv_check_cred(cred, PRIV_HAMMER_IOCTL, 0);
77 case HAMMER2IOC_VERSION_GET:
78 error = hammer2_ioctl_version_get(ip, data);
80 case HAMMER2IOC_RECLUSTER:
82 error = hammer2_ioctl_recluster(ip, data);
84 case HAMMER2IOC_REMOTE_SCAN:
86 error = hammer2_ioctl_remote_scan(ip, data);
88 case HAMMER2IOC_REMOTE_ADD:
90 error = hammer2_ioctl_remote_add(ip, data);
92 case HAMMER2IOC_REMOTE_DEL:
94 error = hammer2_ioctl_remote_del(ip, data);
96 case HAMMER2IOC_REMOTE_REP:
98 error = hammer2_ioctl_remote_rep(ip, data);
100 case HAMMER2IOC_SOCKET_GET:
102 error = hammer2_ioctl_socket_get(ip, data);
104 case HAMMER2IOC_SOCKET_SET:
106 error = hammer2_ioctl_socket_set(ip, data);
108 case HAMMER2IOC_PFS_GET:
110 error = hammer2_ioctl_pfs_get(ip, data);
112 case HAMMER2IOC_PFS_LOOKUP:
114 error = hammer2_ioctl_pfs_lookup(ip, data);
116 case HAMMER2IOC_PFS_CREATE:
118 error = hammer2_ioctl_pfs_create(ip, data);
120 case HAMMER2IOC_PFS_DELETE:
122 error = hammer2_ioctl_pfs_delete(ip, data);
124 case HAMMER2IOC_PFS_SNAPSHOT:
126 error = hammer2_ioctl_pfs_snapshot(ip, data);
128 case HAMMER2IOC_INODE_GET:
129 error = hammer2_ioctl_inode_get(ip, data);
131 case HAMMER2IOC_INODE_SET:
133 error = hammer2_ioctl_inode_set(ip, data);
135 /*case HAMMER2IOC_INODE_COMP_SET:
136 error = hammer2_ioctl_inode_comp_set(ip, data);
138 case HAMMER2IOC_INODE_COMP_REC_SET:
139 error = hammer2_ioctl_inode_comp_rec_set(ip, data);
141 case HAMMER2IOC_INODE_COMP_REC_SET2:
142 error = hammer2_ioctl_inode_comp_rec_set2(ip, data);
152 * Retrieve version and basic info
155 hammer2_ioctl_version_get(hammer2_inode_t *ip, void *data)
157 hammer2_mount_t *hmp = ip->pmp->mount_cluster->hmp;
158 hammer2_ioc_version_t *version = data;
160 version->version = hmp->voldata.version;
165 hammer2_ioctl_recluster(hammer2_inode_t *ip, void *data)
167 hammer2_ioc_recluster_t *recl = data;
170 fp = holdfp(curproc->p_fd, recl->fd, -1);
172 kprintf("reconnect to cluster\n");
173 hammer2_cluster_reconnect(ip->pmp, fp);
181 * Retrieve information about a remote
184 hammer2_ioctl_remote_scan(hammer2_inode_t *ip, void *data)
186 hammer2_mount_t *hmp = ip->pmp->mount_cluster->hmp;
187 hammer2_ioc_remote_t *remote = data;
188 int copyid = remote->copyid;
190 if (copyid < 0 || copyid >= HAMMER2_COPYID_COUNT)
193 hammer2_voldata_lock(hmp);
194 remote->copy1 = hmp->voldata.copyinfo[copyid];
195 hammer2_voldata_unlock(hmp, 0);
198 * Adjust nextid (GET only)
200 while (++copyid < HAMMER2_COPYID_COUNT &&
201 hmp->voldata.copyinfo[copyid].copyid == 0) {
204 if (copyid == HAMMER2_COPYID_COUNT)
207 remote->nextid = copyid;
213 * Add new remote entry
216 hammer2_ioctl_remote_add(hammer2_inode_t *ip, void *data)
218 hammer2_ioc_remote_t *remote = data;
219 hammer2_pfsmount_t *pmp = ip->pmp;
220 hammer2_mount_t *hmp;
221 int copyid = remote->copyid;
224 if (copyid >= HAMMER2_COPYID_COUNT)
227 hmp = pmp->mount_cluster->hmp;
228 hammer2_voldata_lock(hmp);
230 for (copyid = 1; copyid < HAMMER2_COPYID_COUNT; ++copyid) {
231 if (hmp->voldata.copyinfo[copyid].copyid == 0)
234 if (copyid == HAMMER2_COPYID_COUNT) {
239 hammer2_modify_volume(hmp);
240 remote->copy1.copyid = copyid;
241 hmp->voldata.copyinfo[copyid] = remote->copy1;
242 hammer2_volconf_update(pmp, copyid);
244 hammer2_voldata_unlock(hmp, 1);
249 * Delete existing remote entry
252 hammer2_ioctl_remote_del(hammer2_inode_t *ip, void *data)
254 hammer2_ioc_remote_t *remote = data;
255 hammer2_pfsmount_t *pmp = ip->pmp;
256 hammer2_mount_t *hmp;
257 int copyid = remote->copyid;
260 hmp = pmp->mount_cluster->hmp;
261 if (copyid >= HAMMER2_COPYID_COUNT)
263 remote->copy1.path[sizeof(remote->copy1.path) - 1] = 0;
264 hammer2_voldata_lock(hmp);
266 for (copyid = 1; copyid < HAMMER2_COPYID_COUNT; ++copyid) {
267 if (hmp->voldata.copyinfo[copyid].copyid == 0)
269 if (strcmp(remote->copy1.path,
270 hmp->voldata.copyinfo[copyid].path) == 0) {
274 if (copyid == HAMMER2_COPYID_COUNT) {
279 hammer2_modify_volume(hmp);
280 hmp->voldata.copyinfo[copyid].copyid = 0;
281 hammer2_volconf_update(pmp, copyid);
283 hammer2_voldata_unlock(hmp, 1);
288 * Replace existing remote entry
291 hammer2_ioctl_remote_rep(hammer2_inode_t *ip, void *data)
293 hammer2_ioc_remote_t *remote = data;
294 hammer2_mount_t *hmp;
295 int copyid = remote->copyid;
297 hmp = ip->pmp->mount_cluster->hmp;
299 if (copyid < 0 || copyid >= HAMMER2_COPYID_COUNT)
302 hammer2_voldata_lock(hmp);
303 /*hammer2_volconf_update(pmp, copyid);*/
304 hammer2_voldata_unlock(hmp, 1);
310 * Retrieve communications socket
313 hammer2_ioctl_socket_get(hammer2_inode_t *ip, void *data)
319 * Set communications socket for connection
322 hammer2_ioctl_socket_set(hammer2_inode_t *ip, void *data)
324 hammer2_ioc_remote_t *remote = data;
325 hammer2_mount_t *hmp;
326 int copyid = remote->copyid;
328 hmp = ip->pmp->mount_cluster->hmp;
329 if (copyid < 0 || copyid >= HAMMER2_COPYID_COUNT)
332 hammer2_voldata_lock(hmp);
333 hammer2_voldata_unlock(hmp, 0);
339 * Used to scan and retrieve PFS information. PFS's are directories under
342 * To scan PFSs pass name_key=0. The function will scan for the next
343 * PFS and set all fields, as well as set name_next to the next key.
344 * When no PFSs remain, name_next is set to (hammer2_key_t)-1.
346 * To retrieve the PFS associated with the file descriptor, pass
347 * name_key set to (hammer2_key_t)-1.
350 hammer2_ioctl_pfs_get(hammer2_inode_t *ip, void *data)
352 hammer2_inode_data_t *ipdata;
353 hammer2_mount_t *hmp;
354 hammer2_ioc_pfs_t *pfs;
355 hammer2_chain_t *parent;
356 hammer2_chain_t *chain;
357 hammer2_chain_t *rchain;
358 hammer2_key_t key_next;
360 int cache_index = -1;
363 hmp = ip->pmp->mount_cluster->hmp;
365 parent = hammer2_chain_lookup_init(hmp->schain, 0);
366 rchain = ip->pmp->mount_cluster->rchain;
369 * Search for the first key or specific key. Remember that keys
370 * can be returned in any order.
372 if (pfs->name_key == 0) {
373 chain = hammer2_chain_lookup(&parent, &key_next,
374 0, (hammer2_key_t)-1,
376 } else if (pfs->name_key == (hammer2_key_t)-1) {
377 chain = hammer2_chain_lookup(&parent, &key_next,
378 rchain->data->ipdata.name_key,
379 rchain->data->ipdata.name_key,
382 chain = hammer2_chain_lookup(&parent, &key_next,
383 pfs->name_key, pfs->name_key,
386 while (chain && chain->bref.type != HAMMER2_BREF_TYPE_INODE) {
387 chain = hammer2_chain_next(&parent, chain, &key_next,
388 key_next, (hammer2_key_t)-1,
393 * Load the data being returned by the ioctl.
395 ipdata = &chain->data->ipdata;
396 pfs->name_key = ipdata->name_key;
397 pfs->pfs_type = ipdata->pfs_type;
398 pfs->pfs_clid = ipdata->pfs_clid;
399 pfs->pfs_fsid = ipdata->pfs_fsid;
400 KKASSERT(ipdata->name_len < sizeof(pfs->name));
401 bcopy(ipdata->filename, pfs->name, ipdata->name_len);
402 pfs->name[ipdata->name_len] = 0;
403 ipdata = NULL; /* safety */
406 * Calculate the next field
409 chain = hammer2_chain_next(&parent, chain, &key_next,
410 0, (hammer2_key_t)-1,
412 } while (chain && chain->bref.type != HAMMER2_BREF_TYPE_INODE);
414 pfs->name_next = chain->data->ipdata.name_key;
415 hammer2_chain_unlock(chain);
417 pfs->name_next = (hammer2_key_t)-1;
420 pfs->name_next = (hammer2_key_t)-1;
423 hammer2_chain_lookup_done(parent);
429 * Find a specific PFS by name
432 hammer2_ioctl_pfs_lookup(hammer2_inode_t *ip, void *data)
434 hammer2_inode_data_t *ipdata;
435 hammer2_mount_t *hmp;
436 hammer2_ioc_pfs_t *pfs;
437 hammer2_chain_t *parent;
438 hammer2_chain_t *chain;
439 hammer2_key_t key_next;
442 int cache_index = -1;
446 hmp = ip->pmp->mount_cluster->hmp;
448 parent = hammer2_chain_lookup_init(hmp->schain, HAMMER2_LOOKUP_SHARED);
450 pfs->name[sizeof(pfs->name) - 1] = 0;
451 len = strlen(pfs->name);
452 lhc = hammer2_dirhash(pfs->name, len);
454 chain = hammer2_chain_lookup(&parent, &key_next,
455 lhc, lhc + HAMMER2_DIRHASH_LOMASK,
456 &cache_index, HAMMER2_LOOKUP_SHARED);
458 if (chain->bref.type == HAMMER2_BREF_TYPE_INODE &&
459 len == chain->data->ipdata.name_len &&
460 bcmp(pfs->name, chain->data->ipdata.filename, len) == 0) {
463 chain = hammer2_chain_next(&parent, chain, &key_next,
465 lhc + HAMMER2_DIRHASH_LOMASK,
466 &cache_index, HAMMER2_LOOKUP_SHARED);
470 * Load the data being returned by the ioctl.
473 ipdata = &chain->data->ipdata;
474 pfs->name_key = ipdata->name_key;
475 pfs->pfs_type = ipdata->pfs_type;
476 pfs->pfs_clid = ipdata->pfs_clid;
477 pfs->pfs_fsid = ipdata->pfs_fsid;
480 hammer2_chain_unlock(chain);
484 hammer2_chain_lookup_done(parent);
489 * Create a new PFS under the super-root
492 hammer2_ioctl_pfs_create(hammer2_inode_t *ip, void *data)
494 hammer2_inode_data_t *nipdata;
495 hammer2_mount_t *hmp;
496 hammer2_ioc_pfs_t *pfs;
497 hammer2_inode_t *nip;
498 hammer2_chain_t *nchain;
499 hammer2_trans_t trans;
502 hmp = ip->pmp->mount_cluster->hmp;
506 if (pfs->name[0] == 0)
508 pfs->name[sizeof(pfs->name) - 1] = 0; /* ensure 0-termination */
510 hammer2_trans_init(&trans, ip->pmp, 0);
511 nip = hammer2_inode_create(&trans, hmp->sroot, NULL, NULL,
512 pfs->name, strlen(pfs->name),
515 nipdata = hammer2_chain_modify_ip(&trans, nip, &nchain,
516 HAMMER2_MODIFY_ASSERTNOCOPY);
517 nipdata->pfs_type = pfs->pfs_type;
518 nipdata->pfs_clid = pfs->pfs_clid;
519 nipdata->pfs_fsid = pfs->pfs_fsid;
522 * Do not allow compression on PFS's with the special name
523 * "boot", the boot loader can't decompress (yet).
525 if (strcmp(pfs->name, "boot") == 0)
526 nipdata->comp_algo = HAMMER2_COMP_AUTOZERO;
527 hammer2_inode_unlock_ex(nip, nchain);
529 hammer2_trans_done(&trans);
534 * Destroy an existing PFS under the super-root
537 hammer2_ioctl_pfs_delete(hammer2_inode_t *ip, void *data)
539 hammer2_mount_t *hmp;
540 hammer2_ioc_pfs_t *pfs = data;
541 hammer2_trans_t trans;
544 hmp = ip->pmp->mount_cluster->hmp;
545 hammer2_trans_init(&trans, ip->pmp, 0);
546 error = hammer2_unlink_file(&trans, hmp->sroot,
547 pfs->name, strlen(pfs->name),
549 hammer2_trans_done(&trans);
555 hammer2_ioctl_pfs_snapshot(hammer2_inode_t *ip, void *data)
557 hammer2_ioc_pfs_t *pfs = data;
558 hammer2_trans_t trans;
559 hammer2_chain_t *parent;
562 if (pfs->name[0] == 0)
564 if (pfs->name[sizeof(pfs->name)-1] != 0)
567 hammer2_trans_init(&trans, ip->pmp, 0);
568 parent = hammer2_inode_lock_ex(ip);
569 error = hammer2_chain_snapshot(&trans, ip, pfs);
570 hammer2_inode_unlock_ex(ip, parent);
571 hammer2_trans_done(&trans);
577 * Retrieve the raw inode structure
580 hammer2_ioctl_inode_get(hammer2_inode_t *ip, void *data)
582 hammer2_ioc_inode_t *ino = data;
583 hammer2_chain_t *parent;
585 parent = hammer2_inode_lock_sh(ip);
586 ino->ip_data = ip->chain->data->ipdata;
588 hammer2_inode_unlock_sh(ip, parent);
594 * Set various parameters in an inode which cannot be set through
595 * normal filesystem VNOPS.
598 hammer2_ioctl_inode_set(hammer2_inode_t *ip, void *data)
600 hammer2_inode_data_t *ipdata;
601 hammer2_ioc_inode_t *ino = data;
602 hammer2_chain_t *chain;
603 hammer2_trans_t trans;
606 hammer2_trans_init(&trans, ip->pmp, 0);
607 chain = hammer2_inode_lock_ex(ip);
609 if (ino->ip_data.comp_algo != chain->data->ipdata.comp_algo) {
610 ipdata = hammer2_chain_modify_ip(&trans, ip, &chain, 0);
611 ipdata->comp_algo = ino->ip_data.comp_algo;
615 /* Ignore these flags for now...*/
616 if (ino->flags & HAMMER2IOC_INODE_FLAG_IQUOTA) {
618 if (ino->flags & HAMMER2IOC_INODE_FLAG_DQUOTA) {
620 if (ino->flags & HAMMER2IOC_INODE_FLAG_COPIES) {
622 hammer2_trans_done(&trans);
623 hammer2_inode_unlock_ex(ip, chain);