blob: 308c188770185962547e196312aa87f304aa4502 [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;
Trond Myklebuste4fd72a2011-02-22 15:44:31 -080068struct nfs_server;
Trond Myklebust6926afd2012-01-07 13:22:46 -050069struct nfs_fattr;
70struct nfs4_string;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Bryan Schumaker955a8572010-09-29 15:41:49 -040072#ifdef CONFIG_NFS_USE_NEW_IDMAPPER
73
74int nfs_idmap_init(void);
75void nfs_idmap_quit(void);
76
77static inline int nfs_idmap_new(struct nfs_client *clp)
78{
79 return 0;
80}
81
82static inline void nfs_idmap_delete(struct nfs_client *clp)
83{
84}
85
86#else /* CONFIG_NFS_USE_NEW_IDMAPPER not set */
87
88static inline int nfs_idmap_init(void)
89{
90 return 0;
91}
92
93static inline void nfs_idmap_quit(void)
94{
95}
96
David Howellsb7162792006-08-22 20:06:09 -040097int nfs_idmap_new(struct nfs_client *);
David Howellsadfa6f92006-08-22 20:06:08 -040098void nfs_idmap_delete(struct nfs_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Bryan Schumaker955a8572010-09-29 15:41:49 -0400100#endif /* CONFIG_NFS_USE_NEW_IDMAPPER */
101
Trond Myklebust6926afd2012-01-07 13:22:46 -0500102void nfs_fattr_init_names(struct nfs_fattr *fattr,
103 struct nfs4_string *owner_name,
104 struct nfs4_string *group_name);
105void nfs_fattr_free_names(struct nfs_fattr *);
106void nfs_fattr_map_and_free_names(struct nfs_server *, struct nfs_fattr *);
107
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800108int nfs_map_name_to_uid(const struct nfs_server *, const char *, size_t, __u32 *);
109int nfs_map_group_to_gid(const struct nfs_server *, const char *, size_t, __u32 *);
110int nfs_map_uid_to_name(const struct nfs_server *, __u32, char *, size_t);
111int nfs_map_gid_to_group(const struct nfs_server *, __u32, char *, size_t);
Trond Myklebust58df0952006-01-03 09:55:57 +0100112
113extern unsigned int nfs_idmap_cache_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#endif /* __KERNEL__ */
115
116#endif /* NFS_IDMAP_H */