blob: de44d7330ab3ba7bf1f36ced933f33f47b814fc3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Anna Schumaker40c64c22015-04-15 13:00:05 -04002 * fs/nfs/nfs4idmap.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#ifndef NFS_IDMAP_H
37#define NFS_IDMAP_H
38
Eric W. Biederman9f309c82013-02-01 03:21:47 -080039#include <linux/uidgid.h>
David Howells607ca462012-10-13 10:46:48 +010040#include <uapi/linux/nfs_idmap.h>
Jaswinder Singh Rajputa81184c2009-01-30 21:59:48 +053041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43/* Forward declaration to make this header independent of others */
David Howellsadfa6f92006-08-22 20:06:08 -040044struct nfs_client;
Trond Myklebuste4fd72a2011-02-22 15:44:31 -080045struct nfs_server;
Trond Myklebust6926afd12012-01-07 13:22:46 -050046struct nfs_fattr;
47struct nfs4_string;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Bryan Schumaker955a8572010-09-29 15:41:49 -040049int nfs_idmap_init(void);
50void nfs_idmap_quit(void);
David Howellsb7162792006-08-22 20:06:09 -040051int nfs_idmap_new(struct nfs_client *);
David Howellsadfa6f92006-08-22 20:06:08 -040052void nfs_idmap_delete(struct nfs_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Trond Myklebust6926afd12012-01-07 13:22:46 -050054void nfs_fattr_init_names(struct nfs_fattr *fattr,
55 struct nfs4_string *owner_name,
56 struct nfs4_string *group_name);
57void nfs_fattr_free_names(struct nfs_fattr *);
58void nfs_fattr_map_and_free_names(struct nfs_server *, struct nfs_fattr *);
59
Eric W. Biederman9f309c82013-02-01 03:21:47 -080060int nfs_map_name_to_uid(const struct nfs_server *, const char *, size_t, kuid_t *);
61int nfs_map_group_to_gid(const struct nfs_server *, const char *, size_t, kgid_t *);
62int nfs_map_uid_to_name(const struct nfs_server *, kuid_t, char *, size_t);
63int nfs_map_gid_to_group(const struct nfs_server *, kgid_t, char *, size_t);
Trond Myklebust58df0952006-01-03 09:55:57 +010064
Tom Haynesd67ae822014-12-11 17:02:04 -050065int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res);
66
Trond Myklebust58df0952006-01-03 09:55:57 +010067extern unsigned int nfs_idmap_cache_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#endif /* NFS_IDMAP_H */