1/* 2 * Server-side types for NFSv4. 3 * 4 * Copyright (c) 2002 The Regents of the University of Michigan. 5 * All rights reserved. 6 * 7 * Kendrick Smith <kmsmith@umich.edu> 8 * Andy Adamson <andros@umich.edu> 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the University nor the names of its 20 * contributors may be used to endorse or promote products derived 21 * from this software without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 26 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 * 35 */ 36 37#ifndef _LINUX_NFSD_XDR4_H 38#define _LINUX_NFSD_XDR4_H 39 40#include "state.h" 41#include "nfsd.h" 42 43#define NFSD4_MAX_TAGLEN 128 44#define XDR_LEN(n) (((n) + 3) & ~3) 45 46#define CURRENT_STATE_ID_FLAG (1<<0) 47#define SAVED_STATE_ID_FLAG (1<<1) 48 49#define SET_CSTATE_FLAG(c, f) ((c)->sid_flags |= (f)) 50#define HAS_CSTATE_FLAG(c, f) ((c)->sid_flags & (f)) 51#define CLEAR_CSTATE_FLAG(c, f) ((c)->sid_flags &= ~(f)) 52 53struct nfsd4_compound_state { 54 struct svc_fh current_fh; 55 struct svc_fh save_fh; 56 struct nfs4_stateowner *replay_owner; 57 struct nfs4_client *clp; 58 /* For sessions DRC */ 59 struct nfsd4_session *session; 60 struct nfsd4_slot *slot; 61 int data_offset; 62 bool spo_must_allowed; 63 size_t iovlen; 64 u32 minorversion; 65 __be32 status; 66 stateid_t current_stateid; 67 stateid_t save_stateid; 68 /* to indicate current and saved state id presents */ 69 u32 sid_flags; 70}; 71 72static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs) 73{ 74 return cs->slot != NULL; 75} 76 77struct nfsd4_change_info { 78 u32 atomic; 79 u64 before_change; 80 u64 after_change; 81}; 82 83struct nfsd4_access { 84 u32 ac_req_access; /* request */ 85 u32 ac_supported; /* response */ 86 u32 ac_resp_access; /* response */ 87}; 88 89struct nfsd4_close { 90 u32 cl_seqid; /* request */ 91 stateid_t cl_stateid; /* request+response */ 92}; 93 94struct nfsd4_commit { 95 u64 co_offset; /* request */ 96 u32 co_count; /* request */ 97 nfs4_verifier co_verf; /* response */ 98}; 99 100struct nfsd4_create { 101 u32 cr_namelen; /* request */ 102 char * cr_name; /* request */ 103 u32 cr_type; /* request */ 104 union { /* request */ 105 struct { 106 u32 datalen; 107 char *data; 108 struct kvec first; 109 } link; /* NF4LNK */ 110 struct { 111 u32 specdata1; 112 u32 specdata2; 113 } dev; /* NF4BLK, NF4CHR */ 114 } u; 115 u32 cr_bmval[3]; /* request */ 116 struct iattr cr_iattr; /* request */ 117 int cr_umask; /* request */ 118 struct nfsd4_change_info cr_cinfo; /* response */ 119 struct nfs4_acl *cr_acl; 120 struct xdr_netobj cr_label; 121}; 122#define cr_datalen u.link.datalen 123#define cr_data u.link.data 124#define cr_first u.link.first 125#define cr_specdata1 u.dev.specdata1 126#define cr_specdata2 u.dev.specdata2 127 128struct nfsd4_delegreturn { 129 stateid_t dr_stateid; 130}; 131 132struct nfsd4_getattr { 133 u32 ga_bmval[3]; /* request */ 134 struct svc_fh *ga_fhp; /* response */ 135}; 136 137struct nfsd4_link { 138 u32 li_namelen; /* request */ 139 char * li_name; /* request */ 140 struct nfsd4_change_info li_cinfo; /* response */ 141}; 142 143struct nfsd4_lock_denied { 144 clientid_t ld_clientid; 145 struct xdr_netobj ld_owner; 146 u64 ld_start; 147 u64 ld_length; 148 u32 ld_type; 149}; 150 151struct nfsd4_lock { 152 /* request */ 153 u32 lk_type; 154 u32 lk_reclaim; /* boolean */ 155 u64 lk_offset; 156 u64 lk_length; 157 u32 lk_is_new; 158 union { 159 struct { 160 u32 open_seqid; 161 stateid_t open_stateid; 162 u32 lock_seqid; 163 clientid_t clientid; 164 struct xdr_netobj owner; 165 } new; 166 struct { 167 stateid_t lock_stateid; 168 u32 lock_seqid; 169 } old; 170 } v; 171 172 /* response */ 173 union { 174 struct { 175 stateid_t stateid; 176 } ok; 177 struct nfsd4_lock_denied denied; 178 } u; 179}; 180#define lk_new_open_seqid v.new.open_seqid 181#define lk_new_open_stateid v.new.open_stateid 182#define lk_new_lock_seqid v.new.lock_seqid 183#define lk_new_clientid v.new.clientid 184#define lk_new_owner v.new.owner 185#define lk_old_lock_stateid v.old.lock_stateid 186#define lk_old_lock_seqid v.old.lock_seqid 187 188#define lk_resp_stateid u.ok.stateid 189#define lk_denied u.denied 190 191 192struct nfsd4_lockt { 193 u32 lt_type; 194 clientid_t lt_clientid; 195 struct xdr_netobj lt_owner; 196 u64 lt_offset; 197 u64 lt_length; 198 struct nfsd4_lock_denied lt_denied; 199}; 200 201 202struct nfsd4_locku { 203 u32 lu_type; 204 u32 lu_seqid; 205 stateid_t lu_stateid; 206 u64 lu_offset; 207 u64 lu_length; 208}; 209 210 211struct nfsd4_lookup { 212 u32 lo_len; /* request */ 213 char * lo_name; /* request */ 214}; 215 216struct nfsd4_putfh { 217 u32 pf_fhlen; /* request */ 218 char *pf_fhval; /* request */ 219 bool no_verify; /* represents foreigh fh */ 220}; 221 222struct nfsd4_getxattr { 223 char *getxa_name; /* request */ 224 u32 getxa_len; /* request */ 225 void *getxa_buf; 226}; 227 228struct nfsd4_setxattr { 229 u32 setxa_flags; /* request */ 230 char *setxa_name; /* request */ 231 char *setxa_buf; /* request */ 232 u32 setxa_len; /* request */ 233 struct nfsd4_change_info setxa_cinfo; /* response */ 234}; 235 236struct nfsd4_removexattr { 237 char *rmxa_name; /* request */ 238 struct nfsd4_change_info rmxa_cinfo; /* response */ 239}; 240 241struct nfsd4_listxattrs { 242 u64 lsxa_cookie; /* request */ 243 u32 lsxa_maxcount; /* request */ 244 char *lsxa_buf; /* unfiltered buffer (reply) */ 245 u32 lsxa_len; /* unfiltered len (reply) */ 246}; 247 248struct nfsd4_open { 249 u32 op_claim_type; /* request */ 250 u32 op_fnamelen; 251 char * op_fname; /* request - everything but CLAIM_PREV */ 252 u32 op_delegate_type; /* request - CLAIM_PREV only */ 253 stateid_t op_delegate_stateid; /* request - response */ 254 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */ 255 u32 op_create; /* request */ 256 u32 op_createmode; /* request */ 257 int op_umask; /* request */ 258 u32 op_bmval[3]; /* request */ 259 struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */ 260 nfs4_verifier op_verf __attribute__((aligned(32))); 261 /* EXCLUSIVE4 */ 262 clientid_t op_clientid; /* request */ 263 struct xdr_netobj op_owner; /* request */ 264 u32 op_seqid; /* request */ 265 u32 op_share_access; /* request */ 266 u32 op_share_deny; /* request */ 267 u32 op_deleg_want; /* request */ 268 stateid_t op_stateid; /* response */ 269 __be32 op_xdr_error; /* see nfsd4_open_omfg() */ 270 u32 op_recall; /* recall */ 271 struct nfsd4_change_info op_cinfo; /* response */ 272 u32 op_rflags; /* response */ 273 bool op_truncate; /* used during processing */ 274 bool op_created; /* used during processing */ 275 struct nfs4_openowner *op_openowner; /* used during processing */ 276 struct file *op_filp; /* used during processing */ 277 struct nfs4_file *op_file; /* used during processing */ 278 struct nfs4_ol_stateid *op_stp; /* used during processing */ 279 struct nfs4_clnt_odstate *op_odstate; /* used during processing */ 280 struct nfs4_acl *op_acl; 281 struct xdr_netobj op_label; 282 struct svc_rqst *op_rqstp; 283}; 284 285struct nfsd4_open_confirm { 286 stateid_t oc_req_stateid /* request */; 287 u32 oc_seqid /* request */; 288 stateid_t oc_resp_stateid /* response */; 289}; 290 291struct nfsd4_open_downgrade { 292 stateid_t od_stateid; 293 u32 od_seqid; 294 u32 od_share_access; /* request */ 295 u32 od_deleg_want; /* request */ 296 u32 od_share_deny; /* request */ 297}; 298 299 300struct nfsd4_read { 301 stateid_t rd_stateid; /* request */ 302 u64 rd_offset; /* request */ 303 u32 rd_length; /* request */ 304 int rd_vlen; 305 struct nfsd_file *rd_nf; 306 307 struct svc_rqst *rd_rqstp; /* response */ 308 struct svc_fh *rd_fhp; /* response */ 309 u32 rd_eof; /* response */ 310}; 311 312struct nfsd4_readdir { 313 u64 rd_cookie; /* request */ 314 nfs4_verifier rd_verf; /* request */ 315 u32 rd_dircount; /* request */ 316 u32 rd_maxcount; /* request */ 317 u32 rd_bmval[3]; /* request */ 318 struct svc_rqst *rd_rqstp; /* response */ 319 struct svc_fh * rd_fhp; /* response */ 320 321 struct readdir_cd common; 322 struct xdr_stream *xdr; 323 int cookie_offset; 324}; 325 326struct nfsd4_release_lockowner { 327 clientid_t rl_clientid; 328 struct xdr_netobj rl_owner; 329}; 330struct nfsd4_readlink { 331 struct svc_rqst *rl_rqstp; /* request */ 332 struct svc_fh * rl_fhp; /* request */ 333}; 334 335struct nfsd4_remove { 336 u32 rm_namelen; /* request */ 337 char * rm_name; /* request */ 338 struct nfsd4_change_info rm_cinfo; /* response */ 339}; 340 341struct nfsd4_rename { 342 u32 rn_snamelen; /* request */ 343 char * rn_sname; /* request */ 344 u32 rn_tnamelen; /* request */ 345 char * rn_tname; /* request */ 346 struct nfsd4_change_info rn_sinfo; /* response */ 347 struct nfsd4_change_info rn_tinfo; /* response */ 348}; 349 350struct nfsd4_secinfo { 351 u32 si_namelen; /* request */ 352 char *si_name; /* request */ 353 struct svc_export *si_exp; /* response */ 354}; 355 356struct nfsd4_secinfo_no_name { 357 u32 sin_style; /* request */ 358 struct svc_export *sin_exp; /* response */ 359}; 360 361struct nfsd4_setattr { 362 stateid_t sa_stateid; /* request */ 363 u32 sa_bmval[3]; /* request */ 364 struct iattr sa_iattr; /* request */ 365 struct nfs4_acl *sa_acl; 366 struct xdr_netobj sa_label; 367}; 368 369struct nfsd4_setclientid { 370 nfs4_verifier se_verf; /* request */ 371 struct xdr_netobj se_name; 372 u32 se_callback_prog; /* request */ 373 u32 se_callback_netid_len; /* request */ 374 char * se_callback_netid_val; /* request */ 375 u32 se_callback_addr_len; /* request */ 376 char * se_callback_addr_val; /* request */ 377 u32 se_callback_ident; /* request */ 378 clientid_t se_clientid; /* response */ 379 nfs4_verifier se_confirm; /* response */ 380}; 381 382struct nfsd4_setclientid_confirm { 383 clientid_t sc_clientid; 384 nfs4_verifier sc_confirm; 385}; 386 387struct nfsd4_test_stateid_id { 388 __be32 ts_id_status; 389 stateid_t ts_id_stateid; 390 struct list_head ts_id_list; 391}; 392 393struct nfsd4_test_stateid { 394 u32 ts_num_ids; 395 struct list_head ts_stateid_list; 396}; 397 398struct nfsd4_free_stateid { 399 stateid_t fr_stateid; /* request */ 400}; 401 402/* also used for NVERIFY */ 403struct nfsd4_verify { 404 u32 ve_bmval[3]; /* request */ 405 u32 ve_attrlen; /* request */ 406 char * ve_attrval; /* request */ 407}; 408 409struct nfsd4_write { 410 stateid_t wr_stateid; /* request */ 411 u64 wr_offset; /* request */ 412 u32 wr_stable_how; /* request */ 413 u32 wr_buflen; /* request */ 414 struct xdr_buf wr_payload; /* request */ 415 416 u32 wr_bytes_written; /* response */ 417 u32 wr_how_written; /* response */ 418 nfs4_verifier wr_verifier; /* response */ 419}; 420 421struct nfsd4_exchange_id { 422 nfs4_verifier verifier; 423 struct xdr_netobj clname; 424 u32 flags; 425 clientid_t clientid; 426 u32 seqid; 427 u32 spa_how; 428 u32 spo_must_enforce[3]; 429 u32 spo_must_allow[3]; 430 struct xdr_netobj nii_domain; 431 struct xdr_netobj nii_name; 432 struct timespec64 nii_time; 433}; 434 435struct nfsd4_sequence { 436 struct nfs4_sessionid sessionid; /* request/response */ 437 u32 seqid; /* request/response */ 438 u32 slotid; /* request/response */ 439 u32 maxslots; /* request/response */ 440 u32 cachethis; /* request */ 441#if 0 442 u32 target_maxslots; /* response */ 443#endif /* not yet */ 444 u32 status_flags; /* response */ 445}; 446 447struct nfsd4_destroy_session { 448 struct nfs4_sessionid sessionid; 449}; 450 451struct nfsd4_destroy_clientid { 452 clientid_t clientid; 453}; 454 455struct nfsd4_reclaim_complete { 456 u32 rca_one_fs; 457}; 458 459struct nfsd4_deviceid { 460 u64 fsid_idx; 461 u32 generation; 462 u32 pad; 463}; 464 465struct nfsd4_layout_seg { 466 u32 iomode; 467 u64 offset; 468 u64 length; 469}; 470 471struct nfsd4_getdeviceinfo { 472 struct nfsd4_deviceid gd_devid; /* request */ 473 u32 gd_layout_type; /* request */ 474 u32 gd_maxcount; /* request */ 475 u32 gd_notify_types;/* request - response */ 476 void *gd_device; /* response */ 477}; 478 479struct nfsd4_layoutget { 480 u64 lg_minlength; /* request */ 481 u32 lg_signal; /* request */ 482 u32 lg_layout_type; /* request */ 483 u32 lg_maxcount; /* request */ 484 stateid_t lg_sid; /* request/response */ 485 struct nfsd4_layout_seg lg_seg; /* request/response */ 486 void *lg_content; /* response */ 487}; 488 489struct nfsd4_layoutcommit { 490 stateid_t lc_sid; /* request */ 491 struct nfsd4_layout_seg lc_seg; /* request */ 492 u32 lc_reclaim; /* request */ 493 u32 lc_newoffset; /* request */ 494 u64 lc_last_wr; /* request */ 495 struct timespec64 lc_mtime; /* request */ 496 u32 lc_layout_type; /* request */ 497 u32 lc_up_len; /* layout length */ 498 void *lc_up_layout; /* decoded by callback */ 499 u32 lc_size_chg; /* boolean for response */ 500 u64 lc_newsize; /* response */ 501}; 502 503struct nfsd4_layoutreturn { 504 u32 lr_return_type; /* request */ 505 u32 lr_layout_type; /* request */ 506 struct nfsd4_layout_seg lr_seg; /* request */ 507 u32 lr_reclaim; /* request */ 508 u32 lrf_body_len; /* request */ 509 void *lrf_body; /* request */ 510 stateid_t lr_sid; /* request/response */ 511 u32 lrs_present; /* response */ 512}; 513 514struct nfsd4_fallocate { 515 /* request */ 516 stateid_t falloc_stateid; 517 loff_t falloc_offset; 518 u64 falloc_length; 519}; 520 521struct nfsd4_clone { 522 /* request */ 523 stateid_t cl_src_stateid; 524 stateid_t cl_dst_stateid; 525 u64 cl_src_pos; 526 u64 cl_dst_pos; 527 u64 cl_count; 528}; 529 530struct nfsd42_write_res { 531 u64 wr_bytes_written; 532 u32 wr_stable_how; 533 nfs4_verifier wr_verifier; 534 stateid_t cb_stateid; 535}; 536 537struct nfsd4_cb_offload { 538 struct nfsd4_callback co_cb; 539 struct nfsd42_write_res co_res; 540 __be32 co_nfserr; 541 struct knfsd_fh co_fh; 542}; 543 544struct nfsd4_copy { 545 /* request */ 546 stateid_t cp_src_stateid; 547 stateid_t cp_dst_stateid; 548 u64 cp_src_pos; 549 u64 cp_dst_pos; 550 u64 cp_count; 551 struct nl4_server *cp_src; 552 553 unsigned long cp_flags; 554#define NFSD4_COPY_F_STOPPED (0) 555#define NFSD4_COPY_F_INTRA (1) 556#define NFSD4_COPY_F_SYNCHRONOUS (2) 557#define NFSD4_COPY_F_COMMITTED (3) 558 559 /* response */ 560 struct nfsd42_write_res cp_res; 561 struct knfsd_fh fh; 562 563 struct nfs4_client *cp_clp; 564 565 struct nfsd_file *nf_src; 566 struct nfsd_file *nf_dst; 567 568 copy_stateid_t cp_stateid; 569 570 struct list_head copies; 571 struct task_struct *copy_task; 572 refcount_t refcount; 573 574 struct nfsd4_ssc_umount_item *ss_nsui; 575 struct nfs_fh c_fh; 576 nfs4_stateid stateid; 577}; 578 579static inline void nfsd4_copy_set_sync(struct nfsd4_copy *copy, bool sync) 580{ 581 if (sync) 582 set_bit(NFSD4_COPY_F_SYNCHRONOUS, ©->cp_flags); 583 else 584 clear_bit(NFSD4_COPY_F_SYNCHRONOUS, ©->cp_flags); 585} 586 587static inline bool nfsd4_copy_is_sync(const struct nfsd4_copy *copy) 588{ 589 return test_bit(NFSD4_COPY_F_SYNCHRONOUS, ©->cp_flags); 590} 591 592static inline bool nfsd4_copy_is_async(const struct nfsd4_copy *copy) 593{ 594 return !test_bit(NFSD4_COPY_F_SYNCHRONOUS, ©->cp_flags); 595} 596 597static inline bool nfsd4_ssc_is_inter(const struct nfsd4_copy *copy) 598{ 599 return !test_bit(NFSD4_COPY_F_INTRA, ©->cp_flags); 600} 601 602struct nfsd4_seek { 603 /* request */ 604 stateid_t seek_stateid; 605 loff_t seek_offset; 606 u32 seek_whence; 607 608 /* response */ 609 u32 seek_eof; 610 loff_t seek_pos; 611}; 612 613struct nfsd4_offload_status { 614 /* request */ 615 stateid_t stateid; 616 617 /* response */ 618 u64 count; 619 u32 status; 620}; 621 622struct nfsd4_copy_notify { 623 /* request */ 624 stateid_t cpn_src_stateid; 625 struct nl4_server *cpn_dst; 626 627 /* response */ 628 stateid_t cpn_cnr_stateid; 629 u64 cpn_sec; 630 u32 cpn_nsec; 631 struct nl4_server *cpn_src; 632}; 633 634struct nfsd4_op { 635 u32 opnum; 636 __be32 status; 637 const struct nfsd4_operation *opdesc; 638 struct nfs4_replay *replay; 639 union nfsd4_op_u { 640 struct nfsd4_access access; 641 struct nfsd4_close close; 642 struct nfsd4_commit commit; 643 struct nfsd4_create create; 644 struct nfsd4_delegreturn delegreturn; 645 struct nfsd4_getattr getattr; 646 struct svc_fh * getfh; 647 struct nfsd4_link link; 648 struct nfsd4_lock lock; 649 struct nfsd4_lockt lockt; 650 struct nfsd4_locku locku; 651 struct nfsd4_lookup lookup; 652 struct nfsd4_verify nverify; 653 struct nfsd4_open open; 654 struct nfsd4_open_confirm open_confirm; 655 struct nfsd4_open_downgrade open_downgrade; 656 struct nfsd4_putfh putfh; 657 struct nfsd4_read read; 658 struct nfsd4_readdir readdir; 659 struct nfsd4_readlink readlink; 660 struct nfsd4_remove remove; 661 struct nfsd4_rename rename; 662 clientid_t renew; 663 struct nfsd4_secinfo secinfo; 664 struct nfsd4_setattr setattr; 665 struct nfsd4_setclientid setclientid; 666 struct nfsd4_setclientid_confirm setclientid_confirm; 667 struct nfsd4_verify verify; 668 struct nfsd4_write write; 669 struct nfsd4_release_lockowner release_lockowner; 670 671 /* NFSv4.1 */ 672 struct nfsd4_exchange_id exchange_id; 673 struct nfsd4_backchannel_ctl backchannel_ctl; 674 struct nfsd4_bind_conn_to_session bind_conn_to_session; 675 struct nfsd4_create_session create_session; 676 struct nfsd4_destroy_session destroy_session; 677 struct nfsd4_destroy_clientid destroy_clientid; 678 struct nfsd4_sequence sequence; 679 struct nfsd4_reclaim_complete reclaim_complete; 680 struct nfsd4_test_stateid test_stateid; 681 struct nfsd4_free_stateid free_stateid; 682 struct nfsd4_getdeviceinfo getdeviceinfo; 683 struct nfsd4_layoutget layoutget; 684 struct nfsd4_layoutcommit layoutcommit; 685 struct nfsd4_layoutreturn layoutreturn; 686 struct nfsd4_secinfo_no_name secinfo_no_name; 687 688 /* NFSv4.2 */ 689 struct nfsd4_fallocate allocate; 690 struct nfsd4_fallocate deallocate; 691 struct nfsd4_clone clone; 692 struct nfsd4_copy copy; 693 struct nfsd4_offload_status offload_status; 694 struct nfsd4_copy_notify copy_notify; 695 struct nfsd4_seek seek; 696 697 struct nfsd4_getxattr getxattr; 698 struct nfsd4_setxattr setxattr; 699 struct nfsd4_listxattrs listxattrs; 700 struct nfsd4_removexattr removexattr; 701 } u; 702}; 703 704bool nfsd4_cache_this_op(struct nfsd4_op *); 705 706/* 707 * Memory needed just for the duration of processing one compound: 708 */ 709struct svcxdr_tmpbuf { 710 struct svcxdr_tmpbuf *next; 711 char buf[]; 712}; 713 714struct nfsd4_compoundargs { 715 /* scratch variables for XDR decode */ 716 struct xdr_stream *xdr; 717 struct svcxdr_tmpbuf *to_free; 718 struct svc_rqst *rqstp; 719 720 char * tag; 721 u32 taglen; 722 u32 minorversion; 723 u32 client_opcnt; 724 u32 opcnt; 725 struct nfsd4_op *ops; 726 struct nfsd4_op iops[8]; 727}; 728 729struct nfsd4_compoundres { 730 /* scratch variables for XDR encode */ 731 struct xdr_stream *xdr; 732 struct svc_rqst * rqstp; 733 734 __be32 *statusp; 735 char * tag; 736 u32 taglen; 737 u32 opcnt; 738 739 struct nfsd4_compound_state cstate; 740}; 741 742static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp) 743{ 744 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp; 745 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE; 746} 747 748/* 749 * The session reply cache only needs to cache replies that the client 750 * actually asked us to. But it's almost free for us to cache compounds 751 * consisting of only a SEQUENCE op, so we may as well cache those too. 752 * Also, the protocol doesn't give us a convenient response in the case 753 * of a replay of a solo SEQUENCE op that wasn't cached 754 * (RETRY_UNCACHED_REP can only be returned in the second op of a 755 * compound). 756 */ 757static inline bool nfsd4_cache_this(struct nfsd4_compoundres *resp) 758{ 759 return (resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS) 760 || nfsd4_is_solo_sequence(resp); 761} 762 763static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp) 764{ 765 struct nfsd4_compoundres *resp = rqstp->rq_resp; 766 struct nfsd4_compoundargs *argp = rqstp->rq_argp; 767 768 return argp->opcnt == resp->opcnt; 769} 770 771const struct nfsd4_operation *OPDESC(struct nfsd4_op *op); 772int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op); 773void warn_on_nonidempotent_op(struct nfsd4_op *op); 774 775#define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs) 776 777bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp); 778bool nfs4svc_decode_compoundargs(struct svc_rqst *rqstp, struct xdr_stream *xdr); 779bool nfs4svc_encode_compoundres(struct svc_rqst *rqstp, struct xdr_stream *xdr); 780__be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32); 781void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *); 782void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op); 783__be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words, 784 struct svc_fh *fhp, struct svc_export *exp, 785 struct dentry *dentry, 786 u32 *bmval, struct svc_rqst *, int ignore_crossmnt); 787extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp, 788 struct nfsd4_compound_state *, union nfsd4_op_u *u); 789extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp, 790 struct nfsd4_compound_state *, union nfsd4_op_u *u); 791extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp, 792 struct nfsd4_compound_state *, union nfsd4_op_u *u); 793extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *, 794 struct nfsd4_compound_state *, union nfsd4_op_u *u); 795extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, 796 struct nfsd4_compound_state *, union nfsd4_op_u *u); 797extern __be32 nfsd4_create_session(struct svc_rqst *, 798 struct nfsd4_compound_state *, union nfsd4_op_u *u); 799extern __be32 nfsd4_sequence(struct svc_rqst *, 800 struct nfsd4_compound_state *, union nfsd4_op_u *u); 801extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp); 802extern __be32 nfsd4_destroy_session(struct svc_rqst *, 803 struct nfsd4_compound_state *, union nfsd4_op_u *u); 804extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *, 805 union nfsd4_op_u *u); 806__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, 807 union nfsd4_op_u *u); 808extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *, 809 struct nfsd4_open *open, struct nfsd_net *nn); 810extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp, 811 struct svc_fh *current_fh, struct nfsd4_open *open); 812extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate); 813extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate, 814 struct nfsd4_open *open); 815extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp, 816 struct nfsd4_compound_state *, union nfsd4_op_u *u); 817extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *, 818 union nfsd4_op_u *u); 819extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp, 820 struct nfsd4_compound_state *, union nfsd4_op_u *u); 821extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *, 822 union nfsd4_op_u *u); 823extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *, 824 union nfsd4_op_u *u); 825extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *, 826 union nfsd4_op_u *u); 827extern __be32 828nfsd4_release_lockowner(struct svc_rqst *rqstp, 829 struct nfsd4_compound_state *, union nfsd4_op_u *u); 830extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp); 831extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp, 832 struct nfsd4_compound_state *, union nfsd4_op_u *u); 833extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *, 834 union nfsd4_op_u *u); 835extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp, 836 struct nfsd4_compound_state *, union nfsd4_op_u *); 837extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp, 838 struct nfsd4_compound_state *, union nfsd4_op_u *); 839extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr); 840 841enum nfsd4_op_flags { 842 ALLOWED_WITHOUT_FH = 1 << 0, /* No current filehandle required */ 843 ALLOWED_ON_ABSENT_FS = 1 << 1, /* ops processed on absent fs */ 844 ALLOWED_AS_FIRST_OP = 1 << 2, /* ops reqired first in compound */ 845 /* For rfc 5661 section 2.6.3.1.1: */ 846 OP_HANDLES_WRONGSEC = 1 << 3, 847 OP_IS_PUTFH_LIKE = 1 << 4, 848 /* 849 * These are the ops whose result size we estimate before 850 * encoding, to avoid performing an op then not being able to 851 * respond or cache a response. This includes writes and setattrs 852 * as well as the operations usually called "nonidempotent": 853 */ 854 OP_MODIFIES_SOMETHING = 1 << 5, 855 /* 856 * Cache compounds containing these ops in the xid-based drc: 857 * We use the DRC for compounds containing non-idempotent 858 * operations, *except* those that are 4.1-specific (since 859 * sessions provide their own EOS), and except for stateful 860 * operations other than setclientid and setclientid_confirm 861 * (since sequence numbers provide EOS for open, lock, etc in 862 * the v4.0 case). 863 */ 864 OP_CACHEME = 1 << 6, 865 /* 866 * These are ops which clear current state id. 867 */ 868 OP_CLEAR_STATEID = 1 << 7, 869 /* Most ops return only an error on failure; some may do more: */ 870 OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8, 871}; 872 873struct nfsd4_operation { 874 __be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *, 875 union nfsd4_op_u *); 876 void (*op_release)(union nfsd4_op_u *); 877 u32 op_flags; 878 char *op_name; 879 /* Try to get response size before operation */ 880 u32 (*op_rsize_bop)(const struct svc_rqst *rqstp, 881 const struct nfsd4_op *op); 882 void (*op_get_currentstateid)(struct nfsd4_compound_state *, 883 union nfsd4_op_u *); 884 void (*op_set_currentstateid)(struct nfsd4_compound_state *, 885 union nfsd4_op_u *); 886}; 887 888struct nfsd4_cb_recall_any { 889 struct nfsd4_callback ra_cb; 890 u32 ra_keep; 891 u32 ra_bmval[1]; 892}; 893 894#endif 895