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;
361 hmp = ip->pmp->mount_cluster->hmp;
363 parent = hammer2_chain_lookup_init(hmp->schain, 0);
364 rchain = ip->pmp->mount_cluster->rchain;
367 * Search for the first key or specific key. Remember that keys
368 * can be returned in any order.
370 if (pfs->name_key == 0) {
371 chain = hammer2_chain_lookup(&parent,
372 0, (hammer2_key_t)-1, 0);
373 } else if (pfs->name_key == (hammer2_key_t)-1) {
374 chain = hammer2_chain_lookup(&parent,
375 rchain->data->ipdata.name_key,
376 rchain->data->ipdata.name_key,
379 chain = hammer2_chain_lookup(&parent,
380 pfs->name_key, pfs->name_key, 0);
382 while (chain && chain->bref.type != HAMMER2_BREF_TYPE_INODE) {
383 chain = hammer2_chain_next(&parent, chain,
384 0, (hammer2_key_t)-1, 0);
388 * Load the data being returned by the ioctl.
390 ipdata = &chain->data->ipdata;
391 pfs->name_key = ipdata->name_key;
392 pfs->pfs_type = ipdata->pfs_type;
393 pfs->pfs_clid = ipdata->pfs_clid;
394 pfs->pfs_fsid = ipdata->pfs_fsid;
395 KKASSERT(ipdata->name_len < sizeof(pfs->name));
396 bcopy(ipdata->filename, pfs->name, ipdata->name_len);
397 pfs->name[ipdata->name_len] = 0;
398 ipdata = NULL; /* safety */
401 * Calculate the next field
404 chain = hammer2_chain_next(&parent, chain,
405 0, (hammer2_key_t)-1, 0);
406 } while (chain && chain->bref.type != HAMMER2_BREF_TYPE_INODE);
408 pfs->name_next = chain->data->ipdata.name_key;
409 hammer2_chain_unlock(chain);
411 pfs->name_next = (hammer2_key_t)-1;
414 pfs->name_next = (hammer2_key_t)-1;
417 hammer2_chain_lookup_done(parent);
423 * Find a specific PFS by name
426 hammer2_ioctl_pfs_lookup(hammer2_inode_t *ip, void *data)
428 hammer2_inode_data_t *ipdata;
429 hammer2_mount_t *hmp;
430 hammer2_ioc_pfs_t *pfs;
431 hammer2_chain_t *parent;
432 hammer2_chain_t *chain;
438 hmp = ip->pmp->mount_cluster->hmp;
440 parent = hammer2_chain_lookup_init(hmp->schain, HAMMER2_LOOKUP_SHARED);
442 pfs->name[sizeof(pfs->name) - 1] = 0;
443 len = strlen(pfs->name);
444 lhc = hammer2_dirhash(pfs->name, len);
446 chain = hammer2_chain_lookup(&parent,
447 lhc, lhc + HAMMER2_DIRHASH_LOMASK,
448 HAMMER2_LOOKUP_SHARED);
450 if (chain->bref.type == HAMMER2_BREF_TYPE_INODE &&
451 len == chain->data->ipdata.name_len &&
452 bcmp(pfs->name, chain->data->ipdata.filename, len) == 0) {
455 chain = hammer2_chain_next(&parent, chain,
456 lhc, lhc + HAMMER2_DIRHASH_LOMASK,
457 HAMMER2_LOOKUP_SHARED);
461 * Load the data being returned by the ioctl.
464 ipdata = &chain->data->ipdata;
465 pfs->name_key = ipdata->name_key;
466 pfs->pfs_type = ipdata->pfs_type;
467 pfs->pfs_clid = ipdata->pfs_clid;
468 pfs->pfs_fsid = ipdata->pfs_fsid;
471 hammer2_chain_unlock(chain);
475 hammer2_chain_lookup_done(parent);
480 * Create a new PFS under the super-root
483 hammer2_ioctl_pfs_create(hammer2_inode_t *ip, void *data)
485 hammer2_inode_data_t *nipdata;
486 hammer2_mount_t *hmp;
487 hammer2_ioc_pfs_t *pfs;
488 hammer2_inode_t *nip;
489 hammer2_chain_t *nchain;
490 hammer2_trans_t trans;
493 hmp = ip->pmp->mount_cluster->hmp;
497 if (pfs->name[0] == 0)
499 pfs->name[sizeof(pfs->name) - 1] = 0; /* ensure 0-termination */
501 hammer2_trans_init(&trans, ip->pmp, 0);
502 nip = hammer2_inode_create(&trans, hmp->sroot, NULL, NULL,
503 pfs->name, strlen(pfs->name),
506 nipdata = hammer2_chain_modify_ip(&trans, nip, &nchain,
507 HAMMER2_MODIFY_ASSERTNOCOPY);
508 nipdata->pfs_type = pfs->pfs_type;
509 nipdata->pfs_clid = pfs->pfs_clid;
510 nipdata->pfs_fsid = pfs->pfs_fsid;
511 hammer2_inode_unlock_ex(nip, nchain);
513 hammer2_trans_done(&trans);
518 * Destroy an existing PFS under the super-root
521 hammer2_ioctl_pfs_delete(hammer2_inode_t *ip, void *data)
523 hammer2_mount_t *hmp;
524 hammer2_ioc_pfs_t *pfs = data;
525 hammer2_trans_t trans;
528 hmp = ip->pmp->mount_cluster->hmp;
529 hammer2_trans_init(&trans, ip->pmp, 0);
530 error = hammer2_unlink_file(&trans, hmp->sroot,
531 pfs->name, strlen(pfs->name),
533 hammer2_trans_done(&trans);
539 hammer2_ioctl_pfs_snapshot(hammer2_inode_t *ip, void *data)
541 hammer2_ioc_pfs_t *pfs = data;
542 hammer2_trans_t trans;
543 hammer2_chain_t *parent;
546 if (pfs->name[0] == 0)
548 if (pfs->name[sizeof(pfs->name)-1] != 0)
551 hammer2_trans_init(&trans, ip->pmp, 0);
552 parent = hammer2_inode_lock_ex(ip);
553 error = hammer2_chain_snapshot(&trans, ip, pfs);
554 hammer2_inode_unlock_ex(ip, parent);
555 hammer2_trans_done(&trans);
561 * Retrieve the raw inode structure
564 hammer2_ioctl_inode_get(hammer2_inode_t *ip, void *data)
566 hammer2_ioc_inode_t *ino = data;
567 hammer2_chain_t *parent;
569 parent = hammer2_inode_lock_sh(ip);
570 ino->ip_data = ip->chain->data->ipdata;
572 hammer2_inode_unlock_sh(ip, parent);
578 * Set various parameters in an inode which cannot be set through
579 * normal filesystem VNOPS.
582 hammer2_ioctl_inode_set(hammer2_inode_t *ip, void *data)
584 hammer2_inode_data_t *ipdata;
585 hammer2_ioc_inode_t *ino = data;
586 hammer2_chain_t *chain;
587 hammer2_trans_t trans;
590 hammer2_trans_init(&trans, ip->pmp, 0);
591 chain = hammer2_inode_lock_ex(ip);
593 if (ino->ip_data.comp_algo != chain->data->ipdata.comp_algo) {
594 ipdata = hammer2_chain_modify_ip(&trans, ip, &chain, 0);
595 ipdata->comp_algo = ino->ip_data.comp_algo;
599 /* Ignore these flags for now...*/
600 if (ino->flags & HAMMER2IOC_INODE_FLAG_IQUOTA) {
602 if (ino->flags & HAMMER2IOC_INODE_FLAG_DQUOTA) {
604 if (ino->flags & HAMMER2IOC_INODE_FLAG_COPIES) {
606 hammer2_trans_done(&trans);
607 hammer2_inode_unlock_ex(ip, chain);