include/linux/nfsd/xdr4.h

   1 /*
   2  *  include/linux/nfsd/xdr4.h
   3  *
   4  *  Server-side types for NFSv4.
   5  *
   6  *  Copyright (c) 2002 The Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  Kendrick Smith <kmsmith@umich.edu>
  10  *  Andy Adamson   <andros@umich.edu>
  11  *
  12  *  Redistribution and use in source and binary forms, with or without
  13  *  modification, are permitted provided that the following conditions
  14  *  are met:
  15  *
  16  *  1. Redistributions of source code must retain the above copyright
  17  *     notice, this list of conditions and the following disclaimer.
  18  *  2. Redistributions in binary form must reproduce the above copyright
  19  *     notice, this list of conditions and the following disclaimer in the
  20  *     documentation and/or other materials provided with the distribution.
  21  *  3. Neither the name of the University nor the names of its
  22  *     contributors may be used to endorse or promote products derived
  23  *     from this software without specific prior written permission.
  24  *
  25  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  26  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  27  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  28  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  32  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  33  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  34  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  */
  38
  39 #ifndef _LINUX_NFSD_XDR4_H
  40 #define _LINUX_NFSD_XDR4_H
  41
  42 #include <linux/nfs4.h>
  43
  44 #define NFSD4_MAX_TAGLEN        128
  45 #define XDR_LEN(n)                     (((n) + 3) & ~3)
  46
  47 struct nfsd4_compound_state {
  48         struct svc_fh           current_fh;
  49         struct svc_fh           save_fh;
  50         struct nfs4_stateowner  *replay_owner;
  51         /* For sessions DRC */
  52         struct nfsd4_session    *session;
  53         struct nfsd4_slot       *slot;
  54         __be32                  *statp;
  55         size_t                  iovlen;
  56         u32                     minorversion;
  57         u32                     status;
  58 };
  59
  60 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
  61 {
  62         return cs->slot != NULL;
  63 }
  64
  65 struct nfsd4_change_info {
  66         u32             atomic;
  67         u32             before_ctime_sec;
  68         u32             before_ctime_nsec;
  69         u32             after_ctime_sec;
  70         u32             after_ctime_nsec;
  71 };
  72
  73 struct nfsd4_access {
  74         u32             ac_req_access;      /* request */
  75         u32             ac_supported;       /* response */
  76         u32             ac_resp_access;     /* response */
  77 };
  78
  79 struct nfsd4_close {
  80         u32             cl_seqid;           /* request */
  81         stateid_t       cl_stateid;         /* request+response */
  82         struct nfs4_stateowner * cl_stateowner; /* response */
  83 };
  84
  85 struct nfsd4_commit {
  86         u64             co_offset;          /* request */
  87         u32             co_count;           /* request */
  88         nfs4_verifier   co_verf;            /* response */
  89 };
  90
  91 struct nfsd4_create {
  92         u32             cr_namelen;         /* request */
  93         char *          cr_name;            /* request */
  94         u32             cr_type;            /* request */
  95         union {                             /* request */
  96                 struct {
  97                         u32 namelen;
  98                         char *name;
  99                 } link;   /* NF4LNK */
 100                 struct {
 101                         u32 specdata1;
 102                         u32 specdata2;
 103                 } dev;    /* NF4BLK, NF4CHR */
 104         } u;
 105         u32             cr_bmval[3];        /* request */
 106         struct iattr    cr_iattr;           /* request */
 107         struct nfsd4_change_info  cr_cinfo; /* response */
 108         struct nfs4_acl *cr_acl;
 109 };
 110 #define cr_linklen      u.link.namelen
 111 #define cr_linkname     u.link.name
 112 #define cr_specdata1    u.dev.specdata1
 113 #define cr_specdata2    u.dev.specdata2
 114
 115 struct nfsd4_delegreturn {
 116         stateid_t       dr_stateid;
 117 };
 118
 119 struct nfsd4_getattr {
 120         u32             ga_bmval[3];        /* request */
 121         struct svc_fh   *ga_fhp;            /* response */
 122 };
 123
 124 struct nfsd4_link {
 125         u32             li_namelen;         /* request */
 126         char *          li_name;            /* request */
 127         struct nfsd4_change_info  li_cinfo; /* response */
 128 };
 129
 130 struct nfsd4_lock_denied {
 131         clientid_t      ld_clientid;
 132         struct nfs4_stateowner   *ld_sop;
 133         u64             ld_start;
 134         u64             ld_length;
 135         u32             ld_type;
 136 };
 137
 138 struct nfsd4_lock {
 139         /* request */
 140         u32             lk_type;
 141         u32             lk_reclaim;         /* boolean */
 142         u64             lk_offset;
 143         u64             lk_length;
 144         u32             lk_is_new;
 145         union {
 146                 struct {
 147                         u32             open_seqid;
 148                         stateid_t       open_stateid;
 149                         u32             lock_seqid;
 150                         clientid_t      clientid;
 151                         struct xdr_netobj owner;
 152                 } new;
 153                 struct {
 154                         stateid_t       lock_stateid;
 155                         u32             lock_seqid;
 156                 } old;
 157         } v;
 158
 159         /* response */
 160         union {
 161                 struct {
 162                         stateid_t               stateid;
 163                 } ok;
 164                 struct nfsd4_lock_denied        denied;
 165         } u;
 166         /* The lk_replay_owner is the open owner in the open_to_lock_owner
 167          * case and the lock owner otherwise: */
 168         struct nfs4_stateowner *lk_replay_owner;
 169 };
 170 #define lk_new_open_seqid       v.new.open_seqid
 171 #define lk_new_open_stateid     v.new.open_stateid
 172 #define lk_new_lock_seqid       v.new.lock_seqid
 173 #define lk_new_clientid         v.new.clientid
 174 #define lk_new_owner            v.new.owner
 175 #define lk_old_lock_stateid     v.old.lock_stateid
 176 #define lk_old_lock_seqid       v.old.lock_seqid
 177
 178 #define lk_rflags       u.ok.rflags
 179 #define lk_resp_stateid u.ok.stateid
 180 #define lk_denied       u.denied
 181
 182
 183 struct nfsd4_lockt {
 184         u32                             lt_type;
 185         clientid_t                      lt_clientid;
 186         struct xdr_netobj               lt_owner;
 187         u64                             lt_offset;
 188         u64                             lt_length;
 189         struct nfs4_stateowner *        lt_stateowner;
 190         struct nfsd4_lock_denied        lt_denied;
 191 };
 192
 193
 194 struct nfsd4_locku {
 195         u32             lu_type;
 196         u32             lu_seqid;
 197         stateid_t       lu_stateid;
 198         u64             lu_offset;
 199         u64             lu_length;
 200         struct nfs4_stateowner  *lu_stateowner;
 201 };
 202
 203
 204 struct nfsd4_lookup {
 205         u32             lo_len;             /* request */
 206         char *          lo_name;            /* request */
 207 };
 208
 209 struct nfsd4_putfh {
 210         u32             pf_fhlen;           /* request */
 211         char            *pf_fhval;          /* request */
 212 };
 213
 214 struct nfsd4_open {
 215         u32             op_claim_type;      /* request */
 216         struct xdr_netobj op_fname;         /* request - everything but CLAIM_PREV */
 217         u32             op_delegate_type;   /* request - CLAIM_PREV only */
 218         stateid_t       op_delegate_stateid; /* request - response */
 219         u32             op_create;          /* request */
 220         u32             op_createmode;      /* request */
 221         u32             op_bmval[3];        /* request */
 222         struct iattr    iattr;              /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
 223         nfs4_verifier   verf;               /* EXCLUSIVE4 */
 224         clientid_t      op_clientid;        /* request */
 225         struct xdr_netobj op_owner;           /* request */
 226         u32             op_seqid;           /* request */
 227         u32             op_share_access;    /* request */
 228         u32             op_share_deny;      /* request */
 229         stateid_t       op_stateid;         /* response */
 230         u32             op_recall;          /* recall */
 231         struct nfsd4_change_info  op_cinfo; /* response */
 232         u32             op_rflags;          /* response */
 233         int             op_truncate;        /* used during processing */
 234         struct nfs4_stateowner *op_stateowner; /* used during processing */
 235         struct nfs4_acl *op_acl;
 236 };
 237 #define op_iattr        iattr
 238 #define op_verf         verf
 239
 240 struct nfsd4_open_confirm {
 241         stateid_t       oc_req_stateid          /* request */;
 242         u32             oc_seqid                /* request */;
 243         stateid_t       oc_resp_stateid         /* response */;
 244         struct nfs4_stateowner * oc_stateowner; /* response */
 245 };
 246
 247 struct nfsd4_open_downgrade {
 248         stateid_t       od_stateid;
 249         u32             od_seqid;
 250         u32             od_share_access;
 251         u32             od_share_deny;
 252         struct nfs4_stateowner *od_stateowner;
 253 };
 254
 255
 256 struct nfsd4_read {
 257         stateid_t       rd_stateid;         /* request */
 258         u64             rd_offset;          /* request */
 259         u32             rd_length;          /* request */
 260         int             rd_vlen;
 261         struct file     *rd_filp;
 262
 263         struct svc_rqst *rd_rqstp;          /* response */
 264         struct svc_fh * rd_fhp;             /* response */
 265 };
 266
 267 struct nfsd4_readdir {
 268         u64             rd_cookie;          /* request */
 269         nfs4_verifier   rd_verf;            /* request */
 270         u32             rd_dircount;        /* request */
 271         u32             rd_maxcount;        /* request */
 272         u32             rd_bmval[3];        /* request */
 273         struct svc_rqst *rd_rqstp;          /* response */
 274         struct svc_fh * rd_fhp;             /* response */
 275
 276         struct readdir_cd       common;
 277         __be32 *                buffer;
 278         int                     buflen;
 279         __be32 *                offset;
 280 };
 281
 282 struct nfsd4_release_lockowner {
 283         clientid_t        rl_clientid;
 284         struct xdr_netobj rl_owner;
 285 };
 286 struct nfsd4_readlink {
 287         struct svc_rqst *rl_rqstp;          /* request */
 288         struct svc_fh * rl_fhp;             /* request */
 289 };
 290
 291 struct nfsd4_remove {
 292         u32             rm_namelen;         /* request */
 293         char *          rm_name;            /* request */
 294         struct nfsd4_change_info  rm_cinfo; /* response */
 295 };
 296
 297 struct nfsd4_rename {
 298         u32             rn_snamelen;        /* request */
 299         char *          rn_sname;           /* request */
 300         u32             rn_tnamelen;        /* request */
 301         char *          rn_tname;           /* request */
 302         struct nfsd4_change_info  rn_sinfo; /* response */
 303         struct nfsd4_change_info  rn_tinfo; /* response */
 304 };
 305
 306 struct nfsd4_secinfo {
 307         u32 si_namelen;                                 /* request */
 308         char *si_name;                                  /* request */
 309         struct svc_export *si_exp;                      /* response */
 310 };
 311
 312 struct nfsd4_setattr {
 313         stateid_t       sa_stateid;         /* request */
 314         u32             sa_bmval[3];        /* request */
 315         struct iattr    sa_iattr;           /* request */
 316         struct nfs4_acl *sa_acl;
 317 };
 318
 319 struct nfsd4_setclientid {
 320         nfs4_verifier   se_verf;            /* request */
 321         u32             se_namelen;         /* request */
 322         char *          se_name;            /* request */
 323         u32             se_callback_prog;   /* request */
 324         u32             se_callback_netid_len;  /* request */
 325         char *          se_callback_netid_val;  /* request */
 326         u32             se_callback_addr_len;   /* request */
 327         char *          se_callback_addr_val;   /* request */
 328         u32             se_callback_ident;  /* request */
 329         clientid_t      se_clientid;        /* response */
 330         nfs4_verifier   se_confirm;         /* response */
 331 };
 332
 333 struct nfsd4_setclientid_confirm {
 334         clientid_t      sc_clientid;
 335         nfs4_verifier   sc_confirm;
 336 };
 337
 338 /* also used for NVERIFY */
 339 struct nfsd4_verify {
 340         u32             ve_bmval[3];        /* request */
 341         u32             ve_attrlen;         /* request */
 342         char *          ve_attrval;         /* request */
 343 };
 344
 345 struct nfsd4_write {
 346         stateid_t       wr_stateid;         /* request */
 347         u64             wr_offset;          /* request */
 348         u32             wr_stable_how;      /* request */
 349         u32             wr_buflen;          /* request */
 350         int             wr_vlen;
 351
 352         u32             wr_bytes_written;   /* response */
 353         u32             wr_how_written;     /* response */
 354         nfs4_verifier   wr_verifier;        /* response */
 355 };
 356
 357 struct nfsd4_exchange_id {
 358         nfs4_verifier   verifier;
 359         struct xdr_netobj clname;
 360         u32             flags;
 361         clientid_t      clientid;
 362         u32             seqid;
 363         int             spa_how;
 364 };
 365
 366 struct nfsd4_channel_attrs {
 367         u32             headerpadsz;
 368         u32             maxreq_sz;
 369         u32             maxresp_sz;
 370         u32             maxresp_cached;
 371         u32             maxops;
 372         u32             maxreqs;
 373         u32             nr_rdma_attrs;
 374         u32             rdma_attrs;
 375 };
 376
 377 struct nfsd4_create_session {
 378         clientid_t              clientid;
 379         struct nfs4_sessionid   sessionid;
 380         u32                     seqid;
 381         u32                     flags;
 382         struct nfsd4_channel_attrs fore_channel;
 383         struct nfsd4_channel_attrs back_channel;
 384         u32                     callback_prog;
 385         u32                     uid;
 386         u32                     gid;
 387 };
 388
 389 struct nfsd4_sequence {
 390         struct nfs4_sessionid   sessionid;              /* request/response */
 391         u32                     seqid;                  /* request/response */
 392         u32                     slotid;                 /* request/response */
 393         u32                     maxslots;               /* request/response */
 394         u32                     cachethis;              /* request */
 395 #if 0
 396         u32                     target_maxslots;        /* response */
 397         u32                     status_flags;           /* response */
 398 #endif /* not yet */
 399 };
 400
 401 struct nfsd4_destroy_session {
 402         struct nfs4_sessionid   sessionid;
 403 };
 404
 405 struct nfsd4_op {
 406         int                                     opnum;
 407         __be32                                  status;
 408         union {
 409                 struct nfsd4_access             access;
 410                 struct nfsd4_close              close;
 411                 struct nfsd4_commit             commit;
 412                 struct nfsd4_create             create;
 413                 struct nfsd4_delegreturn        delegreturn;
 414                 struct nfsd4_getattr            getattr;
 415                 struct svc_fh *                 getfh;
 416                 struct nfsd4_link               link;
 417                 struct nfsd4_lock               lock;
 418                 struct nfsd4_lockt              lockt;
 419                 struct nfsd4_locku              locku;
 420                 struct nfsd4_lookup             lookup;
 421                 struct nfsd4_verify             nverify;
 422                 struct nfsd4_open               open;
 423                 struct nfsd4_open_confirm       open_confirm;
 424                 struct nfsd4_open_downgrade     open_downgrade;
 425                 struct nfsd4_putfh              putfh;
 426                 struct nfsd4_read               read;
 427                 struct nfsd4_readdir            readdir;
 428                 struct nfsd4_readlink           readlink;
 429                 struct nfsd4_remove             remove;
 430                 struct nfsd4_rename             rename;
 431                 clientid_t                      renew;
 432                 struct nfsd4_secinfo            secinfo;
 433                 struct nfsd4_setattr            setattr;
 434                 struct nfsd4_setclientid        setclientid;
 435                 struct nfsd4_setclientid_confirm setclientid_confirm;
 436                 struct nfsd4_verify             verify;
 437                 struct nfsd4_write              write;
 438                 struct nfsd4_release_lockowner  release_lockowner;
 439
 440                 /* NFSv4.1 */
 441                 struct nfsd4_exchange_id        exchange_id;
 442                 struct nfsd4_create_session     create_session;
 443                 struct nfsd4_destroy_session    destroy_session;
 444                 struct nfsd4_sequence           sequence;
 445         } u;
 446         struct nfs4_replay *                    replay;
 447 };
 448
 449 struct nfsd4_compoundargs {
 450         /* scratch variables for XDR decode */
 451         __be32 *                        p;
 452         __be32 *                        end;
 453         struct page **                  pagelist;
 454         int                             pagelen;
 455         __be32                          tmp[8];
 456         __be32 *                        tmpp;
 457         struct tmpbuf {
 458                 struct tmpbuf *next;
 459                 void (*release)(const void *);
 460                 void *buf;
 461         }                               *to_free;
 462
 463         struct svc_rqst                 *rqstp;
 464
 465         u32                             taglen;
 466         char *                          tag;
 467         u32                             minorversion;
 468         u32                             opcnt;
 469         struct nfsd4_op                 *ops;
 470         struct nfsd4_op                 iops[8];
 471 };
 472
 473 struct nfsd4_compoundres {
 474         /* scratch variables for XDR encode */
 475         __be32 *                        p;
 476         __be32 *                        end;
 477         struct xdr_buf *                xbuf;
 478         struct svc_rqst *               rqstp;
 479
 480         u32                             taglen;
 481         char *                          tag;
 482         u32                             opcnt;
 483         __be32 *                        tagp; /* tag, opcount encode location */
 484         struct nfsd4_compound_state     cstate;
 485 };
 486
 487 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
 488 {
 489         struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
 490         return args->opcnt == 1;
 491 }
 492
 493 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
 494 {
 495         return !resp->cstate.slot->sl_cache_entry.ce_cachethis ||
 496                         nfsd4_is_solo_sequence(resp);
 497 }
 498
 499 #define NFS4_SVC_XDRSIZE                sizeof(struct nfsd4_compoundargs)
 500
 501 static inline void
 502 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
 503 {
 504         BUG_ON(!fhp->fh_pre_saved || !fhp->fh_post_saved);
 505         cinfo->atomic = 1;
 506         cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
 507         cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
 508         cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
 509         cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
 510 }
 511
 512 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
 513 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
 514                 struct nfsd4_compoundargs *);
 515 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
 516                 struct nfsd4_compoundres *);
 517 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
 518 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
 519 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
 520                        struct dentry *dentry, __be32 *buffer, int *countp,
 521                        u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
 522 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
 523                 struct nfsd4_compound_state *,
 524                 struct nfsd4_setclientid *setclid);
 525 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
 526                 struct nfsd4_compound_state *,
 527                 struct nfsd4_setclientid_confirm *setclientid_confirm);
 528 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
 529 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
 530                 struct nfsd4_sequence *seq);
 531 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
 532                 struct nfsd4_compound_state *,
 533 struct nfsd4_exchange_id *);
 534                 extern __be32 nfsd4_create_session(struct svc_rqst *,
 535                 struct nfsd4_compound_state *,
 536                 struct nfsd4_create_session *);
 537 extern __be32 nfsd4_sequence(struct svc_rqst *,
 538                 struct nfsd4_compound_state *,
 539                 struct nfsd4_sequence *);
 540 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
 541                 struct nfsd4_compound_state *,
 542                 struct nfsd4_destroy_session *);
 543 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
 544                 struct nfsd4_open *open);
 545 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
 546                 struct svc_fh *current_fh, struct nfsd4_open *open);
 547 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
 548                 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
 549 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
 550                 struct nfsd4_compound_state *,
 551                 struct nfsd4_close *close);
 552 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
 553                 struct nfsd4_compound_state *,
 554                 struct nfsd4_open_downgrade *od);
 555 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
 556                 struct nfsd4_lock *lock);
 557 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
 558                 struct nfsd4_compound_state *,
 559                 struct nfsd4_lockt *lockt);
 560 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
 561                 struct nfsd4_compound_state *,
 562                 struct nfsd4_locku *locku);
 563 extern __be32
 564 nfsd4_release_lockowner(struct svc_rqst *rqstp,
 565                 struct nfsd4_compound_state *,
 566                 struct nfsd4_release_lockowner *rlockowner);
 567 extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);
 568 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
 569                 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
 570 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
 571                           struct nfsd4_compound_state *, clientid_t *clid);
 572 #endif
 573
 574 /*
 575  * Local variables:
 576  *  c-basic-offset: 8
 577  * End:
 578  */