[deliverable/linux.git] / include / linux / nfs_idmap.h

/*
 * include/linux/nfs_idmap.h
 *
 *  UID and GID to name mapping for clients.
 *
 *  Copyright (c) 2002 The Regents of the University of Michigan.
 *  All rights reserved.
 *
 *  Marius Aamodt Eriksen <marius@umich.edu>
 *
 *  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.
 *  3. Neither the name of the University nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED ``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 REGENTS 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.
 */

#ifndef NFS_IDMAP_H
#define NFS_IDMAP_H

#include <linux/types.h>

/* XXX from bits/utmp.h  */
#define IDMAP_NAMESZ  128

#define IDMAP_TYPE_USER  0
#define IDMAP_TYPE_GROUP 1

#define IDMAP_CONV_IDTONAME 0
#define IDMAP_CONV_NAMETOID 1

#define IDMAP_STATUS_INVALIDMSG 0x01
#define IDMAP_STATUS_AGAIN      0x02
#define IDMAP_STATUS_LOOKUPFAIL 0x04
#define IDMAP_STATUS_SUCCESS    0x08

struct idmap_msg {
	__u8  im_type;
	__u8  im_conv;
	char  im_name[IDMAP_NAMESZ];
	__u32 im_id;
	__u8  im_status;
};

#ifdef __KERNEL__

/* Forward declaration to make this header independent of others */
struct nfs_client;
struct nfs_server;
struct nfs_fattr;
struct nfs4_string;

#ifdef CONFIG_NFS_V4
int nfs_idmap_init(void);
void nfs_idmap_quit(void);
#else
static inline int nfs_idmap_init(void)
{
	return 0;
}

static inline void nfs_idmap_quit(void)
{}
#endif

int nfs_idmap_new(struct nfs_client *);
void nfs_idmap_delete(struct nfs_client *);

void nfs_fattr_init_names(struct nfs_fattr *fattr,
		struct nfs4_string *owner_name,
		struct nfs4_string *group_name);
void nfs_fattr_free_names(struct nfs_fattr *);
void nfs_fattr_map_and_free_names(struct nfs_server *, struct nfs_fattr *);

int nfs_map_name_to_uid(const struct nfs_server *, const char *, size_t, __u32 *);
int nfs_map_group_to_gid(const struct nfs_server *, const char *, size_t, __u32 *);
int nfs_map_uid_to_name(const struct nfs_server *, __u32, char *, size_t);
int nfs_map_gid_to_group(const struct nfs_server *, __u32, char *, size_t);

extern unsigned int nfs_idmap_cache_timeout;
#endif /* __KERNEL__ */

#endif /* NFS_IDMAP_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/nfs_idmap.h
	3	*
	4	* UID and GID to name mapping for clients.
	5	*
	6	* Copyright (c) 2002 The Regents of the University of Michigan.
	7	* All rights reserved.
	8	*
	9	* Marius Aamodt Eriksen <marius@umich.edu>
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	*
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions and the following disclaimer.
	17	* 2. Redistributions in binary form must reproduce the above copyright
	18	* notice, this list of conditions and the following disclaimer in the
	19	* documentation and/or other materials provided with the distribution.
	20	* 3. Neither the name of the University nor the names of its
	21	* contributors may be used to endorse or promote products derived
	22	* from this software without specific prior written permission.
	23	*
	24	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
	25	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	26	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	27	* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	29	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	30	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
	31	* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	32	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	33	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	34	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	35	*/
	36
	37	#ifndef NFS_IDMAP_H
	38	#define NFS_IDMAP_H
	39
a81184c1 JSR	40	#include <linux/types.h>
a81184c1 JSR	41
1da177e4 LT	42	/* XXX from bits/utmp.h */
	43	#define IDMAP_NAMESZ 128
	44
	45	#define IDMAP_TYPE_USER 0
	46	#define IDMAP_TYPE_GROUP 1
	47
	48	#define IDMAP_CONV_IDTONAME 0
	49	#define IDMAP_CONV_NAMETOID 1
	50
	51	#define IDMAP_STATUS_INVALIDMSG 0x01
	52	#define IDMAP_STATUS_AGAIN 0x02
	53	#define IDMAP_STATUS_LOOKUPFAIL 0x04
	54	#define IDMAP_STATUS_SUCCESS 0x08
	55
	56	struct idmap_msg {
	57	__u8 im_type;
	58	__u8 im_conv;
	59	char im_name[IDMAP_NAMESZ];
	60	__u32 im_id;
	61	__u8 im_status;
	62	};
	63
	64	#ifdef __KERNEL__
	65
	66	/* Forward declaration to make this header independent of others */
adfa6f98	67	struct nfs_client;
e4fd72a1	68	struct nfs_server;
6926afd1 TM	69	struct nfs_fattr;
6926afd1 TM	70	struct nfs4_string;
1da177e4	71
91e56aae	72	#ifdef CONFIG_NFS_V4
955a857e BS	73	int nfs_idmap_init(void);
955a857e BS	74	void nfs_idmap_quit(void);
91e56aae BS	75	#else
	76	static inline int nfs_idmap_init(void)
	77	{
	78	return 0;
	79	}
	80
	81	static inline void nfs_idmap_quit(void)
	82	{}
	83	#endif
	84
b7162792	85	int nfs_idmap_new(struct nfs_client *);
adfa6f98	86	void nfs_idmap_delete(struct nfs_client *);
1da177e4	87
6926afd1 TM	88	void nfs_fattr_init_names(struct nfs_fattr *fattr,
	89	struct nfs4_string *owner_name,
	90	struct nfs4_string *group_name);
	91	void nfs_fattr_free_names(struct nfs_fattr *);
	92	void nfs_fattr_map_and_free_names(struct nfs_server , struct nfs_fattr );
	93
e4fd72a1 TM	94	int nfs_map_name_to_uid(const struct nfs_server , const char , size_t, __u32 *);
	95	int nfs_map_group_to_gid(const struct nfs_server , const char , size_t, __u32 *);
	96	int nfs_map_uid_to_name(const struct nfs_server , __u32, char , size_t);
	97	int nfs_map_gid_to_group(const struct nfs_server , __u32, char , size_t);
58df095b TM	98
58df095b TM	99	extern unsigned int nfs_idmap_cache_timeout;
1da177e4 LT	100	#endif /* __KERNEL__ */
	101
	102	#endif /* NFS_IDMAP_H */