Pileus Git - ~andy/linux/blob - 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         struct net              *net;
 127 };
 128
 129 /* mount_clnt.c */
 130 struct nfs_mount_request {
 131         struct sockaddr         *sap;
 132         size_t                  salen;
 133         char                    *hostname;
 134         char                    *dirpath;
 135         u32                     version;
 136         unsigned short          protocol;
 137         struct nfs_fh           *fh;
 138         int                     noresvport;
 139         unsigned int            *auth_flav_len;
 140         rpc_authflavor_t        *auth_flavs;
 141         struct net              *net;
 142 };
 143
 144 extern int nfs_mount(struct nfs_mount_request *info);
 145 extern void nfs_umount(const struct nfs_mount_request *info);
 146
 147 /* client.c */
 148 extern struct rpc_program nfs_program;
 149
 150 extern void nfs_cleanup_cb_ident_idr(void);
 151 extern void nfs_put_client(struct nfs_client *);
 152 extern struct nfs_client *nfs4_find_client_no_ident(const struct sockaddr *);
 153 extern struct nfs_client *nfs4_find_client_ident(int);
 154 extern struct nfs_client *
 155 nfs4_find_client_sessionid(const struct sockaddr *, struct nfs4_sessionid *);
 156 extern struct nfs_server *nfs_create_server(
 157                                         const struct nfs_parsed_mount_data *,
 158                                         struct nfs_fh *);
 159 extern struct nfs_server *nfs4_create_server(
 160                                         const struct nfs_parsed_mount_data *,
 161                                         struct nfs_fh *);
 162 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 163                                                       struct nfs_fh *);
 164 extern void nfs_free_server(struct nfs_server *server);
 165 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 166                                            struct nfs_fh *,
 167                                            struct nfs_fattr *);
 168 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 169 extern int nfs4_check_client_ready(struct nfs_client *clp);
 170 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
 171                                              const struct sockaddr *ds_addr,
 172                                              int ds_addrlen, int ds_proto);
 173 #ifdef CONFIG_PROC_FS
 174 extern int __init nfs_fs_proc_init(void);
 175 extern void nfs_fs_proc_exit(void);
 176 #else
 177 static inline int nfs_fs_proc_init(void)
 178 {
 179         return 0;
 180 }
 181 static inline void nfs_fs_proc_exit(void)
 182 {
 183 }
 184 #endif
 185 #ifdef CONFIG_NFS_V4
 186 extern spinlock_t nfs_client_lock;
 187 extern struct list_head nfs_client_list;
 188 #endif
 189
 190 /* nfs4namespace.c */
 191 #ifdef CONFIG_NFS_V4
 192 extern struct vfsmount *nfs_do_refmount(struct dentry *dentry);
 193 #else
 194 static inline
 195 struct vfsmount *nfs_do_refmount(struct dentry *dentry)
 196 {
 197         return ERR_PTR(-ENOENT);
 198 }
 199 #endif
 200
 201 /* callback_xdr.c */
 202 extern struct svc_version nfs4_callback_version1;
 203 extern struct svc_version nfs4_callback_version4;
 204
 205 /* pagelist.c */
 206 extern int __init nfs_init_nfspagecache(void);
 207 extern void nfs_destroy_nfspagecache(void);
 208 extern int __init nfs_init_readpagecache(void);
 209 extern void nfs_destroy_readpagecache(void);
 210 extern int __init nfs_init_writepagecache(void);
 211 extern void nfs_destroy_writepagecache(void);
 212
 213 extern int __init nfs_init_directcache(void);
 214 extern void nfs_destroy_directcache(void);
 215
 216 /* nfs2xdr.c */
 217 extern int nfs_stat_to_errno(enum nfs_stat);
 218 extern struct rpc_procinfo nfs_procedures[];
 219 extern int nfs2_decode_dirent(struct xdr_stream *,
 220                                 struct nfs_entry *, int);
 221
 222 /* nfs3xdr.c */
 223 extern struct rpc_procinfo nfs3_procedures[];
 224 extern int nfs3_decode_dirent(struct xdr_stream *,
 225                                 struct nfs_entry *, int);
 226
 227 /* nfs4xdr.c */
 228 #ifdef CONFIG_NFS_V4
 229 extern int nfs4_decode_dirent(struct xdr_stream *,
 230                                 struct nfs_entry *, int);
 231 #endif
 232 #ifdef CONFIG_NFS_V4_1
 233 extern const u32 nfs41_maxread_overhead;
 234 extern const u32 nfs41_maxwrite_overhead;
 235 #endif
 236
 237 /* nfs4proc.c */
 238 #ifdef CONFIG_NFS_V4
 239 extern struct rpc_procinfo nfs4_procedures[];
 240 void nfs_fixup_secinfo_attributes(struct nfs_fattr *, struct nfs_fh *);
 241 #endif
 242
 243 extern int nfs4_init_ds_session(struct nfs_client *clp);
 244
 245 /* proc.c */
 246 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 247 extern int nfs_init_client(struct nfs_client *clp,
 248                            const struct rpc_timeout *timeparms,
 249                            const char *ip_addr, rpc_authflavor_t authflavour,
 250                            int noresvport);
 251
 252 /* dir.c */
 253 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
 254                                         struct shrink_control *sc);
 255
 256 /* inode.c */
 257 extern struct workqueue_struct *nfsiod_workqueue;
 258 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 259 extern void nfs_destroy_inode(struct inode *);
 260 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 261 extern void nfs_evict_inode(struct inode *);
 262 #ifdef CONFIG_NFS_V4
 263 extern void nfs4_evict_inode(struct inode *);
 264 #endif
 265 void nfs_zap_acl_cache(struct inode *inode);
 266 extern int nfs_wait_bit_killable(void *word);
 267
 268 /* super.c */
 269 extern struct file_system_type nfs_xdev_fs_type;
 270 #ifdef CONFIG_NFS_V4
 271 extern struct file_system_type nfs4_xdev_fs_type;
 272 extern struct file_system_type nfs4_referral_fs_type;
 273 #endif
 274
 275 extern struct rpc_stat nfs_rpcstat;
 276
 277 extern int __init register_nfs_fs(void);
 278 extern void __exit unregister_nfs_fs(void);
 279 extern void nfs_sb_active(struct super_block *sb);
 280 extern void nfs_sb_deactive(struct super_block *sb);
 281
 282 /* namespace.c */
 283 extern char *nfs_path(char **p, struct dentry *dentry,
 284                       char *buffer, ssize_t buflen);
 285 extern struct vfsmount *nfs_d_automount(struct path *path);
 286 #ifdef CONFIG_NFS_V4
 287 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
 288 #endif
 289
 290 /* getroot.c */
 291 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
 292                                    const char *);
 293 #ifdef CONFIG_NFS_V4
 294 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
 295                                     const char *);
 296
 297 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
 298 #endif
 299
 300 struct nfs_pageio_descriptor;
 301 /* read.c */
 302 extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
 303                              const struct rpc_call_ops *call_ops);
 304 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 305 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
 306                 struct list_head *head);
 307
 308 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
 309                 struct inode *inode);
 310 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
 311 extern void nfs_readdata_release(struct nfs_read_data *rdata);
 312
 313 /* write.c */
 314 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
 315                 struct list_head *head);
 316 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
 317                                   struct inode *inode, int ioflags);
 318 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
 319 extern void nfs_writedata_release(struct nfs_write_data *wdata);
 320 extern void nfs_commit_free(struct nfs_write_data *p);
 321 extern int nfs_initiate_write(struct nfs_write_data *data,
 322                               struct rpc_clnt *clnt,
 323                               const struct rpc_call_ops *call_ops,
 324                               int how);
 325 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 326 extern int nfs_initiate_commit(struct nfs_write_data *data,
 327                                struct rpc_clnt *clnt,
 328                                const struct rpc_call_ops *call_ops,
 329                                int how);
 330 extern void nfs_init_commit(struct nfs_write_data *data,
 331                             struct list_head *head,
 332                             struct pnfs_layout_segment *lseg);
 333 void nfs_retry_commit(struct list_head *page_list,
 334                       struct pnfs_layout_segment *lseg);
 335 void nfs_commit_clear_lock(struct nfs_inode *nfsi);
 336 void nfs_commitdata_release(void *data);
 337 void nfs_commit_release_pages(struct nfs_write_data *data);
 338
 339 #ifdef CONFIG_MIGRATION
 340 extern int nfs_migrate_page(struct address_space *,
 341                 struct page *, struct page *, enum migrate_mode);
 342 #else
 343 #define nfs_migrate_page NULL
 344 #endif
 345
 346 /* nfs4proc.c */
 347 extern void __nfs4_read_done_cb(struct nfs_read_data *);
 348 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
 349 extern int nfs4_init_client(struct nfs_client *clp,
 350                             const struct rpc_timeout *timeparms,
 351                             const char *ip_addr,
 352                             rpc_authflavor_t authflavour,
 353                             int noresvport);
 354 extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
 355 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
 356                            struct nfs_server *server,
 357                            struct rpc_message *msg,
 358                            struct nfs4_sequence_args *args,
 359                            struct nfs4_sequence_res *res,
 360                            int cache_reply);
 361 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
 362                                    struct nfs_server *server,
 363                                    struct rpc_message *msg,
 364                                    struct nfs4_sequence_args *args,
 365                                    struct nfs4_sequence_res *res,
 366                                    int cache_reply);
 367
 368 /*
 369  * Determine the device name as a string
 370  */
 371 static inline char *nfs_devname(struct dentry *dentry,
 372                                 char *buffer, ssize_t buflen)
 373 {
 374         char *dummy;
 375         return nfs_path(&dummy, dentry, buffer, buflen);
 376 }
 377
 378 /*
 379  * Determine the actual block size (and log2 thereof)
 380  */
 381 static inline
 382 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 383 {
 384         /* make sure blocksize is a power of two */
 385         if ((bsize & (bsize - 1)) || nrbitsp) {
 386                 unsigned char   nrbits;
 387
 388                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 389                         ;
 390                 bsize = 1 << nrbits;
 391                 if (nrbitsp)
 392                         *nrbitsp = nrbits;
 393         }
 394
 395         return bsize;
 396 }
 397
 398 /*
 399  * Calculate the number of 512byte blocks used.
 400  */
 401 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 402 {
 403         blkcnt_t used = (tsize + 511) >> 9;
 404         return (used > ULONG_MAX) ? ULONG_MAX : used;
 405 }
 406
 407 /*
 408  * Compute and set NFS server blocksize
 409  */
 410 static inline
 411 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 412 {
 413         if (bsize < NFS_MIN_FILE_IO_SIZE)
 414                 bsize = NFS_DEF_FILE_IO_SIZE;
 415         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 416                 bsize = NFS_MAX_FILE_IO_SIZE;
 417
 418         return nfs_block_bits(bsize, nrbitsp);
 419 }
 420
 421 /*
 422  * Determine the maximum file size for a superblock
 423  */
 424 static inline
 425 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 426 {
 427         sb->s_maxbytes = (loff_t)maxfilesize;
 428         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 429                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 430 }
 431
 432 /*
 433  * Determine the number of bytes of data the page contains
 434  */
 435 static inline
 436 unsigned int nfs_page_length(struct page *page)
 437 {
 438         loff_t i_size = i_size_read(page->mapping->host);
 439
 440         if (i_size > 0) {
 441                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 442                 if (page->index < end_index)
 443                         return PAGE_CACHE_SIZE;
 444                 if (page->index == end_index)
 445                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 446         }
 447         return 0;
 448 }
 449
 450 /*
 451  * Convert a umode to a dirent->d_type
 452  */
 453 static inline
 454 unsigned char nfs_umode_to_dtype(umode_t mode)
 455 {
 456         return (mode >> 12) & 15;
 457 }
 458
 459 /*
 460  * Determine the number of pages in an array of length 'len' and
 461  * with a base offset of 'base'
 462  */
 463 static inline
 464 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 465 {
 466         return ((unsigned long)len + (unsigned long)base +
 467                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 468 }
 469