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