sdev_impl.h revision 0fbb751d81ab0a7c7ddfd8d4e447e075a9f7024f
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _SYS_SDEV_IMPL_H
#define _SYS_SDEV_IMPL_H
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/vfs_opreg.h>
/*
* sdev_nodes are the file-system specific part of the
* vnodes for the device filesystem.
*
* The device filesystem exports two node types:
*
* VDIR nodes to represent directories
* VCHR & VBLK nodes to represent devices
*/
/*
* /dev mount arguments
*/
struct sdev_mountargs {
};
/*
* Nvpair names of profile information (list of device files available) of
* non-global /dev mounts. These strings must be unique among them.
*/
#define SDEV_NVNAME_MOUNTPT "prof_mountpt"
#define SDEV_NVNAME_INCLUDE "prof_include"
#define SDEV_NVNAME_EXCLUDE "prof_exclude"
#define SDEV_NVNAME_SYMLINK "prof_symlink"
#define SDEV_NVNAME_MAP "prof_map"
/*
* supported devfsadm_cmd
*/
#define DEVFSADMD_RUN_ALL 1
/*
* devfsadm_error codes
*/
#define DEVFSADM_RUN_INVALID 1
#define DEVFSADM_RUN_EPERM 2
#define DEVFSADM_RUN_NOTSUP 3
/*
*/
typedef struct sdev_door_arg {
typedef struct sdev_door_res {
#ifdef _KERNEL
struct sdev_dprof {
int has_glob;
};
/*
* devname_handle_t
*/
struct devname_handle {
void *dh_args;
};
typedef struct devname_handle devname_handle_t;
/*
* Per-instance node data for the global zone instance
* Only one mount of /dev in the global zone
*/
typedef struct sdev_global_data {
struct devname_handle sdev_ghandle;
/*
* Per-instance node data - profile data per non-global zone mount instance
*/
typedef struct sdev_local_data {
/*
* /dev filesystem sdev_node defines
*/
typedef struct sdev_node {
char *sdev_name; /* node name */
char *sdev_path; /* absolute path */
char *sdev_symlink; /* source for a symlink */
int sdev_state; /* state of this node */
int sdev_flags; /* flags bit */
int sdev_lookup_flags; /* node creation flags */
/* per-instance data, either global or non-global zone */
union {
struct sdev_global_data sdev_globaldata;
struct sdev_local_data sdev_localdata;
void *sdev_private;
} sdev_node_t;
/*
* Directory contents traversal
*/
/*
* sdev_state
*
* A sdev_node may go through 3 states:
* SDEV_INIT: When a new /dev file is first looked up, a sdev_node
* is allocated, initialized and added to the directory's
* sdev_node cache. A node at this state will also
* have the SDEV_LOOKUP flag set.
*
* Other threads that are trying to look up a node at
* this state will be blocked until the SDEV_LOOKUP flag
* is cleared.
*
* When the SDEV_LOOKUP flag is cleared, the node may
* transition into the SDEV_READY state for a successful
* lookup or the node is removed from the directory cache
* and destroyed if the named node can not be found.
* An ENOENT error is returned for the second case.
*
* SDEV_READY: A /dev file has been successfully looked up and
* associated with a vnode. The /dev file is available
* for the supported /dev filesystem operations.
*
* SDEV_ZOMBIE: Deletion of a /dev file has been explicitely issued
* to an SDEV_READY node. The node is transitioned into
* the SDEV_ZOMBIE state if the vnode reference count
* is still held. A SDEV_ZOMBIE node does not support
* any of the /dev filesystem operations. A SDEV_ZOMBIE
* node is removed from the directory cache and destroyed
* once the reference count reaches "zero".
*/
typedef enum {
SDEV_ZOMBIE = -1,
SDEV_INIT = 0,
/* sdev_flags */
/* (ex: pts) */
/* need update */
/* sdev_lookup_flags */
#define SDEV_VTOR_INVALID -1
#define SDEV_VTOR_SKIP 0
#define SDEV_VTOR_VALID 1
#define SDEV_VTOR_STALE 2
/* convenient macros */
#define SDEV_IS_GLOBAL(dv) \
#define SDEV_IS_PERSIST(dv) \
#define SDEV_IS_DYNAMIC(dv) \
#define SDEV_IS_NO_NCACHE(dv) \
#define SDEV_IS_LOOKUP(dv) \
#define SDEV_IS_READDIR(dv) \
#define SDEV_IS_LGWAITING(dv) \
#define SDEV_SIMPLE_RELE(dv) { \
}
/*
* some defaults
*/
#define SDEV_UID_DEFAULT (0)
#define SDEV_GID_DEFAULT (3)
#define SDEV_DEVMODE_DEFAULT (0600)
extern struct vattr sdev_vattr_dir;
extern struct vattr sdev_vattr_lnk;
extern struct vattr sdev_vattr_blk;
extern struct vattr sdev_vattr_chr;
/*
* devname_lookup_func()
*/
void *, char *), int);
/*
* flags used by devname_lookup_func callbacks
*/
/*
* devname_readdir_func()
*/
/*
* flags for devname_readdir_func
*/
/*
* devname_setattr_func()
*/
/*
* devname_inactive_func()
*/
void (*)(struct vnode *));
/*
* /dev file system instance defines
*/
/*
* /dev version of vfs_data
*/
struct sdev_data {
struct sdev_mountargs *sdev_mountargs;
};
/*
* sdev_fid overlays the fid structure (for VFS_VGET)
*/
struct sdev_fid {
};
/*
* devfsadm and devname communication defines
*/
typedef enum {
DEVNAME_DEVFSADM_STOPPED = 0, /* devfsadm has never run */
DEVNAME_DEVFSADM_RUNNING, /* devfsadm is running */
DEVNAME_DEVFSADM_RUN /* devfsadm ran once */
#define DEVNAME_DEVFSADM_SET_RUNNING(devfsadm_state) \
#define DEVNAME_DEVFSADM_SET_STOP(devfsadm_state) \
#define DEVNAME_DEVFSADM_SET_RUN(devfsadm_state) \
#define DEVNAME_DEVFSADM_IS_RUNNING(devfsadm_state) \
#define DEVNAME_DEVFSADM_HAS_RUN(devfsadm_state) \
}
}
}
extern int sdev_wait4lookup(struct sdev_node *, int);
extern int devname_filename_register(char *);
extern int devname_nsmaps_register(char *, size_t);
extern void sdev_devfsadm_lockinit(void);
extern void sdev_devfsadm_lockdestroy(void);
extern void devname_add_devfsadm_node(char *);
struct cred *);
extern int devname_profile_update(char *, size_t);
extern struct sdev_data *sdev_find_mntinfo(char *);
void sdev_mntinfo_rele(struct sdev_data *);
extern struct vnodeops *devpts_getvnodeops(void);
extern struct vnodeops *devvt_getvnodeops(void);
/*
* boot states - warning, the ordering here is significant
*
* the difference between "system available" and "boot complete"
* is a debounce timeout to catch some daemon issuing a readdir
* triggering a nuisance implict reconfig on each boot.
*/
#define SDEV_BOOT_STATE_INITIAL 0
/*
* Negative cache list and list element
* The mutex protects the flags against multiple accesses and
* must only be acquired when already holding the r/w lock.
*/
typedef struct sdev_nc_list {
int ncl_flags;
int ncl_nentries;
typedef struct sdev_nc_node {
char *ncn_name; /* name of the node */
int ncn_flags; /* state information */
int ncn_expirecnt; /* remove once expired */
/* ncl_flags */
/* ncn_flags */
/* sdev_lookup_failed flags */
/*
* The nvlist name and nvpair identifiers in the
* /etc/devices/devname_cache nvlist format
*/
#define DP_DEVNAME_ID "devname"
#define DP_DEVNAME_NCACHE_ID "ncache"
#define DP_DEVNAME_NC_EXPIRECNT_ID "expire-counts"
/* devname-cache list element */
typedef struct nvp_devname {
char **nvp_paths;
int *nvp_expirecnts;
int nvp_npaths;
/*
* name service globals and prototypes
*/
/*
* vnodeops and vfsops helpers
*/
typedef enum {
SDEV_CACHE_ADD = 0,
extern void sdev_node_cache_init(void);
extern void sdev_node_cache_fini(void);
extern void sdev_filldir_dynamic(struct sdev_node *);
vattr_t *);
cred_t *);
extern void sdev_devstate_change(void);
extern int sdev_lookup_filter(sdev_node_t *, char *);
extern void sdev_lookup_failed(sdev_node_t *, char *, int);
extern int sdev_unlocked_access(void *, int, struct cred *);
#define SDEV_ENFORCE 0x1
extern void sdev_stale(struct sdev_node *);
extern int devname_backstore_lookup(struct sdev_node *, char *,
struct vnode **);
extern int sdev_is_devfs_node(char *);
extern int sdev_reserve_subdirs(struct sdev_node *);
extern int prof_lookup();
extern void prof_filldir(struct sdev_node *);
/*
* devinfo helpers
*/
extern int sdev_modctl_readdir(const char *, char ***, int *, int *, int);
extern void sdev_modctl_readdir_free(char **, int, int);
extern int sdev_modctl_devexists(const char *);
/*
* ncache handlers
*/
extern void sdev_ncache_init(void);
extern void sdev_ncache_setup(void);
extern void sdev_ncache_teardown(void);
extern void sdev_nc_node_exists(sdev_node_t *);
extern void sdev_nc_path_exists(sdev_nc_list_t *, char *);
extern void sdev_modctl_dump_files(void);
/*
* globals
*/
extern int devtype;
extern kmem_cache_t *sdev_node_cache;
extern struct vnodeops *sdev_vnodeops;
extern struct vnodeops *devpts_vnodeops;
extern struct vnodeops *devnet_vnodeops;
extern struct vnodeops *devipnet_vnodeops;
extern struct vnodeops *devvt_vnodeops;
extern struct vnodeops *devzvol_vnodeops;
extern const fs_operation_def_t sdev_vnodeops_tbl[];
extern const fs_operation_def_t devpts_vnodeops_tbl[];
extern const fs_operation_def_t devnet_vnodeops_tbl[];
extern const fs_operation_def_t devipnet_vnodeops_tbl[];
extern const fs_operation_def_t devvt_vnodeops_tbl[];
extern const fs_operation_def_t devsys_vnodeops_tbl[];
extern const fs_operation_def_t devpseudo_vnodeops_tbl[];
extern const fs_operation_def_t devzvol_vnodeops_tbl[];
extern sdev_nc_list_t *sdev_ncache;
extern int sdev_reconfig_boot;
extern int sdev_boot_state;
extern int sdev_reconfig_verbose;
extern int sdev_reconfig_disable;
extern int sdev_nc_disable;
extern int sdev_nc_disable_reset;
extern int sdev_nc_verbose;
/*
* misc. defines
*/
#ifdef DEBUG
extern int sdev_debug;
#else
#endif
#ifdef DEBUG
if ((sdev_debug & SDEV_DEBUG_FLK) || \
printf("lookup of %s/%s by %s failed, line %d\n", \
__LINE__); \
}
#else
#endif
#endif /* _KERNEL */
#ifdef __cplusplus
}
#endif
#endif /* _SYS_SDEV_IMPL_H */