xref: /src/sys/fs/autofs/autofs.h

/*	$NetBSD: autofs.h,v 1.5 2023/05/17 06:44:38 tkusumi Exp $	*/

/*-
 * Copyright (c) 2017 The NetBSD Foundation, Inc.
 * Copyright (c) 2016 The DragonFly Project
 * Copyright (c) 2014 The FreeBSD Foundation
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Tomohiro Kusumi <kusumi.tomohiro (at) gmail.com>.
 *
 * This software was developed by Edward Tomasz Napierala under sponsorship
 * from the FreeBSD Foundation.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef _SYS_FS_AUTOFS_AUTOFS_H_
#define	_SYS_FS_AUTOFS_AUTOFS_H_

#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kmem.h>
#include <sys/tree.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/mount.h>
#include <sys/vnode.h>
#include <sys/timespec.h>
#include <sys/callout.h>
#include <sys/workqueue.h>
#include <sys/conf.h>
#include <sys/proc.h>

#include "autofs_ioctl.h"

#define AUTOFS_ROOTINO	((ino_t)1)
#define VFSTOAUTOFS(mp)	((struct autofs_mount *)((mp)->mnt_data))
#define VTOI(vp)	((struct autofs_node *)((vp)->v_data))

extern int (**autofs_vnodeop_p)(void *);
extern const struct vnodeopv_desc autofs_vnodeop_opv_desc;

extern struct cdevsw autofs_ops;

extern struct pool autofs_request_pool;
extern struct pool autofs_node_pool;
extern struct autofs_softc *autofs_softc;
extern struct workqueue	*autofs_tmo_wq;

extern int autofs_debug;
extern int autofs_mount_on_stat;
extern int autofs_timeout;
extern int autofs_cache;
extern int autofs_retry_attempts;
extern int autofs_retry_delay;
extern int autofs_interruptible;

#define	AUTOFS_DEBUG(X, ...)				\
	do {						\
		if (autofs_debug > 1)			\
			printf("%s: " X "\n",		\
			    __func__, ## __VA_ARGS__);	\
	} while (0)

#define	AUTOFS_WARN(X, ...)				\
	do {						\
		if (autofs_debug > 0) {			\
			printf("WARNING: %s: " X "\n",	\
			    __func__, ## __VA_ARGS__);	\
		}					\
	} while (0)

struct autofs_node {
	RB_ENTRY(autofs_node)		an_entry;
	char				*an_name;
	ino_t				an_ino;
	struct autofs_node		*an_parent;
	RB_HEAD(autofs_node_tree,
	    autofs_node)		an_children;
	struct autofs_mount		*an_mount;
	struct vnode			*an_vnode;
	bool				an_cached;
	bool				an_wildcards;
	struct callout			an_callout;
	int				an_retries;
	struct timespec			an_ctime;
};

struct autofs_mount {
	struct autofs_node		*am_root;
	struct mount			*am_mp;
	kmutex_t			am_lock;
	char				am_from[AUTOFS_MAXPATHLEN];
	char				am_on[AUTOFS_MAXPATHLEN];
	char				am_options[AUTOFS_MAXPATHLEN];
	char				am_prefix[AUTOFS_MAXPATHLEN];
	ino_t				am_last_ino;
};

struct autofs_request {
	struct work			ar_wk; /* must be first */
	TAILQ_ENTRY(autofs_request)	ar_next;
	struct autofs_mount		*ar_mount;
	int				ar_id;
	bool				ar_done;
	int				ar_error;
	bool				ar_wildcards;
	bool				ar_in_progress;
	char				ar_from[AUTOFS_MAXPATHLEN];
	char				ar_path[AUTOFS_MAXPATHLEN];
	char				ar_prefix[AUTOFS_MAXPATHLEN];
	char				ar_key[AUTOFS_MAXPATHLEN];
	char				ar_options[AUTOFS_MAXPATHLEN];
	struct callout			ar_callout;
	volatile unsigned int		ar_refcount;
};

struct autofs_softc {
	kcondvar_t			sc_cv;
	kmutex_t			sc_lock;
	TAILQ_HEAD(, autofs_request)	sc_requests;
	bool				sc_dev_opened;
	pid_t				sc_dev_sid;
	int				sc_last_request_id;
};

int	autofs_trigger(struct autofs_node *anp, const char *component,
	    int componentlen);
bool	autofs_cached(struct autofs_node *anp, const char *component,
	    int componentlen);
void	autofs_flush(struct autofs_mount *amp);
bool	autofs_ignore_thread(void);
void	autofs_timeout_wq(struct work *wk, void *arg);
int	autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp,
	    const char *name, int namelen, struct autofs_node **anpp);
int	autofs_node_find(struct autofs_node *parent,
	    const char *name, int namelen, struct autofs_node **anpp);
void	autofs_node_delete(struct autofs_node *anp);

static __inline void
autofs_node_cache(struct autofs_node *anp)
{

	anp->an_cached = true;
}

static __inline void
autofs_node_uncache(struct autofs_node *anp)
{

	anp->an_cached = false;
}

static __inline char *
autofs_strndup(const char *name, int nlen, km_flag_t fl)
{
	return nlen > 0 ? kmem_strndup(name, nlen, fl) : kmem_strdup(name, fl);
}

RB_PROTOTYPE(autofs_node_tree, autofs_node, an_entry, autofs_node_cmp);

#endif /* !_SYS_FS_AUTOFS_AUTOFS_H_ */