linux/include/linux/nfs_xdr.h
<<
>>
Prefs
   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_NFS_XDR_H
   3#define _LINUX_NFS_XDR_H
   4
   5#include <linux/nfsacl.h>
   6#include <linux/sunrpc/gss_api.h>
   7
   8/*
   9 * To change the maximum rsize and wsize supported by the NFS client, adjust
  10 * NFS_MAX_FILE_IO_SIZE.  64KB is a typical maximum, but some servers can
  11 * support a megabyte or more.  The default is left at 4096 bytes, which is
  12 * reasonable for NFS over UDP.
  13 */
  14#define NFS_MAX_FILE_IO_SIZE    (1048576U)
  15#define NFS_DEF_FILE_IO_SIZE    (4096U)
  16#define NFS_MIN_FILE_IO_SIZE    (1024U)
  17
  18struct nfs4_string {
  19        unsigned int len;
  20        char *data;
  21};
  22
  23struct nfs_fsid {
  24        uint64_t                major;
  25        uint64_t                minor;
  26};
  27
  28/*
  29 * Helper for checking equality between 2 fsids.
  30 */
  31static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
  32{
  33        return a->major == b->major && a->minor == b->minor;
  34}
  35
  36struct nfs4_threshold {
  37        __u32   bm;
  38        __u32   l_type;
  39        __u64   rd_sz;
  40        __u64   wr_sz;
  41        __u64   rd_io_sz;
  42        __u64   wr_io_sz;
  43};
  44
  45struct nfs_fattr {
  46        unsigned int            valid;          /* which fields are valid */
  47        umode_t                 mode;
  48        __u32                   nlink;
  49        kuid_t                  uid;
  50        kgid_t                  gid;
  51        dev_t                   rdev;
  52        __u64                   size;
  53        union {
  54                struct {
  55                        __u32   blocksize;
  56                        __u32   blocks;
  57                } nfs2;
  58                struct {
  59                        __u64   used;
  60                } nfs3;
  61        } du;
  62        struct nfs_fsid         fsid;
  63        __u64                   fileid;
  64        __u64                   mounted_on_fileid;
  65        struct timespec64       atime;
  66        struct timespec64       mtime;
  67        struct timespec64       ctime;
  68        __u64                   change_attr;    /* NFSv4 change attribute */
  69        __u64                   pre_change_attr;/* pre-op NFSv4 change attribute */
  70        __u64                   pre_size;       /* pre_op_attr.size       */
  71        struct timespec64       pre_mtime;      /* pre_op_attr.mtime      */
  72        struct timespec64       pre_ctime;      /* pre_op_attr.ctime      */
  73        unsigned long           time_start;
  74        unsigned long           gencount;
  75        struct nfs4_string      *owner_name;
  76        struct nfs4_string      *group_name;
  77        struct nfs4_threshold   *mdsthreshold;  /* pNFS threshold hints */
  78        struct nfs4_label       *label;
  79};
  80
  81#define NFS_ATTR_FATTR_TYPE             (1U << 0)
  82#define NFS_ATTR_FATTR_MODE             (1U << 1)
  83#define NFS_ATTR_FATTR_NLINK            (1U << 2)
  84#define NFS_ATTR_FATTR_OWNER            (1U << 3)
  85#define NFS_ATTR_FATTR_GROUP            (1U << 4)
  86#define NFS_ATTR_FATTR_RDEV             (1U << 5)
  87#define NFS_ATTR_FATTR_SIZE             (1U << 6)
  88#define NFS_ATTR_FATTR_PRESIZE          (1U << 7)
  89#define NFS_ATTR_FATTR_BLOCKS_USED      (1U << 8)
  90#define NFS_ATTR_FATTR_SPACE_USED       (1U << 9)
  91#define NFS_ATTR_FATTR_FSID             (1U << 10)
  92#define NFS_ATTR_FATTR_FILEID           (1U << 11)
  93#define NFS_ATTR_FATTR_ATIME            (1U << 12)
  94#define NFS_ATTR_FATTR_MTIME            (1U << 13)
  95#define NFS_ATTR_FATTR_CTIME            (1U << 14)
  96#define NFS_ATTR_FATTR_PREMTIME         (1U << 15)
  97#define NFS_ATTR_FATTR_PRECTIME         (1U << 16)
  98#define NFS_ATTR_FATTR_CHANGE           (1U << 17)
  99#define NFS_ATTR_FATTR_PRECHANGE        (1U << 18)
 100#define NFS_ATTR_FATTR_V4_LOCATIONS     (1U << 19)
 101#define NFS_ATTR_FATTR_V4_REFERRAL      (1U << 20)
 102#define NFS_ATTR_FATTR_MOUNTPOINT       (1U << 21)
 103#define NFS_ATTR_FATTR_MOUNTED_ON_FILEID (1U << 22)
 104#define NFS_ATTR_FATTR_OWNER_NAME       (1U << 23)
 105#define NFS_ATTR_FATTR_GROUP_NAME       (1U << 24)
 106#define NFS_ATTR_FATTR_V4_SECURITY_LABEL (1U << 25)
 107
 108#define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
 109                | NFS_ATTR_FATTR_MODE \
 110                | NFS_ATTR_FATTR_NLINK \
 111                | NFS_ATTR_FATTR_OWNER \
 112                | NFS_ATTR_FATTR_GROUP \
 113                | NFS_ATTR_FATTR_RDEV \
 114                | NFS_ATTR_FATTR_SIZE \
 115                | NFS_ATTR_FATTR_FSID \
 116                | NFS_ATTR_FATTR_FILEID \
 117                | NFS_ATTR_FATTR_ATIME \
 118                | NFS_ATTR_FATTR_MTIME \
 119                | NFS_ATTR_FATTR_CTIME \
 120                | NFS_ATTR_FATTR_CHANGE)
 121#define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
 122                | NFS_ATTR_FATTR_BLOCKS_USED)
 123#define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
 124                | NFS_ATTR_FATTR_SPACE_USED)
 125#define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
 126                | NFS_ATTR_FATTR_SPACE_USED \
 127                | NFS_ATTR_FATTR_V4_SECURITY_LABEL)
 128
 129/*
 130 * Maximal number of supported layout drivers.
 131 */
 132#define NFS_MAX_LAYOUT_TYPES 8
 133
 134/*
 135 * Info on the file system
 136 */
 137struct nfs_fsinfo {
 138        struct nfs_fattr        *fattr; /* Post-op attributes */
 139        __u32                   rtmax;  /* max.  read transfer size */
 140        __u32                   rtpref; /* pref. read transfer size */
 141        __u32                   rtmult; /* reads should be multiple of this */
 142        __u32                   wtmax;  /* max.  write transfer size */
 143        __u32                   wtpref; /* pref. write transfer size */
 144        __u32                   wtmult; /* writes should be multiple of this */
 145        __u32                   dtpref; /* pref. readdir transfer size */
 146        __u64                   maxfilesize;
 147        struct timespec64       time_delta; /* server time granularity */
 148        __u32                   lease_time; /* in seconds */
 149        __u32                   nlayouttypes; /* number of layouttypes */
 150        __u32                   layouttype[NFS_MAX_LAYOUT_TYPES]; /* supported pnfs layout driver */
 151        __u32                   blksize; /* preferred pnfs io block size */
 152        __u32                   clone_blksize; /* granularity of a CLONE operation */
 153        __u32                   xattr_support; /* User xattrs supported */
 154};
 155
 156struct nfs_fsstat {
 157        struct nfs_fattr        *fattr; /* Post-op attributes */
 158        __u64                   tbytes; /* total size in bytes */
 159        __u64                   fbytes; /* # of free bytes */
 160        __u64                   abytes; /* # of bytes available to user */
 161        __u64                   tfiles; /* # of files */
 162        __u64                   ffiles; /* # of free files */
 163        __u64                   afiles; /* # of files available to user */
 164};
 165
 166struct nfs2_fsstat {
 167        __u32                   tsize;  /* Server transfer size */
 168        __u32                   bsize;  /* Filesystem block size */
 169        __u32                   blocks; /* No. of "bsize" blocks on filesystem */
 170        __u32                   bfree;  /* No. of free "bsize" blocks */
 171        __u32                   bavail; /* No. of available "bsize" blocks */
 172};
 173
 174struct nfs_pathconf {
 175        struct nfs_fattr        *fattr; /* Post-op attributes */
 176        __u32                   max_link; /* max # of hard links */
 177        __u32                   max_namelen; /* max name length */
 178};
 179
 180struct nfs4_change_info {
 181        u32                     atomic;
 182        u64                     before;
 183        u64                     after;
 184};
 185
 186struct nfs_seqid;
 187
 188/* nfs41 sessions channel attributes */
 189struct nfs4_channel_attrs {
 190        u32                     max_rqst_sz;
 191        u32                     max_resp_sz;
 192        u32                     max_resp_sz_cached;
 193        u32                     max_ops;
 194        u32                     max_reqs;
 195};
 196
 197struct nfs4_slot;
 198struct nfs4_sequence_args {
 199        struct nfs4_slot        *sa_slot;
 200        u8                      sa_cache_this : 1,
 201                                sa_privileged : 1;
 202};
 203
 204struct nfs4_sequence_res {
 205        struct nfs4_slot        *sr_slot;       /* slot used to send request */
 206        unsigned long           sr_timestamp;
 207        int                     sr_status;      /* sequence operation status */
 208        u32                     sr_status_flags;
 209        u32                     sr_highest_slotid;
 210        u32                     sr_target_highest_slotid;
 211};
 212
 213struct nfs4_get_lease_time_args {
 214        struct nfs4_sequence_args       la_seq_args;
 215};
 216
 217struct nfs4_get_lease_time_res {
 218        struct nfs4_sequence_res        lr_seq_res;
 219        struct nfs_fsinfo              *lr_fsinfo;
 220};
 221
 222struct xdr_stream;
 223struct nfs4_xdr_opaque_data;
 224
 225struct nfs4_xdr_opaque_ops {
 226        void (*encode)(struct xdr_stream *, const void *args,
 227                        const struct nfs4_xdr_opaque_data *);
 228        void (*free)(struct nfs4_xdr_opaque_data *);
 229};
 230
 231struct nfs4_xdr_opaque_data {
 232        const struct nfs4_xdr_opaque_ops *ops;
 233        void *data;
 234};
 235
 236#define PNFS_LAYOUT_MAXSIZE 4096
 237
 238struct nfs4_layoutdriver_data {
 239        struct page **pages;
 240        __u32 pglen;
 241        __u32 len;
 242};
 243
 244struct pnfs_layout_range {
 245        u32 iomode;
 246        u64 offset;
 247        u64 length;
 248};
 249
 250struct nfs4_layoutget_args {
 251        struct nfs4_sequence_args seq_args;
 252        __u32 type;
 253        struct pnfs_layout_range range;
 254        __u64 minlength;
 255        __u32 maxcount;
 256        struct inode *inode;
 257        struct nfs_open_context *ctx;
 258        nfs4_stateid stateid;
 259        struct nfs4_layoutdriver_data layout;
 260};
 261
 262struct nfs4_layoutget_res {
 263        struct nfs4_sequence_res seq_res;
 264        int status;
 265        __u32 return_on_close;
 266        struct pnfs_layout_range range;
 267        __u32 type;
 268        nfs4_stateid stateid;
 269        struct nfs4_layoutdriver_data *layoutp;
 270};
 271
 272struct nfs4_layoutget {
 273        struct nfs4_layoutget_args args;
 274        struct nfs4_layoutget_res res;
 275        const struct cred *cred;
 276        gfp_t gfp_flags;
 277};
 278
 279struct nfs4_getdeviceinfo_args {
 280        struct nfs4_sequence_args seq_args;
 281        struct pnfs_device *pdev;
 282        __u32 notify_types;
 283};
 284
 285struct nfs4_getdeviceinfo_res {
 286        struct nfs4_sequence_res seq_res;
 287        struct pnfs_device *pdev;
 288        __u32 notification;
 289};
 290
 291struct nfs4_layoutcommit_args {
 292        struct nfs4_sequence_args seq_args;
 293        nfs4_stateid stateid;
 294        __u64 lastbytewritten;
 295        struct inode *inode;
 296        const u32 *bitmask;
 297        size_t layoutupdate_len;
 298        struct page *layoutupdate_page;
 299        struct page **layoutupdate_pages;
 300        __be32 *start_p;
 301};
 302
 303struct nfs4_layoutcommit_res {
 304        struct nfs4_sequence_res seq_res;
 305        struct nfs_fattr *fattr;
 306        const struct nfs_server *server;
 307        int status;
 308};
 309
 310struct nfs4_layoutcommit_data {
 311        struct rpc_task task;
 312        struct nfs_fattr fattr;
 313        struct list_head lseg_list;
 314        const struct cred *cred;
 315        struct inode *inode;
 316        struct nfs4_layoutcommit_args args;
 317        struct nfs4_layoutcommit_res res;
 318};
 319
 320struct nfs4_layoutreturn_args {
 321        struct nfs4_sequence_args seq_args;
 322        struct pnfs_layout_hdr *layout;
 323        struct inode *inode;
 324        struct pnfs_layout_range range;
 325        nfs4_stateid stateid;
 326        __u32   layout_type;
 327        struct nfs4_xdr_opaque_data *ld_private;
 328};
 329
 330struct nfs4_layoutreturn_res {
 331        struct nfs4_sequence_res seq_res;
 332        u32 lrs_present;
 333        nfs4_stateid stateid;
 334};
 335
 336struct nfs4_layoutreturn {
 337        struct nfs4_layoutreturn_args args;
 338        struct nfs4_layoutreturn_res res;
 339        const struct cred *cred;
 340        struct nfs_client *clp;
 341        struct inode *inode;
 342        int rpc_status;
 343        struct nfs4_xdr_opaque_data ld_private;
 344};
 345
 346#define PNFS_LAYOUTSTATS_MAXSIZE 256
 347
 348struct nfs42_layoutstat_args;
 349struct nfs42_layoutstat_devinfo;
 350typedef void (*layoutstats_encode_t)(struct xdr_stream *,
 351                struct nfs42_layoutstat_args *,
 352                struct nfs42_layoutstat_devinfo *);
 353
 354/* Per file per deviceid layoutstats */
 355struct nfs42_layoutstat_devinfo {
 356        struct nfs4_deviceid dev_id;
 357        __u64 offset;
 358        __u64 length;
 359        __u64 read_count;
 360        __u64 read_bytes;
 361        __u64 write_count;
 362        __u64 write_bytes;
 363        __u32 layout_type;
 364        struct nfs4_xdr_opaque_data ld_private;
 365};
 366
 367struct nfs42_layoutstat_args {
 368        struct nfs4_sequence_args seq_args;
 369        struct nfs_fh *fh;
 370        struct inode *inode;
 371        nfs4_stateid stateid;
 372        int num_dev;
 373        struct nfs42_layoutstat_devinfo *devinfo;
 374};
 375
 376struct nfs42_layoutstat_res {
 377        struct nfs4_sequence_res seq_res;
 378        int num_dev;
 379        int rpc_status;
 380};
 381
 382struct nfs42_layoutstat_data {
 383        struct inode *inode;
 384        struct nfs42_layoutstat_args args;
 385        struct nfs42_layoutstat_res res;
 386};
 387
 388struct nfs42_device_error {
 389        struct nfs4_deviceid dev_id;
 390        int status;
 391        enum nfs_opnum4 opnum;
 392};
 393
 394struct nfs42_layout_error {
 395        __u64 offset;
 396        __u64 length;
 397        nfs4_stateid stateid;
 398        struct nfs42_device_error errors[1];
 399};
 400
 401#define NFS42_LAYOUTERROR_MAX 5
 402
 403struct nfs42_layouterror_args {
 404        struct nfs4_sequence_args seq_args;
 405        struct inode *inode;
 406        unsigned int num_errors;
 407        struct nfs42_layout_error errors[NFS42_LAYOUTERROR_MAX];
 408};
 409
 410struct nfs42_layouterror_res {
 411        struct nfs4_sequence_res seq_res;
 412        unsigned int num_errors;
 413        int rpc_status;
 414};
 415
 416struct nfs42_layouterror_data {
 417        struct nfs42_layouterror_args args;
 418        struct nfs42_layouterror_res res;
 419        struct inode *inode;
 420        struct pnfs_layout_segment *lseg;
 421};
 422
 423struct nfs42_clone_args {
 424        struct nfs4_sequence_args       seq_args;
 425        struct nfs_fh                   *src_fh;
 426        struct nfs_fh                   *dst_fh;
 427        nfs4_stateid                    src_stateid;
 428        nfs4_stateid                    dst_stateid;
 429        __u64                           src_offset;
 430        __u64                           dst_offset;
 431        __u64                           count;
 432        const u32                       *dst_bitmask;
 433};
 434
 435struct nfs42_clone_res {
 436        struct nfs4_sequence_res        seq_res;
 437        unsigned int                    rpc_status;
 438        struct nfs_fattr                *dst_fattr;
 439        const struct nfs_server         *server;
 440};
 441
 442struct stateowner_id {
 443        __u64   create_time;
 444        __u32   uniquifier;
 445};
 446
 447/*
 448 * Arguments to the open call.
 449 */
 450struct nfs_openargs {
 451        struct nfs4_sequence_args       seq_args;
 452        const struct nfs_fh *   fh;
 453        struct nfs_seqid *      seqid;
 454        int                     open_flags;
 455        fmode_t                 fmode;
 456        u32                     share_access;
 457        u32                     access;
 458        __u64                   clientid;
 459        struct stateowner_id    id;
 460        union {
 461                struct {
 462                        struct iattr *  attrs;    /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
 463                        nfs4_verifier   verifier; /* EXCLUSIVE */
 464                };
 465                nfs4_stateid    delegation;             /* CLAIM_DELEGATE_CUR */
 466                fmode_t         delegation_type;        /* CLAIM_PREVIOUS */
 467        } u;
 468        const struct qstr *     name;
 469        const struct nfs_server *server;         /* Needed for ID mapping */
 470        const u32 *             bitmask;
 471        const u32 *             open_bitmap;
 472        enum open_claim_type4   claim;
 473        enum createmode4        createmode;
 474        const struct nfs4_label *label;
 475        umode_t                 umask;
 476        struct nfs4_layoutget_args *lg_args;
 477};
 478
 479struct nfs_openres {
 480        struct nfs4_sequence_res        seq_res;
 481        nfs4_stateid            stateid;
 482        struct nfs_fh           fh;
 483        struct nfs4_change_info cinfo;
 484        __u32                   rflags;
 485        struct nfs_fattr *      f_attr;
 486        struct nfs4_label       *f_label;
 487        struct nfs_seqid *      seqid;
 488        const struct nfs_server *server;
 489        fmode_t                 delegation_type;
 490        nfs4_stateid            delegation;
 491        unsigned long           pagemod_limit;
 492        __u32                   do_recall;
 493        __u32                   attrset[NFS4_BITMAP_SIZE];
 494        struct nfs4_string      *owner;
 495        struct nfs4_string      *group_owner;
 496        __u32                   access_request;
 497        __u32                   access_supported;
 498        __u32                   access_result;
 499        struct nfs4_layoutget_res *lg_res;
 500};
 501
 502/*
 503 * Arguments to the open_confirm call.
 504 */
 505struct nfs_open_confirmargs {
 506        struct nfs4_sequence_args       seq_args;
 507        const struct nfs_fh *   fh;
 508        nfs4_stateid *          stateid;
 509        struct nfs_seqid *      seqid;
 510};
 511
 512struct nfs_open_confirmres {
 513        struct nfs4_sequence_res        seq_res;
 514        nfs4_stateid            stateid;
 515        struct nfs_seqid *      seqid;
 516};
 517
 518/*
 519 * Arguments to the close call.
 520 */
 521struct nfs_closeargs {
 522        struct nfs4_sequence_args       seq_args;
 523        struct nfs_fh *         fh;
 524        nfs4_stateid            stateid;
 525        struct nfs_seqid *      seqid;
 526        fmode_t                 fmode;
 527        u32                     share_access;
 528        u32 *                   bitmask;
 529        struct nfs4_layoutreturn_args *lr_args;
 530};
 531
 532struct nfs_closeres {
 533        struct nfs4_sequence_res        seq_res;
 534        nfs4_stateid            stateid;
 535        struct nfs_fattr *      fattr;
 536        struct nfs_seqid *      seqid;
 537        const struct nfs_server *server;
 538        struct nfs4_layoutreturn_res *lr_res;
 539        int lr_ret;
 540};
 541/*
 542 *  * Arguments to the lock,lockt, and locku call.
 543 *   */
 544struct nfs_lowner {
 545        __u64                   clientid;
 546        __u64                   id;
 547        dev_t                   s_dev;
 548};
 549
 550struct nfs_lock_args {
 551        struct nfs4_sequence_args       seq_args;
 552        struct nfs_fh *         fh;
 553        struct file_lock *      fl;
 554        struct nfs_seqid *      lock_seqid;
 555        nfs4_stateid            lock_stateid;
 556        struct nfs_seqid *      open_seqid;
 557        nfs4_stateid            open_stateid;
 558        struct nfs_lowner       lock_owner;
 559        unsigned char           block : 1;
 560        unsigned char           reclaim : 1;
 561        unsigned char           new_lock : 1;
 562        unsigned char           new_lock_owner : 1;
 563};
 564
 565struct nfs_lock_res {
 566        struct nfs4_sequence_res        seq_res;
 567        nfs4_stateid            stateid;
 568        struct nfs_seqid *      lock_seqid;
 569        struct nfs_seqid *      open_seqid;
 570};
 571
 572struct nfs_locku_args {
 573        struct nfs4_sequence_args       seq_args;
 574        struct nfs_fh *         fh;
 575        struct file_lock *      fl;
 576        struct nfs_seqid *      seqid;
 577        nfs4_stateid            stateid;
 578};
 579
 580struct nfs_locku_res {
 581        struct nfs4_sequence_res        seq_res;
 582        nfs4_stateid            stateid;
 583        struct nfs_seqid *      seqid;
 584};
 585
 586struct nfs_lockt_args {
 587        struct nfs4_sequence_args       seq_args;
 588        struct nfs_fh *         fh;
 589        struct file_lock *      fl;
 590        struct nfs_lowner       lock_owner;
 591};
 592
 593struct nfs_lockt_res {
 594        struct nfs4_sequence_res        seq_res;
 595        struct file_lock *      denied; /* LOCK, LOCKT failed */
 596};
 597
 598struct nfs_release_lockowner_args {
 599        struct nfs4_sequence_args       seq_args;
 600        struct nfs_lowner       lock_owner;
 601};
 602
 603struct nfs_release_lockowner_res {
 604        struct nfs4_sequence_res        seq_res;
 605};
 606
 607struct nfs4_delegreturnargs {
 608        struct nfs4_sequence_args       seq_args;
 609        const struct nfs_fh *fhandle;
 610        const nfs4_stateid *stateid;
 611        u32 * bitmask;
 612        struct nfs4_layoutreturn_args *lr_args;
 613};
 614
 615struct nfs4_delegreturnres {
 616        struct nfs4_sequence_res        seq_res;
 617        struct nfs_fattr * fattr;
 618        struct nfs_server *server;
 619        struct nfs4_layoutreturn_res *lr_res;
 620        int lr_ret;
 621};
 622
 623/*
 624 * Arguments to the write call.
 625 */
 626struct nfs_write_verifier {
 627        char                    data[8];
 628};
 629
 630struct nfs_writeverf {
 631        struct nfs_write_verifier verifier;
 632        enum nfs3_stable_how    committed;
 633};
 634
 635/*
 636 * Arguments shared by the read and write call.
 637 */
 638struct nfs_pgio_args {
 639        struct nfs4_sequence_args       seq_args;
 640        struct nfs_fh *         fh;
 641        struct nfs_open_context *context;
 642        struct nfs_lock_context *lock_context;
 643        nfs4_stateid            stateid;
 644        __u64                   offset;
 645        __u32                   count;
 646        unsigned int            pgbase;
 647        struct page **          pages;
 648        union {
 649                unsigned int            replen;                 /* used by read */
 650                struct {
 651                        u32 *                   bitmask;        /* used by write */
 652                        enum nfs3_stable_how    stable;         /* used by write */
 653                };
 654        };
 655};
 656
 657struct nfs_pgio_res {
 658        struct nfs4_sequence_res        seq_res;
 659        struct nfs_fattr *      fattr;
 660        __u32                   count;
 661        __u32                   op_status;
 662        union {
 663                struct {
 664                        unsigned int            replen;         /* used by read */
 665                        int                     eof;            /* used by read */
 666                };
 667                struct {
 668                        struct nfs_writeverf *  verf;           /* used by write */
 669                        const struct nfs_server *server;        /* used by write */
 670                };
 671        };
 672};
 673
 674/*
 675 * Arguments to the commit call.
 676 */
 677struct nfs_commitargs {
 678        struct nfs4_sequence_args       seq_args;
 679        struct nfs_fh           *fh;
 680        __u64                   offset;
 681        __u32                   count;
 682        const u32               *bitmask;
 683};
 684
 685struct nfs_commitres {
 686        struct nfs4_sequence_res        seq_res;
 687        __u32                   op_status;
 688        struct nfs_fattr        *fattr;
 689        struct nfs_writeverf    *verf;
 690        const struct nfs_server *server;
 691};
 692
 693/*
 694 * Common arguments to the unlink call
 695 */
 696struct nfs_removeargs {
 697        struct nfs4_sequence_args       seq_args;
 698        const struct nfs_fh     *fh;
 699        struct qstr             name;
 700};
 701
 702struct nfs_removeres {
 703        struct nfs4_sequence_res        seq_res;
 704        struct nfs_server *server;
 705        struct nfs_fattr        *dir_attr;
 706        struct nfs4_change_info cinfo;
 707};
 708
 709/*
 710 * Common arguments to the rename call
 711 */
 712struct nfs_renameargs {
 713        struct nfs4_sequence_args       seq_args;
 714        const struct nfs_fh             *old_dir;
 715        const struct nfs_fh             *new_dir;
 716        const struct qstr               *old_name;
 717        const struct qstr               *new_name;
 718};
 719
 720struct nfs_renameres {
 721        struct nfs4_sequence_res        seq_res;
 722        struct nfs_server               *server;
 723        struct nfs4_change_info         old_cinfo;
 724        struct nfs_fattr                *old_fattr;
 725        struct nfs4_change_info         new_cinfo;
 726        struct nfs_fattr                *new_fattr;
 727};
 728
 729/* parsed sec= options */
 730#define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
 731struct nfs_auth_info {
 732        unsigned int            flavor_len;
 733        rpc_authflavor_t        flavors[NFS_AUTH_INFO_MAX_FLAVORS];
 734};
 735
 736/*
 737 * Argument struct for decode_entry function
 738 */
 739struct nfs_entry {
 740        __u64                   ino;
 741        __u64                   cookie,
 742                                prev_cookie;
 743        const char *            name;
 744        unsigned int            len;
 745        int                     eof;
 746        struct nfs_fh *         fh;
 747        struct nfs_fattr *      fattr;
 748        struct nfs4_label  *label;
 749        unsigned char           d_type;
 750        struct nfs_server *     server;
 751};
 752
 753struct nfs_readdir_arg {
 754        struct dentry           *dentry;
 755        const struct cred       *cred;
 756        __be32                  *verf;
 757        u64                     cookie;
 758        struct page             **pages;
 759        unsigned int            page_len;
 760        bool                    plus;
 761};
 762
 763struct nfs_readdir_res {
 764        __be32                  *verf;
 765};
 766
 767/*
 768 * The following types are for NFSv2 only.
 769 */
 770struct nfs_sattrargs {
 771        struct nfs_fh *         fh;
 772        struct iattr *          sattr;
 773};
 774
 775struct nfs_diropargs {
 776        struct nfs_fh *         fh;
 777        const char *            name;
 778        unsigned int            len;
 779};
 780
 781struct nfs_createargs {
 782        struct nfs_fh *         fh;
 783        const char *            name;
 784        unsigned int            len;
 785        struct iattr *          sattr;
 786};
 787
 788struct nfs_setattrargs {
 789        struct nfs4_sequence_args       seq_args;
 790        struct nfs_fh *                 fh;
 791        nfs4_stateid                    stateid;
 792        struct iattr *                  iap;
 793        const struct nfs_server *       server; /* Needed for name mapping */
 794        const u32 *                     bitmask;
 795        const struct nfs4_label         *label;
 796};
 797
 798struct nfs_setaclargs {
 799        struct nfs4_sequence_args       seq_args;
 800        struct nfs_fh *                 fh;
 801        size_t                          acl_len;
 802        struct page **                  acl_pages;
 803};
 804
 805struct nfs_setaclres {
 806        struct nfs4_sequence_res        seq_res;
 807};
 808
 809struct nfs_getaclargs {
 810        struct nfs4_sequence_args       seq_args;
 811        struct nfs_fh *                 fh;
 812        size_t                          acl_len;
 813        struct page **                  acl_pages;
 814};
 815
 816/* getxattr ACL interface flags */
 817#define NFS4_ACL_TRUNC          0x0001  /* ACL was truncated */
 818struct nfs_getaclres {
 819        struct nfs4_sequence_res        seq_res;
 820        size_t                          acl_len;
 821        size_t                          acl_data_offset;
 822        int                             acl_flags;
 823        struct page *                   acl_scratch;
 824};
 825
 826struct nfs_setattrres {
 827        struct nfs4_sequence_res        seq_res;
 828        struct nfs_fattr *              fattr;
 829        struct nfs4_label               *label;
 830        const struct nfs_server *       server;
 831};
 832
 833struct nfs_linkargs {
 834        struct nfs_fh *         fromfh;
 835        struct nfs_fh *         tofh;
 836        const char *            toname;
 837        unsigned int            tolen;
 838};
 839
 840struct nfs_symlinkargs {
 841        struct nfs_fh *         fromfh;
 842        const char *            fromname;
 843        unsigned int            fromlen;
 844        struct page **          pages;
 845        unsigned int            pathlen;
 846        struct iattr *          sattr;
 847};
 848
 849struct nfs_readdirargs {
 850        struct nfs_fh *         fh;
 851        __u32                   cookie;
 852        unsigned int            count;
 853        struct page **          pages;
 854};
 855
 856struct nfs3_getaclargs {
 857        struct nfs_fh *         fh;
 858        int                     mask;
 859        struct page **          pages;
 860};
 861
 862struct nfs3_setaclargs {
 863        struct inode *          inode;
 864        int                     mask;
 865        struct posix_acl *      acl_access;
 866        struct posix_acl *      acl_default;
 867        size_t                  len;
 868        unsigned int            npages;
 869        struct page **          pages;
 870};
 871
 872struct nfs_diropok {
 873        struct nfs_fh *         fh;
 874        struct nfs_fattr *      fattr;
 875};
 876
 877struct nfs_readlinkargs {
 878        struct nfs_fh *         fh;
 879        unsigned int            pgbase;
 880        unsigned int            pglen;
 881        struct page **          pages;
 882};
 883
 884struct nfs3_sattrargs {
 885        struct nfs_fh *         fh;
 886        struct iattr *          sattr;
 887        unsigned int            guard;
 888        struct timespec64       guardtime;
 889};
 890
 891struct nfs3_diropargs {
 892        struct nfs_fh *         fh;
 893        const char *            name;
 894        unsigned int            len;
 895};
 896
 897struct nfs3_accessargs {
 898        struct nfs_fh *         fh;
 899        __u32                   access;
 900};
 901
 902struct nfs3_createargs {
 903        struct nfs_fh *         fh;
 904        const char *            name;
 905        unsigned int            len;
 906        struct iattr *          sattr;
 907        enum nfs3_createmode    createmode;
 908        __be32                  verifier[2];
 909};
 910
 911struct nfs3_mkdirargs {
 912        struct nfs_fh *         fh;
 913        const char *            name;
 914        unsigned int            len;
 915        struct iattr *          sattr;
 916};
 917
 918struct nfs3_symlinkargs {
 919        struct nfs_fh *         fromfh;
 920        const char *            fromname;
 921        unsigned int            fromlen;
 922        struct page **          pages;
 923        unsigned int            pathlen;
 924        struct iattr *          sattr;
 925};
 926
 927struct nfs3_mknodargs {
 928        struct nfs_fh *         fh;
 929        const char *            name;
 930        unsigned int            len;
 931        enum nfs3_ftype         type;
 932        struct iattr *          sattr;
 933        dev_t                   rdev;
 934};
 935
 936struct nfs3_linkargs {
 937        struct nfs_fh *         fromfh;
 938        struct nfs_fh *         tofh;
 939        const char *            toname;
 940        unsigned int            tolen;
 941};
 942
 943struct nfs3_readdirargs {
 944        struct nfs_fh *         fh;
 945        __u64                   cookie;
 946        __be32                  verf[2];
 947        bool                    plus;
 948        unsigned int            count;
 949        struct page **          pages;
 950};
 951
 952struct nfs3_diropres {
 953        struct nfs_fattr *      dir_attr;
 954        struct nfs_fh *         fh;
 955        struct nfs_fattr *      fattr;
 956};
 957
 958struct nfs3_accessres {
 959        struct nfs_fattr *      fattr;
 960        __u32                   access;
 961};
 962
 963struct nfs3_readlinkargs {
 964        struct nfs_fh *         fh;
 965        unsigned int            pgbase;
 966        unsigned int            pglen;
 967        struct page **          pages;
 968};
 969
 970struct nfs3_linkres {
 971        struct nfs_fattr *      dir_attr;
 972        struct nfs_fattr *      fattr;
 973};
 974
 975struct nfs3_readdirres {
 976        struct nfs_fattr *      dir_attr;
 977        __be32 *                verf;
 978        bool                    plus;
 979};
 980
 981struct nfs3_getaclres {
 982        struct nfs_fattr *      fattr;
 983        int                     mask;
 984        unsigned int            acl_access_count;
 985        unsigned int            acl_default_count;
 986        struct posix_acl *      acl_access;
 987        struct posix_acl *      acl_default;
 988};
 989
 990#if IS_ENABLED(CONFIG_NFS_V4)
 991
 992typedef u64 clientid4;
 993
 994struct nfs4_accessargs {
 995        struct nfs4_sequence_args       seq_args;
 996        const struct nfs_fh *           fh;
 997        const u32 *                     bitmask;
 998        u32                             access;
 999};
1000
1001struct nfs4_accessres {
1002        struct nfs4_sequence_res        seq_res;
1003        const struct nfs_server *       server;
1004        struct nfs_fattr *              fattr;
1005        u32                             supported;
1006        u32                             access;
1007};
1008
1009struct nfs4_create_arg {
1010        struct nfs4_sequence_args       seq_args;
1011        u32                             ftype;
1012        union {
1013                struct {
1014                        struct page **  pages;
1015                        unsigned int    len;
1016                } symlink;   /* NF4LNK */
1017                struct {
1018                        u32             specdata1;
1019                        u32             specdata2;
1020                } device;    /* NF4BLK, NF4CHR */
1021        } u;
1022        const struct qstr *             name;
1023        const struct nfs_server *       server;
1024        const struct iattr *            attrs;
1025        const struct nfs_fh *           dir_fh;
1026        const u32 *                     bitmask;
1027        const struct nfs4_label         *label;
1028        umode_t                         umask;
1029};
1030
1031struct nfs4_create_res {
1032        struct nfs4_sequence_res        seq_res;
1033        const struct nfs_server *       server;
1034        struct nfs_fh *                 fh;
1035        struct nfs_fattr *              fattr;
1036        struct nfs4_label               *label;
1037        struct nfs4_change_info         dir_cinfo;
1038};
1039
1040struct nfs4_fsinfo_arg {
1041        struct nfs4_sequence_args       seq_args;
1042        const struct nfs_fh *           fh;
1043        const u32 *                     bitmask;
1044};
1045
1046struct nfs4_fsinfo_res {
1047        struct nfs4_sequence_res        seq_res;
1048        struct nfs_fsinfo              *fsinfo;
1049};
1050
1051struct nfs4_getattr_arg {
1052        struct nfs4_sequence_args       seq_args;
1053        const struct nfs_fh *           fh;
1054        const u32 *                     bitmask;
1055};
1056
1057struct nfs4_getattr_res {
1058        struct nfs4_sequence_res        seq_res;
1059        const struct nfs_server *       server;
1060        struct nfs_fattr *              fattr;
1061        struct nfs4_label               *label;
1062};
1063
1064struct nfs4_link_arg {
1065        struct nfs4_sequence_args       seq_args;
1066        const struct nfs_fh *           fh;
1067        const struct nfs_fh *           dir_fh;
1068        const struct qstr *             name;
1069        const u32 *                     bitmask;
1070};
1071
1072struct nfs4_link_res {
1073        struct nfs4_sequence_res        seq_res;
1074        const struct nfs_server *       server;
1075        struct nfs_fattr *              fattr;
1076        struct nfs4_label               *label;
1077        struct nfs4_change_info         cinfo;
1078        struct nfs_fattr *              dir_attr;
1079};
1080
1081struct nfs4_lookup_arg {
1082        struct nfs4_sequence_args       seq_args;
1083        const struct nfs_fh *           dir_fh;
1084        const struct qstr *             name;
1085        const u32 *                     bitmask;
1086};
1087
1088struct nfs4_lookup_res {
1089        struct nfs4_sequence_res        seq_res;
1090        const struct nfs_server *       server;
1091        struct nfs_fattr *              fattr;
1092        struct nfs_fh *                 fh;
1093        struct nfs4_label               *label;
1094};
1095
1096struct nfs4_lookupp_arg {
1097        struct nfs4_sequence_args       seq_args;
1098        const struct nfs_fh             *fh;
1099        const u32                       *bitmask;
1100};
1101
1102struct nfs4_lookupp_res {
1103        struct nfs4_sequence_res        seq_res;
1104        const struct nfs_server         *server;
1105        struct nfs_fattr                *fattr;
1106        struct nfs_fh                   *fh;
1107        struct nfs4_label               *label;
1108};
1109
1110struct nfs4_lookup_root_arg {
1111        struct nfs4_sequence_args       seq_args;
1112        const u32 *                     bitmask;
1113};
1114
1115struct nfs4_pathconf_arg {
1116        struct nfs4_sequence_args       seq_args;
1117        const struct nfs_fh *           fh;
1118        const u32 *                     bitmask;
1119};
1120
1121struct nfs4_pathconf_res {
1122        struct nfs4_sequence_res        seq_res;
1123        struct nfs_pathconf            *pathconf;
1124};
1125
1126struct nfs4_readdir_arg {
1127        struct nfs4_sequence_args       seq_args;
1128        const struct nfs_fh *           fh;
1129        u64                             cookie;
1130        nfs4_verifier                   verifier;
1131        u32                             count;
1132        struct page **                  pages;  /* zero-copy data */
1133        unsigned int                    pgbase; /* zero-copy data */
1134        const u32 *                     bitmask;
1135        bool                            plus;
1136};
1137
1138struct nfs4_readdir_res {
1139        struct nfs4_sequence_res        seq_res;
1140        nfs4_verifier                   verifier;
1141        unsigned int                    pgbase;
1142};
1143
1144struct nfs4_readlink {
1145        struct nfs4_sequence_args       seq_args;
1146        const struct nfs_fh *           fh;
1147        unsigned int                    pgbase;
1148        unsigned int                    pglen;   /* zero-copy data */
1149        struct page **                  pages;   /* zero-copy data */
1150};
1151
1152struct nfs4_readlink_res {
1153        struct nfs4_sequence_res        seq_res;
1154};
1155
1156struct nfs4_setclientid {
1157        const nfs4_verifier *           sc_verifier;
1158        u32                             sc_prog;
1159        unsigned int                    sc_netid_len;
1160        char                            sc_netid[RPCBIND_MAXNETIDLEN + 1];
1161        unsigned int                    sc_uaddr_len;
1162        char                            sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1163        struct nfs_client               *sc_clnt;
1164        struct rpc_cred                 *sc_cred;
1165};
1166
1167struct nfs4_setclientid_res {
1168        u64                             clientid;
1169        nfs4_verifier                   confirm;
1170};
1171
1172struct nfs4_statfs_arg {
1173        struct nfs4_sequence_args       seq_args;
1174        const struct nfs_fh *           fh;
1175        const u32 *                     bitmask;
1176};
1177
1178struct nfs4_statfs_res {
1179        struct nfs4_sequence_res        seq_res;
1180        struct nfs_fsstat              *fsstat;
1181};
1182
1183struct nfs4_server_caps_arg {
1184        struct nfs4_sequence_args       seq_args;
1185        struct nfs_fh                  *fhandle;
1186        const u32 *                     bitmask;
1187};
1188
1189struct nfs4_server_caps_res {
1190        struct nfs4_sequence_res        seq_res;
1191        u32                             attr_bitmask[3];
1192        u32                             exclcreat_bitmask[3];
1193        u32                             acl_bitmask;
1194        u32                             has_links;
1195        u32                             has_symlinks;
1196        u32                             fh_expire_type;
1197};
1198
1199#define NFS4_PATHNAME_MAXCOMPONENTS 512
1200struct nfs4_pathname {
1201        unsigned int ncomponents;
1202        struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1203};
1204
1205#define NFS4_FS_LOCATION_MAXSERVERS 10
1206struct nfs4_fs_location {
1207        unsigned int nservers;
1208        struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1209        struct nfs4_pathname rootpath;
1210};
1211
1212#define NFS4_FS_LOCATIONS_MAXENTRIES 10
1213struct nfs4_fs_locations {
1214        struct nfs_fattr fattr;
1215        const struct nfs_server *server;
1216        struct nfs4_pathname fs_path;
1217        int nlocations;
1218        struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1219};
1220
1221struct nfs4_fs_locations_arg {
1222        struct nfs4_sequence_args       seq_args;
1223        const struct nfs_fh *dir_fh;
1224        const struct nfs_fh *fh;
1225        const struct qstr *name;
1226        struct page *page;
1227        const u32 *bitmask;
1228        clientid4 clientid;
1229        unsigned char migration:1, renew:1;
1230};
1231
1232struct nfs4_fs_locations_res {
1233        struct nfs4_sequence_res        seq_res;
1234        struct nfs4_fs_locations       *fs_locations;
1235        unsigned char                   migration:1, renew:1;
1236};
1237
1238struct nfs4_secinfo4 {
1239        u32                     flavor;
1240        struct rpcsec_gss_info  flavor_info;
1241};
1242
1243struct nfs4_secinfo_flavors {
1244        unsigned int            num_flavors;
1245        struct nfs4_secinfo4    flavors[];
1246};
1247
1248struct nfs4_secinfo_arg {
1249        struct nfs4_sequence_args       seq_args;
1250        const struct nfs_fh             *dir_fh;
1251        const struct qstr               *name;
1252};
1253
1254struct nfs4_secinfo_res {
1255        struct nfs4_sequence_res        seq_res;
1256        struct nfs4_secinfo_flavors     *flavors;
1257};
1258
1259struct nfs4_fsid_present_arg {
1260        struct nfs4_sequence_args       seq_args;
1261        const struct nfs_fh             *fh;
1262        clientid4                       clientid;
1263        unsigned char                   renew:1;
1264};
1265
1266struct nfs4_fsid_present_res {
1267        struct nfs4_sequence_res        seq_res;
1268        struct nfs_fh                   *fh;
1269        unsigned char                   renew:1;
1270};
1271
1272#endif /* CONFIG_NFS_V4 */
1273
1274struct nfstime4 {
1275        u64     seconds;
1276        u32     nseconds;
1277};
1278
1279#ifdef CONFIG_NFS_V4_1
1280
1281struct pnfs_commit_bucket {
1282        struct list_head written;
1283        struct list_head committing;
1284        struct pnfs_layout_segment *lseg;
1285        struct nfs_writeverf direct_verf;
1286};
1287
1288struct pnfs_commit_array {
1289        struct list_head cinfo_list;
1290        struct list_head lseg_list;
1291        struct pnfs_layout_segment *lseg;
1292        struct rcu_head rcu;
1293        refcount_t refcount;
1294        unsigned int nbuckets;
1295        struct pnfs_commit_bucket buckets[];
1296};
1297
1298struct pnfs_ds_commit_info {
1299        struct list_head commits;
1300        unsigned int nwritten;
1301        unsigned int ncommitting;
1302        const struct pnfs_commit_ops *ops;
1303};
1304
1305struct nfs41_state_protection {
1306        u32 how;
1307        struct nfs4_op_map enforce;
1308        struct nfs4_op_map allow;
1309};
1310
1311struct nfs41_exchange_id_args {
1312        struct nfs_client               *client;
1313        nfs4_verifier                   verifier;
1314        u32                             flags;
1315        struct nfs41_state_protection   state_protect;
1316};
1317
1318struct nfs41_server_owner {
1319        uint64_t                        minor_id;
1320        uint32_t                        major_id_sz;
1321        char                            major_id[NFS4_OPAQUE_LIMIT];
1322};
1323
1324struct nfs41_server_scope {
1325        uint32_t                        server_scope_sz;
1326        char                            server_scope[NFS4_OPAQUE_LIMIT];
1327};
1328
1329struct nfs41_impl_id {
1330        char                            domain[NFS4_OPAQUE_LIMIT + 1];
1331        char                            name[NFS4_OPAQUE_LIMIT + 1];
1332        struct nfstime4                 date;
1333};
1334
1335#define MAX_BIND_CONN_TO_SESSION_RETRIES 3
1336struct nfs41_bind_conn_to_session_args {
1337        struct nfs_client               *client;
1338        struct nfs4_sessionid           sessionid;
1339        u32                             dir;
1340        bool                            use_conn_in_rdma_mode;
1341        int                             retries;
1342};
1343
1344struct nfs41_bind_conn_to_session_res {
1345        struct nfs4_sessionid           sessionid;
1346        u32                             dir;
1347        bool                            use_conn_in_rdma_mode;
1348};
1349
1350struct nfs41_exchange_id_res {
1351        u64                             clientid;
1352        u32                             seqid;
1353        u32                             flags;
1354        struct nfs41_server_owner       *server_owner;
1355        struct nfs41_server_scope       *server_scope;
1356        struct nfs41_impl_id            *impl_id;
1357        struct nfs41_state_protection   state_protect;
1358};
1359
1360struct nfs41_create_session_args {
1361        struct nfs_client              *client;
1362        u64                             clientid;
1363        uint32_t                        seqid;
1364        uint32_t                        flags;
1365        uint32_t                        cb_program;
1366        struct nfs4_channel_attrs       fc_attrs;       /* Fore Channel */
1367        struct nfs4_channel_attrs       bc_attrs;       /* Back Channel */
1368};
1369
1370struct nfs41_create_session_res {
1371        struct nfs4_sessionid           sessionid;
1372        uint32_t                        seqid;
1373        uint32_t                        flags;
1374        struct nfs4_channel_attrs       fc_attrs;       /* Fore Channel */
1375        struct nfs4_channel_attrs       bc_attrs;       /* Back Channel */
1376};
1377
1378struct nfs41_reclaim_complete_args {
1379        struct nfs4_sequence_args       seq_args;
1380        /* In the future extend to include curr_fh for use with migration */
1381        unsigned char                   one_fs:1;
1382};
1383
1384struct nfs41_reclaim_complete_res {
1385        struct nfs4_sequence_res        seq_res;
1386};
1387
1388#define SECINFO_STYLE_CURRENT_FH 0
1389#define SECINFO_STYLE_PARENT 1
1390struct nfs41_secinfo_no_name_args {
1391        struct nfs4_sequence_args       seq_args;
1392        int                             style;
1393};
1394
1395struct nfs41_test_stateid_args {
1396        struct nfs4_sequence_args       seq_args;
1397        nfs4_stateid                    *stateid;
1398};
1399
1400struct nfs41_test_stateid_res {
1401        struct nfs4_sequence_res        seq_res;
1402        unsigned int                    status;
1403};
1404
1405struct nfs41_free_stateid_args {
1406        struct nfs4_sequence_args       seq_args;
1407        nfs4_stateid                    stateid;
1408};
1409
1410struct nfs41_free_stateid_res {
1411        struct nfs4_sequence_res        seq_res;
1412        unsigned int                    status;
1413};
1414
1415#else
1416
1417struct pnfs_ds_commit_info {
1418};
1419
1420#endif /* CONFIG_NFS_V4_1 */
1421
1422#ifdef CONFIG_NFS_V4_2
1423struct nfs42_falloc_args {
1424        struct nfs4_sequence_args       seq_args;
1425
1426        struct nfs_fh                   *falloc_fh;
1427        nfs4_stateid                     falloc_stateid;
1428        u64                              falloc_offset;
1429        u64                              falloc_length;
1430        const u32                       *falloc_bitmask;
1431};
1432
1433struct nfs42_falloc_res {
1434        struct nfs4_sequence_res        seq_res;
1435        unsigned int                    status;
1436
1437        struct nfs_fattr                *falloc_fattr;
1438        const struct nfs_server         *falloc_server;
1439};
1440
1441struct nfs42_copy_args {
1442        struct nfs4_sequence_args       seq_args;
1443
1444        struct nfs_fh                   *src_fh;
1445        nfs4_stateid                    src_stateid;
1446        u64                             src_pos;
1447
1448        struct nfs_fh                   *dst_fh;
1449        nfs4_stateid                    dst_stateid;
1450        u64                             dst_pos;
1451
1452        u64                             count;
1453        bool                            sync;
1454};
1455
1456struct nfs42_write_res {
1457        nfs4_stateid            stateid;
1458        u64                     count;
1459        struct nfs_writeverf    verifier;
1460};
1461
1462struct nfs42_copy_res {
1463        struct nfs4_sequence_res        seq_res;
1464        struct nfs42_write_res          write_res;
1465        bool                            consecutive;
1466        bool                            synchronous;
1467        struct nfs_commitres            commit_res;
1468};
1469
1470struct nfs42_offload_status_args {
1471        struct nfs4_sequence_args       osa_seq_args;
1472        struct nfs_fh                   *osa_src_fh;
1473        nfs4_stateid                    osa_stateid;
1474};
1475
1476struct nfs42_offload_status_res {
1477        struct nfs4_sequence_res        osr_seq_res;
1478        uint64_t                        osr_count;
1479        int                             osr_status;
1480};
1481
1482struct nfs42_seek_args {
1483        struct nfs4_sequence_args       seq_args;
1484
1485        struct nfs_fh                   *sa_fh;
1486        nfs4_stateid                    sa_stateid;
1487        u64                             sa_offset;
1488        u32                             sa_what;
1489};
1490
1491struct nfs42_seek_res {
1492        struct nfs4_sequence_res        seq_res;
1493        unsigned int                    status;
1494
1495        u32     sr_eof;
1496        u64     sr_offset;
1497};
1498
1499struct nfs42_setxattrargs {
1500        struct nfs4_sequence_args       seq_args;
1501        struct nfs_fh                   *fh;
1502        const char                      *xattr_name;
1503        u32                             xattr_flags;
1504        size_t                          xattr_len;
1505        struct page                     **xattr_pages;
1506};
1507
1508struct nfs42_setxattrres {
1509        struct nfs4_sequence_res        seq_res;
1510        struct nfs4_change_info         cinfo;
1511};
1512
1513struct nfs42_getxattrargs {
1514        struct nfs4_sequence_args       seq_args;
1515        struct nfs_fh                   *fh;
1516        const char                      *xattr_name;
1517        size_t                          xattr_len;
1518        struct page                     **xattr_pages;
1519};
1520
1521struct nfs42_getxattrres {
1522        struct nfs4_sequence_res        seq_res;
1523        size_t                          xattr_len;
1524};
1525
1526struct nfs42_listxattrsargs {
1527        struct nfs4_sequence_args       seq_args;
1528        struct nfs_fh                   *fh;
1529        u32                             count;
1530        u64                             cookie;
1531        struct page                     **xattr_pages;
1532};
1533
1534struct nfs42_listxattrsres {
1535        struct nfs4_sequence_res        seq_res;
1536        struct page                     *scratch;
1537        void                            *xattr_buf;
1538        size_t                          xattr_len;
1539        u64                             cookie;
1540        bool                            eof;
1541        size_t                          copied;
1542};
1543
1544struct nfs42_removexattrargs {
1545        struct nfs4_sequence_args       seq_args;
1546        struct nfs_fh                   *fh;
1547        const char                      *xattr_name;
1548};
1549
1550struct nfs42_removexattrres {
1551        struct nfs4_sequence_res        seq_res;
1552        struct nfs4_change_info         cinfo;
1553};
1554
1555#endif /* CONFIG_NFS_V4_2 */
1556
1557struct nfs_page;
1558
1559#define NFS_PAGEVEC_SIZE        (8U)
1560
1561struct nfs_page_array {
1562        struct page             **pagevec;
1563        unsigned int            npages;         /* Max length of pagevec */
1564        struct page             *page_array[NFS_PAGEVEC_SIZE];
1565};
1566
1567/* used as flag bits in nfs_pgio_header */
1568enum {
1569        NFS_IOHDR_ERROR = 0,
1570        NFS_IOHDR_EOF,
1571        NFS_IOHDR_REDO,
1572        NFS_IOHDR_STAT,
1573        NFS_IOHDR_RESEND_PNFS,
1574        NFS_IOHDR_RESEND_MDS,
1575};
1576
1577struct nfs_io_completion;
1578struct nfs_pgio_header {
1579        struct inode            *inode;
1580        const struct cred               *cred;
1581        struct list_head        pages;
1582        struct nfs_page         *req;
1583        struct nfs_writeverf    verf;           /* Used for writes */
1584        fmode_t                 rw_mode;
1585        struct pnfs_layout_segment *lseg;
1586        loff_t                  io_start;
1587        const struct rpc_call_ops *mds_ops;
1588        void (*release) (struct nfs_pgio_header *hdr);
1589        const struct nfs_pgio_completion_ops *completion_ops;
1590        const struct nfs_rw_ops *rw_ops;
1591        struct nfs_io_completion *io_completion;
1592        struct nfs_direct_req   *dreq;
1593
1594        int                     pnfs_error;
1595        int                     error;          /* merge with pnfs_error */
1596        unsigned int            good_bytes;     /* boundary of good data */
1597        unsigned long           flags;
1598
1599        /*
1600         * rpc data
1601         */
1602        struct rpc_task         task;
1603        struct nfs_fattr        fattr;
1604        struct nfs_pgio_args    args;           /* argument struct */
1605        struct nfs_pgio_res     res;            /* result struct */
1606        unsigned long           timestamp;      /* For lease renewal */
1607        int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1608        __u64                   mds_offset;     /* Filelayout dense stripe */
1609        struct nfs_page_array   page_array;
1610        struct nfs_client       *ds_clp;        /* pNFS data server */
1611        u32                     ds_commit_idx;  /* ds index if ds_clp is set */
1612        u32                     pgio_mirror_idx;/* mirror index in pgio layer */
1613};
1614
1615struct nfs_mds_commit_info {
1616        atomic_t rpcs_out;
1617        atomic_long_t           ncommit;
1618        struct list_head        list;
1619};
1620
1621struct nfs_commit_info;
1622struct nfs_commit_data;
1623struct nfs_inode;
1624struct nfs_commit_completion_ops {
1625        void (*completion) (struct nfs_commit_data *data);
1626        void (*resched_write) (struct nfs_commit_info *, struct nfs_page *);
1627};
1628
1629struct nfs_commit_info {
1630        struct inode                    *inode; /* Needed for inode->i_lock */
1631        struct nfs_mds_commit_info      *mds;
1632        struct pnfs_ds_commit_info      *ds;
1633        struct nfs_direct_req           *dreq;  /* O_DIRECT request */
1634        const struct nfs_commit_completion_ops *completion_ops;
1635};
1636
1637struct nfs_commit_data {
1638        struct rpc_task         task;
1639        struct inode            *inode;
1640        const struct cred               *cred;
1641        struct nfs_fattr        fattr;
1642        struct nfs_writeverf    verf;
1643        struct list_head        pages;          /* Coalesced requests we wish to flush */
1644        struct list_head        list;           /* lists of struct nfs_write_data */
1645        struct nfs_direct_req   *dreq;          /* O_DIRECT request */
1646        struct nfs_commitargs   args;           /* argument struct */
1647        struct nfs_commitres    res;            /* result struct */
1648        struct nfs_open_context *context;
1649        struct pnfs_layout_segment *lseg;
1650        struct nfs_client       *ds_clp;        /* pNFS data server */
1651        int                     ds_commit_index;
1652        loff_t                  lwb;
1653        const struct rpc_call_ops *mds_ops;
1654        const struct nfs_commit_completion_ops *completion_ops;
1655        int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1656        unsigned long           flags;
1657};
1658
1659struct nfs_pgio_completion_ops {
1660        void    (*error_cleanup)(struct list_head *head, int);
1661        void    (*init_hdr)(struct nfs_pgio_header *hdr);
1662        void    (*completion)(struct nfs_pgio_header *hdr);
1663        void    (*reschedule_io)(struct nfs_pgio_header *hdr);
1664};
1665
1666struct nfs_unlinkdata {
1667        struct nfs_removeargs args;
1668        struct nfs_removeres res;
1669        struct dentry *dentry;
1670        wait_queue_head_t wq;
1671        const struct cred *cred;
1672        struct nfs_fattr dir_attr;
1673        long timeout;
1674};
1675
1676struct nfs_renamedata {
1677        struct nfs_renameargs   args;
1678        struct nfs_renameres    res;
1679        const struct cred       *cred;
1680        struct inode            *old_dir;
1681        struct dentry           *old_dentry;
1682        struct nfs_fattr        old_fattr;
1683        struct inode            *new_dir;
1684        struct dentry           *new_dentry;
1685        struct nfs_fattr        new_fattr;
1686        void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1687        long timeout;
1688        bool cancelled;
1689};
1690
1691struct nfs_access_entry;
1692struct nfs_client;
1693struct rpc_timeout;
1694struct nfs_subversion;
1695struct nfs_mount_info;
1696struct nfs_client_initdata;
1697struct nfs_pageio_descriptor;
1698struct fs_context;
1699
1700/*
1701 * RPC procedure vector for NFSv2/NFSv3 demuxing
1702 */
1703struct nfs_rpc_ops {
1704        u32     version;                /* Protocol version */
1705        const struct dentry_operations *dentry_ops;
1706        const struct inode_operations *dir_inode_ops;
1707        const struct inode_operations *file_inode_ops;
1708        const struct file_operations *file_ops;
1709        const struct nlmclnt_operations *nlmclnt_ops;
1710
1711        int     (*getroot) (struct nfs_server *, struct nfs_fh *,
1712                            struct nfs_fsinfo *);
1713        int     (*submount) (struct fs_context *, struct nfs_server *);
1714        int     (*try_get_tree) (struct fs_context *);
1715        int     (*getattr) (struct nfs_server *, struct nfs_fh *,
1716                            struct nfs_fattr *, struct nfs4_label *,
1717                            struct inode *);
1718        int     (*setattr) (struct dentry *, struct nfs_fattr *,
1719                            struct iattr *);
1720        int     (*lookup)  (struct inode *, struct dentry *,
1721                            struct nfs_fh *, struct nfs_fattr *,
1722                            struct nfs4_label *);
1723        int     (*lookupp) (struct inode *, struct nfs_fh *,
1724                            struct nfs_fattr *, struct nfs4_label *);
1725        int     (*access)  (struct inode *, struct nfs_access_entry *);
1726        int     (*readlink)(struct inode *, struct page *, unsigned int,
1727                            unsigned int);
1728        int     (*create)  (struct inode *, struct dentry *,
1729                            struct iattr *, int);
1730        int     (*remove)  (struct inode *, struct dentry *);
1731        void    (*unlink_setup)  (struct rpc_message *, struct dentry *, struct inode *);
1732        void    (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1733        int     (*unlink_done) (struct rpc_task *, struct inode *);
1734        void    (*rename_setup)  (struct rpc_message *msg,
1735                        struct dentry *old_dentry,
1736                        struct dentry *new_dentry);
1737        void    (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1738        int     (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1739        int     (*link)    (struct inode *, struct inode *, const struct qstr *);
1740        int     (*symlink) (struct inode *, struct dentry *, struct page *,
1741                            unsigned int, struct iattr *);
1742        int     (*mkdir)   (struct inode *, struct dentry *, struct iattr *);
1743        int     (*rmdir)   (struct inode *, const struct qstr *);
1744        int     (*readdir) (struct nfs_readdir_arg *, struct nfs_readdir_res *);
1745        int     (*mknod)   (struct inode *, struct dentry *, struct iattr *,
1746                            dev_t);
1747        int     (*statfs)  (struct nfs_server *, struct nfs_fh *,
1748                            struct nfs_fsstat *);
1749        int     (*fsinfo)  (struct nfs_server *, struct nfs_fh *,
1750                            struct nfs_fsinfo *);
1751        int     (*pathconf) (struct nfs_server *, struct nfs_fh *,
1752                             struct nfs_pathconf *);
1753        int     (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1754        int     (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, bool);
1755        int     (*pgio_rpc_prepare)(struct rpc_task *,
1756                                    struct nfs_pgio_header *);
1757        void    (*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1758        int     (*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1759        void    (*write_setup)(struct nfs_pgio_header *, struct rpc_message *,
1760                                struct rpc_clnt **);
1761        int     (*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1762        void    (*commit_setup) (struct nfs_commit_data *, struct rpc_message *,
1763                                struct rpc_clnt **);
1764        void    (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1765        int     (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1766        int     (*lock)(struct file *, int, struct file_lock *);
1767        int     (*lock_check_bounds)(const struct file_lock *);
1768        void    (*clear_acl_cache)(struct inode *);
1769        void    (*close_context)(struct nfs_open_context *ctx, int);
1770        struct inode * (*open_context) (struct inode *dir,
1771                                struct nfs_open_context *ctx,
1772                                int open_flags,
1773                                struct iattr *iattr,
1774                                int *);
1775        int (*have_delegation)(struct inode *, fmode_t);
1776        struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1777        struct nfs_client *(*init_client) (struct nfs_client *,
1778                                const struct nfs_client_initdata *);
1779        void    (*free_client) (struct nfs_client *);
1780        struct nfs_server *(*create_server)(struct fs_context *);
1781        struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1782                                           struct nfs_fattr *, rpc_authflavor_t);
1783};
1784
1785/*
1786 *      NFS_CALL(getattr, inode, (fattr));
1787 * into
1788 *      NFS_PROTO(inode)->getattr(fattr);
1789 */
1790#define NFS_CALL(op, inode, args)       NFS_PROTO(inode)->op args
1791
1792/*
1793 * Function vectors etc. for the NFS client
1794 */
1795extern const struct nfs_rpc_ops nfs_v2_clientops;
1796extern const struct nfs_rpc_ops nfs_v3_clientops;
1797extern const struct nfs_rpc_ops nfs_v4_clientops;
1798extern const struct rpc_version nfs_version2;
1799extern const struct rpc_version nfs_version3;
1800extern const struct rpc_version nfs_version4;
1801
1802extern const struct rpc_version nfsacl_version3;
1803extern const struct rpc_program nfsacl_program;
1804
1805#endif
1806