blob: 91a1c24e0cbffdeb97e28d072cd657510d22faab [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Jaswinder Singh Rajputa81184c2009-01-30 21:59:48 +053040#include <linux/types.h>
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* 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
56struct 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 */
David Howellsadfa6f92006-08-22 20:06:08 -040067struct nfs_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
David Howellsb7162792006-08-22 20:06:09 -040069int nfs_idmap_new(struct nfs_client *);
David Howellsadfa6f92006-08-22 20:06:08 -040070void nfs_idmap_delete(struct nfs_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
David Howellsadfa6f92006-08-22 20:06:08 -040072int nfs_map_name_to_uid(struct nfs_client *, const char *, size_t, __u32 *);
73int nfs_map_group_to_gid(struct nfs_client *, const char *, size_t, __u32 *);
74int nfs_map_uid_to_name(struct nfs_client *, __u32, char *);
75int nfs_map_gid_to_group(struct nfs_client *, __u32, char *);
Trond Myklebust58df0952006-01-03 09:55:57 +010076
77extern unsigned int nfs_idmap_cache_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#endif /* __KERNEL__ */
79
80#endif /* NFS_IDMAP_H */