fs/nfsd/xdr4.h

   1 /*
   2  *  Server-side types for NFSv4.
   3  *
   4  *  Copyright (c) 2002 The Regents of the University of Michigan.
   5  *  All rights reserved.
   6  *
   7  *  Kendrick Smith <kmsmith@umich.edu>
   8  *  Andy Adamson   <andros@umich.edu>
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *  1. Redistributions of source code must retain the above copyright
  15  *     notice, this list of conditions and the following disclaimer.
  16  *  2. Redistributions in binary form must reproduce the above copyright
  17  *     notice, this list of conditions and the following disclaimer in the
  18  *     documentation and/or other materials provided with the distribution.
  19  *  3. Neither the name of the University nor the names of its
  20  *     contributors may be used to endorse or promote products derived
  21  *     from this software without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  24  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #ifndef _LINUX_NFSD_XDR4_H
  38 #define _LINUX_NFSD_XDR4_H
  39
  40 #include "state.h"
  41 #include "nfsd.h"
  42
  43 #define NFSD4_MAX_TAGLEN        128
  44 #define XDR_LEN(n)                     (((n) + 3) & ~3)
  45
  46 #define CURRENT_STATE_ID_FLAG (1<<0)
  47 #define SAVED_STATE_ID_FLAG (1<<1)
  48
  49 #define SET_STATE_ID(c, f) ((c)->sid_flags |= (f))
  50 #define HAS_STATE_ID(c, f) ((c)->sid_flags & (f))
  51 #define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f))
  52
  53 struct nfsd4_compound_state {
  54         struct svc_fh           current_fh;
  55         struct svc_fh           save_fh;
  56         struct nfs4_stateowner  *replay_owner;
  57         struct nfs4_client      *clp;
  58         /* For sessions DRC */
  59         struct nfsd4_session    *session;
  60         struct nfsd4_slot       *slot;
  61         int                     data_offset;
  62         bool                    spo_must_allowed;
  63         size_t                  iovlen;
  64         u32                     minorversion;
  65         __be32                  status;
  66         stateid_t       current_stateid;
  67         stateid_t       save_stateid;
  68         /* to indicate current and saved state id presents */
  69         u32             sid_flags;
  70 };
  71
  72 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
  73 {
  74         return cs->slot != NULL;
  75 }
  76
  77 struct nfsd4_change_info {
  78         u32             atomic;
  79         bool            change_supported;
  80         u32             before_ctime_sec;
  81         u32             before_ctime_nsec;
  82         u64             before_change;
  83         u32             after_ctime_sec;
  84         u32             after_ctime_nsec;
  85         u64             after_change;
  86 };
  87
  88 struct nfsd4_access {
  89         u32             ac_req_access;      /* request */
  90         u32             ac_supported;       /* response */
  91         u32             ac_resp_access;     /* response */
  92 };
  93
  94 struct nfsd4_close {
  95         u32             cl_seqid;           /* request */
  96         stateid_t       cl_stateid;         /* request+response */
  97 };
  98
  99 struct nfsd4_commit {
 100         u64             co_offset;          /* request */
 101         u32             co_count;           /* request */
 102         nfs4_verifier   co_verf;            /* response */
 103 };
 104
 105 struct nfsd4_create {
 106         u32             cr_namelen;         /* request */
 107         char *          cr_name;            /* request */
 108         u32             cr_type;            /* request */
 109         union {                             /* request */
 110                 struct {
 111                         u32 datalen;
 112                         char *data;
 113                 } link;   /* NF4LNK */
 114                 struct {
 115                         u32 specdata1;
 116                         u32 specdata2;
 117                 } dev;    /* NF4BLK, NF4CHR */
 118         } u;
 119         u32             cr_bmval[3];        /* request */
 120         struct iattr    cr_iattr;           /* request */
 121         int             cr_umask;           /* request */
 122         struct nfsd4_change_info  cr_cinfo; /* response */
 123         struct nfs4_acl *cr_acl;
 124         struct xdr_netobj cr_label;
 125 };
 126 #define cr_datalen      u.link.datalen
 127 #define cr_data         u.link.data
 128 #define cr_specdata1    u.dev.specdata1
 129 #define cr_specdata2    u.dev.specdata2
 130
 131 struct nfsd4_delegreturn {
 132         stateid_t       dr_stateid;
 133 };
 134
 135 struct nfsd4_getattr {
 136         u32             ga_bmval[3];        /* request */
 137         struct svc_fh   *ga_fhp;            /* response */
 138 };
 139
 140 struct nfsd4_link {
 141         u32             li_namelen;         /* request */
 142         char *          li_name;            /* request */
 143         struct nfsd4_change_info  li_cinfo; /* response */
 144 };
 145
 146 struct nfsd4_lock_denied {
 147         clientid_t      ld_clientid;
 148         struct xdr_netobj       ld_owner;
 149         u64             ld_start;
 150         u64             ld_length;
 151         u32             ld_type;
 152 };
 153
 154 struct nfsd4_lock {
 155         /* request */
 156         u32             lk_type;
 157         u32             lk_reclaim;         /* boolean */
 158         u64             lk_offset;
 159         u64             lk_length;
 160         u32             lk_is_new;
 161         union {
 162                 struct {
 163                         u32             open_seqid;
 164                         stateid_t       open_stateid;
 165                         u32             lock_seqid;
 166                         clientid_t      clientid;
 167                         struct xdr_netobj owner;
 168                 } new;
 169                 struct {
 170                         stateid_t       lock_stateid;
 171                         u32             lock_seqid;
 172                 } old;
 173         } v;
 174
 175         /* response */
 176         union {
 177                 struct {
 178                         stateid_t               stateid;
 179                 } ok;
 180                 struct nfsd4_lock_denied        denied;
 181         } u;
 182 };
 183 #define lk_new_open_seqid       v.new.open_seqid
 184 #define lk_new_open_stateid     v.new.open_stateid
 185 #define lk_new_lock_seqid       v.new.lock_seqid
 186 #define lk_new_clientid         v.new.clientid
 187 #define lk_new_owner            v.new.owner
 188 #define lk_old_lock_stateid     v.old.lock_stateid
 189 #define lk_old_lock_seqid       v.old.lock_seqid
 190
 191 #define lk_resp_stateid u.ok.stateid
 192 #define lk_denied       u.denied
 193
 194
 195 struct nfsd4_lockt {
 196         u32                             lt_type;
 197         clientid_t                      lt_clientid;
 198         struct xdr_netobj               lt_owner;
 199         u64                             lt_offset;
 200         u64                             lt_length;
 201         struct nfsd4_lock_denied        lt_denied;
 202 };
 203
 204
 205 struct nfsd4_locku {
 206         u32             lu_type;
 207         u32             lu_seqid;
 208         stateid_t       lu_stateid;
 209         u64             lu_offset;
 210         u64             lu_length;
 211 };
 212
 213
 214 struct nfsd4_lookup {
 215         u32             lo_len;             /* request */
 216         char *          lo_name;            /* request */
 217 };
 218
 219 struct nfsd4_putfh {
 220         u32             pf_fhlen;           /* request */
 221         char            *pf_fhval;          /* request */
 222 };
 223
 224 struct nfsd4_open {
 225         u32             op_claim_type;      /* request */
 226         struct xdr_netobj op_fname;         /* request - everything but CLAIM_PREV */
 227         u32             op_delegate_type;   /* request - CLAIM_PREV only */
 228         stateid_t       op_delegate_stateid; /* request - response */
 229         u32             op_why_no_deleg;    /* response - DELEG_NONE_EXT only */
 230         u32             op_create;          /* request */
 231         u32             op_createmode;      /* request */
 232         int             op_umask;           /* request */
 233         u32             op_bmval[3];        /* request */
 234         struct iattr    op_iattr;           /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
 235         nfs4_verifier   op_verf __attribute__((aligned(32)));
 236                                             /* EXCLUSIVE4 */
 237         clientid_t      op_clientid;        /* request */
 238         struct xdr_netobj op_owner;           /* request */
 239         u32             op_seqid;           /* request */
 240         u32             op_share_access;    /* request */
 241         u32             op_share_deny;      /* request */
 242         u32             op_deleg_want;      /* request */
 243         stateid_t       op_stateid;         /* response */
 244         __be32          op_xdr_error;       /* see nfsd4_open_omfg() */
 245         u32             op_recall;          /* recall */
 246         struct nfsd4_change_info  op_cinfo; /* response */
 247         u32             op_rflags;          /* response */
 248         bool            op_truncate;        /* used during processing */
 249         bool            op_created;         /* used during processing */
 250         struct nfs4_openowner *op_openowner; /* used during processing */
 251         struct nfs4_file *op_file;          /* used during processing */
 252         struct nfs4_ol_stateid *op_stp;     /* used during processing */
 253         struct nfs4_clnt_odstate *op_odstate; /* used during processing */
 254         struct nfs4_acl *op_acl;
 255         struct xdr_netobj op_label;
 256 };
 257
 258 struct nfsd4_open_confirm {
 259         stateid_t       oc_req_stateid          /* request */;
 260         u32             oc_seqid                /* request */;
 261         stateid_t       oc_resp_stateid         /* response */;
 262 };
 263
 264 struct nfsd4_open_downgrade {
 265         stateid_t       od_stateid;
 266         u32             od_seqid;
 267         u32             od_share_access;        /* request */
 268         u32             od_deleg_want;          /* request */
 269         u32             od_share_deny;          /* request */
 270 };
 271
 272
 273 struct nfsd4_read {
 274         stateid_t       rd_stateid;         /* request */
 275         u64             rd_offset;          /* request */
 276         u32             rd_length;          /* request */
 277         int             rd_vlen;
 278         struct file     *rd_filp;
 279         bool            rd_tmp_file;
 280
 281         struct svc_rqst *rd_rqstp;          /* response */
 282         struct svc_fh * rd_fhp;             /* response */
 283 };
 284
 285 struct nfsd4_readdir {
 286         u64             rd_cookie;          /* request */
 287         nfs4_verifier   rd_verf;            /* request */
 288         u32             rd_dircount;        /* request */
 289         u32             rd_maxcount;        /* request */
 290         u32             rd_bmval[3];        /* request */
 291         struct svc_rqst *rd_rqstp;          /* response */
 292         struct svc_fh * rd_fhp;             /* response */
 293
 294         struct readdir_cd       common;
 295         struct xdr_stream       *xdr;
 296         int                     cookie_offset;
 297 };
 298
 299 struct nfsd4_release_lockowner {
 300         clientid_t        rl_clientid;
 301         struct xdr_netobj rl_owner;
 302 };
 303 struct nfsd4_readlink {
 304         struct svc_rqst *rl_rqstp;          /* request */
 305         struct svc_fh * rl_fhp;             /* request */
 306 };
 307
 308 struct nfsd4_remove {
 309         u32             rm_namelen;         /* request */
 310         char *          rm_name;            /* request */
 311         struct nfsd4_change_info  rm_cinfo; /* response */
 312 };
 313
 314 struct nfsd4_rename {
 315         u32             rn_snamelen;        /* request */
 316         char *          rn_sname;           /* request */
 317         u32             rn_tnamelen;        /* request */
 318         char *          rn_tname;           /* request */
 319         struct nfsd4_change_info  rn_sinfo; /* response */
 320         struct nfsd4_change_info  rn_tinfo; /* response */
 321 };
 322
 323 struct nfsd4_secinfo {
 324         u32 si_namelen;                                 /* request */
 325         char *si_name;                                  /* request */
 326         struct svc_export *si_exp;                      /* response */
 327 };
 328
 329 struct nfsd4_secinfo_no_name {
 330         u32 sin_style;                                  /* request */
 331         struct svc_export *sin_exp;                     /* response */
 332 };
 333
 334 struct nfsd4_setattr {
 335         stateid_t       sa_stateid;         /* request */
 336         u32             sa_bmval[3];        /* request */
 337         struct iattr    sa_iattr;           /* request */
 338         struct nfs4_acl *sa_acl;
 339         struct xdr_netobj sa_label;
 340 };
 341
 342 struct nfsd4_setclientid {
 343         nfs4_verifier   se_verf;            /* request */
 344         struct xdr_netobj se_name;
 345         u32             se_callback_prog;   /* request */
 346         u32             se_callback_netid_len;  /* request */
 347         char *          se_callback_netid_val;  /* request */
 348         u32             se_callback_addr_len;   /* request */
 349         char *          se_callback_addr_val;   /* request */
 350         u32             se_callback_ident;  /* request */
 351         clientid_t      se_clientid;        /* response */
 352         nfs4_verifier   se_confirm;         /* response */
 353 };
 354
 355 struct nfsd4_setclientid_confirm {
 356         clientid_t      sc_clientid;
 357         nfs4_verifier   sc_confirm;
 358 };
 359
 360 struct nfsd4_saved_compoundargs {
 361         __be32 *p;
 362         __be32 *end;
 363         int pagelen;
 364         struct page **pagelist;
 365 };
 366
 367 struct nfsd4_test_stateid_id {
 368         __be32                  ts_id_status;
 369         stateid_t               ts_id_stateid;
 370         struct list_head        ts_id_list;
 371 };
 372
 373 struct nfsd4_test_stateid {
 374         u32             ts_num_ids;
 375         struct list_head ts_stateid_list;
 376 };
 377
 378 struct nfsd4_free_stateid {
 379         stateid_t       fr_stateid;         /* request */
 380 };
 381
 382 /* also used for NVERIFY */
 383 struct nfsd4_verify {
 384         u32             ve_bmval[3];        /* request */
 385         u32             ve_attrlen;         /* request */
 386         char *          ve_attrval;         /* request */
 387 };
 388
 389 struct nfsd4_write {
 390         stateid_t       wr_stateid;         /* request */
 391         u64             wr_offset;          /* request */
 392         u32             wr_stable_how;      /* request */
 393         u32             wr_buflen;          /* request */
 394         struct kvec     wr_head;
 395         struct page **  wr_pagelist;        /* request */
 396
 397         u32             wr_bytes_written;   /* response */
 398         u32             wr_how_written;     /* response */
 399         nfs4_verifier   wr_verifier;        /* response */
 400 };
 401
 402 struct nfsd4_exchange_id {
 403         nfs4_verifier   verifier;
 404         struct xdr_netobj clname;
 405         u32             flags;
 406         clientid_t      clientid;
 407         u32             seqid;
 408         int             spa_how;
 409         u32             spo_must_enforce[3];
 410         u32             spo_must_allow[3];
 411 };
 412
 413 struct nfsd4_sequence {
 414         struct nfs4_sessionid   sessionid;              /* request/response */
 415         u32                     seqid;                  /* request/response */
 416         u32                     slotid;                 /* request/response */
 417         u32                     maxslots;               /* request/response */
 418         u32                     cachethis;              /* request */
 419 #if 0
 420         u32                     target_maxslots;        /* response */
 421 #endif /* not yet */
 422         u32                     status_flags;           /* response */
 423 };
 424
 425 struct nfsd4_destroy_session {
 426         struct nfs4_sessionid   sessionid;
 427 };
 428
 429 struct nfsd4_destroy_clientid {
 430         clientid_t clientid;
 431 };
 432
 433 struct nfsd4_reclaim_complete {
 434         u32 rca_one_fs;
 435 };
 436
 437 struct nfsd4_deviceid {
 438         u64                     fsid_idx;
 439         u32                     generation;
 440         u32                     pad;
 441 };
 442
 443 struct nfsd4_layout_seg {
 444         u32                     iomode;
 445         u64                     offset;
 446         u64                     length;
 447 };
 448
 449 struct nfsd4_getdeviceinfo {
 450         struct nfsd4_deviceid   gd_devid;       /* request */
 451         u32                     gd_layout_type; /* request */
 452         u32                     gd_maxcount;    /* request */
 453         u32                     gd_notify_types;/* request - response */
 454         void                    *gd_device;     /* response */
 455 };
 456
 457 struct nfsd4_layoutget {
 458         u64                     lg_minlength;   /* request */
 459         u32                     lg_signal;      /* request */
 460         u32                     lg_layout_type; /* request */
 461         u32                     lg_maxcount;    /* request */
 462         stateid_t               lg_sid;         /* request/response */
 463         struct nfsd4_layout_seg lg_seg;         /* request/response */
 464         void                    *lg_content;    /* response */
 465 };
 466
 467 struct nfsd4_layoutcommit {
 468         stateid_t               lc_sid;         /* request */
 469         struct nfsd4_layout_seg lc_seg;         /* request */
 470         u32                     lc_reclaim;     /* request */
 471         u32                     lc_newoffset;   /* request */
 472         u64                     lc_last_wr;     /* request */
 473         struct timespec         lc_mtime;       /* request */
 474         u32                     lc_layout_type; /* request */
 475         u32                     lc_up_len;      /* layout length */
 476         void                    *lc_up_layout;  /* decoded by callback */
 477         u32                     lc_size_chg;    /* boolean for response */
 478         u64                     lc_newsize;     /* response */
 479 };
 480
 481 struct nfsd4_layoutreturn {
 482         u32                     lr_return_type; /* request */
 483         u32                     lr_layout_type; /* request */
 484         struct nfsd4_layout_seg lr_seg;         /* request */
 485         u32                     lr_reclaim;     /* request */
 486         u32                     lrf_body_len;   /* request */
 487         void                    *lrf_body;      /* request */
 488         stateid_t               lr_sid;         /* request/response */
 489         u32                     lrs_present;    /* response */
 490 };
 491
 492 struct nfsd4_fallocate {
 493         /* request */
 494         stateid_t       falloc_stateid;
 495         loff_t          falloc_offset;
 496         u64             falloc_length;
 497 };
 498
 499 struct nfsd4_clone {
 500         /* request */
 501         stateid_t       cl_src_stateid;
 502         stateid_t       cl_dst_stateid;
 503         u64             cl_src_pos;
 504         u64             cl_dst_pos;
 505         u64             cl_count;
 506 };
 507
 508 struct nfsd42_write_res {
 509         u64                     wr_bytes_written;
 510         u32                     wr_stable_how;
 511         nfs4_verifier           wr_verifier;
 512 };
 513
 514 struct nfsd4_copy {
 515         /* request */
 516         stateid_t       cp_src_stateid;
 517         stateid_t       cp_dst_stateid;
 518         u64             cp_src_pos;
 519         u64             cp_dst_pos;
 520         u64             cp_count;
 521
 522         /* both */
 523         bool            cp_consecutive;
 524         bool            cp_synchronous;
 525
 526         /* response */
 527         struct nfsd42_write_res cp_res;
 528 };
 529
 530 struct nfsd4_seek {
 531         /* request */
 532         stateid_t       seek_stateid;
 533         loff_t          seek_offset;
 534         u32             seek_whence;
 535
 536         /* response */
 537         u32             seek_eof;
 538         loff_t          seek_pos;
 539 };
 540
 541 struct nfsd4_op {
 542         int                                     opnum;
 543         const struct nfsd4_operation *          opdesc;
 544         __be32                                  status;
 545         union nfsd4_op_u {
 546                 struct nfsd4_access             access;
 547                 struct nfsd4_close              close;
 548                 struct nfsd4_commit             commit;
 549                 struct nfsd4_create             create;
 550                 struct nfsd4_delegreturn        delegreturn;
 551                 struct nfsd4_getattr            getattr;
 552                 struct svc_fh *                 getfh;
 553                 struct nfsd4_link               link;
 554                 struct nfsd4_lock               lock;
 555                 struct nfsd4_lockt              lockt;
 556                 struct nfsd4_locku              locku;
 557                 struct nfsd4_lookup             lookup;
 558                 struct nfsd4_verify             nverify;
 559                 struct nfsd4_open               open;
 560                 struct nfsd4_open_confirm       open_confirm;
 561                 struct nfsd4_open_downgrade     open_downgrade;
 562                 struct nfsd4_putfh              putfh;
 563                 struct nfsd4_read               read;
 564                 struct nfsd4_readdir            readdir;
 565                 struct nfsd4_readlink           readlink;
 566                 struct nfsd4_remove             remove;
 567                 struct nfsd4_rename             rename;
 568                 clientid_t                      renew;
 569                 struct nfsd4_secinfo            secinfo;
 570                 struct nfsd4_setattr            setattr;
 571                 struct nfsd4_setclientid        setclientid;
 572                 struct nfsd4_setclientid_confirm setclientid_confirm;
 573                 struct nfsd4_verify             verify;
 574                 struct nfsd4_write              write;
 575                 struct nfsd4_release_lockowner  release_lockowner;
 576
 577                 /* NFSv4.1 */
 578                 struct nfsd4_exchange_id        exchange_id;
 579                 struct nfsd4_backchannel_ctl    backchannel_ctl;
 580                 struct nfsd4_bind_conn_to_session bind_conn_to_session;
 581                 struct nfsd4_create_session     create_session;
 582                 struct nfsd4_destroy_session    destroy_session;
 583                 struct nfsd4_destroy_clientid   destroy_clientid;
 584                 struct nfsd4_sequence           sequence;
 585                 struct nfsd4_reclaim_complete   reclaim_complete;
 586                 struct nfsd4_test_stateid       test_stateid;
 587                 struct nfsd4_free_stateid       free_stateid;
 588                 struct nfsd4_getdeviceinfo      getdeviceinfo;
 589                 struct nfsd4_layoutget          layoutget;
 590                 struct nfsd4_layoutcommit       layoutcommit;
 591                 struct nfsd4_layoutreturn       layoutreturn;
 592                 struct nfsd4_secinfo_no_name    secinfo_no_name;
 593
 594                 /* NFSv4.2 */
 595                 struct nfsd4_fallocate          allocate;
 596                 struct nfsd4_fallocate          deallocate;
 597                 struct nfsd4_clone              clone;
 598                 struct nfsd4_copy               copy;
 599                 struct nfsd4_seek               seek;
 600         } u;
 601         struct nfs4_replay *                    replay;
 602 };
 603
 604 bool nfsd4_cache_this_op(struct nfsd4_op *);
 605
 606 /*
 607  * Memory needed just for the duration of processing one compound:
 608  */
 609 struct svcxdr_tmpbuf {
 610         struct svcxdr_tmpbuf *next;
 611         char buf[];
 612 };
 613
 614 struct nfsd4_compoundargs {
 615         /* scratch variables for XDR decode */
 616         __be32 *                        p;
 617         __be32 *                        end;
 618         struct page **                  pagelist;
 619         int                             pagelen;
 620         bool                            tail;
 621         __be32                          tmp[8];
 622         __be32 *                        tmpp;
 623         struct svcxdr_tmpbuf            *to_free;
 624
 625         struct svc_rqst                 *rqstp;
 626
 627         u32                             taglen;
 628         char *                          tag;
 629         u32                             minorversion;
 630         u32                             opcnt;
 631         struct nfsd4_op                 *ops;
 632         struct nfsd4_op                 iops[8];
 633         int                             cachetype;
 634 };
 635
 636 struct nfsd4_compoundres {
 637         /* scratch variables for XDR encode */
 638         struct xdr_stream               xdr;
 639         struct svc_rqst *               rqstp;
 640
 641         u32                             taglen;
 642         char *                          tag;
 643         u32                             opcnt;
 644         __be32 *                        tagp; /* tag, opcount encode location */
 645         struct nfsd4_compound_state     cstate;
 646 };
 647
 648 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
 649 {
 650         struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
 651         return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
 652 }
 653
 654 /*
 655  * The session reply cache only needs to cache replies that the client
 656  * actually asked us to.  But it's almost free for us to cache compounds
 657  * consisting of only a SEQUENCE op, so we may as well cache those too.
 658  * Also, the protocol doesn't give us a convenient response in the case
 659  * of a replay of a solo SEQUENCE op that wasn't cached
 660  * (RETRY_UNCACHED_REP can only be returned in the second op of a
 661  * compound).
 662  */
 663 static inline bool nfsd4_cache_this(struct nfsd4_compoundres *resp)
 664 {
 665         return (resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
 666                 || nfsd4_is_solo_sequence(resp);
 667 }
 668
 669 static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
 670 {
 671         struct nfsd4_compoundres *resp = rqstp->rq_resp;
 672         struct nfsd4_compoundargs *argp = rqstp->rq_argp;
 673
 674         return argp->opcnt == resp->opcnt;
 675 }
 676
 677 const struct nfsd4_operation *OPDESC(struct nfsd4_op *op);
 678 int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
 679 void warn_on_nonidempotent_op(struct nfsd4_op *op);
 680
 681 #define NFS4_SVC_XDRSIZE                sizeof(struct nfsd4_compoundargs)
 682
 683 static inline void
 684 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
 685 {
 686         BUG_ON(!fhp->fh_pre_saved);
 687         cinfo->atomic = (u32)fhp->fh_post_saved;
 688         cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry));
 689
 690         cinfo->before_change = fhp->fh_pre_change;
 691         cinfo->after_change = fhp->fh_post_change;
 692         cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
 693         cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
 694         cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
 695         cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
 696
 697 }
 698
 699
 700 bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp);
 701 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *);
 702 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *);
 703 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *);
 704 __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
 705 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
 706 void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
 707 __be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
 708                 struct svc_fh *fhp, struct svc_export *exp,
 709                 struct dentry *dentry,
 710                 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
 711 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
 712                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 713 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
 714                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 715 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
 716                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 717 extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *,
 718                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 719 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *,
 720                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 721 extern __be32 nfsd4_create_session(struct svc_rqst *,
 722                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 723 extern __be32 nfsd4_sequence(struct svc_rqst *,
 724                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 725 extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
 726 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
 727                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 728 extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *,
 729                 union nfsd4_op_u *u);
 730 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *,
 731                 union nfsd4_op_u *u);
 732 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
 733                 struct nfsd4_open *open, struct nfsd_net *nn);
 734 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
 735                 struct svc_fh *current_fh, struct nfsd4_open *open);
 736 extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
 737 extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
 738                 struct nfsd4_open *open);
 739 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
 740                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 741 extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 742                 union nfsd4_op_u *u);
 743 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
 744                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 745 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 746                 union nfsd4_op_u *u);
 747 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 748                 union nfsd4_op_u *u);
 749 extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 750                 union nfsd4_op_u *u);
 751 extern __be32
 752 nfsd4_release_lockowner(struct svc_rqst *rqstp,
 753                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 754 extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp);
 755 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
 756                 struct nfsd4_compound_state *, union nfsd4_op_u *u);
 757 extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 758                 union nfsd4_op_u *u);
 759 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
 760                 struct nfsd4_compound_state *, union nfsd4_op_u *);
 761 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
 762                 struct nfsd4_compound_state *, union nfsd4_op_u *);
 763 extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
 764
 765 enum nfsd4_op_flags {
 766         ALLOWED_WITHOUT_FH = 1 << 0,    /* No current filehandle required */
 767         ALLOWED_ON_ABSENT_FS = 1 << 1,  /* ops processed on absent fs */
 768         ALLOWED_AS_FIRST_OP = 1 << 2,   /* ops reqired first in compound */
 769         /* For rfc 5661 section 2.6.3.1.1: */
 770         OP_HANDLES_WRONGSEC = 1 << 3,
 771         OP_IS_PUTFH_LIKE = 1 << 4,
 772         /*
 773          * These are the ops whose result size we estimate before
 774          * encoding, to avoid performing an op then not being able to
 775          * respond or cache a response.  This includes writes and setattrs
 776          * as well as the operations usually called "nonidempotent":
 777          */
 778         OP_MODIFIES_SOMETHING = 1 << 5,
 779         /*
 780          * Cache compounds containing these ops in the xid-based drc:
 781          * We use the DRC for compounds containing non-idempotent
 782          * operations, *except* those that are 4.1-specific (since
 783          * sessions provide their own EOS), and except for stateful
 784          * operations other than setclientid and setclientid_confirm
 785          * (since sequence numbers provide EOS for open, lock, etc in
 786          * the v4.0 case).
 787          */
 788         OP_CACHEME = 1 << 6,
 789         /*
 790          * These are ops which clear current state id.
 791          */
 792         OP_CLEAR_STATEID = 1 << 7,
 793         /* Most ops return only an error on failure; some may do more: */
 794         OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8,
 795 };
 796
 797 struct nfsd4_operation {
 798         __be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
 799                         union nfsd4_op_u *);
 800         void (*op_release)(union nfsd4_op_u *);
 801         u32 op_flags;
 802         char *op_name;
 803         /* Try to get response size before operation */
 804         u32 (*op_rsize_bop)(struct svc_rqst *, struct nfsd4_op *);
 805         void (*op_get_currentstateid)(struct nfsd4_compound_state *,
 806                         union nfsd4_op_u *);
 807         void (*op_set_currentstateid)(struct nfsd4_compound_state *,
 808                         union nfsd4_op_u *);
 809 };
 810
 811
 812 #endif
 813
 814 /*
 815  * Local variables:
 816  *  c-basic-offset: 8
 817  * End:
 818  */