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