4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Gunnar Beutner
25 * Copyright (c) 2012 Cyril Plisko. All rights reserved.
35 #include "libshare_impl.h"
37 static boolean_t
nfs_available(void);
39 static sa_fstype_t
*nfs_fstype
;
42 * nfs_exportfs_temp_fd refers to a temporary copy of the output
45 static int nfs_exportfs_temp_fd
= -1;
47 typedef int (*nfs_shareopt_callback_t
)(const char *opt
, const char *value
,
50 typedef int (*nfs_host_callback_t
)(const char *sharepath
, const char *host
,
51 const char *security
, const char *access
, void *cookie
);
54 * Invokes the specified callback function for each Solaris share option
55 * listed in the specified string.
58 foreach_nfs_shareopt(const char *shareopts
,
59 nfs_shareopt_callback_t callback
, void *cookie
)
61 char *shareopts_dup
, *opt
, *cur
, *value
;
64 if (shareopts
== NULL
)
67 shareopts_dup
= strdup(shareopts
);
69 if (shareopts_dup
== NULL
)
70 return (SA_NO_MEMORY
);
78 while (*cur
!= ',' && *cur
!= '\0')
87 value
= strchr(opt
, '=');
94 rc
= callback(opt
, value
, cookie
);
113 typedef struct nfs_host_cookie_s
{
114 nfs_host_callback_t callback
;
115 const char *sharepath
;
117 const char *security
;
121 * Helper function for foreach_nfs_host. This function checks whether the
122 * current share option is a host specification and invokes a callback
123 * function with information about the host.
126 foreach_nfs_host_cb(const char *opt
, const char *value
, void *pcookie
)
130 char *host_dup
, *host
, *next
;
131 nfs_host_cookie_t
*udata
= (nfs_host_cookie_t
*)pcookie
;
134 fprintf(stderr
, "foreach_nfs_host_cb: key=%s, value=%s\n", opt
, value
);
137 if (strcmp(opt
, "sec") == 0)
138 udata
->security
= value
;
140 if (strcmp(opt
, "rw") == 0 || strcmp(opt
, "ro") == 0) {
146 host_dup
= strdup(value
);
148 if (host_dup
== NULL
)
149 return (SA_NO_MEMORY
);
154 next
= strchr(host
, ':');
160 rc
= udata
->callback(udata
->sharepath
, host
,
161 udata
->security
, access
, udata
->cookie
);
170 } while (host
!= NULL
);
179 * Invokes a callback function for all NFS hosts that are set for a share.
182 foreach_nfs_host(sa_share_impl_t impl_share
, nfs_host_callback_t callback
,
185 nfs_host_cookie_t udata
;
188 udata
.callback
= callback
;
189 udata
.sharepath
= impl_share
->sharepath
;
190 udata
.cookie
= cookie
;
191 udata
.security
= "sys";
193 shareopts
= FSINFO(impl_share
, nfs_fstype
)->shareopts
;
195 return foreach_nfs_shareopt(shareopts
, foreach_nfs_host_cb
,
200 * Converts a Solaris NFS host specification to its Linux equivalent.
203 get_linux_hostspec(const char *solaris_hostspec
, char **plinux_hostspec
)
206 * For now we just support CIDR masks (e.g. @192.168.0.0/16) and host
207 * wildcards (e.g. *.example.org).
209 if (solaris_hostspec
[0] == '@') {
211 * Solaris host specifier, e.g. @192.168.0.0/16; we just need
212 * to skip the @ in this case
214 *plinux_hostspec
= strdup(solaris_hostspec
+ 1);
216 *plinux_hostspec
= strdup(solaris_hostspec
);
219 if (*plinux_hostspec
== NULL
) {
220 return (SA_NO_MEMORY
);
227 * Used internally by nfs_enable_share to enable sharing for a single host.
230 nfs_enable_share_one(const char *sharepath
, const char *host
,
231 const char *security
, const char *access
, void *pcookie
)
234 char *linuxhost
, *hostpath
, *opts
;
235 const char *linux_opts
= (const char *)pcookie
;
238 /* exportfs -i -o sec=XX,rX,<opts> <host>:<sharepath> */
240 rc
= get_linux_hostspec(host
, &linuxhost
);
245 hostpath
= malloc(strlen(linuxhost
) + 1 + strlen(sharepath
) + 1);
247 if (hostpath
== NULL
) {
253 sprintf(hostpath
, "%s:%s", linuxhost
, sharepath
);
257 if (linux_opts
== NULL
)
260 opts
= malloc(4 + strlen(security
) + 4 + strlen(linux_opts
) + 1);
265 sprintf(opts
, "sec=%s,%s,%s", security
, access
, linux_opts
);
268 fprintf(stderr
, "sharing %s with opts %s\n", hostpath
, opts
);
271 argv
[0] = "/usr/sbin/exportfs";
278 rc
= libzfs_run_process(argv
[0], argv
, 0);
284 return (SA_SYSTEM_ERR
);
290 * Adds a Linux share option to an array of NFS options.
293 add_linux_shareopt(char **plinux_opts
, const char *key
, const char *value
)
296 char *new_linux_opts
;
298 if (*plinux_opts
!= NULL
)
299 len
= strlen(*plinux_opts
);
301 new_linux_opts
= realloc(*plinux_opts
, len
+ 1 + strlen(key
) +
302 (value
? 1 + strlen(value
) : 0) + 1);
304 if (new_linux_opts
== NULL
)
305 return (SA_NO_MEMORY
);
307 new_linux_opts
[len
] = '\0';
310 strcat(new_linux_opts
, ",");
312 strcat(new_linux_opts
, key
);
315 strcat(new_linux_opts
, "=");
316 strcat(new_linux_opts
, value
);
319 *plinux_opts
= new_linux_opts
;
325 * Validates and converts a single Solaris share option to its Linux
329 get_linux_shareopts_cb(const char *key
, const char *value
, void *cookie
)
331 char **plinux_opts
= (char **)cookie
;
333 /* host-specific options, these are taken care of elsewhere */
334 if (strcmp(key
, "ro") == 0 || strcmp(key
, "rw") == 0 ||
335 strcmp(key
, "sec") == 0)
338 if (strcmp(key
, "anon") == 0)
341 if (strcmp(key
, "root_mapping") == 0) {
342 (void) add_linux_shareopt(plinux_opts
, "root_squash", NULL
);
346 if (strcmp(key
, "nosub") == 0)
347 key
= "subtree_check";
349 if (strcmp(key
, "insecure") != 0 && strcmp(key
, "secure") != 0 &&
350 strcmp(key
, "async") != 0 && strcmp(key
, "sync") != 0 &&
351 strcmp(key
, "no_wdelay") != 0 && strcmp(key
, "wdelay") != 0 &&
352 strcmp(key
, "nohide") != 0 && strcmp(key
, "hide") != 0 &&
353 strcmp(key
, "crossmnt") != 0 &&
354 strcmp(key
, "no_subtree_check") != 0 &&
355 strcmp(key
, "subtree_check") != 0 &&
356 strcmp(key
, "insecure_locks") != 0 &&
357 strcmp(key
, "secure_locks") != 0 &&
358 strcmp(key
, "no_auth_nlm") != 0 && strcmp(key
, "auth_nlm") != 0 &&
359 strcmp(key
, "no_acl") != 0 && strcmp(key
, "mountpoint") != 0 &&
360 strcmp(key
, "mp") != 0 && strcmp(key
, "fsuid") != 0 &&
361 strcmp(key
, "refer") != 0 && strcmp(key
, "replicas") != 0 &&
362 strcmp(key
, "root_squash") != 0 &&
363 strcmp(key
, "no_root_squash") != 0 &&
364 strcmp(key
, "all_squash") != 0 &&
365 strcmp(key
, "no_all_squash") != 0 && strcmp(key
, "fsid") != 0 &&
366 strcmp(key
, "anonuid") != 0 && strcmp(key
, "anongid") != 0) {
367 return (SA_SYNTAX_ERR
);
370 (void) add_linux_shareopt(plinux_opts
, key
, value
);
376 * Takes a string containing Solaris share options (e.g. "sync,no_acl") and
377 * converts them to a NULL-terminated array of Linux NFS options.
380 get_linux_shareopts(const char *shareopts
, char **plinux_opts
)
384 assert(plinux_opts
!= NULL
);
388 /* default options for Solaris shares */
389 (void) add_linux_shareopt(plinux_opts
, "no_subtree_check", NULL
);
390 (void) add_linux_shareopt(plinux_opts
, "no_root_squash", NULL
);
391 (void) add_linux_shareopt(plinux_opts
, "mountpoint", NULL
);
393 rc
= foreach_nfs_shareopt(shareopts
, get_linux_shareopts_cb
,
405 * Enables NFS sharing for the specified share.
408 nfs_enable_share(sa_share_impl_t impl_share
)
410 char *shareopts
, *linux_opts
;
413 if (!nfs_available()) {
414 return (SA_SYSTEM_ERR
);
417 shareopts
= FSINFO(impl_share
, nfs_fstype
)->shareopts
;
419 if (shareopts
== NULL
)
422 rc
= get_linux_shareopts(shareopts
, &linux_opts
);
427 rc
= foreach_nfs_host(impl_share
, nfs_enable_share_one
, linux_opts
);
435 * Used internally by nfs_disable_share to disable sharing for a single host.
438 nfs_disable_share_one(const char *sharepath
, const char *host
,
439 const char *security
, const char *access
, void *cookie
)
442 char *linuxhost
, *hostpath
;
445 rc
= get_linux_hostspec(host
, &linuxhost
);
450 hostpath
= malloc(strlen(linuxhost
) + 1 + strlen(sharepath
) + 1);
452 if (hostpath
== NULL
) {
457 sprintf(hostpath
, "%s:%s", linuxhost
, sharepath
);
462 fprintf(stderr
, "unsharing %s\n", hostpath
);
465 argv
[0] = "/usr/sbin/exportfs";
470 rc
= libzfs_run_process(argv
[0], argv
, 0);
475 return (SA_SYSTEM_ERR
);
481 * Disables NFS sharing for the specified share.
484 nfs_disable_share(sa_share_impl_t impl_share
)
486 if (!nfs_available()) {
488 * The share can't possibly be active, so nothing
489 * needs to be done to disable it.
494 return (foreach_nfs_host(impl_share
, nfs_disable_share_one
, NULL
));
498 * Checks whether the specified NFS share options are syntactically correct.
501 nfs_validate_shareopts(const char *shareopts
)
506 rc
= get_linux_shareopts(shareopts
, &linux_opts
);
517 * Checks whether a share is currently active.
520 nfs_is_share_active(sa_share_impl_t impl_share
)
524 FILE *nfs_exportfs_temp_fp
;
526 if (!nfs_available())
529 nfs_exportfs_temp_fp
= fdopen(dup(nfs_exportfs_temp_fd
), "r");
531 if (nfs_exportfs_temp_fp
== NULL
||
532 fseek(nfs_exportfs_temp_fp
, 0, SEEK_SET
) < 0) {
533 fclose(nfs_exportfs_temp_fp
);
537 while (fgets(line
, sizeof (line
), nfs_exportfs_temp_fp
) != NULL
) {
539 * exportfs uses separate lines for the share path
540 * and the export options when the share path is longer
541 * than a certain amount of characters; this ignores
547 tab
= strchr(line
, '\t');
554 * there's no tab character, which means the
555 * NFS options are on a separate line; we just
556 * need to remove the new-line character
557 * at the end of the line
559 cur
= line
+ strlen(line
) - 1;
562 /* remove trailing spaces and new-line characters */
563 while (cur
>= line
&& (*cur
== ' ' || *cur
== '\n'))
566 if (strcmp(line
, impl_share
->sharepath
) == 0) {
567 fclose(nfs_exportfs_temp_fp
);
572 fclose(nfs_exportfs_temp_fp
);
578 * Called to update a share's options. A share's options might be out of
579 * date if the share was loaded from disk (i.e. /etc/dfs/sharetab) and the
580 * "sharenfs" dataset property has changed in the meantime. This function
581 * also takes care of re-enabling the share if necessary.
584 nfs_update_shareopts(sa_share_impl_t impl_share
, const char *resource
,
585 const char *shareopts
)
588 boolean_t needs_reshare
= B_FALSE
;
591 FSINFO(impl_share
, nfs_fstype
)->active
=
592 nfs_is_share_active(impl_share
);
594 old_shareopts
= FSINFO(impl_share
, nfs_fstype
)->shareopts
;
596 if (strcmp(shareopts
, "on") == 0)
599 if (FSINFO(impl_share
, nfs_fstype
)->active
&& old_shareopts
!= NULL
&&
600 strcmp(old_shareopts
, shareopts
) != 0) {
601 needs_reshare
= B_TRUE
;
602 nfs_disable_share(impl_share
);
605 shareopts_dup
= strdup(shareopts
);
607 if (shareopts_dup
== NULL
)
608 return (SA_NO_MEMORY
);
610 if (old_shareopts
!= NULL
)
613 FSINFO(impl_share
, nfs_fstype
)->shareopts
= shareopts_dup
;
616 nfs_enable_share(impl_share
);
622 * Clears a share's NFS options. Used by libshare to
623 * clean up shares that are about to be free()'d.
626 nfs_clear_shareopts(sa_share_impl_t impl_share
)
628 free(FSINFO(impl_share
, nfs_fstype
)->shareopts
);
629 FSINFO(impl_share
, nfs_fstype
)->shareopts
= NULL
;
632 static const sa_share_ops_t nfs_shareops
= {
633 .enable_share
= nfs_enable_share
,
634 .disable_share
= nfs_disable_share
,
636 .validate_shareopts
= nfs_validate_shareopts
,
637 .update_shareopts
= nfs_update_shareopts
,
638 .clear_shareopts
= nfs_clear_shareopts
,
642 * nfs_check_exportfs() checks that the exportfs command runs
643 * and also maintains a temporary copy of the output from
645 * To update this temporary copy simply call this function again.
647 * TODO : Use /var/lib/nfs/etab instead of our private copy.
648 * But must implement locking to prevent concurrent access.
650 * TODO : The temporary file descriptor is never closed since
651 * there is no libshare_nfs_fini() function.
654 nfs_check_exportfs(void)
658 static char nfs_exportfs_tempfile
[] = "/tmp/exportfs.XXXXXX";
661 * Close any existing temporary copies of output from exportfs.
662 * We have already called unlink() so file will be deleted.
664 if (nfs_exportfs_temp_fd
>= 0)
665 close(nfs_exportfs_temp_fd
);
667 nfs_exportfs_temp_fd
= mkstemp(nfs_exportfs_tempfile
);
669 if (nfs_exportfs_temp_fd
< 0)
670 return (SA_SYSTEM_ERR
);
672 unlink(nfs_exportfs_tempfile
);
674 fcntl(nfs_exportfs_temp_fd
, F_SETFD
, FD_CLOEXEC
);
679 (void) close(nfs_exportfs_temp_fd
);
680 nfs_exportfs_temp_fd
= -1;
681 return (SA_SYSTEM_ERR
);
685 while ((rc
= waitpid(pid
, &status
, 0)) <= 0 && errno
== EINTR
);
688 (void) close(nfs_exportfs_temp_fd
);
689 nfs_exportfs_temp_fd
= -1;
690 return (SA_SYSTEM_ERR
);
693 if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
694 (void) close(nfs_exportfs_temp_fd
);
695 nfs_exportfs_temp_fd
= -1;
696 return (SA_CONFIG_ERR
);
706 if (dup2(nfs_exportfs_temp_fd
, STDOUT_FILENO
) < 0)
709 rc
= execlp("/usr/sbin/exportfs", "exportfs", "-v", NULL
);
719 * Provides a convenient wrapper for determing nfs availability
724 if (nfs_exportfs_temp_fd
== -1)
725 (void) nfs_check_exportfs();
727 return ((nfs_exportfs_temp_fd
!= -1) ? B_TRUE
: B_FALSE
);
731 * Initializes the NFS functionality of libshare.
734 libshare_nfs_init(void)
736 nfs_fstype
= register_fstype("nfs", &nfs_shareops
);