/* * Server-side types for NFSv4. * * Copyright (c) 2002 The Regents of the University of Michigan. * All rights reserved. * * Kendrick Smith <kmsmith@umich.edu> * Andy Adamson <andros@umich.edu> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the University nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ #ifndef _LINUX_NFSD_XDR4_H #define _LINUX_NFSD_XDR4_H #include "state.h" #include "nfsd.h" #define NFSD4_MAX_TAGLEN 128 #define XDR_LEN(n) (((n) + 3) & ~3) #define CURRENT_STATE_ID_FLAG (1<<0) #define SAVED_STATE_ID_FLAG (1<<1) #define SET_STATE_ID(c, f) ((c)->sid_flags |= (f)) #define HAS_STATE_ID(c, f) ((c)->sid_flags & (f)) #define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f)) struct nfsd4_compound_state { struct svc_fh current_fh; struct svc_fh save_fh; struct nfs4_stateowner *replay_owner; struct nfs4_client *clp; /* For sessions DRC */ struct nfsd4_session *session; struct nfsd4_slot *slot; int data_offset; bool spo_must_allowed; size_t iovlen; u32 minorversion; __be32 status; stateid_t current_stateid; stateid_t save_stateid; /* to indicate current and saved state id presents */ u32 sid_flags; }; static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs) { return cs->slot != NULL; } struct nfsd4_change_info { u32 atomic; bool change_supported; u32 before_ctime_sec; u32 before_ctime_nsec; u64 before_change; u32 after_ctime_sec; u32 after_ctime_nsec; u64 after_change; }; struct nfsd4_access { u32 ac_req_access; /* request */ u32 ac_supported; /* response */ u32 ac_resp_access; /* response */ }; struct nfsd4_close { u32 cl_seqid; /* request */ stateid_t cl_stateid; /* request+response */ }; struct nfsd4_commit { u64 co_offset; /* request */ u32 co_count; /* request */ nfs4_verifier co_verf; /* response */ }; struct nfsd4_create { u32 cr_namelen; /* request */ char * cr_name; /* request */ u32 cr_type; /* request */ union { /* request */ struct { u32 datalen; char *data; } link; /* NF4LNK */ struct { u32 specdata1; u32 specdata2; } dev; /* NF4BLK, NF4CHR */ } u; u32 cr_bmval[3]; /* request */ struct iattr cr_iattr; /* request */ struct nfsd4_change_info cr_cinfo; /* response */ struct nfs4_acl *cr_acl; struct xdr_netobj cr_label; }; #define cr_datalen u.link.datalen #define cr_data u.link.data #define cr_specdata1 u.dev.specdata1 #define cr_specdata2 u.dev.specdata2 struct nfsd4_delegreturn { stateid_t dr_stateid; }; struct nfsd4_getattr { u32 ga_bmval[3]; /* request */ struct svc_fh *ga_fhp; /* response */ }; struct nfsd4_link { u32 li_namelen; /* request */ char * li_name; /* request */ struct nfsd4_change_info li_cinfo; /* response */ }; struct nfsd4_lock_denied { clientid_t ld_clientid; struct xdr_netobj ld_owner; u64 ld_start; u64 ld_length; u32 ld_type; }; struct nfsd4_lock { /* request */ u32 lk_type; u32 lk_reclaim; /* boolean */ u64 lk_offset; u64 lk_length; u32 lk_is_new; union { struct { u32 open_seqid; stateid_t open_stateid; u32 lock_seqid; clientid_t clientid; struct xdr_netobj owner; } new; struct { stateid_t lock_stateid; u32 lock_seqid; } old; } v; /* response */ union { struct { stateid_t stateid; } ok; struct nfsd4_lock_denied denied; } u; }; #define lk_new_open_seqid v.new.open_seqid #define lk_new_open_stateid v.new.open_stateid #define lk_new_lock_seqid v.new.lock_seqid #define lk_new_clientid v.new.clientid #define lk_new_owner v.new.owner #define lk_old_lock_stateid v.old.lock_stateid #define lk_old_lock_seqid v.old.lock_seqid #define lk_resp_stateid u.ok.stateid #define lk_denied u.denied struct nfsd4_lockt { u32 lt_type; clientid_t lt_clientid; struct xdr_netobj lt_owner; u64 lt_offset; u64 lt_length; struct nfsd4_lock_denied lt_denied; }; struct nfsd4_locku { u32 lu_type; u32 lu_seqid; stateid_t lu_stateid; u64 lu_offset; u64 lu_length; }; struct nfsd4_lookup { u32 lo_len; /* request */ char * lo_name; /* request */ }; struct nfsd4_putfh { u32 pf_fhlen; /* request */ char *pf_fhval; /* request */ }; struct nfsd4_open { u32 op_claim_type; /* request */ struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */ u32 op_delegate_type; /* request - CLAIM_PREV only */ stateid_t op_delegate_stateid; /* request - response */ u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */ u32 op_create; /* request */ u32 op_createmode; /* request */ u32 op_bmval[3]; /* request */ struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */ nfs4_verifier op_verf __attribute__((aligned(32))); /* EXCLUSIVE4 */ clientid_t op_clientid; /* request */ struct xdr_netobj op_owner; /* request */ u32 op_seqid; /* request */ u32 op_share_access; /* request */ u32 op_share_deny; /* request */ u32 op_deleg_want; /* request */ stateid_t op_stateid; /* response */ __be32 op_xdr_error; /* see nfsd4_open_omfg() */ u32 op_recall; /* recall */ struct nfsd4_change_info op_cinfo; /* response */ u32 op_rflags; /* response */ bool op_truncate; /* used during processing */ bool op_created; /* used during processing */ struct nfs4_openowner *op_openowner; /* used during processing */ struct nfs4_file *op_file; /* used during processing */ struct nfs4_ol_stateid *op_stp; /* used during processing */ struct nfs4_clnt_odstate *op_odstate; /* used during processing */ struct nfs4_acl *op_acl; struct xdr_netobj op_label; }; struct nfsd4_open_confirm { stateid_t oc_req_stateid /* request */; u32 oc_seqid /* request */; stateid_t oc_resp_stateid /* response */; }; struct nfsd4_open_downgrade { stateid_t od_stateid; u32 od_seqid; u32 od_share_access; /* request */ u32 od_deleg_want; /* request */ u32 od_share_deny; /* request */ }; struct nfsd4_read { stateid_t rd_stateid; /* request */ u64 rd_offset; /* request */ u32 rd_length; /* request */ int rd_vlen; struct file *rd_filp; bool rd_tmp_file; struct svc_rqst *rd_rqstp; /* response */ struct svc_fh * rd_fhp; /* response */ }; struct nfsd4_readdir { u64 rd_cookie; /* request */ nfs4_verifier rd_verf; /* request */ u32 rd_dircount; /* request */ u32 rd_maxcount; /* request */ u32 rd_bmval[3]; /* request */ struct svc_rqst *rd_rqstp; /* response */ struct svc_fh * rd_fhp; /* response */ struct readdir_cd common; struct xdr_stream *xdr; int cookie_offset; }; struct nfsd4_release_lockowner { clientid_t rl_clientid; struct xdr_netobj rl_owner; }; struct nfsd4_readlink { struct svc_rqst *rl_rqstp; /* request */ struct svc_fh * rl_fhp; /* request */ }; struct nfsd4_remove { u32 rm_namelen; /* request */ char * rm_name; /* request */ struct nfsd4_change_info rm_cinfo; /* response */ }; struct nfsd4_rename { u32 rn_snamelen; /* request */ char * rn_sname; /* request */ u32 rn_tnamelen; /* request */ char * rn_tname; /* request */ struct nfsd4_change_info rn_sinfo; /* response */ struct nfsd4_change_info rn_tinfo; /* response */ }; struct nfsd4_secinfo { u32 si_namelen; /* request */ char *si_name; /* request */ struct svc_export *si_exp; /* response */ }; struct nfsd4_secinfo_no_name { u32 sin_style; /* request */ struct svc_export *sin_exp; /* response */ }; struct nfsd4_setattr { stateid_t sa_stateid; /* request */ u32 sa_bmval[3]; /* request */ struct iattr sa_iattr; /* request */ struct nfs4_acl *sa_acl; struct xdr_netobj sa_label; }; struct nfsd4_setclientid { nfs4_verifier se_verf; /* request */ struct xdr_netobj se_name; u32 se_callback_prog; /* request */ u32 se_callback_netid_len; /* request */ char * se_callback_netid_val; /* request */ u32 se_callback_addr_len; /* request */ char * se_callback_addr_val; /* request */ u32 se_callback_ident; /* request */ clientid_t se_clientid; /* response */ nfs4_verifier se_confirm; /* response */ }; struct nfsd4_setclientid_confirm { clientid_t sc_clientid; nfs4_verifier sc_confirm; }; struct nfsd4_saved_compoundargs { __be32 *p; __be32 *end; int pagelen; struct page **pagelist; }; struct nfsd4_test_stateid_id { __be32 ts_id_status; stateid_t ts_id_stateid; struct list_head ts_id_list; }; struct nfsd4_test_stateid { u32 ts_num_ids; struct list_head ts_stateid_list; }; struct nfsd4_free_stateid { stateid_t fr_stateid; /* request */ }; /* also used for NVERIFY */ struct nfsd4_verify { u32 ve_bmval[3]; /* request */ u32 ve_attrlen; /* request */ char * ve_attrval; /* request */ }; struct nfsd4_write { stateid_t wr_stateid; /* request */ u64 wr_offset; /* request */ u32 wr_stable_how; /* request */ u32 wr_buflen; /* request */ struct kvec wr_head; struct page ** wr_pagelist; /* request */ u32 wr_bytes_written; /* response */ u32 wr_how_written; /* response */ nfs4_verifier wr_verifier; /* response */ }; struct nfsd4_exchange_id { nfs4_verifier verifier; struct xdr_netobj clname; u32 flags; clientid_t clientid; u32 seqid; int spa_how; u32 spo_must_enforce[3]; u32 spo_must_allow[3]; }; struct nfsd4_sequence { struct nfs4_sessionid sessionid; /* request/response */ u32 seqid; /* request/response */ u32 slotid; /* request/response */ u32 maxslots; /* request/response */ u32 cachethis; /* request */ #if 0 u32 target_maxslots; /* response */ #endif /* not yet */ u32 status_flags; /* response */ }; struct nfsd4_destroy_session { struct nfs4_sessionid sessionid; }; struct nfsd4_destroy_clientid { clientid_t clientid; }; struct nfsd4_reclaim_complete { u32 rca_one_fs; }; struct nfsd4_deviceid { u64 fsid_idx; u32 generation; u32 pad; }; struct nfsd4_layout_seg { u32 iomode; u64 offset; u64 length; }; struct nfsd4_getdeviceinfo { struct nfsd4_deviceid gd_devid; /* request */ u32 gd_layout_type; /* request */ u32 gd_maxcount; /* request */ u32 gd_notify_types;/* request - response */ void *gd_device; /* response */ }; struct nfsd4_layoutget { u64 lg_minlength; /* request */ u32 lg_signal; /* request */ u32 lg_layout_type; /* request */ u32 lg_maxcount; /* request */ stateid_t lg_sid; /* request/response */ struct nfsd4_layout_seg lg_seg; /* request/response */ void *lg_content; /* response */ }; struct nfsd4_layoutcommit { stateid_t lc_sid; /* request */ struct nfsd4_layout_seg lc_seg; /* request */ u32 lc_reclaim; /* request */ u32 lc_newoffset; /* request */ u64 lc_last_wr; /* request */ struct timespec lc_mtime; /* request */ u32 lc_layout_type; /* request */ u32 lc_up_len; /* layout length */ void *lc_up_layout; /* decoded by callback */ u32 lc_size_chg; /* boolean for response */ u64 lc_newsize; /* response */ }; struct nfsd4_layoutreturn { u32 lr_return_type; /* request */ u32 lr_layout_type; /* request */ struct nfsd4_layout_seg lr_seg; /* request */ u32 lr_reclaim; /* request */ u32 lrf_body_len; /* request */ void *lrf_body; /* request */ stateid_t lr_sid; /* request/response */ u32 lrs_present; /* response */ }; struct nfsd4_fallocate { /* request */ stateid_t falloc_stateid; loff_t falloc_offset; u64 falloc_length; }; struct nfsd4_clone { /* request */ stateid_t cl_src_stateid; stateid_t cl_dst_stateid; u64 cl_src_pos; u64 cl_dst_pos; u64 cl_count; }; struct nfsd42_write_res { u64 wr_bytes_written; u32 wr_stable_how; nfs4_verifier wr_verifier; }; struct nfsd4_copy { /* request */ stateid_t cp_src_stateid; stateid_t cp_dst_stateid; u64 cp_src_pos; u64 cp_dst_pos; u64 cp_count; /* both */ bool cp_consecutive; bool cp_synchronous; /* response */ struct nfsd42_write_res cp_res; }; struct nfsd4_seek { /* request */ stateid_t seek_stateid; loff_t seek_offset; u32 seek_whence; /* response */ u32 seek_eof; loff_t seek_pos; }; struct nfsd4_op { int opnum; __be32 status; union { struct nfsd4_access access; struct nfsd4_close close; struct nfsd4_commit commit; struct nfsd4_create create; struct nfsd4_delegreturn delegreturn; struct nfsd4_getattr getattr; struct svc_fh * getfh; struct nfsd4_link link; struct nfsd4_lock lock; struct nfsd4_lockt lockt; struct nfsd4_locku locku; struct nfsd4_lookup lookup; struct nfsd4_verify nverify; struct nfsd4_open open; struct nfsd4_open_confirm open_confirm; struct nfsd4_open_downgrade open_downgrade; struct nfsd4_putfh putfh; struct nfsd4_read read; struct nfsd4_readdir readdir; struct nfsd4_readlink readlink; struct nfsd4_remove remove; struct nfsd4_rename rename; clientid_t renew; struct nfsd4_secinfo secinfo; struct nfsd4_setattr setattr; struct nfsd4_setclientid setclientid; struct nfsd4_setclientid_confirm setclientid_confirm; struct nfsd4_verify verify; struct nfsd4_write write; struct nfsd4_release_lockowner release_lockowner; /* NFSv4.1 */ struct nfsd4_exchange_id exchange_id; struct nfsd4_backchannel_ctl backchannel_ctl; struct nfsd4_bind_conn_to_session bind_conn_to_session; struct nfsd4_create_session create_session; struct nfsd4_destroy_session destroy_session; struct nfsd4_sequence sequence; struct nfsd4_reclaim_complete reclaim_complete; struct nfsd4_test_stateid test_stateid; struct nfsd4_free_stateid free_stateid; struct nfsd4_getdeviceinfo getdeviceinfo; struct nfsd4_layoutget layoutget; struct nfsd4_layoutcommit layoutcommit; struct nfsd4_layoutreturn layoutreturn; /* NFSv4.2 */ struct nfsd4_fallocate allocate; struct nfsd4_fallocate deallocate; struct nfsd4_clone clone; struct nfsd4_copy copy; struct nfsd4_seek seek; } u; struct nfs4_replay * replay; }; bool nfsd4_cache_this_op(struct nfsd4_op *); /* * Memory needed just for the duration of processing one compound: */ struct svcxdr_tmpbuf { struct svcxdr_tmpbuf *next; char buf[]; }; struct nfsd4_compoundargs { /* scratch variables for XDR decode */ __be32 * p; __be32 * end; struct page ** pagelist; int pagelen; __be32 tmp[8]; __be32 * tmpp; struct svcxdr_tmpbuf *to_free; struct svc_rqst *rqstp; u32 taglen; char * tag; u32 minorversion; u32 opcnt; struct nfsd4_op *ops; struct nfsd4_op iops[8]; int cachetype; }; struct nfsd4_compoundres { /* scratch variables for XDR encode */ struct xdr_stream xdr; struct svc_rqst * rqstp; u32 taglen; char * tag; u32 opcnt; __be32 * tagp; /* tag, opcount encode location */ struct nfsd4_compound_state cstate; }; static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp) { struct nfsd4_compoundargs *args = resp->rqstp->rq_argp; return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE; } static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp) { return !(resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS) || nfsd4_is_solo_sequence(resp); } static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp) { struct nfsd4_compoundres *resp = rqstp->rq_resp; struct nfsd4_compoundargs *argp = rqstp->rq_argp; return argp->opcnt == resp->opcnt; } int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op); void warn_on_nonidempotent_op(struct nfsd4_op *op); #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs) static inline void set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp) { BUG_ON(!fhp->fh_pre_saved); cinfo->atomic = (u32)fhp->fh_post_saved; cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry)); cinfo->before_change = fhp->fh_pre_change; cinfo->after_change = fhp->fh_post_change; cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec; cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec; cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec; cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec; } bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp); int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *); int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *, struct nfsd4_compoundargs *); int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *, struct nfsd4_compoundres *); __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32); void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *); void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op); __be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words, struct svc_fh *fhp, struct svc_export *exp, struct dentry *dentry, u32 *bmval, struct svc_rqst *, int ignore_crossmnt); extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_setclientid *setclid); extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_setclientid_confirm *setclientid_confirm); extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_exchange_id *); extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_backchannel_ctl *); extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *); extern __be32 nfsd4_create_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_create_session *); extern __be32 nfsd4_sequence(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_sequence *); extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp); extern __be32 nfsd4_destroy_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_destroy_session *); extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_destroy_clientid *); __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *); extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *, struct nfsd4_open *open, struct nfsd_net *nn); extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open); extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate); extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate, struct nfsd4_open *open); extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc); extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_close *close); extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_open_downgrade *od); extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_lock *lock); extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_lockt *lockt); extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_locku *locku); extern __be32 nfsd4_release_lockowner(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_release_lockowner *rlockowner); extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp); extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr); extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *, clientid_t *clid); extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid); extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp, struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid); extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr); #endif /* * Local variables: * c-basic-offset: 8 * End: */