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