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