include/linux/nfs_idmap.h

   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 #ifndef NFS_IDMAP_H
  37 #define NFS_IDMAP_H
  38
  39 #include <linux/uidgid.h>
  40 #include <uapi/linux/nfs_idmap.h>
  41
  42
  43 /* Forward declaration to make this header independent of others */
  44 struct nfs_client;
  45 struct nfs_server;
  46 struct nfs_fattr;
  47 struct nfs4_string;
  48
  49 #if IS_ENABLED(CONFIG_NFS_V4)
  50 int nfs_idmap_init(void);
  51 void nfs_idmap_quit(void);
  52 #else
  53 static inline int nfs_idmap_init(void)
  54 {
  55         return 0;
  56 }
  57
  58 static inline void nfs_idmap_quit(void)
  59 {}
  60 #endif
  61
  62 int nfs_idmap_new(struct nfs_client *);
  63 void nfs_idmap_delete(struct nfs_client *);
  64
  65 void nfs_fattr_init_names(struct nfs_fattr *fattr,
  66                 struct nfs4_string *owner_name,
  67                 struct nfs4_string *group_name);
  68 void nfs_fattr_free_names(struct nfs_fattr *);
  69 void nfs_fattr_map_and_free_names(struct nfs_server *, struct nfs_fattr *);
  70
  71 int nfs_map_name_to_uid(const struct nfs_server *, const char *, size_t, kuid_t *);
  72 int nfs_map_group_to_gid(const struct nfs_server *, const char *, size_t, kgid_t *);
  73 int nfs_map_uid_to_name(const struct nfs_server *, kuid_t, char *, size_t);
  74 int nfs_map_gid_to_group(const struct nfs_server *, kgid_t, char *, size_t);
  75
  76 extern unsigned int nfs_idmap_cache_timeout;
  77 #endif /* NFS_IDMAP_H */