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