Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 | /* * Copyright (c) 2000-2018 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ /* * Copyright (c) 1989, 1993, 1995 * The Regents of the University of California. All rights reserved. * * This code is derived from software contributed to Berkeley by * Rick Macklem at The University of Guelph. * * 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. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. 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 BY THE REGENTS AND CONTRIBUTORS ``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. * * @(#)nfs.h 8.4 (Berkeley) 5/1/95 * FreeBSD-Id: nfs.h,v 1.32 1997/10/12 20:25:38 phk Exp $ */ #ifndef _NFS_NFS_H_ #define _NFS_NFS_H_ #include <sys/appleapiopts.h> #include <sys/cdefs.h> #include <sys/socket.h> #include <sys/mount.h> #include <sys/ioccom.h> #ifdef KERNEL #include <sys/vnode.h> #include <sys/user.h> #include <net/radix.h> #include <kern/locks.h> #include <kern/lock_group.h> #endif #include <nfs/rpcv2.h> #include <nfs/nfsproto.h> #ifdef __APPLE_API_PRIVATE /* * Tunable constants for nfs */ #define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */ #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */ extern int nfs_ticks; #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */ #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */ #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */ #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/ #define NFS_MAXREXMIT 100 /* Stop counting after this many */ #define NFS_RETRANS 10 /* Num of retrans for soft mounts */ #define NFS_TRYLATERDEL 4 /* Initial try later delay (sec) */ #define NFS_MAXGRPS 16U /* Max. size of groups list */ #define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */ #define NFS_MAXATTRTIMO 60 #define NFS_MINDIRATTRTIMO 5 /* directory attribute cache timeout in sec */ #define NFS_MAXDIRATTRTIMO 60 #define NFS_MAXPORT 0xffff #define NFS_IOSIZE (1024 * 1024) /* suggested I/O size */ #define NFS_RWSIZE 32768 /* Def. read/write data size <= 32K */ #define NFS_WSIZE NFS_RWSIZE /* Def. write data size <= 32K */ #define NFS_RSIZE NFS_RWSIZE /* Def. read data size <= 32K */ #define NFS_DGRAM_WSIZE 8192 /* UDP Def. write data size <= 8K */ #define NFS_DGRAM_RSIZE 8192 /* UDP Def. read data size <= 8K */ #define NFS_READDIRSIZE 32768 /* Def. readdir size */ #define NFS_DEFRAHEAD 16 /* Def. read ahead # blocks */ #define NFS_MAXRAHEAD 128 /* Max. read ahead # blocks */ #define NFS_DEFMAXASYNCWRITES 128 /* Def. max # concurrent async write RPCs */ #define NFS_DEFASYNCTHREAD 16 /* Def. # nfsiod threads */ #define NFS_MAXASYNCTHREAD 64 /* max # nfsiod threads */ #define NFS_ASYNCTHREADMAXIDLE 60 /* Seconds before idle nfsiods are reaped */ #define NFS_DEFSTATFSRATELIMIT 10 /* Def. max # statfs RPCs per second */ #define NFS_REQUESTDELAY 10 /* ms interval to check request queue */ #define NFSRV_MAXWGATHERDELAY 100 /* Max. write gather delay (msec) */ #ifndef NFSRV_WGATHERDELAY #define NFSRV_WGATHERDELAY 1 /* Default write gather delay (msec) */ #endif #define NFS_DIRBLKSIZ 4096 /* size of NFS directory buffers */ #if defined(KERNEL) && !defined(DIRBLKSIZ) #define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */ /* can't be larger than NFS_FABLKSIZE */ #endif /* default values for unresponsive mount timeouts */ #define NFS_TPRINTF_INITIAL_DELAY 5 #define NFS_TPRINTF_DELAY 30 /* NFS client mount timeouts */ #define NFS_MOUNT_TIMEOUT 30 #define NFS_MOUNT_QUICK_TIMEOUT 8 /* * Oddballs */ #define NFS_CMPFH(n, f, s) \ ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s))) #define NFSRV_NDMAXDATA(n) \ (((n)->nd_vers == NFS_VER3) ? (((n)->nd_nam2) ? \ NFS_MAXDGRAMDATA : NFSRV_MAXDATA) : NFS_V2MAXDATA) #define NFS_PORT_INVALID(port) \ (((port) > NFS_MAXPORT) || ((port) < 0)) /* * The IO_METASYNC flag should be implemented for local file systems. * (Until then, it is nothin at all.) */ #ifndef IO_METASYNC #define IO_METASYNC 0 #endif /* * Expected allocation sizes for major data structures. If the actual size * of the structure exceeds these sizes, then malloc() will be allocating * almost twice the memory required. This is used in nfs_init() to warn * the sysadmin that the size of a structure should be reduced. * (These sizes are always a power of 2. If the kernel malloc() changes * to one that does not allocate space in powers of 2 size, then this all * becomes bunk!). * Note that some of these structures come out of their own nfs zones. */ #define NFS_NODEALLOC 1024 #define NFS_MNTALLOC 1024 #define NFS_SVCALLOC 512 #define NFS_ARGSVERSION_XDR 88 /* NFS mount args are in XDR format */ #define NFS_XDRARGS_VERSION_0 0 #define NFS_MATTR_BITMAP_LEN 2 /* length of mount attributes bitmap */ #define NFS_MFLAG_BITMAP_LEN 1 /* length of mount flags bitmap */ /* NFS mount attributes */ #define NFS_MATTR_FLAGS 0 /* mount flags (NFS_MATTR_*) */ #define NFS_MATTR_NFS_VERSION 1 /* NFS protocol version */ #define NFS_MATTR_NFS_MINOR_VERSION 2 /* NFS protocol minor version */ #define NFS_MATTR_READ_SIZE 3 /* READ RPC size */ #define NFS_MATTR_WRITE_SIZE 4 /* WRITE RPC size */ #define NFS_MATTR_READDIR_SIZE 5 /* READDIR RPC size */ #define NFS_MATTR_READAHEAD 6 /* block readahead count */ #define NFS_MATTR_ATTRCACHE_REG_MIN 7 /* minimum attribute cache time */ #define NFS_MATTR_ATTRCACHE_REG_MAX 8 /* maximum attribute cache time */ #define NFS_MATTR_ATTRCACHE_DIR_MIN 9 /* minimum attribute cache time for dirs */ #define NFS_MATTR_ATTRCACHE_DIR_MAX 10 /* maximum attribute cache time for dirs */ #define NFS_MATTR_LOCK_MODE 11 /* advisory file locking mode (NFS_LOCK_MODE_*) */ #define NFS_MATTR_SECURITY 12 /* RPC security flavors to use */ #define NFS_MATTR_MAX_GROUP_LIST 13 /* max # of RPC AUTH_SYS groups */ #define NFS_MATTR_SOCKET_TYPE 14 /* socket transport type as a netid-like string */ #define NFS_MATTR_NFS_PORT 15 /* port # to use for NFS protocol */ #define NFS_MATTR_MOUNT_PORT 16 /* port # to use for MOUNT protocol */ #define NFS_MATTR_REQUEST_TIMEOUT 17 /* initial RPC request timeout value */ #define NFS_MATTR_SOFT_RETRY_COUNT 18 /* max RPC retransmissions for soft mounts */ #define NFS_MATTR_DEAD_TIMEOUT 19 /* how long until unresponsive mount is considered dead */ #define NFS_MATTR_FH 20 /* file handle for mount directory */ #define NFS_MATTR_FS_LOCATIONS 21 /* list of locations for the file system */ #define NFS_MATTR_MNTFLAGS 22 /* VFS mount flags (MNT_*) */ #define NFS_MATTR_MNTFROM 23 /* fixed string to use for "f_mntfromname" */ #define NFS_MATTR_REALM 24 /* Realm to authenticate with */ #define NFS_MATTR_PRINCIPAL 25 /* GSS principal to authenticate with */ #define NFS_MATTR_SVCPRINCIPAL 26 /* GSS principal to authenticate to, the server principal */ #define NFS_MATTR_NFS_VERSION_RANGE 27 /* Packed version range to try */ #define NFS_MATTR_KERB_ETYPE 28 /* Enctype to use for kerberos mounts */ #define NFS_MATTR_LOCAL_NFS_PORT 29 /* Unix domain socket for NFS protocol */ #define NFS_MATTR_LOCAL_MOUNT_PORT 30 /* Unix domain socket for MOUNT protocol */ #define NFS_MATTR_SET_MOUNT_OWNER 31 /* Set owner of mount point */ #define NFS_MATTR_READLINK_NOCACHE 32 /* Readlink nocache mode */ #define NFS_MATTR_ATTRCACHE_ROOTDIR_MIN 33 /* minimum attribute cache time for root dir */ #define NFS_MATTR_ATTRCACHE_ROOTDIR_MAX 34 /* maximum attribute cache time for root dir */ #define NFS_MATTR_ACCESS_CACHE 35 /* Access cache size */ /* NFS mount flags */ #define NFS_MFLAG_SOFT 0 /* soft mount (requests fail if unresponsive) */ #define NFS_MFLAG_INTR 1 /* allow operations to be interrupted */ #define NFS_MFLAG_RESVPORT 2 /* use a reserved port */ #define NFS_MFLAG_NOCONNECT 3 /* don't connect the socket (UDP) */ #define NFS_MFLAG_DUMBTIMER 4 /* don't estimate RTT dynamically */ #define NFS_MFLAG_CALLUMNT 5 /* call MOUNTPROC_UMNT on unmount */ #define NFS_MFLAG_RDIRPLUS 6 /* request additional info when reading directories */ #define NFS_MFLAG_NONEGNAMECACHE 7 /* don't do negative name caching */ #define NFS_MFLAG_MUTEJUKEBOX 8 /* don't treat jukebox errors as unresponsive */ #define NFS_MFLAG_EPHEMERAL 9 /* ephemeral (mirror) mount */ #define NFS_MFLAG_NOCALLBACK 10 /* don't provide callback RPC service */ #define NFS_MFLAG_NAMEDATTR 11 /* don't use named attributes */ #define NFS_MFLAG_NOACL 12 /* don't support ACLs */ #define NFS_MFLAG_ACLONLY 13 /* only support ACLs - not mode */ #define NFS_MFLAG_NFC 14 /* send NFC strings */ #define NFS_MFLAG_NOQUOTA 15 /* don't support QUOTA requests */ #define NFS_MFLAG_MNTUDP 16 /* MOUNT protocol should use UDP */ #define NFS_MFLAG_MNTQUICK 17 /* use short timeouts while mounting */ #define NFS_MFLAG_NOOPAQUE_AUTH 19 /* don't make the mount AUTH_OPAQUE. Used by V3 */ #define NFS_MFLAG_SKIP_RENEW 20 /* don't send OP_RENEW when no files are opened. Used by V4 */ /* Macros for packing and unpacking packed versions */ #define PVER2MAJOR(M) ((uint32_t)(((M) >> 16) & 0xffff)) #define PVER2MINOR(m) ((uint32_t)((m) & 0xffff)) #define VER2PVER(M, m) ((uint32_t)((M) << 16) | ((m) & 0xffff)) /* NFS advisory file locking modes */ #define NFS_LOCK_MODE_ENABLED 0 /* advisory file locking enabled */ #define NFS_LOCK_MODE_DISABLED 1 /* do not support advisory file locking */ #define NFS_LOCK_MODE_LOCAL 2 /* perform advisory file locking locally */ #define NFS_STRLEN_INT(str) \ (int)strnlen(str, INT_MAX) #define NFS_UIO_ADDIOV(a_uio, a_baseaddr, a_length) \ assert(a_length <= UINT32_MAX); uio_addiov(a_uio, a_baseaddr, (uint32_t)(a_length)); #define NFS_BZERO(off, bytes) \ do { \ uint32_t bytes32 = bytes > UINT32_MAX ? UINT32_MAX : (uint32_t)(bytes); \ bzero(off, bytes32); \ if (bytes > UINT32_MAX) { \ bzero(off + bytes32, (uint32_t)(bytes - UINT32_MAX)); \ } \ } while(0); #define NFS_ZFREE(zone, ptr) \ do { \ if ((ptr)) { \ zfree((zone), (ptr)); \ (ptr) = NULL; \ } \ } while (0); \ /* Supported encryption types for kerberos session keys */ typedef enum nfs_supported_kerberos_etypes { NFS_DES3_CBC_SHA1_KD = 16, NFS_AES128_CTS_HMAC_SHA1_96 = 17, NFS_AES256_CTS_HMAC_SHA1_96 = 18 } nfs_supported_kerberos_etypes; /* Structure to hold an array of kerberos enctypes to allow on a mount */ #define NFS_MAX_ETYPES 3 struct nfs_etype { uint32_t count; uint32_t selected; /* index in etypes that is being used. Set to count if nothing has been selected */ nfs_supported_kerberos_etypes etypes[NFS_MAX_ETYPES]; }; /* * Old-style arguments to mount NFS */ #define NFS_ARGSVERSION 6 /* change when nfs_args changes */ struct nfs_args { int version; /* args structure version number */ #ifdef KERNEL user32_addr_t addr; /* file server address */ #else struct sockaddr *addr; /* file server address */ #endif uint8_t addrlen; /* length of address */ int sotype; /* Socket type */ int proto; /* and Protocol */ #ifdef KERNEL user32_addr_t fh; /* File handle to be mounted */ #else u_char *fh; /* File handle to be mounted */ #endif int fhsize; /* Size, in bytes, of fh */ int flags; /* flags */ int wsize; /* write size in bytes */ int rsize; /* read size in bytes */ int readdirsize; /* readdir size in bytes */ int timeo; /* initial timeout in .1 secs */ int retrans; /* times to retry send */ int maxgrouplist; /* Max. size of group list */ int readahead; /* # of blocks to readahead */ int leaseterm; /* obsolete: Term (sec) of lease */ int deadthresh; /* obsolete: Retrans threshold */ #ifdef KERNEL user32_addr_t hostname; /* server's name */ #else char *hostname; /* server's name */ #endif /* NFS_ARGSVERSION 3 ends here */ int acregmin; /* reg file min attr cache timeout */ int acregmax; /* reg file max attr cache timeout */ int acdirmin; /* dir min attr cache timeout */ int acdirmax; /* dir max attr cache timeout */ /* NFS_ARGSVERSION 4 ends here */ uint32_t auth; /* security mechanism flavor */ /* NFS_ARGSVERSION 5 ends here */ uint32_t deadtimeout; /* secs until unresponsive mount considered dead */ }; /* incremental size additions in each version of nfs_args */ #define NFS_ARGSVERSION4_INCSIZE (4 * sizeof(int)) #define NFS_ARGSVERSION5_INCSIZE (sizeof(uint32_t)) #define NFS_ARGSVERSION6_INCSIZE (sizeof(uint32_t)) #ifdef KERNEL /* LP64 version of nfs_args. all pointers and longs * grow when we're dealing with a 64-bit process. * WARNING - keep in sync with nfs_args */ struct user_nfs_args { int version; /* args structure version number */ user_addr_t addr __attribute((aligned(8))); /* file server address */ uint8_t addrlen; /* length of address */ int sotype; /* Socket type */ int proto; /* and Protocol */ user_addr_t fh __attribute((aligned(8))); /* File handle to be mounted */ int fhsize; /* Size, in bytes, of fh */ int flags; /* flags */ int wsize; /* write size in bytes */ int rsize; /* read size in bytes */ int readdirsize; /* readdir size in bytes */ int timeo; /* initial timeout in .1 secs */ int retrans; /* times to retry send */ int maxgrouplist; /* Max. size of group list */ int readahead; /* # of blocks to readahead */ int leaseterm; /* obsolete: Term (sec) of lease */ int deadthresh; /* obsolete: Retrans threshold */ user_addr_t hostname __attribute((aligned(8))); /* server's name */ /* NFS_ARGSVERSION 3 ends here */ int acregmin; /* reg file min attr cache timeout */ int acregmax; /* reg file max attr cache timeout */ int acdirmin; /* dir min attr cache timeout */ int acdirmax; /* dir max attr cache timeout */ /* NFS_ARGSVERSION 4 ends here */ uint32_t auth; /* security mechanism flavor */ /* NFS_ARGSVERSION 5 ends here */ uint32_t deadtimeout; /* secs until unresponsive mount considered dead */ }; #endif // KERNEL /* * Old-style NFS mount option flags */ #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */ #define NFSMNT_WSIZE 0x00000002 /* set write size */ #define NFSMNT_RSIZE 0x00000004 /* set read size */ #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */ #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */ #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */ #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */ #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */ #define NFSMNT_NONEGNAMECACHE 0x00000100 /* Don't do negative name caching */ #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */ #define NFSMNT_NFSV4 0x00000400 /* Use NFS Version 4 protocol */ #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */ #define NFSMNT_DEADTIMEOUT 0x00001000 /* unmount after a period of unresponsiveness */ #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */ #define NFSMNT_CALLUMNT 0x00004000 /* call MOUNTPROC_UMNT on unmount */ #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */ #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */ #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */ #define NFSMNT_NOLOCKS 0x00040000 /* don't support file locking */ #define NFSMNT_LOCALLOCKS 0x00080000 /* do file locking locally on client */ #define NFSMNT_ACREGMIN 0x00100000 /* reg min attr cache timeout */ #define NFSMNT_ACREGMAX 0x00200000 /* reg max attr cache timeout */ #define NFSMNT_ACDIRMIN 0x00400000 /* dir min attr cache timeout */ #define NFSMNT_ACDIRMAX 0x00800000 /* dir max attr cache timeout */ #define NFSMNT_SECFLAVOR 0x01000000 /* Use security flavor */ #define NFSMNT_SECSYSOK 0x02000000 /* Server can support auth sys */ #define NFSMNT_MUTEJUKEBOX 0x04000000 /* don't treat jukebox errors as unresponsive */ #define NFSMNT_NOQUOTA 0x08000000 /* don't support QUOTA requests */ /* * fs.nfs sysctl(3) NFS_MOUNTINFO defines */ #define NFS_MOUNT_INFO_VERSION 0 /* nfsstat mount information version */ #define NFS_MIATTR_BITMAP_LEN 1 /* length of mount info attributes bitmap */ #define NFS_MIFLAG_BITMAP_LEN 1 /* length of mount info flags bitmap */ /* NFS mount info attributes */ #define NFS_MIATTR_FLAGS 0 /* mount info flags bitmap (MIFLAG_*) */ #define NFS_MIATTR_ORIG_ARGS 1 /* original mount args passed into mount call */ #define NFS_MIATTR_CUR_ARGS 2 /* current mount args values */ #define NFS_MIATTR_CUR_LOC_INDEX 3 /* current fs location index */ /* NFS mount info flags */ #define NFS_MIFLAG_DEAD 0 /* mount is dead */ #define NFS_MIFLAG_NOTRESP 1 /* server is unresponsive */ #define NFS_MIFLAG_RECOVERY 2 /* mount in recovery */ /* * Structures for the nfssvc(2) syscall. Not that anyone but nfsd * should ever try and use it. */ struct nfsd_args { int sock; /* Socket to serve */ #ifdef KERNEL user32_addr_t name; /* Client addr for connection based sockets */ #else caddr_t name; /* Client addr for connection based sockets */ #endif int namelen; /* Length of name */ }; #ifdef KERNEL /* LP64 version of nfsd_args. all pointers and longs * grow when we're dealing with a 64-bit process. * WARNING - keep in sync with nfsd_args */ struct user_nfsd_args { int sock; /* Socket to serve */ user_addr_t name __attribute((aligned(8))); /* Client addr for connection based sockets */ int namelen; /* Length of name */ }; #endif // KERNEL /* * NFS Server File Handle structures */ /* NFS export handle identifies which NFS export */ #define NFS_FH_VERSION 0x4e580000 /* 'NX00' */ struct nfs_exphandle { uint32_t nxh_version; /* data structure version */ uint32_t nxh_fsid; /* File System Export ID */ uint32_t nxh_expid; /* Export ID */ uint16_t nxh_flags; /* export handle flags */ uint8_t nxh_reserved; /* future use */ uint32_t nxh_fidlen; /* length of File ID */ }; /* nxh_flags */ #define NXHF_INVALIDFH 0x0001 /* file handle is invalid */ #define NFS_MAX_FID_SIZE (NFS_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV4_MAX_FID_SIZE (NFSV4_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV3_MAX_FID_SIZE (NFSV3_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV2_MAX_FID_SIZE (NFSV2_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) /* NFS server internal view of fhandle_t */ /* The first sizeof(fhandle_t) bytes must match what goes into fhandle_t. */ /* (fhp is used to allow use of an external buffer) */ struct nfs_filehandle { uint32_t nfh_len; /* total length of file handle */ struct nfs_exphandle nfh_xh; /* export handle */ unsigned char nfh_fid[NFS_MAX_FID_SIZE]; /* File ID */ unsigned char *nfh_fhp; /* pointer to file handle */ }; /* * NFS export data structures */ /* Structure to hold an array of security flavors */ #define NX_MAX_SEC_FLAVORS 5 struct nfs_sec { int count; uint32_t flavors[NX_MAX_SEC_FLAVORS]; }; struct nfs_export_net_args { uint32_t nxna_flags; /* export flags */ struct xucred nxna_cred; /* mapped credential for root/all user */ struct sockaddr_storage nxna_addr; /* net address to which exported */ struct sockaddr_storage nxna_mask; /* mask for net address */ struct nfs_sec nxna_sec; /* security mechanism flavors */ }; struct nfs_export_args { uint32_t nxa_fsid; /* export FS ID */ uint32_t nxa_expid; /* export ID */ #ifdef KERNEL user32_addr_t nxa_fspath; /* export FS path */ user32_addr_t nxa_exppath; /* export sub-path */ #else char *nxa_fspath; /* export FS path */ char *nxa_exppath; /* export sub-path */ #endif uint32_t nxa_flags; /* export arg flags */ uint32_t nxa_netcount; /* #entries in ex_nets array */ #ifdef KERNEL user32_addr_t nxa_nets; /* array of net args */ #else struct nfs_export_net_args *nxa_nets; /* array of net args */ #endif }; #ifdef KERNEL /* LP64 version of export_args */ struct user_nfs_export_args { uint32_t nxa_fsid; /* export FS ID */ uint32_t nxa_expid; /* export ID */ user_addr_t nxa_fspath; /* export FS path */ user_addr_t nxa_exppath; /* export sub-path */ uint32_t nxa_flags; /* export arg flags */ uint32_t nxa_netcount; /* #entries in ex_nets array */ user_addr_t nxa_nets; /* array of net args */ }; #endif /* KERNEL */ /* nfs export arg flags */ #define NXA_DELETE 0x0001 /* delete the specified export(s) */ #define NXA_ADD 0x0002 /* add the specified export(s) */ #define NXA_REPLACE 0x0003 /* delete and add the specified export(s) */ #define NXA_DELETE_ALL 0x0004 /* delete all exports */ #define NXA_OFFLINE 0x0008 /* export is offline */ #define NXA_CHECK 0x0010 /* check if exportable */ /* export option flags */ #define NX_READONLY 0x0001 /* exported read-only */ #define NX_DEFAULTEXPORT 0x0002 /* exported to the world */ #define NX_MAPROOT 0x0004 /* map root access to anon credential */ #define NX_MAPALL 0x0008 /* map all access to anon credential */ #define NX_32BITCLIENTS 0x0020 /* restrict directory cookies to 32 bits */ #define NX_OFFLINE 0x0040 /* export is offline */ #define NX_MANGLEDNAMES 0x0080 /* export will return mangled names for names > 255 bytes */ /* * fs.nfs sysctl(3) export stats record structures */ #define NFS_EXPORT_STAT_REC_VERSION 1 /* export stat record version */ #define NFS_USER_STAT_REC_VERSION 1 /* active user list record version */ /* descriptor describing following records */ struct nfs_export_stat_desc { uint32_t rec_vers; /* version of export stat records */ uint64_t rec_count; /* total record count */ }__attribute__((__packed__)); /* export stat record containing path and stat counters */ struct nfs_export_stat_rec { char path[RPCMNT_PATHLEN + 1]; uint64_t ops; /* Count of NFS Requests received for this export */ uint64_t bytes_read; /* Count of bytes read from this export */ uint64_t bytes_written; /* Count of bytes written to this export */ }__attribute__((__packed__)); /* Active user list stat buffer descriptor */ struct nfs_user_stat_desc { uint32_t rec_vers; /* version of active user stat records */ uint32_t rec_count; /* total record count */ }__attribute__((__packed__)); /* Active user list user stat record format */ struct nfs_user_stat_user_rec { u_char rec_type; uid_t uid; struct sockaddr_storage sock; uint64_t ops; uint64_t bytes_read; uint64_t bytes_written; time_t tm_start; time_t tm_last; }__attribute__((__packed__)); /* Active user list path record format */ struct nfs_user_stat_path_rec { u_char rec_type; char path[RPCMNT_PATHLEN + 1]; }__attribute__((__packed__)); /* Defines for rec_type field of * nfs_user_stat_rec & nfs_user_stat_rec * data structures */ #define NFS_USER_STAT_USER_REC 0 #define NFS_USER_STAT_PATH_REC 1 #ifdef XNU_KERNEL_PRIVATE struct nfs_exportfs; struct nfs_export_options { uint32_t nxo_flags; /* export options */ kauth_cred_t nxo_cred; /* mapped credential */ struct nfs_sec nxo_sec; /* security mechanism flavors */ }; /* Network address lookup element and individual export options */ struct nfs_netopt { struct radix_node no_rnodes[2]; /* radix tree glue */ struct nfs_export_options no_opt; /* export options */ struct sockaddr *no_addr; /* net address to which exported */ struct sockaddr *no_mask; /* mask for net address */ }; /* statistic counters for each exported directory * * Since 64-bit atomic operations are not available on 32-bit platforms, * 64-bit counters are implemented using 32-bit integers and 32-bit * atomic operations */ typedef struct nfsstatcount64 { uint32_t hi; uint32_t lo; } nfsstatcount64; struct nfs_export_stat_counters { struct nfsstatcount64 ops; /* Count of NFS Requests received for this export */ struct nfsstatcount64 bytes_read; /* Count of bytes read from this export */ struct nfsstatcount64 bytes_written; /* Count of bytes written to his export */ }; /* Macro for updating nfs export stat counters */ #define NFSStatAdd64(PTR, VAL) \ do { \ uint32_t NFSSA_OldValue = \ OSAddAtomic((VAL), &(PTR)->lo); \ if ((NFSSA_OldValue + (VAL)) < NFSSA_OldValue) \ OSAddAtomic(1, &(PTR)->hi); \ } while (0) /* Some defines for dealing with active user list stats */ #define NFSRV_USER_STAT_DEF_MAX_NODES 1024 /* default active user list size limit */ #define NFSRV_USER_STAT_DEF_IDLE_SEC 7200 /* default idle seconds (node no longer considered active) */ /* active user list globals */ extern uint32_t nfsrv_user_stat_enabled; /* enable/disable active user list */ extern uint32_t nfsrv_user_stat_node_count; /* current count of user stat nodes */ extern uint32_t nfsrv_user_stat_max_idle_sec; /* idle seconds (node no longer considered active) */ extern uint32_t nfsrv_user_stat_max_nodes; /* active user list size limit */ extern lck_grp_t nfsrv_active_user_mutex_group; /* An active user node represented in the kernel */ struct nfs_user_stat_node { TAILQ_ENTRY(nfs_user_stat_node) lru_link; LIST_ENTRY(nfs_user_stat_node) hash_link; uid_t uid; struct sockaddr_storage sock; uint64_t ops; uint64_t bytes_read; uint64_t bytes_written; time_t tm_start; time_t tm_last; }; /* Hash table for active user nodes */ #define NFS_USER_STAT_HASH_SIZE 16 /* MUST be a power of 2 */ #define NFS_USER_STAT_HASH(userhashtbl, uid) \ &((userhashtbl)[(uid) & (NFS_USER_STAT_HASH_SIZE - 1)]) TAILQ_HEAD(nfs_user_stat_lru_head, nfs_user_stat_node); LIST_HEAD(nfs_user_stat_hashtbl_head, nfs_user_stat_node); /* Active user list data structure */ /* One per exported directory */ struct nfs_active_user_list { struct nfs_user_stat_lru_head user_lru; struct nfs_user_stat_hashtbl_head user_hashtbl[NFS_USER_STAT_HASH_SIZE]; uint32_t node_count; lck_mtx_t user_mutex; }; /* Network export information */ /* one of these for each exported directory */ struct nfs_export { LIST_ENTRY(nfs_export) nx_next; /* FS export list */ LIST_ENTRY(nfs_export) nx_hash; /* export hash chain */ struct nfs_export *nx_parent; /* parent export */ uint32_t nx_id; /* export ID */ uint32_t nx_flags; /* export flags */ struct nfs_exportfs *nx_fs; /* exported file system */ char *nx_path; /* exported file system sub-path */ struct nfs_filehandle nx_fh; /* export root file handle */ struct nfs_export_options nx_defopt; /* default options */ uint32_t nx_expcnt; /* # exports in table */ struct radix_node_head *nx_rtable[AF_MAX + 1]; /* table of exports (netopts) */ struct nfs_export_stat_counters nx_stats; /* statistic counters for this exported directory */ struct nfs_active_user_list nx_user_list; /* Active User List for this exported directory */ struct timeval nx_exptime; /* time of export for write verifier */ }; /* NFS exported file system info */ /* one of these for each exported file system */ struct nfs_exportfs { LIST_ENTRY(nfs_exportfs) nxfs_next; /* exported file system list */ uint32_t nxfs_id; /* exported file system ID */ char *nxfs_path; /* exported file system path */ LIST_HEAD(, nfs_export) nxfs_exports; /* list of exports for this file system */ }; extern LIST_HEAD(nfsrv_expfs_list, nfs_exportfs) nfsrv_exports; extern lck_rw_t nfsrv_export_rwlock; // lock for export data structures #define NFSRVEXPHASHSZ 64 #define NFSRVEXPHASHVAL(FSID, EXPID) \ (((FSID) >> 24) ^ ((FSID) >> 16) ^ ((FSID) >> 8) ^ (EXPID)) #define NFSRVEXPHASH(FSID, EXPID) \ (&nfsrv_export_hashtbl[NFSRVEXPHASHVAL((FSID),(EXPID)) & nfsrv_export_hash]) extern LIST_HEAD(nfsrv_export_hashhead, nfs_export) * nfsrv_export_hashtbl; extern u_long nfsrv_export_hash; #if CONFIG_FSE /* * NFS server file mod fsevents */ struct nfsrv_fmod { LIST_ENTRY(nfsrv_fmod) fm_link; vnode_t fm_vp; struct vfs_context fm_context; uint64_t fm_deadline; }; #define NFSRVFMODHASHSZ 128 #define NFSRVFMODHASH(vp) (((uintptr_t) vp) & nfsrv_fmod_hash) extern LIST_HEAD(nfsrv_fmod_hashhead, nfsrv_fmod) * nfsrv_fmod_hashtbl; extern u_long nfsrv_fmod_hash; extern lck_mtx_t nfsrv_fmod_mutex; extern int nfsrv_fmod_pending, nfsrv_fsevents_enabled; #endif extern int nfsrv_async, nfsrv_export_hash_size, nfsrv_reqcache_size, nfsrv_sock_max_rec_queue_length; extern uint32_t nfsrv_gss_context_ttl; extern uint32_t nfsrv_unprocessed_rpc_current, nfsrv_unprocessed_rpc_max; extern struct nfsrvstats nfsrvstats; #define NFS_UC_Q_DEBUG #ifdef NFS_UC_Q_DEBUG extern int nfsrv_uc_use_proxy; extern uint32_t nfsrv_uc_queue_limit; extern uint32_t nfsrv_uc_queue_max_seen; extern volatile uint32_t nfsrv_uc_queue_count; #endif #endif // XNU_KERNEL_PRIVATE typedef struct nfserr_info { const char * nei_name; const int nei_error; const int nei_index; } nfserr_info_t; /* * NFS Common Errors */ #define NFSERR_INFO_COMMON \ { "NFS_OK", NFS_OK, 0 }, \ { "NFSERR_PERM", NFSERR_PERM, 1 }, \ { "NFSERR_NOENT", NFSERR_NOENT, 2 }, \ { "NFSERR_IO", NFSERR_IO, 3 }, \ { "NFSERR_NXIO", NFSERR_NXIO, 4 }, \ { "NFSERR_ACCES", NFSERR_ACCES, 5 }, \ { "NFSERR_EXIST", NFSERR_EXIST, 6 }, \ { "NFSERR_XDEV", NFSERR_XDEV, 7 }, \ { "NFSERR_NODEV", NFSERR_NODEV, 8 }, \ { "NFSERR_NOTDIR", NFSERR_NOTDIR, 9 }, \ { "NFSERR_ISDIR", NFSERR_ISDIR, 10 }, \ { "NFSERR_INVAL", NFSERR_INVAL, 11 }, \ { "NFSERR_FBIG", NFSERR_FBIG, 12 }, \ { "NFSERR_NOSPC", NFSERR_NOSPC, 13 }, \ { "NFSERR_ROFS", NFSERR_ROFS, 14 }, \ { "NFSERR_MLINK", NFSERR_MLINK, 15 }, \ { "NFSERR_NAMETOL", NFSERR_NAMETOL, 16 }, \ { "NFSERR_NOTEMPTY", NFSERR_NOTEMPTY, 17 }, \ { "NFSERR_DQUOT", NFSERR_DQUOT, 18 }, \ { "NFSERR_STALE", NFSERR_STALE, 19 }, \ { "NFSERR_REMOTE", NFSERR_REMOTE, 20 }, \ { "NFSERR_WFLUSH", NFSERR_WFLUSH, 21 }, \ { "NFSERR_BADHANDLE", NFSERR_BADHANDLE, 22 }, \ { "NFSERR_NOT_SYNC", NFSERR_NOT_SYNC, 23 }, \ { "NFSERR_BAD_COOKIE", NFSERR_BAD_COOKIE, 24 }, \ { "NFSERR_NOTSUPP", NFSERR_NOTSUPP, 25 }, \ { "NFSERR_TOOSMALL", NFSERR_TOOSMALL, 26 }, \ { "NFSERR_SERVERFAULT", NFSERR_SERVERFAULT, 27 }, \ { "NFSERR_BADTYPE", NFSERR_BADTYPE, 28 }, \ { "NFSERR_DELAY", NFSERR_DELAY, 29 } #define NFSERR_INFO_COMMON_SIZE 30 /* * NFSv4 Errors */ #define NFSERR_INFO_V4 \ { "ERR_SAME", NFSERR_SAME, 0 }, \ { "ERR_DENIED", NFSERR_DENIED, 1 }, \ { "ERR_EXPIRED", NFSERR_EXPIRED, 2 }, \ { "ERR_LOCKED", NFSERR_LOCKED, 3 }, \ { "ERR_GRACE", NFSERR_GRACE, 4 }, \ { "ERR_FHEXPIRED", NFSERR_FHEXPIRED, 5 }, \ { "ERR_SHARE_DENIED", NFSERR_SHARE_DENIED, 6 }, \ { "ERR_WRONGSEC", NFSERR_WRONGSEC, 7 }, \ { "ERR_CLID_INUSE", NFSERR_CLID_INUSE, 8 }, \ { "ERR_RESOURCE", NFSERR_RESOURCE, 9 }, \ { "ERR_MOVED", NFSERR_MOVED, 10 }, \ { "ERR_NOFILEHANDLE", NFSERR_NOFILEHANDLE, 11 }, \ { "ERR_MINOR_VERS_MISMATCH", NFSERR_MINOR_VERS_MISMATCH, 12 }, \ { "ERR_STALE_CLIENTID", NFSERR_STALE_CLIENTID, 13 }, \ { "ERR_STALE_STATEID", NFSERR_STALE_STATEID, 14 }, \ { "ERR_OLD_STATEID", NFSERR_OLD_STATEID, 15 }, \ { "ERR_BAD_STATEID", NFSERR_BAD_STATEID, 16 }, \ { "ERR_BAD_SEQID", NFSERR_BAD_SEQID, 17 }, \ { "ERR_NOT_SAME", NFSERR_NOT_SAME, 18 }, \ { "ERR_LOCK_RANGE", NFSERR_LOCK_RANGE, 19 }, \ { "ERR_SYMLINK", NFSERR_SYMLINK, 20 }, \ { "ERR_RESTOREFH", NFSERR_RESTOREFH, 21 }, \ { "ERR_LEASE_MOVED", NFSERR_LEASE_MOVED, 22 }, \ { "ERR_ATTRNOTSUPP", NFSERR_ATTRNOTSUPP, 23 }, \ { "ERR_NO_GRACE", NFSERR_NO_GRACE, 24 }, \ { "ERR_RECLAIM_BAD", NFSERR_RECLAIM_BAD, 25 }, \ { "ERR_RECLAIM_CONFLICT", NFSERR_RECLAIM_CONFLICT, 26 }, \ { "ERR_BADXDR", NFSERR_BADXDR, 27 }, \ { "ERR_LOCKS_HELD", NFSERR_LOCKS_HELD, 28 }, \ { "ERR_OPENMODE", NFSERR_OPENMODE, 29 }, \ { "ERR_BADOWNER", NFSERR_BADOWNER, 30 }, \ { "ERR_BADCHAR", NFSERR_BADCHAR, 31 }, \ { "ERR_BADNAME", NFSERR_BADNAME, 32 }, \ { "ERR_BAD_RANGE", NFSERR_BAD_RANGE, 33 }, \ { "ERR_LOCK_NOTSUPP", NFSERR_LOCK_NOTSUPP, 34 }, \ { "ERR_OP_ILLEGAL", NFSERR_OP_ILLEGAL, 35 }, \ { "ERR_DEADLOCK", NFSERR_DEADLOCK, 36 }, \ { "ERR_FILE_OPEN", NFSERR_FILE_OPEN, 37 }, \ { "ERR_ADMIN_REVOKED", NFSERR_ADMIN_REVOKED, 38 }, \ { "ERR_CB_PATH_DOWN", NFSERR_CB_PATH_DOWN, 39 } #define NFSERR_INFO_V4_SIZE 40 /* * XXX to allow amd to include nfs.h without nfsproto.h */ #ifdef NFS_NPROCS /* * Stats structure */ struct nfsclntstats { uint64_t attrcache_hits; uint64_t attrcache_misses; uint64_t lookupcache_hits; uint64_t lookupcache_misses; uint64_t direofcache_hits; uint64_t direofcache_misses; uint64_t accesscache_hits; uint64_t accesscache_misses; uint64_t biocache_reads; uint64_t read_bios; uint64_t read_physios; uint64_t biocache_writes; uint64_t write_bios; uint64_t write_physios; uint64_t biocache_readlinks; uint64_t readlink_bios; uint64_t biocache_readdirs; uint64_t readdir_bios; uint64_t rpccntv3[NFS_NPROCS]; struct { uint64_t nlm_lock; uint64_t nlm_test; uint64_t nlm_unlock; } nlmcnt; // NFSv3 only uint64_t opcntv4[NFS_OP_COUNT]; uint64_t rpcretries; uint64_t rpcrequests; uint64_t rpctimeouts; uint64_t rpcunexpected; uint64_t rpcinvalid; uint64_t pageins; uint64_t pageouts; struct { uint64_t errs_common[NFSERR_INFO_COMMON_SIZE]; uint64_t errs_v4[NFSERR_INFO_V4_SIZE]; uint64_t errs_unknown; } nfs_errs; }; struct nfsrvstats { uint64_t srvrpccntv3[NFS_NPROCS]; uint64_t srvrpc_errs; uint64_t srv_errs; uint64_t srvcache_inproghits; uint64_t srvcache_idemdonehits; uint64_t srvcache_nonidemdonehits; uint64_t srvcache_misses; uint64_t srvvop_writes; struct { uint64_t errs_common[NFSERR_INFO_COMMON_SIZE]; uint64_t errs_unknown; } nfs_errs; }; #endif /* * Flags for nfssvc() system call. */ #define NFSSVC_NFSD 0x004 #define NFSSVC_ADDSOCK 0x008 #define NFSSVC_EXPORTSTATS 0x010 /* gets exported directory stats */ #define NFSSVC_USERSTATS 0x020 /* gets exported directory active user stats */ #define NFSSVC_USERCOUNT 0x040 /* gets current count of active nfs users */ #define NFSSVC_ZEROSTATS 0x080 /* zero nfs server statistics */ #define NFSSVC_SRVSTATS 0x100 /* struct: struct nfsrvstats */ #define NFSSVC_EXPORT 0x200 /* * The structure that lockd hands the kernel for each lock answer. */ #define LOCKD_ANS_VERSION 2 struct lockd_ans { int la_version; /* lockd_ans version */ int la_errno; /* return status */ u_int64_t la_xid; /* unique message transaction ID */ int la_flags; /* answer flags */ pid_t la_pid; /* pid of lock requester/owner */ off_t la_start; /* lock starting offset */ off_t la_len; /* lock length */ int la_fh_len; /* The file handle length. */ u_int8_t la_fh[NFSV3_MAX_FH_SIZE];/* The file handle. */ }; /* * The structure that lockd hands the kernel for each notify. */ #define LOCKD_NOTIFY_VERSION 1 struct lockd_notify { int ln_version; /* lockd_notify version */ int ln_flags; /* notify flags */ int ln_pad; /* (for alignment) */ int ln_addrcount; /* # of addresss */ struct sockaddr_storage *ln_addr; /* List of addresses. */ }; #include <sys/_types/_guid_t.h> /* for guid_t below */ #define MAXIDNAMELEN 1024 struct nfs_testmapid { uint32_t ntm_lookup; /* lookup name 2 id or id 2 name */ uint32_t ntm_grpflag; /* Is this a group or user maping */ uint32_t ntm_id; /* id to map or return */ uint32_t pad; guid_t ntm_guid; /* intermidiate guid used in conversion */ char ntm_name[MAXIDNAMELEN]; /* name to map or return */ }; #define NTM_ID2NAME 0 #define NTM_NAME2ID 1 #define NTM_NAME2GUID 2 #define NTM_GUID2NAME 3 /* * Flags for nfsclnt() system call. */ #define NFSCLNT_LOCKDANS _IOW('n', 101, struct lockd_ans) #define NFSCLNT_LOCKDNOTIFY _IOW('n', 102, struct lockd_notify) #define NFSCLNT_TESTIDMAP _IOWR('n', 103, struct nfs_testmapid) /* nfsclnt() system call character device */ #define NFSCLNT_DEVICE "nfsclnt" /* nfsclnt() system call */ int nfsclnt(unsigned long request, void *argstructp); /* * fs.nfs sysctl(3) identifiers */ #define NFS_NFSSTATS 1 /* struct: struct nfsclntstats */ #define NFS_MOUNTINFO 6 /* gets information about an NFS mount */ #define NFS_NFSZEROSTATS 7 /* zero nfs client statistics */ #ifndef NFS_WDELAYHASHSIZ #define NFS_WDELAYHASHSIZ 16 /* and with this */ #endif #ifdef KERNEL_PRIVATE /* NFS hooks */ /* NFS hooks in struct */ struct nfs_hooks_in { int (*f_vinvalbuf)(vnode_t, int, vfs_context_t, int); int (*f_buf_page_inval)(vnode_t, off_t); }; /* NFS hooks out struct */ struct nfs_hooks_out { void * (*f_get_bsdthreadtask_info)(thread_t); }; /* NFS hooks registration functions */ void nfs_register_hooks(struct nfs_hooks_in *, struct nfs_hooks_out *); void nfs_unregister_hooks(void); #ifdef XNU_KERNEL_PRIVATE /* NFS hooks wrappers */ int nfs_vinvalbuf(vnode_t, int, vfs_context_t, int); int nfs_buf_page_inval(vnode_t, off_t); #endif /* XNU_KERNEL_PRIVATE */ /* Debug support */ #define __NFS_DEBUG_LEVEL(dbgctl) ((dbgctl) & 0xf) #define __NFS_DEBUG_FACILITY(dbgctl) (((dbgctl) >> 4) & 0xfff) #define __NFS_DEBUG_FLAGS(dbgctl) (((dbgctl) >> 16) & 0xf) #define __NFS_DEBUG_VALUE(dbgctl) (((dbgctl) >> 20) & 0xfff) #define __NFS_IS_DBG(dbgctl, fac, lev) (__builtin_expect((__NFS_DEBUG_FACILITY(dbgctl) & (fac)) && ((lev) <= __NFS_DEBUG_LEVEL(dbgctl)), 0)) #define __NFS_DBG(dbgctl, fac, lev, fmt, ...) nfs_printf((dbgctl), (fac), (lev), "%s: %d: " fmt, __func__, __LINE__, ## __VA_ARGS__) void nfs_printf(unsigned int, unsigned int, unsigned int, const char *, ...) __printflike(4, 5); void nfs_dump_mbuf(const char *, int, const char *, mbuf_t); /* * NFS mbuf chain structure used for managing the building/dissection of RPCs */ struct nfsm_chain { mbuf_t nmc_mhead; /* mbuf chain head */ mbuf_t nmc_mcur; /* current mbuf */ caddr_t nmc_ptr; /* pointer into current mbuf */ size_t nmc_left; /* bytes remaining in current mbuf */ uint32_t nmc_flags; /* flags for this nfsm_chain */ }; #define NFSM_CHAIN_FLAG_ADD_CLUSTERS 0x1 /* always add mbuf clusters */ extern size_t nfs_mbuf_mhlen, nfs_mbuf_minclsize; /* * Each retransmission of an RPCSEC_GSS request * has an additional sequence number. */ struct gss_seq { SLIST_ENTRY(gss_seq) gss_seqnext; uint32_t gss_seqnum; }; #endif /* KERNEL_PRIVATE */ #ifdef XNU_KERNEL_PRIVATE extern uint32_t nfsrv_debug_ctl; /* Server debug support */ #define NFSRV_FAC_GSS 0x001 #define NFSRV_FAC_SRV 0x002 #define NFSRV_DEBUG_LEVEL __NFS_DEBUG_LEVEL(nfsrv_debug_ctl) #define NFSRV_DEBUG_FACILITY __NFS_DEBUG_FACILITY(nfsrv_debug_ctl) #define NFSRV_DEBUG_FLAGS __NFS_DEBUG_FLAGS(nfsrv_debug_ctl) #define NFSRV_DEBUG_VALUE __NFS_DEBUG_VALUE(nfsrv_debug_ctl) #define NFSRV_IS_DBG(fac, lev) __NFS_IS_DBG(nfsrv_debug_ctl, fac, lev) #define NFSRV_DBG(fac, lev, fmt, ...) __NFS_DBG(nfsrv_debug_ctl, fac, lev, fmt, ## __VA_ARGS__) #ifdef MALLOC_DECLARE MALLOC_DECLARE(M_NFSD); #endif struct nameidata; struct nfsrv_uc_arg; /* * One nfsrv_sock structure is maintained for each socket the * server is servicing requests on. */ struct nfsrv_sock { TAILQ_ENTRY(nfsrv_sock) ns_chain; /* List of all nfsrv_sock's */ TAILQ_ENTRY(nfsrv_sock) ns_svcq; /* List of sockets needing servicing */ TAILQ_ENTRY(nfsrv_sock) ns_wgq; /* List of sockets with a pending write gather */ struct nfsrv_uc_arg *ns_ua; /* Opaque pointer to upcall */ lck_rw_t ns_rwlock; /* lock for most fields */ socket_t ns_so; mbuf_t ns_nam; mbuf_t ns_raw; mbuf_t ns_rawend; mbuf_t ns_rec; mbuf_t ns_recend; mbuf_t ns_frag; int ns_flag; int ns_sotype; size_t ns_cc; u_int32_t ns_reclen; /* Unprocessed RPC record length */ u_int32_t ns_recslen; /* Total unprocessed RPC records length */ int ns_reccnt; u_int32_t ns_sref; time_t ns_timestamp; /* socket timestamp */ lck_mtx_t ns_wgmutex; /* mutex for write gather fields */ time_t ns_wgtime; /* next Write deadline (usec) */ LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */ LIST_HEAD(nfsrv_wg_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ]; }; /* Bits for "ns_flag" */ #define SLP_VALID 0x0001 /* nfs sock valid */ #define SLP_DOREC 0x0002 /* nfs sock has received data to process */ #define SLP_NEEDQ 0x0004 /* network socket has data to receive */ #define SLP_DISCONN 0x0008 /* socket needs to be zapped */ #define SLP_GETSTREAM 0x0010 /* currently in nfsrv_getstream() */ #define SLP_LASTFRAG 0x0020 /* on last fragment of RPC record */ #define SLP_DOWRITES 0x0040 /* nfs sock has gathered writes to service */ #define SLP_WORKTODO 0x004e /* mask of all "work to do" flags */ #define SLP_ALLFLAGS 0x007f #define SLP_WAITQ 0x4000 /* nfs sock is on the wait queue */ #define SLP_WORKQ 0x8000 /* nfs sock is on the work queue */ #define SLP_QUEUED 0xc000 /* nfs sock is on a queue */ #define SLPNOLIST ((struct nfsrv_sock *)0xdeadbeef) /* sentinel value for sockets not in the nfsrv_sockwg list */ extern struct nfsrv_sock *nfsrv_udpsock, *nfsrv_udp6sock; /* * global NFS server socket lists: * * nfsrv_socklist - list of all sockets (ns_chain) * nfsrv_sockwait - sockets w/new data waiting to be worked on (ns_svcq) * nfsrv_sockwork - sockets being worked on which may have more work to do (ns_svcq) * nfsrv_sockwg - sockets with pending write gather input (ns_wgq) */ extern TAILQ_HEAD(nfsrv_sockhead, nfsrv_sock) nfsrv_socklist, nfsrv_sockwg, nfsrv_sockwait, nfsrv_sockwork; /* lock groups for nfsrv_sock's */ extern lck_grp_t nfsrv_slp_rwlock_group; extern lck_grp_t nfsrv_slp_mutex_group; /* * One of these structures is allocated for each nfsd. */ struct nfsd { TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */ TAILQ_ENTRY(nfsd) nfsd_queue; /* List of waiting nfsd's */ int nfsd_flag; /* NFSD_ flags */ struct nfsrv_sock *nfsd_slp; /* Current socket */ struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */ }; /* Bits for "nfsd_flag" */ #define NFSD_WAITING 0x01 #define NFSD_REQINPROG 0x02 /* * This structure is used by the server for describing each request. * Some fields are used only when write request gathering is performed. */ struct nfsrv_descript { time_t nd_time; /* Write deadline (usec) */ off_t nd_off; /* Start byte offset */ off_t nd_eoff; /* and end byte offset */ LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */ LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */ LIST_HEAD(, nfsrv_descript) nd_coalesce; /* coalesced writes */ struct nfsm_chain nd_nmreq; /* Request mbuf chain */ mbuf_t nd_mrep; /* Reply mbuf list (WG) */ mbuf_t nd_nam; /* and socket addr */ mbuf_t nd_nam2; /* return socket addr */ u_int32_t nd_procnum; /* RPC # */ int nd_stable; /* storage type */ int nd_vers; /* NFS version */ int nd_len; /* Length of this write */ int nd_repstat; /* Reply status */ u_int32_t nd_retxid; /* Reply xid */ struct timeval nd_starttime; /* Time RPC initiated */ struct nfs_filehandle nd_fh; /* File handle */ uint32_t nd_sec; /* Security flavor */ struct nfs_gss_svc_ctx *nd_gss_context;/* RPCSEC_GSS context */ uint32_t nd_gss_seqnum; /* RPCSEC_GSS seq num */ mbuf_t nd_gss_mb; /* RPCSEC_GSS results mbuf */ kauth_cred_t nd_cr; /* Credentials */ }; extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head, nfsd_queue; typedef int (*nfsrv_proc_t)(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); /* mutex for nfs server */ extern lck_mtx_t nfsd_mutex; extern int nfsd_thread_count, nfsd_thread_max; /* nfs timer call structures */ extern thread_call_t nfsrv_idlesock_timer_call; #if CONFIG_FSE extern thread_call_t nfsrv_fmod_timer_call; #endif __BEGIN_DECLS nfstype vtonfs_type(enum vtype, int); enum vtype nfstov_type(nfstype, int); int vtonfsv2_mode(enum vtype, mode_t); void nfs_mbuf_init(void); int nfs_sockaddr_cmp(struct sockaddr *, struct sockaddr *); void nfsrv_active_user_list_reclaim(void); void nfsrv_cleancache(void); void nfsrv_cleanup(void); int nfsrv_credcheck(struct nfsrv_descript *, vfs_context_t, struct nfs_export *, struct nfs_export_options *); void nfsrv_idlesock_timer(void *, void *); int nfsrv_dorec(struct nfsrv_sock *, struct nfsd *, struct nfsrv_descript **); int nfsrv_errmap(struct nfsrv_descript *, int); int nfsrv_export(struct user_nfs_export_args *, vfs_context_t); int nfsrv_fhmatch(struct nfs_filehandle *, struct nfs_filehandle *); int nfsrv_fhtovp(struct nfs_filehandle *, struct nfsrv_descript *, vnode_t *, struct nfs_export **, struct nfs_export_options **); int nfsrv_check_exports_allow_address(mbuf_t); #if CONFIG_FSE void nfsrv_fmod_timer(void *, void *); #endif int nfsrv_getcache(struct nfsrv_descript *, struct nfsrv_sock *, mbuf_t *); void nfsrv_group_sort(gid_t *, int); void nfsrv_init(void); void nfsrv_initcache(void); int nfsrv_is_initialized(void); int nfsrv_namei(struct nfsrv_descript *, vfs_context_t, struct nameidata *, struct nfs_filehandle *, vnode_t *, struct nfs_export **, struct nfs_export_options **); void nfsrv_rcv(socket_t, void *, int); void nfsrv_rcv_locked(socket_t, struct nfsrv_sock *, int); int nfsrv_rephead(struct nfsrv_descript *, struct nfsrv_sock *, struct nfsm_chain *, size_t); int nfsrv_send(struct nfsrv_sock *, mbuf_t, mbuf_t); void nfsrv_updatecache(struct nfsrv_descript *, int, mbuf_t); void nfsrv_update_user_stat(struct nfs_export *, struct nfsrv_descript *, uid_t, u_int, u_int, u_int); int nfsrv_vptofh(struct nfs_export *, int, struct nfs_filehandle *, vnode_t, vfs_context_t, struct nfs_filehandle *); void nfsrv_wakenfsd(struct nfsrv_sock *); void nfsrv_wg_timer(void *, void *); int nfsrv_writegather(struct nfsrv_descript **, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_access(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_commit(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_create(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_fsinfo(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_getattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_link(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_lookup(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_mkdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_mknod(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_noop(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_null(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_pathconf(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_read(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_readdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_readdirplus(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_readlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_remove(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_rename(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_rmdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_setattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_statfs(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_symlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); int nfsrv_write(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *); void nfs_interval_timer_start(thread_call_t, time_t); /* socket upcall interfaces */ void nfsrv_uc_init(void); void nfsrv_uc_cleanup(void); void nfsrv_uc_addsock(struct nfsrv_sock *, int); void nfsrv_uc_dequeue(struct nfsrv_sock *); #include <kern/kalloc.h> extern zone_t nfsrv_descript_zone; __END_DECLS #endif /* XNU_KERNEL_PRIVATE */ #endif /* __APPLE_API_PRIVATE */ #endif |