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