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