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