fs/nfs/internal.h

   1 /*
   2  * NFS internal definitions
   3  */
   4
   5 #include "nfs4_fs.h"
   6 #include <linux/mount.h>
   7 #include <linux/security.h>
   8
   9 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
  10
  11 struct nfs_string;
  12
  13 /* Maximum number of readahead requests
  14  * FIXME: this should really be a sysctl so that users may tune it to suit
  15  *        their needs. People that do NFS over a slow network, might for
  16  *        instance want to reduce it to something closer to 1 for improved
  17  *        interactive response.
  18  */
  19 #define NFS_MAX_READAHEAD       (RPC_DEF_SLOT_TABLE - 1)
  20
  21 /*
  22  * Determine if sessions are in use.
  23  */
  24 static inline int nfs4_has_session(const struct nfs_client *clp)
  25 {
  26 #ifdef CONFIG_NFS_V4_1
  27         if (clp->cl_session)
  28                 return 1;
  29 #endif /* CONFIG_NFS_V4_1 */
  30         return 0;
  31 }
  32
  33 static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
  34 {
  35 #ifdef CONFIG_NFS_V4_1
  36         if (nfs4_has_session(clp))
  37                 return (clp->cl_session->flags & SESSION4_PERSIST);
  38 #endif /* CONFIG_NFS_V4_1 */
  39         return 0;
  40 }
  41
  42 struct nfs_clone_mount {
  43         const struct super_block *sb;
  44         const struct dentry *dentry;
  45         struct nfs_fh *fh;
  46         struct nfs_fattr *fattr;
  47         char *hostname;
  48         char *mnt_path;
  49         struct sockaddr *addr;
  50         size_t addrlen;
  51         rpc_authflavor_t authflavor;
  52 };
  53
  54 /*
  55  * Note: RFC 1813 doesn't limit the number of auth flavors that
  56  * a server can return, so make something up.
  57  */
  58 #define NFS_MAX_SECFLAVORS      (12)
  59
  60 /*
  61  * Value used if the user did not specify a port value.
  62  */
  63 #define NFS_UNSPEC_PORT         (-1)
  64
  65 /*
  66  * Maximum number of pages that readdir can use for creating
  67  * a vmapped array of pages.
  68  */
  69 #define NFS_MAX_READDIR_PAGES 8
  70
  71 /*
  72  * In-kernel mount arguments
  73  */
  74 struct nfs_parsed_mount_data {
  75         int                     flags;
  76         int                     rsize, wsize;
  77         int                     timeo, retrans;
  78         int                     acregmin, acregmax,
  79                                 acdirmin, acdirmax;
  80         int                     namlen;
  81         unsigned int            options;
  82         unsigned int            bsize;
  83         unsigned int            auth_flavor_len;
  84         rpc_authflavor_t        auth_flavors[1];
  85         char                    *client_address;
  86         unsigned int            version;
  87         unsigned int            minorversion;
  88         char                    *fscache_uniq;
  89
  90         struct {
  91                 struct sockaddr_storage address;
  92                 size_t                  addrlen;
  93                 char                    *hostname;
  94                 u32                     version;
  95                 int                     port;
  96                 unsigned short          protocol;
  97         } mount_server;
  98
  99         struct {
 100                 struct sockaddr_storage address;
 101                 size_t                  addrlen;
 102                 char                    *hostname;
 103                 char                    *export_path;
 104                 int                     port;
 105                 unsigned short          protocol;
 106         } nfs_server;
 107
 108         struct security_mnt_opts lsm_opts;
 109 };
 110
 111 /* mount_clnt.c */
 112 struct nfs_mount_request {
 113         struct sockaddr         *sap;
 114         size_t                  salen;
 115         char                    *hostname;
 116         char                    *dirpath;
 117         u32                     version;
 118         unsigned short          protocol;
 119         struct nfs_fh           *fh;
 120         int                     noresvport;
 121         unsigned int            *auth_flav_len;
 122         rpc_authflavor_t        *auth_flavs;
 123 };
 124
 125 extern int nfs_mount(struct nfs_mount_request *info);
 126 extern void nfs_umount(const struct nfs_mount_request *info);
 127
 128 /* client.c */
 129 extern struct rpc_program nfs_program;
 130
 131 extern void nfs_cleanup_cb_ident_idr(void);
 132 extern void nfs_put_client(struct nfs_client *);
 133 extern struct nfs_client *nfs4_find_client_no_ident(const struct sockaddr *);
 134 extern struct nfs_client *nfs4_find_client_ident(int);
 135 extern struct nfs_client *
 136 nfs4_find_client_sessionid(const struct sockaddr *, struct nfs4_sessionid *);
 137 extern struct nfs_server *nfs_create_server(
 138                                         const struct nfs_parsed_mount_data *,
 139                                         struct nfs_fh *);
 140 extern struct nfs_server *nfs4_create_server(
 141                                         const struct nfs_parsed_mount_data *,
 142                                         struct nfs_fh *);
 143 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 144                                                       struct nfs_fh *);
 145 extern void nfs_free_server(struct nfs_server *server);
 146 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 147                                            struct nfs_fh *,
 148                                            struct nfs_fattr *);
 149 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 150 extern int nfs4_check_client_ready(struct nfs_client *clp);
 151 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
 152                                              const struct sockaddr *ds_addr,
 153                                              int ds_addrlen, int ds_proto);
 154 #ifdef CONFIG_PROC_FS
 155 extern int __init nfs_fs_proc_init(void);
 156 extern void nfs_fs_proc_exit(void);
 157 #else
 158 static inline int nfs_fs_proc_init(void)
 159 {
 160         return 0;
 161 }
 162 static inline void nfs_fs_proc_exit(void)
 163 {
 164 }
 165 #endif
 166
 167 /* nfs4namespace.c */
 168 #ifdef CONFIG_NFS_V4
 169 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
 170 #else
 171 static inline
 172 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
 173 {
 174         return ERR_PTR(-ENOENT);
 175 }
 176 #endif
 177
 178 /* callback_xdr.c */
 179 extern struct svc_version nfs4_callback_version1;
 180 extern struct svc_version nfs4_callback_version4;
 181
 182 /* pagelist.c */
 183 extern int __init nfs_init_nfspagecache(void);
 184 extern void nfs_destroy_nfspagecache(void);
 185 extern int __init nfs_init_readpagecache(void);
 186 extern void nfs_destroy_readpagecache(void);
 187 extern int __init nfs_init_writepagecache(void);
 188 extern void nfs_destroy_writepagecache(void);
 189
 190 extern int __init nfs_init_directcache(void);
 191 extern void nfs_destroy_directcache(void);
 192
 193 /* nfs2xdr.c */
 194 extern int nfs_stat_to_errno(enum nfs_stat);
 195 extern struct rpc_procinfo nfs_procedures[];
 196 extern int nfs2_decode_dirent(struct xdr_stream *,
 197                                 struct nfs_entry *, int);
 198
 199 /* nfs3xdr.c */
 200 extern struct rpc_procinfo nfs3_procedures[];
 201 extern int nfs3_decode_dirent(struct xdr_stream *,
 202                                 struct nfs_entry *, int);
 203
 204 /* nfs4xdr.c */
 205 #ifdef CONFIG_NFS_V4
 206 extern int nfs4_decode_dirent(struct xdr_stream *,
 207                                 struct nfs_entry *, int);
 208 #endif
 209 #ifdef CONFIG_NFS_V4_1
 210 extern const u32 nfs41_maxread_overhead;
 211 extern const u32 nfs41_maxwrite_overhead;
 212 #endif
 213
 214 /* nfs4proc.c */
 215 #ifdef CONFIG_NFS_V4
 216 extern struct rpc_procinfo nfs4_procedures[];
 217 #endif
 218
 219 extern int nfs4_init_ds_session(struct nfs_client *clp);
 220
 221 /* proc.c */
 222 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 223 extern int nfs_init_client(struct nfs_client *clp,
 224                            const struct rpc_timeout *timeparms,
 225                            const char *ip_addr, rpc_authflavor_t authflavour,
 226                            int noresvport);
 227
 228 /* dir.c */
 229 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
 230                                         int nr_to_scan, gfp_t gfp_mask);
 231
 232 /* inode.c */
 233 extern struct workqueue_struct *nfsiod_workqueue;
 234 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 235 extern void nfs_destroy_inode(struct inode *);
 236 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 237 extern void nfs_evict_inode(struct inode *);
 238 #ifdef CONFIG_NFS_V4
 239 extern void nfs4_evict_inode(struct inode *);
 240 #endif
 241 void nfs_zap_acl_cache(struct inode *inode);
 242 extern int nfs_wait_bit_killable(void *word);
 243
 244 /* super.c */
 245 extern struct file_system_type nfs_xdev_fs_type;
 246 #ifdef CONFIG_NFS_V4
 247 extern struct file_system_type nfs4_xdev_fs_type;
 248 extern struct file_system_type nfs4_referral_fs_type;
 249 #endif
 250
 251 extern struct rpc_stat nfs_rpcstat;
 252
 253 extern int __init register_nfs_fs(void);
 254 extern void __exit unregister_nfs_fs(void);
 255 extern void nfs_sb_active(struct super_block *sb);
 256 extern void nfs_sb_deactive(struct super_block *sb);
 257
 258 /* namespace.c */
 259 extern char *nfs_path(const char *base,
 260                       const struct dentry *droot,
 261                       const struct dentry *dentry,
 262                       char *buffer, ssize_t buflen);
 263 extern struct vfsmount *nfs_d_automount(struct path *path);
 264
 265 /* getroot.c */
 266 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
 267 #ifdef CONFIG_NFS_V4
 268 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
 269
 270 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
 271 #endif
 272
 273 /* read.c */
 274 extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
 275                              const struct rpc_call_ops *call_ops);
 276 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 277
 278 /* write.c */
 279 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 280 #ifdef CONFIG_MIGRATION
 281 extern int nfs_migrate_page(struct address_space *,
 282                 struct page *, struct page *);
 283 #else
 284 #define nfs_migrate_page NULL
 285 #endif
 286
 287 /* nfs4proc.c */
 288 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
 289 extern int nfs4_init_client(struct nfs_client *clp,
 290                             const struct rpc_timeout *timeparms,
 291                             const char *ip_addr,
 292                             rpc_authflavor_t authflavour,
 293                             int noresvport);
 294 extern int _nfs4_call_sync(struct nfs_server *server,
 295                            struct rpc_message *msg,
 296                            struct nfs4_sequence_args *args,
 297                            struct nfs4_sequence_res *res,
 298                            int cache_reply);
 299 extern int _nfs4_call_sync_session(struct nfs_server *server,
 300                                    struct rpc_message *msg,
 301                                    struct nfs4_sequence_args *args,
 302                                    struct nfs4_sequence_res *res,
 303                                    int cache_reply);
 304
 305 /*
 306  * Determine the device name as a string
 307  */
 308 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
 309                                 const struct dentry *dentry,
 310                                 char *buffer, ssize_t buflen)
 311 {
 312         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
 313                         dentry, buffer, buflen);
 314 }
 315
 316 /*
 317  * Determine the actual block size (and log2 thereof)
 318  */
 319 static inline
 320 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 321 {
 322         /* make sure blocksize is a power of two */
 323         if ((bsize & (bsize - 1)) || nrbitsp) {
 324                 unsigned char   nrbits;
 325
 326                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 327                         ;
 328                 bsize = 1 << nrbits;
 329                 if (nrbitsp)
 330                         *nrbitsp = nrbits;
 331         }
 332
 333         return bsize;
 334 }
 335
 336 /*
 337  * Calculate the number of 512byte blocks used.
 338  */
 339 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 340 {
 341         blkcnt_t used = (tsize + 511) >> 9;
 342         return (used > ULONG_MAX) ? ULONG_MAX : used;
 343 }
 344
 345 /*
 346  * Compute and set NFS server blocksize
 347  */
 348 static inline
 349 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 350 {
 351         if (bsize < NFS_MIN_FILE_IO_SIZE)
 352                 bsize = NFS_DEF_FILE_IO_SIZE;
 353         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 354                 bsize = NFS_MAX_FILE_IO_SIZE;
 355
 356         return nfs_block_bits(bsize, nrbitsp);
 357 }
 358
 359 /*
 360  * Determine the maximum file size for a superblock
 361  */
 362 static inline
 363 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 364 {
 365         sb->s_maxbytes = (loff_t)maxfilesize;
 366         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 367                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 368 }
 369
 370 /*
 371  * Determine the number of bytes of data the page contains
 372  */
 373 static inline
 374 unsigned int nfs_page_length(struct page *page)
 375 {
 376         loff_t i_size = i_size_read(page->mapping->host);
 377
 378         if (i_size > 0) {
 379                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 380                 if (page->index < end_index)
 381                         return PAGE_CACHE_SIZE;
 382                 if (page->index == end_index)
 383                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 384         }
 385         return 0;
 386 }
 387
 388 /*
 389  * Convert a umode to a dirent->d_type
 390  */
 391 static inline
 392 unsigned char nfs_umode_to_dtype(umode_t mode)
 393 {
 394         return (mode >> 12) & 15;
 395 }
 396
 397 /*
 398  * Determine the number of pages in an array of length 'len' and
 399  * with a base offset of 'base'
 400  */
 401 static inline
 402 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 403 {
 404         return ((unsigned long)len + (unsigned long)base +
 405                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 406 }
 407
 408 /*
 409  * Helper for restarting RPC calls in the possible presence of NFSv4.1
 410  * sessions.
 411  */
 412 static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
 413 {
 414         if (nfs4_has_session(clp))
 415                 return rpc_restart_call_prepare(task);
 416         return rpc_restart_call(task);
 417 }