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 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 | /* * Copyright (c) 2000-2005 Apple Computer, 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@ */ /* * @OSF_COPYRIGHT@ */ /* * Mach Operating System * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University * All Rights Reserved. * * Permission to use, copy, modify and distribute this software and its * documentation is hereby granted, provided that both the copyright * notice and this permission notice appear in all copies of the * software, derivative works or modified versions, and any portions * thereof, and that both notices appear in supporting documentation. * * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. * * Carnegie Mellon requests users of this software to return to * * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU * School of Computer Science * Carnegie Mellon University * Pittsburgh PA 15213-3890 * * any improvements or extensions that they make and grant Carnegie Mellon * the rights to redistribute these changes. */ /* * NOTICE: This file was modified by McAfee Research in 2004 to introduce * support for mandatory and extensible security protections. This notice * is included in support of clause 2.2 (b) of the Apple Public License, * Version 2.0. * Copyright (c) 2005 SPARTA, Inc. */ /* */ /* * File: mach/message.h * * Mach IPC message and primitive function definitions. */ #ifndef _MACH_MESSAGE_H_ #define _MACH_MESSAGE_H_ #include <stddef.h> #include <stdint.h> #include <machine/limits.h> #include <machine/types.h> /* user_addr_t */ #include <mach/port.h> #include <mach/boolean.h> #include <mach/kern_return.h> #include <mach/machine/vm_types.h> #include <sys/cdefs.h> #include <sys/appleapiopts.h> #include <Availability.h> #if !KERNEL && PRIVATE #include <TargetConditionals.h> #endif #if __has_feature(ptrauth_calls) #include <ptrauth.h> #endif /* * The timeout mechanism uses mach_msg_timeout_t values, * passed by value. The timeout units are milliseconds. * It is controlled with the MACH_SEND_TIMEOUT * and MACH_RCV_TIMEOUT options. */ typedef natural_t mach_msg_timeout_t; /* * The value to be used when there is no timeout. * (No MACH_SEND_TIMEOUT/MACH_RCV_TIMEOUT option.) */ #define MACH_MSG_TIMEOUT_NONE ((mach_msg_timeout_t) 0) /* * The kernel uses MACH_MSGH_BITS_COMPLEX as a hint. If it isn't on, it * assumes the body of the message doesn't contain port rights or OOL * data. The field is set in received messages. A user task must * use caution in interpreting the body of a message if the bit isn't * on, because the mach_msg_type's in the body might "lie" about the * contents. If the bit isn't on, but the mach_msg_types * in the body specify rights or OOL data, the behavior is undefined. * (Ie, an error may or may not be produced.) * * The value of MACH_MSGH_BITS_REMOTE determines the interpretation * of the msgh_remote_port field. It is handled like a msgt_name, * but must result in a send or send-once type right. * * The value of MACH_MSGH_BITS_LOCAL determines the interpretation * of the msgh_local_port field. It is handled like a msgt_name, * and also must result in a send or send-once type right. * * The value of MACH_MSGH_BITS_VOUCHER determines the interpretation * of the msgh_voucher_port field. It is handled like a msgt_name, * but must result in a send right (and the msgh_voucher_port field * must be the name of a send right to a Mach voucher kernel object. * * MACH_MSGH_BITS() combines two MACH_MSG_TYPE_* values, for the remote * and local fields, into a single value suitable for msgh_bits. * * MACH_MSGH_BITS_CIRCULAR should be zero; is is used internally. * * The unused bits should be zero and are reserved for the kernel * or for future interface expansion. */ #define MACH_MSGH_BITS_ZERO 0x00000000 #define MACH_MSGH_BITS_REMOTE_MASK 0x0000001f #define MACH_MSGH_BITS_LOCAL_MASK 0x00001f00 #define MACH_MSGH_BITS_VOUCHER_MASK 0x001f0000 #define MACH_MSGH_BITS_PORTS_MASK \ (MACH_MSGH_BITS_REMOTE_MASK | \ MACH_MSGH_BITS_LOCAL_MASK | \ MACH_MSGH_BITS_VOUCHER_MASK) #define MACH_MSGH_BITS_COMPLEX 0x80000000U /* message is complex */ #define MACH_MSGH_BITS_USER 0x801f1f1fU /* allowed bits user->kernel */ #define MACH_MSGH_BITS_RAISEIMP 0x20000000U /* importance raised due to msg */ #define MACH_MSGH_BITS_DENAP MACH_MSGH_BITS_RAISEIMP #define MACH_MSGH_BITS_IMPHOLDASRT 0x10000000U /* assertion help, userland private */ #define MACH_MSGH_BITS_DENAPHOLDASRT MACH_MSGH_BITS_IMPHOLDASRT #define MACH_MSGH_BITS_CIRCULAR 0x10000000U /* message circular, kernel private */ #define MACH_MSGH_BITS_USED 0xb01f1f1fU /* setter macros for the bits */ #define MACH_MSGH_BITS(remote, local) /* legacy */ \ ((remote) | ((local) << 8)) #define MACH_MSGH_BITS_SET_PORTS(remote, local, voucher) \ (((remote) & MACH_MSGH_BITS_REMOTE_MASK) | \ (((local) << 8) & MACH_MSGH_BITS_LOCAL_MASK) | \ (((voucher) << 16) & MACH_MSGH_BITS_VOUCHER_MASK)) #define MACH_MSGH_BITS_SET(remote, local, voucher, other) \ (MACH_MSGH_BITS_SET_PORTS((remote), (local), (voucher)) \ | ((other) &~ MACH_MSGH_BITS_PORTS_MASK)) /* getter macros for pulling values out of the bits field */ #define MACH_MSGH_BITS_REMOTE(bits) \ ((bits) & MACH_MSGH_BITS_REMOTE_MASK) #define MACH_MSGH_BITS_LOCAL(bits) \ (((bits) & MACH_MSGH_BITS_LOCAL_MASK) >> 8) #define MACH_MSGH_BITS_VOUCHER(bits) \ (((bits) & MACH_MSGH_BITS_VOUCHER_MASK) >> 16) #define MACH_MSGH_BITS_PORTS(bits) \ ((bits) & MACH_MSGH_BITS_PORTS_MASK) #define MACH_MSGH_BITS_OTHER(bits) \ ((bits) &~ MACH_MSGH_BITS_PORTS_MASK) /* checking macros */ #define MACH_MSGH_BITS_HAS_REMOTE(bits) \ (MACH_MSGH_BITS_REMOTE(bits) != MACH_MSGH_BITS_ZERO) #define MACH_MSGH_BITS_HAS_LOCAL(bits) \ (MACH_MSGH_BITS_LOCAL(bits) != MACH_MSGH_BITS_ZERO) #define MACH_MSGH_BITS_HAS_VOUCHER(bits) \ (MACH_MSGH_BITS_VOUCHER(bits) != MACH_MSGH_BITS_ZERO) #define MACH_MSGH_BITS_IS_COMPLEX(bits) \ (((bits) & MACH_MSGH_BITS_COMPLEX) != MACH_MSGH_BITS_ZERO) /* importance checking macros */ #define MACH_MSGH_BITS_RAISED_IMPORTANCE(bits) \ (((bits) & MACH_MSGH_BITS_RAISEIMP) != MACH_MSGH_BITS_ZERO) #define MACH_MSGH_BITS_HOLDS_IMPORTANCE_ASSERTION(bits) \ (((bits) & MACH_MSGH_BITS_IMPHOLDASRT) != MACH_MSGH_BITS_ZERO) /* * Every message starts with a message header. * Following the message header, if the message is complex, are a count * of type descriptors and the type descriptors themselves * (mach_msg_descriptor_t). The size of the message must be specified in * bytes, and includes the message header, descriptor count, descriptors, * and inline data. * * The msgh_remote_port field specifies the destination of the message. * It must specify a valid send or send-once right for a port. * * The msgh_local_port field specifies a "reply port". Normally, * This field carries a send-once right that the receiver will use * to reply to the message. It may carry the values MACH_PORT_NULL, * MACH_PORT_DEAD, a send-once right, or a send right. * * The msgh_voucher_port field specifies a Mach voucher port. Only * send rights to kernel-implemented Mach Voucher kernel objects in * addition to MACH_PORT_NULL or MACH_PORT_DEAD may be passed. * * The msgh_id field is uninterpreted by the message primitives. * It normally carries information specifying the format * or meaning of the message. */ typedef unsigned int mach_msg_bits_t; typedef natural_t mach_msg_size_t; typedef integer_t mach_msg_id_t; #define MACH_MSG_SIZE_NULL (mach_msg_size_t *) 0 typedef unsigned int mach_msg_priority_t; #define MACH_MSG_PRIORITY_UNSPECIFIED (mach_msg_priority_t) 0 #if PRIVATE typedef uint8_t mach_msg_qos_t; // same as thread_qos_t #define MACH_MSG_QOS_UNSPECIFIED 0 #define MACH_MSG_QOS_MAINTENANCE 1 #define MACH_MSG_QOS_BACKGROUND 2 #define MACH_MSG_QOS_UTILITY 3 #define MACH_MSG_QOS_DEFAULT 4 #define MACH_MSG_QOS_USER_INITIATED 5 #define MACH_MSG_QOS_USER_INTERACTIVE 6 #define MACH_MSG_QOS_LAST 6 extern int mach_msg_priority_is_pthread_priority(mach_msg_priority_t pri); extern mach_msg_priority_t mach_msg_priority_encode( mach_msg_qos_t override_qos, mach_msg_qos_t qos, int relpri); extern mach_msg_qos_t mach_msg_priority_overide_qos(mach_msg_priority_t pri); extern mach_msg_qos_t mach_msg_priority_qos(mach_msg_priority_t pri); extern int mach_msg_priority_relpri(mach_msg_priority_t pri); #if KERNEL || !TARGET_OS_SIMULATOR static inline int mach_msg_priority_is_pthread_priority_inline(mach_msg_priority_t pri) { return (pri & 0xff) == 0xff; } #define MACH_MSG_PRIORITY_RELPRI_SHIFT 8 #define MACH_MSG_PRIORITY_RELPRI_MASK (0xff << MACH_MSG_PRIORITY_RELPRI_SHIFT) #define MACH_MSG_PRIORITY_QOS_SHIFT 16 #define MACH_MSG_PRIORITY_QOS_MASK (0xf << MACH_MSG_PRIORITY_QOS_SHIFT) #define MACH_MSG_PRIORITY_OVERRIDE_SHIFT 20 #define MACH_MSG_PRIORITY_OVERRIDE_MASK (0xf << MACH_MSG_PRIORITY_OVERRIDE_SHIFT) static inline mach_msg_priority_t mach_msg_priority_encode_inline(mach_msg_qos_t override_qos, mach_msg_qos_t qos, int relpri) { mach_msg_priority_t pri = 0; if (qos > 0 && qos <= MACH_MSG_QOS_LAST) { pri |= (uint32_t)(qos << MACH_MSG_PRIORITY_QOS_SHIFT); pri |= (uint32_t)((uint8_t)(relpri - 1) << MACH_MSG_PRIORITY_RELPRI_SHIFT); } if (override_qos > 0 && override_qos <= MACH_MSG_QOS_LAST) { pri |= (uint32_t)(override_qos << MACH_MSG_PRIORITY_OVERRIDE_SHIFT); } return pri; } static inline mach_msg_qos_t mach_msg_priority_overide_qos_inline(mach_msg_priority_t pri) { pri &= MACH_MSG_PRIORITY_OVERRIDE_MASK; pri >>= MACH_MSG_PRIORITY_OVERRIDE_SHIFT; return (mach_msg_qos_t)(pri <= MACH_MSG_QOS_LAST ? pri : 0); } static inline mach_msg_qos_t mach_msg_priority_qos_inline(mach_msg_priority_t pri) { pri &= MACH_MSG_PRIORITY_QOS_MASK; pri >>= MACH_MSG_PRIORITY_QOS_SHIFT; return (mach_msg_qos_t)(pri <= MACH_MSG_QOS_LAST ? pri : 0); } static inline int mach_msg_priority_relpri_inline(mach_msg_priority_t pri) { if (mach_msg_priority_qos_inline(pri)) { return (int8_t)(pri >> MACH_MSG_PRIORITY_RELPRI_SHIFT) + 1; } return 0; } #define mach_msg_priority_is_pthread_priority(...) \ mach_msg_priority_is_pthread_priority_inline(__VA_ARGS__) #define mach_msg_priority_encode(...) \ mach_msg_priority_encode_inline(__VA_ARGS__) #define mach_msg_priority_overide_qos(...) \ mach_msg_priority_overide_qos_inline(__VA_ARGS__) #define mach_msg_priority_qos(...) \ mach_msg_priority_qos_inline(__VA_ARGS__) #define mach_msg_priority_relpri(...) \ mach_msg_priority_relpri_inline(__VA_ARGS__) #endif #endif // PRIVATE #if XNU_KERNEL_PRIVATE __enum_decl(mach_msg_type_name_t, unsigned int, { MACH_MSG_TYPE_NONE = 0, /* no disposition */ MACH_MSG_TYPE_MOVE_RECEIVE = 16, /* Must hold receive right */ MACH_MSG_TYPE_MOVE_SEND = 17, /* Must hold send right(s) */ MACH_MSG_TYPE_MOVE_SEND_ONCE = 18, /* Must hold sendonce right */ MACH_MSG_TYPE_COPY_SEND = 19, /* Must hold send right(s) */ MACH_MSG_TYPE_MAKE_SEND = 20, /* Must hold receive right */ MACH_MSG_TYPE_MAKE_SEND_ONCE = 21, /* Must hold receive right */ }); #else typedef unsigned int mach_msg_type_name_t; #define MACH_MSG_TYPE_MOVE_RECEIVE 16 /* Must hold receive right */ #define MACH_MSG_TYPE_MOVE_SEND 17 /* Must hold send right(s) */ #define MACH_MSG_TYPE_MOVE_SEND_ONCE 18 /* Must hold sendonce right */ #define MACH_MSG_TYPE_COPY_SEND 19 /* Must hold send right(s) */ #define MACH_MSG_TYPE_MAKE_SEND 20 /* Must hold receive right */ #define MACH_MSG_TYPE_MAKE_SEND_ONCE 21 /* Must hold receive right */ #define MACH_MSG_TYPE_COPY_RECEIVE 22 /* NOT VALID */ #define MACH_MSG_TYPE_DISPOSE_RECEIVE 24 /* must hold receive right */ #define MACH_MSG_TYPE_DISPOSE_SEND 25 /* must hold send right(s) */ #define MACH_MSG_TYPE_DISPOSE_SEND_ONCE 26 /* must hold sendonce right */ #endif typedef unsigned int mach_msg_copy_options_t; #define MACH_MSG_PHYSICAL_COPY 0 #define MACH_MSG_VIRTUAL_COPY 1 #define MACH_MSG_ALLOCATE 2 #define MACH_MSG_OVERWRITE 3 /* deprecated */ #ifdef MACH_KERNEL #define MACH_MSG_KALLOC_COPY_T 4 #endif /* MACH_KERNEL */ #define MACH_MSG_GUARD_FLAGS_NONE 0x0000 #define MACH_MSG_GUARD_FLAGS_IMMOVABLE_RECEIVE 0x0001 /* Move the receive right and mark it as immovable */ #define MACH_MSG_GUARD_FLAGS_UNGUARDED_ON_SEND 0x0002 /* Verify that the port is unguarded */ #define MACH_MSG_GUARD_FLAGS_MASK 0x0003 /* Valid flag bits */ typedef unsigned int mach_msg_guard_flags_t; /* * In a complex mach message, the mach_msg_header_t is followed by * a descriptor count, then an array of that number of descriptors * (mach_msg_*_descriptor_t). The type field of mach_msg_type_descriptor_t * (which any descriptor can be cast to) indicates the flavor of the * descriptor. * * Note that in LP64, the various types of descriptors are no longer all * the same size as mach_msg_descriptor_t, so the array cannot be indexed * as expected. */ typedef unsigned int mach_msg_descriptor_type_t; #define MACH_MSG_PORT_DESCRIPTOR 0 #define MACH_MSG_OOL_DESCRIPTOR 1 #define MACH_MSG_OOL_PORTS_DESCRIPTOR 2 #define MACH_MSG_OOL_VOLATILE_DESCRIPTOR 3 #define MACH_MSG_GUARDED_PORT_DESCRIPTOR 4 #define MACH_MSG_DESCRIPTOR_MAX MACH_MSG_GUARDED_PORT_DESCRIPTOR #if XNU_KERNEL_PRIVATE && __has_feature(ptrauth_calls) #define __ipc_desc_sign(d) \ __ptrauth(ptrauth_key_process_independent_data, \ 1, ptrauth_string_discriminator("ipc_desc." d)) #else #define __ipc_desc_sign(d) #endif /* KERNEL */ #pragma pack(push, 4) typedef struct { natural_t pad1; mach_msg_size_t pad2; unsigned int pad3 : 24; mach_msg_descriptor_type_t type : 8; } mach_msg_type_descriptor_t; xnu_static_assert_struct_size(mach_msg_type_descriptor_t, 12); typedef struct { #if KERNEL union { mach_port_t __ipc_desc_sign("port") name; mach_port_t kext_name; mach_port_t u_name; }; #else mach_port_t name; mach_msg_size_t pad1; #endif unsigned int pad2 : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; #if defined(KERNEL) uint32_t pad_end; #endif } mach_msg_port_descriptor_t; xnu_static_assert_struct_size_kernel_user(mach_msg_port_descriptor_t, 16, 12); #if MACH_KERNEL_PRIVATE typedef struct { mach_port_name_t name; mach_msg_size_t pad1; uint32_t pad2 : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; } mach_msg_user_port_descriptor_t; xnu_static_assert_struct_size(mach_msg_user_port_descriptor_t, 12); #endif /* MACH_KERNEL_PRIVATE */ typedef struct { uint32_t address; mach_msg_size_t size; boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; unsigned int pad1: 8; mach_msg_descriptor_type_t type: 8; } mach_msg_ool_descriptor32_t; xnu_static_assert_struct_size(mach_msg_ool_descriptor32_t, 12); typedef struct { uint64_t address; boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; unsigned int pad1: 8; mach_msg_descriptor_type_t type: 8; mach_msg_size_t size; } mach_msg_ool_descriptor64_t; xnu_static_assert_struct_size(mach_msg_ool_descriptor64_t, 16); typedef struct { #if KERNEL union { void *__ipc_desc_sign("address") address; void *kext_address; user_addr_t u_address; }; #else void *address; #endif #if !defined(__LP64__) mach_msg_size_t size; #endif boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; unsigned int pad1: 8; mach_msg_descriptor_type_t type: 8; #if defined(__LP64__) mach_msg_size_t size; #endif #if defined(KERNEL) && !defined(__LP64__) uint32_t pad_end; #endif } mach_msg_ool_descriptor_t; xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_ool_descriptor_t, 16, 16, 12); typedef struct { uint32_t address; mach_msg_size_t count; boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; } mach_msg_ool_ports_descriptor32_t; xnu_static_assert_struct_size(mach_msg_ool_descriptor32_t, 12); typedef struct { uint64_t address; boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; mach_msg_size_t count; } mach_msg_ool_ports_descriptor64_t; xnu_static_assert_struct_size(mach_msg_ool_ports_descriptor64_t, 16); typedef struct { #if KERNEL union { void *__ipc_desc_sign("port_array") address; void *kext_address; user_addr_t u_address; }; #else void *address; #endif #if !defined(__LP64__) mach_msg_size_t count; #endif boolean_t deallocate: 8; mach_msg_copy_options_t copy: 8; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; #if defined(__LP64__) mach_msg_size_t count; #endif #if defined(KERNEL) && !defined(__LP64__) uint32_t pad_end; #endif } mach_msg_ool_ports_descriptor_t; xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_ool_ports_descriptor_t, 16, 16, 12); typedef struct { uint32_t context; mach_port_name_t name; mach_msg_guard_flags_t flags : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; } mach_msg_guarded_port_descriptor32_t; xnu_static_assert_struct_size(mach_msg_guarded_port_descriptor32_t, 12); typedef struct { uint64_t context; mach_msg_guard_flags_t flags : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; mach_port_name_t name; } mach_msg_guarded_port_descriptor64_t; xnu_static_assert_struct_size(mach_msg_guarded_port_descriptor64_t, 16); typedef struct { #if defined(KERNEL) union { mach_port_t __ipc_desc_sign("guarded_port") name; mach_port_t kext_name; mach_port_context_t u_context; }; mach_msg_guard_flags_t flags : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; union { uint32_t pad_end; mach_port_name_t u_name; }; #else mach_port_context_t context; #if !defined(__LP64__) mach_port_name_t name; #endif mach_msg_guard_flags_t flags : 16; mach_msg_type_name_t disposition : 8; mach_msg_descriptor_type_t type : 8; #if defined(__LP64__) mach_port_name_t name; #endif /* defined(__LP64__) */ #endif /* defined(KERNEL) */ } mach_msg_guarded_port_descriptor_t; xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_guarded_port_descriptor_t, 16, 16, 12); /* * LP64support - This union definition is not really * appropriate in LP64 mode because not all descriptors * are of the same size in that environment. */ #if defined(__LP64__) && defined(KERNEL) typedef union { mach_msg_port_descriptor_t port; mach_msg_ool_descriptor32_t out_of_line; mach_msg_ool_ports_descriptor32_t ool_ports; mach_msg_type_descriptor_t type; mach_msg_guarded_port_descriptor32_t guarded_port; } mach_msg_descriptor_t; #else typedef union { mach_msg_port_descriptor_t port; mach_msg_ool_descriptor_t out_of_line; mach_msg_ool_ports_descriptor_t ool_ports; mach_msg_type_descriptor_t type; mach_msg_guarded_port_descriptor_t guarded_port; } mach_msg_descriptor_t; #endif xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_descriptor_t, 16, 16, 12); typedef struct { mach_msg_size_t msgh_descriptor_count; } mach_msg_body_t; xnu_static_assert_struct_size(mach_msg_body_t, 4); #define MACH_MSG_BODY_NULL ((mach_msg_body_t *) 0) #define MACH_MSG_DESCRIPTOR_NULL ((mach_msg_descriptor_t *) 0) typedef struct { mach_msg_bits_t msgh_bits; mach_msg_size_t msgh_size; mach_port_t msgh_remote_port; mach_port_t msgh_local_port; mach_port_name_t msgh_voucher_port; mach_msg_id_t msgh_id; } mach_msg_header_t; xnu_static_assert_struct_size_kernel_user(mach_msg_header_t, 32, 24); #if PRIVATE /* mach msg2 data vectors are positional */ __enum_decl(mach_msgv_index_t, uint32_t, { MACH_MSGV_IDX_MSG = 0, MACH_MSGV_IDX_AUX = 1, }); #define MACH_MSGV_MAX_COUNT (MACH_MSGV_IDX_AUX + 1) /* at least DISPATCH_MSGV_AUX_MAX_SIZE in libdispatch */ #define LIBSYSCALL_MSGV_AUX_MAX_SIZE 128 typedef struct { /* a mach_msg_header_t* or mach_msg_aux_header_t* */ mach_vm_address_t msgv_data; /* if msgv_rcv_addr is non-zero, use it as rcv address instead */ mach_vm_address_t msgv_rcv_addr; mach_msg_size_t msgv_send_size; mach_msg_size_t msgv_rcv_size; } mach_msg_vector_t; xnu_static_assert_struct_size(mach_msg_vector_t, 24); typedef struct { mach_msg_size_t msgdh_size; uint32_t msgdh_reserved; /* For future */ } mach_msg_aux_header_t; xnu_static_assert_struct_size(mach_msg_aux_header_t, 8); #endif /* PRIVATE */ #define msgh_reserved msgh_voucher_port #define MACH_MSG_NULL ((mach_msg_header_t *) 0) typedef struct { mach_msg_header_t header; mach_msg_body_t body; } mach_msg_base_t; xnu_static_assert_struct_size_kernel_user(mach_msg_base_t, 36, 28); #if MACH_KERNEL_PRIVATE typedef struct { /* first two fields must align with mach_msg_header_t */ mach_msg_bits_t msgh_bits; mach_msg_size_t msgh_size; mach_port_name_t msgh_remote_port; mach_port_name_t msgh_local_port; mach_port_name_t msgh_voucher_port; mach_msg_id_t msgh_id; } mach_msg_user_header_t; xnu_static_assert_struct_size(mach_msg_user_header_t, 24); typedef struct { mach_msg_user_header_t header; mach_msg_body_t body; } mach_msg_user_base_t; xnu_static_assert_struct_size(mach_msg_user_base_t, 28); typedef union { mach_msg_type_descriptor_t kdesc_header; mach_msg_port_descriptor_t kdesc_port; mach_msg_ool_descriptor_t kdesc_memory; mach_msg_ool_ports_descriptor_t kdesc_port_array; mach_msg_guarded_port_descriptor_t kdesc_guarded_port; } mach_msg_kdescriptor_t; xnu_static_assert_struct_size(mach_msg_kdescriptor_t, 16); static inline mach_msg_descriptor_type_t mach_msg_kdescriptor_type(const mach_msg_kdescriptor_t *kdesc) { return kdesc->kdesc_header.type; } typedef struct { mach_msg_header_t msgb_header; mach_msg_size_t msgb_dsc_count; mach_msg_kdescriptor_t msgb_dsc_array[]; } mach_msg_kbase_t; static inline mach_msg_kbase_t * mach_msg_header_to_kbase(mach_msg_header_t *hdr) { return __container_of(hdr, mach_msg_kbase_t, msgb_header); } #define mach_port_array_alloc(count, flags) \ kalloc_type(mach_port_ool_t, count, flags) #define mach_port_array_free(ptr, count) \ kfree_type(mach_port_ool_t, count, ptr) #endif /* MACH_KERNEL_PRIVATE */ typedef unsigned int mach_msg_trailer_type_t; #define MACH_MSG_TRAILER_FORMAT_0 0 typedef unsigned int mach_msg_trailer_size_t; typedef char *mach_msg_trailer_info_t; typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; } mach_msg_trailer_t; xnu_static_assert_struct_size(mach_msg_trailer_t, 8); /* * The msgh_seqno field carries a sequence number * associated with the received-from port. A port's * sequence number is incremented every time a message * is received from it and included in the received * trailer to help put messages back in sequence if * multiple threads receive and/or process received * messages. */ typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; } mach_msg_seqno_trailer_t; xnu_static_assert_struct_size(mach_msg_seqno_trailer_t, 12); typedef struct { unsigned int val[2]; } security_token_t; typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; } mach_msg_security_trailer_t; xnu_static_assert_struct_size(mach_msg_security_trailer_t, 20); /* * The audit token is an opaque token which identifies * Mach tasks and senders of Mach messages as subjects * to the BSM audit system. Only the appropriate BSM * library routines should be used to interpret the * contents of the audit token as the representation * of the subject identity within the token may change * over time. */ typedef struct { unsigned int val[8]; } audit_token_t; /* * Safe initializer for audit_token_t. * Variables holding unset audit tokens should generally * be initialized to INVALID_AUDIT_TOKEN_VALUE, to allow * unset audit tokens be distinguished from the kernel's * audit token, KERNEL_AUDIT_TOKEN_VALUE. It is `safe' * in that it limits potential damage if such an unset * audit token, or one of its fields, were ever to be * interpreted as valid by mistake. Notably, the pid is * outside of range of valid pids, and none of the * fields correspond to privileged users or groups. */ #define INVALID_AUDIT_TOKEN_VALUE {{ \ UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX, \ UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX }} typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; } mach_msg_audit_trailer_t; xnu_static_assert_struct_size(mach_msg_audit_trailer_t, 52); typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context_t msgh_context; } mach_msg_context_trailer_t; xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_context_trailer_t, 60, 60, 56); #if defined(MACH_KERNEL_PRIVATE) && defined(__arm64__) typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context32_t msgh_context; } mach_msg_context_trailer32_t; xnu_static_assert_struct_size(mach_msg_context_trailer32_t, 56); typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context64_t msgh_context; } mach_msg_context_trailer64_t; xnu_static_assert_struct_size(mach_msg_context_trailer64_t, 60); #endif typedef struct { mach_port_name_t sender; } msg_labels_t; typedef int mach_msg_filter_id; #define MACH_MSG_FILTER_POLICY_ALLOW (mach_msg_filter_id)0 /* * Trailer type to pass MAC policy label info as a mach message trailer. * */ typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context_t msgh_context; mach_msg_filter_id msgh_ad; msg_labels_t msgh_labels; } mach_msg_mac_trailer_t; xnu_static_assert_struct_size_kernel_user64_user32(mach_msg_mac_trailer_t, 68, 68, 64); #if defined(MACH_KERNEL_PRIVATE) && defined(__arm64__) typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context32_t msgh_context; mach_msg_filter_id msgh_ad; msg_labels_t msgh_labels; } mach_msg_mac_trailer32_t; xnu_static_assert_struct_size(mach_msg_mac_trailer32_t, 64); typedef struct { mach_msg_trailer_type_t msgh_trailer_type; mach_msg_trailer_size_t msgh_trailer_size; mach_port_seqno_t msgh_seqno; security_token_t msgh_sender; audit_token_t msgh_audit; mach_port_context64_t msgh_context; mach_msg_filter_id msgh_ad; msg_labels_t msgh_labels; } mach_msg_mac_trailer64_t; xnu_static_assert_struct_size(mach_msg_mac_trailer64_t, 68); #endif #define MACH_MSG_TRAILER_MINIMUM_SIZE sizeof(mach_msg_trailer_t) /* * These values can change from release to release - but clearly * code cannot request additional trailer elements one was not * compiled to understand. Therefore, it is safe to use this * constant when the same module specified the receive options. * Otherwise, you run the risk that the options requested by * another module may exceed the local modules notion of * MAX_TRAILER_SIZE. */ #if defined(MACH_KERNEL_PRIVATE) && defined(__arm64__) typedef mach_msg_mac_trailer64_t mach_msg_max_trailer64_t; typedef mach_msg_mac_trailer32_t mach_msg_max_trailer32_t; #endif typedef mach_msg_mac_trailer_t mach_msg_max_trailer_t; #define MAX_TRAILER_SIZE ((mach_msg_size_t)sizeof(mach_msg_max_trailer_t)) /* * Legacy requirements keep us from ever updating these defines (even * when the format_0 trailers gain new option data fields in the future). * Therefore, they shouldn't be used going forward. Instead, the sizes * should be compared against the specific element size requested using * REQUESTED_TRAILER_SIZE. */ typedef mach_msg_security_trailer_t mach_msg_format_0_trailer_t; /*typedef mach_msg_mac_trailer_t mach_msg_format_0_trailer_t; */ #define MACH_MSG_TRAILER_FORMAT_0_SIZE sizeof(mach_msg_format_0_trailer_t) #define KERNEL_SECURITY_TOKEN_VALUE { {0, 1} } extern const security_token_t KERNEL_SECURITY_TOKEN; #define KERNEL_AUDIT_TOKEN_VALUE { {0, 0, 0, 0, 0, 0, 0, 0} } extern const audit_token_t KERNEL_AUDIT_TOKEN; typedef integer_t mach_msg_options_t; #define MACH_MSG_HEADER_EMPTY (mach_msg_header_t){ } typedef struct { mach_msg_header_t header; } mach_msg_empty_send_t; typedef struct { mach_msg_header_t header; mach_msg_trailer_t trailer; } mach_msg_empty_rcv_t; typedef union{ mach_msg_empty_send_t send; mach_msg_empty_rcv_t rcv; } mach_msg_empty_t; #pragma pack(pop) /* utility to round the message size - will become machine dependent */ #define round_msg(x) (((mach_msg_size_t)(x) + sizeof (natural_t) - 1) & \ ~(sizeof (natural_t) - 1)) #ifdef XNU_KERNEL_PRIVATE #include <os/base.h> #include <os/overflow.h> #include <kern/debug.h> #define round_msg_overflow(in, out) __os_warn_unused(({ \ bool __ovr = os_add_overflow(in, (__typeof__(*out))(sizeof(natural_t) - 1), out); \ *out &= ~((__typeof__(*out))(sizeof(natural_t) - 1)); \ __ovr; \ })) static inline mach_msg_size_t mach_round_msg(mach_msg_size_t x) { if (round_msg_overflow(x, &x)) { panic("round msg overflow"); } return x; } #endif /* XNU_KERNEL_PRIVATE */ /* * There is no fixed upper bound to the size of Mach messages. */ #define MACH_MSG_SIZE_MAX ((mach_msg_size_t) ~0) #if defined(__APPLE_API_PRIVATE) /* * But architectural limits of a given implementation, or * temporal conditions may cause unpredictable send failures * for messages larger than MACH_MSG_SIZE_RELIABLE. * * In either case, waiting for memory is [currently] outside * the scope of send timeout values provided to IPC. */ #define MACH_MSG_SIZE_RELIABLE ((mach_msg_size_t) 256 * 1024) #endif /* * Compatibility definitions, for code written * when there was a msgh_kind instead of msgh_seqno. */ #define MACH_MSGH_KIND_NORMAL 0x00000000 #define MACH_MSGH_KIND_NOTIFICATION 0x00000001 #define msgh_kind msgh_seqno #define mach_msg_kind_t mach_port_seqno_t typedef natural_t mach_msg_type_size_t; typedef natural_t mach_msg_type_number_t; /* * Values received/carried in messages. Tells the receiver what * sort of port right he now has. * * MACH_MSG_TYPE_PORT_NAME is used to transfer a port name * which should remain uninterpreted by the kernel. (Port rights * are not transferred, just the port name.) */ #define MACH_MSG_TYPE_PORT_NONE 0 #define MACH_MSG_TYPE_PORT_NAME 15 #define MACH_MSG_TYPE_PORT_RECEIVE MACH_MSG_TYPE_MOVE_RECEIVE #define MACH_MSG_TYPE_PORT_SEND MACH_MSG_TYPE_MOVE_SEND #define MACH_MSG_TYPE_PORT_SEND_ONCE MACH_MSG_TYPE_MOVE_SEND_ONCE #define MACH_MSG_TYPE_LAST 22 /* Last assigned */ /* * A dummy value. Mostly used to indicate that the actual value * will be filled in later, dynamically. */ #define MACH_MSG_TYPE_POLYMORPHIC ((mach_msg_type_name_t) -1) /* * Is a given item a port type? */ #define MACH_MSG_TYPE_PORT_ANY(x) \ (((x) >= MACH_MSG_TYPE_MOVE_RECEIVE) && \ ((x) <= MACH_MSG_TYPE_MAKE_SEND_ONCE)) #define MACH_MSG_TYPE_PORT_ANY_SEND(x) \ (((x) >= MACH_MSG_TYPE_MOVE_SEND) && \ ((x) <= MACH_MSG_TYPE_MAKE_SEND_ONCE)) #define MACH_MSG_TYPE_PORT_ANY_SEND_ONCE(x) \ (((x) == MACH_MSG_TYPE_MOVE_SEND_ONCE) || \ ((x) == MACH_MSG_TYPE_MAKE_SEND_ONCE)) #define MACH_MSG_TYPE_PORT_ANY_RIGHT(x) \ (((x) >= MACH_MSG_TYPE_MOVE_RECEIVE) && \ ((x) <= MACH_MSG_TYPE_MOVE_SEND_ONCE)) typedef integer_t mach_msg_option_t; #define MACH_MSG_OPTION_NONE 0x00000000 #define MACH_SEND_MSG 0x00000001 #define MACH_RCV_MSG 0x00000002 #define MACH_RCV_LARGE 0x00000004 /* report large message sizes */ #define MACH_RCV_LARGE_IDENTITY 0x00000008 /* identify source of large messages */ #define MACH_SEND_TIMEOUT 0x00000010 /* timeout value applies to send */ #define MACH_SEND_OVERRIDE 0x00000020 /* priority override for send */ #define MACH_SEND_INTERRUPT 0x00000040 /* don't restart interrupted sends */ #define MACH_SEND_NOTIFY 0x00000080 /* arm send-possible notify */ #define MACH_SEND_ALWAYS 0x00010000 /* ignore qlimits - kernel only */ #define MACH_SEND_FILTER_NONFATAL 0x00010000 /* rejection by message filter should return failure - user only */ #define MACH_SEND_TRAILER 0x00020000 /* sender-provided trailer */ #define MACH_SEND_NOIMPORTANCE 0x00040000 /* msg won't carry importance */ #define MACH_SEND_NODENAP MACH_SEND_NOIMPORTANCE #define MACH_SEND_IMPORTANCE 0x00080000 /* msg carries importance - kernel only */ #define MACH_SEND_SYNC_OVERRIDE 0x00100000 /* msg should do sync IPC override (on legacy kernels) */ #define MACH_SEND_PROPAGATE_QOS 0x00200000 /* IPC should propagate the caller's QoS */ #define MACH_SEND_SYNC_USE_THRPRI MACH_SEND_PROPAGATE_QOS /* obsolete name */ #define MACH_SEND_KERNEL 0x00400000 /* full send from kernel space - kernel only */ #define MACH_SEND_SYNC_BOOTSTRAP_CHECKIN 0x00800000 /* special reply port should boost thread doing sync bootstrap checkin */ #define MACH_RCV_TIMEOUT 0x00000100 /* timeout value applies to receive */ #define MACH_RCV_NOTIFY 0x00000000 /* legacy name (value was: 0x00000200) */ #define MACH_RCV_INTERRUPT 0x00000400 /* don't restart interrupted receive */ #define MACH_RCV_VOUCHER 0x00000800 /* willing to receive voucher port */ #define MACH_RCV_OVERWRITE 0x00000000 /* scatter receive (deprecated) */ #define MACH_RCV_GUARDED_DESC 0x00001000 /* Can receive new guarded descriptor */ #define MACH_RCV_SYNC_WAIT 0x00004000 /* sync waiter waiting for rcv */ #define MACH_RCV_SYNC_PEEK 0x00008000 /* sync waiter waiting to peek */ #define MACH_MSG_STRICT_REPLY 0x00000200 /* Enforce specific properties about the reply port, and * the context in which a thread replies to a message. * This flag must be passed on both the SEND and RCV */ #if PRIVATE __options_decl(mach_msg_option64_t, uint64_t, { MACH64_MSG_OPTION_NONE = 0x0ull, /* share lower 32 bits with mach_msg_option_t */ MACH64_SEND_MSG = MACH_SEND_MSG, MACH64_RCV_MSG = MACH_RCV_MSG, MACH64_RCV_LARGE = MACH_RCV_LARGE, MACH64_RCV_LARGE_IDENTITY = MACH_RCV_LARGE_IDENTITY, MACH64_SEND_TIMEOUT = MACH_SEND_TIMEOUT, MACH64_SEND_OVERRIDE = MACH_SEND_OVERRIDE, MACH64_SEND_INTERRUPT = MACH_SEND_INTERRUPT, MACH64_SEND_NOTIFY = MACH_SEND_NOTIFY, #if KERNEL MACH64_SEND_ALWAYS = MACH_SEND_ALWAYS, MACH64_SEND_IMPORTANCE = MACH_SEND_IMPORTANCE, MACH64_SEND_KERNEL = MACH_SEND_KERNEL, #endif MACH64_SEND_FILTER_NONFATAL = MACH_SEND_FILTER_NONFATAL, MACH64_SEND_TRAILER = MACH_SEND_TRAILER, MACH64_SEND_NOIMPORTANCE = MACH_SEND_NOIMPORTANCE, MACH64_SEND_NODENAP = MACH_SEND_NODENAP, MACH64_SEND_SYNC_OVERRIDE = MACH_SEND_SYNC_OVERRIDE, MACH64_SEND_PROPAGATE_QOS = MACH_SEND_PROPAGATE_QOS, MACH64_SEND_SYNC_BOOTSTRAP_CHECKIN = MACH_SEND_SYNC_BOOTSTRAP_CHECKIN, MACH64_RCV_TIMEOUT = MACH_RCV_TIMEOUT, MACH64_RCV_INTERRUPT = MACH_RCV_INTERRUPT, MACH64_RCV_VOUCHER = MACH_RCV_VOUCHER, MACH64_RCV_GUARDED_DESC = MACH_RCV_GUARDED_DESC, MACH64_RCV_SYNC_WAIT = MACH_RCV_SYNC_WAIT, MACH64_RCV_SYNC_PEEK = MACH_RCV_SYNC_PEEK, MACH64_MSG_STRICT_REPLY = MACH_MSG_STRICT_REPLY, /* following options are 64 only */ /* Send and receive message as vectors */ MACH64_MSG_VECTOR = 0x0000000100000000ull, /* The message is a kobject call */ MACH64_SEND_KOBJECT_CALL = 0x0000000200000000ull, /* The message is sent to a message queue */ MACH64_SEND_MQ_CALL = 0x0000000400000000ull, /* This message destination is unknown. Used by old simulators only. */ MACH64_SEND_ANY = 0x0000000800000000ull, /* This message is a DriverKit call */ MACH64_SEND_DK_CALL = 0x0000001000000000ull, #ifdef XNU_KERNEL_PRIVATE MACH64_POLICY_KERNEL_EXTENSION = 0x0000002000000000ull, MACH64_POLICY_FILTER_NON_FATAL = 0x0000004000000000ull, MACH64_POLICY_FILTER_MSG = 0x0000008000000000ull, /* * Policy for the mach_msg2_trap() call * `MACH64_POLICY_MASK` holds an ipc_space_policy_t bitfield, shifted. */ MACH64_POLICY_DEFAULT = 0x0000010000000000ull, /* IPC_SPACE_POLICY_DEFAULT */ MACH64_POLICY_ENHANCED = 0x0000020000000000ull, /* IPC_SPACE_POLICY_ENHANCED */ MACH64_POLICY_PLATFORM = 0x0000040000000000ull, /* IPC_SPACE_POLICY_PLATFORM */ MACH64_POLICY_CONTAINED = 0x0000080000000000ull, /* IPC_SPACE_POLICY_CONTAINED */ MACH64_POLICY_KERNEL = 0x0000100000000000ull, /* IPC_SPACE_POLICY_KERNEL */ #if XNU_TARGET_OS_OSX MACH64_POLICY_SIMULATED = 0x0000200000000000ull, /* IPC_SPACE_POLICY_SIMULATED */ #else MACH64_POLICY_SIMULATED = 0x0000000000000000ull, /* IPC_SPACE_POLICY_SIMULATED */ #endif #if CONFIG_ROSETTA MACH64_POLICY_TRANSLATED = 0x0000400000000000ull, /* IPC_SPACE_POLICY_TRANSLATED */ #else MACH64_POLICY_TRANSLATED = 0x0000000000000000ull, /* IPC_SPACE_POLICY_TRANSLATED */ #endif #if XNU_TARGET_OS_OSX MACH64_POLICY_OPTED_OUT = 0x0000800000000000ull, /* IPC_SPACE_POLICY_OPTED_OUT */ #else MACH64_POLICY_OPTED_OUT = 0x0000000000000000ull, /* IPC_SPACE_POLICY_OPTED_OUT */ #endif MACH64_POLICY_ENHANCED_V0 = 0x0001000000000000ull, /* DEPRECATED - includes macos hardened runtime */ MACH64_POLICY_ENHANCED_V1 = 0x0002000000000000ull, /* ES features exposed to 3P in FY2024 release */ MACH64_POLICY_ENHANCED_V2 = 0x0003000000000000ull, /* ES features exposed to 3P in FY2025 release */ MACH64_POLICY_ENHANCED_V3 = 0x0004000000000000ull, /* ES features exposed to 3P in FY2026 release */ MACH64_POLICY_ENHANCED_VERSION_MASK = ( MACH64_POLICY_ENHANCED_V0 | /* IPC_SPACE_POLICY_ENHANCED_V0 */ MACH64_POLICY_ENHANCED_V1 | /* IPC_SPACE_POLICY_ENHANCED_V1 */ MACH64_POLICY_ENHANCED_V2 | /* IPC_SPACE_POLICY_ENHANCED_V2 */ MACH64_POLICY_ENHANCED_V3 /* IPC_SPACE_POLICY_ENHANCED_V3 */ ), MACH64_POLICY_MASK = ( MACH64_POLICY_DEFAULT | MACH64_POLICY_ENHANCED | MACH64_POLICY_PLATFORM | MACH64_POLICY_CONTAINED | MACH64_POLICY_KERNEL | MACH64_POLICY_SIMULATED | MACH64_POLICY_TRANSLATED | MACH64_POLICY_OPTED_OUT), /* * If kmsg has auxiliary data, append it immediate after the message * and trailer. * * Must be used in conjunction with MACH64_MSG_VECTOR, * only used by kevent() from the kernel. */ MACH64_RCV_LINEAR_VECTOR = 0x1000000000000000ull, /* Receive into highest addr of buffer */ MACH64_RCV_STACK = 0x2000000000000000ull, /* unused = 0x4000000000000000ull, */ /* * This is a mach_msg2() send/receive operation. */ MACH64_MACH_MSG2 = 0x8000000000000000ull #endif /* XNU_KERNEL_PRIVATE */ }); #define MACH64_POLICY_SHIFT __builtin_ctzll(MACH64_POLICY_MASK) /* old spelling */ #define MACH64_SEND_USER_CALL MACH64_SEND_MQ_CALL #endif /* PRIVATE */ /* * NOTE: a 0x00------ RCV mask implies to ask for * a MACH_MSG_TRAILER_FORMAT_0 with 0 Elements, * which is equivalent to a mach_msg_trailer_t. * * XXXMAC: unlike the rest of the MACH_RCV_* flags, MACH_RCV_TRAILER_LABELS * needs its own private bit since we only calculate its fields when absolutely * required. */ #define MACH_RCV_TRAILER_NULL 0 #define MACH_RCV_TRAILER_SEQNO 1 #define MACH_RCV_TRAILER_SENDER 2 #define MACH_RCV_TRAILER_AUDIT 3 #define MACH_RCV_TRAILER_CTX 4 #define MACH_RCV_TRAILER_AV 7 #define MACH_RCV_TRAILER_LABELS 8 #define MACH_RCV_TRAILER_TYPE(x) (((x) & 0xf) << 28) #define MACH_RCV_TRAILER_ELEMENTS(x) (((x) & 0xf) << 24) #define MACH_RCV_TRAILER_MASK ((0xf << 24)) #define GET_RCV_ELEMENTS(y) (((y) >> 24) & 0xf) #ifdef MACH_KERNEL_PRIVATE /* * The options that the kernel honors when passed from user space, not including * user-only options that alias kernel-only options. */ #define MACH_SEND_USER (MACH_SEND_MSG | MACH_SEND_TIMEOUT | \ MACH_SEND_NOTIFY | MACH_SEND_OVERRIDE | \ MACH_SEND_TRAILER | MACH_SEND_NOIMPORTANCE | \ MACH_SEND_SYNC_OVERRIDE | MACH_SEND_PROPAGATE_QOS | \ MACH_SEND_FILTER_NONFATAL | \ MACH_SEND_SYNC_BOOTSTRAP_CHECKIN | \ MACH_MSG_STRICT_REPLY | MACH_RCV_GUARDED_DESC) #define MACH_RCV_USER (MACH_RCV_MSG | MACH_RCV_TIMEOUT | \ MACH_RCV_LARGE | MACH_RCV_LARGE_IDENTITY | \ MACH_RCV_VOUCHER | MACH_RCV_TRAILER_MASK | \ MACH_RCV_SYNC_WAIT | MACH_RCV_SYNC_PEEK | \ MACH_RCV_GUARDED_DESC | MACH_MSG_STRICT_REPLY) #define MACH64_MSG_OPTION_CFI_MASK (MACH64_SEND_KOBJECT_CALL | MACH64_SEND_MQ_CALL | \ MACH64_SEND_ANY | MACH64_SEND_DK_CALL) #define MACH64_RCV_USER (MACH_RCV_USER | MACH64_MSG_VECTOR) #define MACH_MSG_OPTION_USER (MACH_SEND_USER | MACH_RCV_USER) #define MACH64_MSG_OPTION_USER (MACH64_SEND_USER | MACH64_RCV_USER) #define MACH64_SEND_USER (MACH_SEND_USER | MACH64_MSG_VECTOR | \ MACH64_MSG_OPTION_CFI_MASK) /* The options implemented by the library interface to mach_msg et. al. */ #define MACH_MSG_OPTION_LIB (MACH_SEND_INTERRUPT | MACH_RCV_INTERRUPT) #define MACH_RCV_WITH_STRICT_REPLY(_opts) (((_opts) & (MACH_MSG_STRICT_REPLY | MACH_RCV_MSG)) == \ (MACH_MSG_STRICT_REPLY | MACH_RCV_MSG)) #endif /* MACH_KERNEL_PRIVATE */ #ifdef XNU_KERNEL_PRIVATE /* * Default options to use when sending from the kernel. * * Until we are sure of its effects, we are disabling * importance donation from the kernel-side of user * threads in importance-donating tasks. * (11938665 & 23925818) */ #define MACH_SEND_KERNEL_DEFAULT \ (mach_msg_option64_t)(MACH_SEND_MSG | MACH_SEND_ALWAYS | MACH_SEND_NOIMPORTANCE) #define MACH_SEND_KERNEL_IMPORTANCE \ (mach_msg_option64_t)(MACH_SEND_MSG | MACH_SEND_ALWAYS | MACH_SEND_IMPORTANCE) #endif /* XNU_KERNEL_PRIVATE */ /* * XXXMAC: note that in the case of MACH_RCV_TRAILER_LABELS, * we just fall through to mach_msg_max_trailer_t. * This is correct behavior since mach_msg_max_trailer_t is defined as * mac_msg_mac_trailer_t which is used for the LABELS trailer. * It also makes things work properly if MACH_RCV_TRAILER_LABELS is ORed * with one of the other options. */ #define REQUESTED_TRAILER_SIZE_NATIVE(y) \ ((mach_msg_trailer_size_t) \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_NULL) ? \ sizeof(mach_msg_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SEQNO) ? \ sizeof(mach_msg_seqno_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SENDER) ? \ sizeof(mach_msg_security_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AUDIT) ? \ sizeof(mach_msg_audit_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_CTX) ? \ sizeof(mach_msg_context_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AV) ? \ sizeof(mach_msg_mac_trailer_t) : \ sizeof(mach_msg_max_trailer_t)))))))) #ifdef XNU_KERNEL_PRIVATE #if defined(__arm64__) #define REQUESTED_TRAILER_SIZE(is64, y) \ ((mach_msg_trailer_size_t) \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_NULL) ? \ sizeof(mach_msg_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SEQNO) ? \ sizeof(mach_msg_seqno_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SENDER) ? \ sizeof(mach_msg_security_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AUDIT) ? \ sizeof(mach_msg_audit_trailer_t) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_CTX) ? \ ((is64) ? sizeof(mach_msg_context_trailer64_t) : sizeof(mach_msg_context_trailer32_t)) : \ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AV) ? \ ((is64) ? sizeof(mach_msg_mac_trailer64_t) : sizeof(mach_msg_mac_trailer32_t)) : \ sizeof(mach_msg_max_trailer_t)))))))) #else #define REQUESTED_TRAILER_SIZE(is64, y) REQUESTED_TRAILER_SIZE_NATIVE(y) #endif #else /* XNU_KERNEL_PRIVATE */ #define REQUESTED_TRAILER_SIZE(y) REQUESTED_TRAILER_SIZE_NATIVE(y) #endif /* XNU_KERNEL_PRIVATE */ /* * Much code assumes that mach_msg_return_t == kern_return_t. * This definition is useful for descriptive purposes. * * See <mach/error.h> for the format of error codes. * IPC errors are system 4. Send errors are subsystem 0; * receive errors are subsystem 1. The code field is always non-zero. * The high bits of the code field communicate extra information * for some error codes. MACH_MSG_MASK masks off these special bits. */ typedef kern_return_t mach_msg_return_t; #define MACH_MSG_SUCCESS 0x00000000 #define MACH_MSG_MASK 0x00003e00 /* All special error code bits defined below. */ #define MACH_MSG_IPC_SPACE 0x00002000 /* No room in IPC name space for another capability name. */ #define MACH_MSG_VM_SPACE 0x00001000 /* No room in VM address space for out-of-line memory. */ #define MACH_MSG_IPC_KERNEL 0x00000800 /* Kernel resource shortage handling an IPC capability. */ #define MACH_MSG_VM_KERNEL 0x00000400 /* Kernel resource shortage handling out-of-line memory. */ #define MACH_SEND_IN_PROGRESS 0x10000001 /* Thread is waiting to send. (Internal use only.) */ #define MACH_SEND_INVALID_DATA 0x10000002 /* Bogus in-line data. */ #define MACH_SEND_INVALID_DEST 0x10000003 /* Bogus destination port. */ #define MACH_SEND_TIMED_OUT 0x10000004 /* Message not sent before timeout expired. */ #define MACH_SEND_INVALID_VOUCHER 0x10000005 /* Bogus voucher port. */ #define MACH_SEND_INTERRUPTED 0x10000007 /* Software interrupt. */ #define MACH_SEND_MSG_TOO_SMALL 0x10000008 /* Data doesn't contain a complete message. */ #define MACH_SEND_INVALID_REPLY 0x10000009 /* Bogus reply port. */ #define MACH_SEND_INVALID_RIGHT 0x1000000a /* Bogus port rights in the message body. */ #define MACH_SEND_INVALID_NOTIFY 0x1000000b /* Bogus notify port argument. */ #define MACH_SEND_INVALID_MEMORY 0x1000000c /* Invalid out-of-line memory pointer. */ #define MACH_SEND_NO_BUFFER 0x1000000d /* No message buffer is available. */ #define MACH_SEND_TOO_LARGE 0x1000000e /* Send is too large for port */ #define MACH_SEND_INVALID_TYPE 0x1000000f /* Invalid msg-type specification. */ #define MACH_SEND_INVALID_HEADER 0x10000010 /* A field in the header had a bad value. */ #define MACH_SEND_INVALID_TRAILER 0x10000011 /* The trailer to be sent does not match kernel format. */ #define MACH_SEND_INVALID_CONTEXT 0x10000012 /* The sending thread context did not match the context on the dest port */ #define MACH_SEND_INVALID_OPTIONS 0x10000013 /* Send options are invalid. */ #define MACH_SEND_INVALID_RT_OOL_SIZE 0x10000015 /* compatibility: no longer a returned error */ #define MACH_SEND_NO_GRANT_DEST 0x10000016 /* compatibility: no longer a returned error */ #define MACH_SEND_MSG_FILTERED 0x10000017 /* Message send was rejected by message filter */ #define MACH_SEND_AUX_TOO_SMALL 0x10000018 /* Message auxiliary data is too small */ #define MACH_SEND_AUX_TOO_LARGE 0x10000019 /* Message auxiliary data is too large */ #define MACH_RCV_IN_PROGRESS 0x10004001 /* Thread is waiting for receive. (Internal use only.) */ #define MACH_RCV_INVALID_NAME 0x10004002 /* Bogus name for receive port/port-set. */ #define MACH_RCV_TIMED_OUT 0x10004003 /* Didn't get a message within the timeout value. */ #define MACH_RCV_TOO_LARGE 0x10004004 /* Message buffer is not large enough for inline data. */ #define MACH_RCV_INTERRUPTED 0x10004005 /* Software interrupt. */ #define MACH_RCV_PORT_CHANGED 0x10004006 /* compatibility: no longer a returned error */ #define MACH_RCV_INVALID_NOTIFY 0x10004007 /* Bogus notify port argument. */ #define MACH_RCV_INVALID_DATA 0x10004008 /* Bogus message buffer for inline data. */ #define MACH_RCV_PORT_DIED 0x10004009 /* Port/set was sent away/died during receive. */ #define MACH_RCV_IN_SET 0x1000400a /* compatibility: no longer a returned error */ #define MACH_RCV_HEADER_ERROR 0x1000400b /* Error receiving message header. See special bits. */ #define MACH_RCV_BODY_ERROR 0x1000400c /* Error receiving message body. See special bits. */ #define MACH_RCV_INVALID_TYPE 0x1000400d /* Invalid msg-type specification in scatter list. */ #define MACH_RCV_SCATTER_SMALL 0x1000400e /* Out-of-line overwrite region is not large enough */ #define MACH_RCV_INVALID_TRAILER 0x1000400f /* trailer type or number of trailer elements not supported */ #define MACH_RCV_IN_PROGRESS_TIMED 0x10004011 /* Waiting for receive with timeout. (Internal use only.) */ #define MACH_RCV_INVALID_REPLY 0x10004012 /* invalid reply port used in a STRICT_REPLY message */ #define MACH_RCV_INVALID_ARGUMENTS 0x10004013 /* invalid receive arguments, receive has not started */ __BEGIN_DECLS /* * Routine: mach_msg_overwrite * Purpose: * Send and/or receive a message. If the message operation * is interrupted, and the user did not request an indication * of that fact, then restart the appropriate parts of the * operation silently (trap version does not restart). * * Distinct send and receive buffers may be specified. If * no separate receive buffer is specified, the msg parameter * will be used for both send and receive operations. * * In addition to a distinct receive buffer, that buffer may * already contain scatter control information to direct the * receiving of the message. */ __WATCHOS_PROHIBITED __TVOS_PROHIBITED extern mach_msg_return_t mach_msg_overwrite( mach_msg_header_t *msg, mach_msg_option_t option, mach_msg_size_t send_size, mach_msg_size_t rcv_size, mach_port_name_t rcv_name, mach_msg_timeout_t timeout, mach_port_name_t notify, mach_msg_header_t *rcv_msg, mach_msg_size_t rcv_limit); #ifndef KERNEL /* * Routine: mach_msg * Purpose: * Send and/or receive a message. If the message operation * is interrupted, and the user did not request an indication * of that fact, then restart the appropriate parts of the * operation silently (trap version does not restart). */ __WATCHOS_PROHIBITED __TVOS_PROHIBITED extern mach_msg_return_t mach_msg( mach_msg_header_t *msg, mach_msg_option_t option, mach_msg_size_t send_size, mach_msg_size_t rcv_size, mach_port_name_t rcv_name, mach_msg_timeout_t timeout, mach_port_name_t notify); #if PRIVATE #if defined(__LP64__) || defined(__arm64__) __API_AVAILABLE(macos(13.0), ios(16.0), tvos(16.0), watchos(9.0)) __IOS_PROHIBITED __WATCHOS_PROHIBITED __TVOS_PROHIBITED extern mach_msg_return_t mach_msg2_internal( void *data, mach_msg_option64_t option64, uint64_t msgh_bits_and_send_size, uint64_t msgh_remote_and_local_port, uint64_t msgh_voucher_and_id, uint64_t desc_count_and_rcv_name, uint64_t rcv_size_and_priority, uint64_t timeout); __API_AVAILABLE(macos(13.0), ios(16.0), tvos(16.0), watchos(9.0)) __IOS_PROHIBITED __WATCHOS_PROHIBITED __TVOS_PROHIBITED static inline mach_msg_return_t mach_msg2( void *data, mach_msg_option64_t option64, mach_msg_header_t header, mach_msg_size_t send_size, mach_msg_size_t rcv_size, mach_port_t rcv_name, uint64_t timeout, uint32_t priority) { mach_msg_base_t *base; mach_msg_size_t descriptors; if (option64 & MACH64_MSG_VECTOR) { base = (mach_msg_base_t *)((mach_msg_vector_t *)data)->msgv_data; } else { base = (mach_msg_base_t *)data; } if ((option64 & MACH64_SEND_MSG) && (base->header.msgh_bits & MACH_MSGH_BITS_COMPLEX)) { descriptors = base->body.msgh_descriptor_count; } else { descriptors = 0; } #define MACH_MSG2_SHIFT_ARGS(lo, hi) ((uint64_t)hi << 32 | (uint32_t)lo) return mach_msg2_internal(data, option64, MACH_MSG2_SHIFT_ARGS(header.msgh_bits, send_size), MACH_MSG2_SHIFT_ARGS(header.msgh_remote_port, header.msgh_local_port), MACH_MSG2_SHIFT_ARGS(header.msgh_voucher_port, header.msgh_id), MACH_MSG2_SHIFT_ARGS(descriptors, rcv_name), MACH_MSG2_SHIFT_ARGS(rcv_size, priority), timeout); #undef MACH_MSG2_SHIFT_ARGS } #endif #endif /* PRIVATE */ /* * Routine: mach_voucher_deallocate * Purpose: * Deallocate a mach voucher created or received in a message. Drops * one (send right) reference to the voucher. */ __WATCHOS_PROHIBITED __TVOS_PROHIBITED extern kern_return_t mach_voucher_deallocate( mach_port_name_t voucher); #elif defined(MACH_KERNEL_PRIVATE) /*! * @typedef mach_msg_send_uctx_t * * @brief * Data structure used for the send half of a @c mach_msg() call from userspace. * * @discussion * Callers must fill the @c send_header, @c send_dsc_count with the user header * being sent, as well as the parameters of user buffers used for send * (@c send_{msg,aux}_{addr,size}). * * @field send_header a copy of the user header being sent. * @field send_dsc_count the number of descriptors being sent. * must be 0 if the header doesn't have * the MACH_MSGH_BITS_COMPLEX bit set. * @field send_msg_addr the userspace address for the message being sent. * @field send_msg_size the size of the message being sent. * @field send_aux_addr the userspace address for the auxiliary data * being sent (will be 0 if not using a vector * operation) * @field send_aux_size the size for the auxiliary data being sent. * * @field send_dsc_mask internal field being used during right copyin * of descriptors. * @field send_dsc_usize the size (in bytes) of the user representation * of descriptors being sent. * @field send_dsc_port_count number of ports being sent in descriptors * (both in port or port array descriptors). * @field send_dsc_inline_port_count number of inline ports being sent in descriptors * @field send_dsc_vm_size kernel wired memory (not counting port arrays) * needed to copyin this message. */ typedef struct { /* send context/arguments */ mach_msg_user_header_t send_header; mach_msg_size_t send_dsc_count; mach_vm_address_t send_msg_addr; mach_vm_address_t send_aux_addr; mach_msg_size_t send_msg_size; mach_msg_size_t send_aux_size; /* filled by copyin */ uint64_t send_dsc_mask; mach_msg_size_t send_dsc_usize; mach_msg_size_t send_dsc_inline_port_count; mach_msg_size_t send_dsc_port_count; vm_size_t send_dsc_vm_size; mach_msg_size_t send_dsc_port_arrays_count; } mach_msg_send_uctx_t; xnu_static_assert_struct_size(mach_msg_send_uctx_t, 96); /*! * @typedef mach_msg_recv_bufs_t * * @brief * Data structure representing the buffers being used by userspace to receive * a message. * * @field recv_msg_addr the userspace address for the message * receive buffer. * @field recv_msg_size the size of the message receive buffer. * * @field recv_aux_addr the userspace address for the auxiliary data * receive buffer (will be 0 if not using a vector * operation) * @field recv_aux_size the size for the auxiliary data receive buffer. */ typedef struct { mach_vm_address_t recv_msg_addr; mach_vm_address_t recv_aux_addr; mach_msg_size_t recv_msg_size; mach_msg_size_t recv_aux_size; } mach_msg_recv_bufs_t; xnu_static_assert_struct_size(mach_msg_recv_bufs_t, 24); /*! * @typedef mach_msg_recv_result_t * * @brief * Data structure representing the results of a receive operation, * in the context of the user task receiving that message. * * @field msgr_msg_size the user size of the message being copied out * (not including trailer or auxiliary data). * set for MACH_RCV_TOO_LARGE or MACH_MSG_SUCCESS, * 0 otherwise. * * @field msgr_trailer_size the trailer size of the message being copied out. * set MACH_MSG_SUCCESS, 0 otherwise. * * @field msgr_aux_size the auxiliary data size of the message being * copied out. * set for MACH_RCV_TOO_LARGE or MACH_MSG_SUCCESS, * 0 otherwise. * * @field msgr_recv_name the name of the port receiving the message. * Set for MACH_RCV_TOO_LARGE, * or to MSGR_PSEUDO_RECEIVE for pseudo-receive. * * @field msgr_seqno the sequence number for the message being * received. * * @field msgr_context the mach port context fort the port receiving * the message. * * @field msgr_priority the pthread priority of the message being * received. * * @field msgr_qos_ovrd the qos override for the message being received. */ typedef struct { /* general info about the message being copied out */ mach_msg_size_t msgr_msg_size; mach_msg_size_t msgr_trailer_size; mach_msg_size_t msgr_aux_size; #define MSGR_PSEUDO_RECEIVE (0xfffffffe) mach_port_name_t msgr_recv_name; mach_port_seqno_t msgr_seqno; mach_port_context_t msgr_context; /* metadata for the sake of kevent only */ uint32_t msgr_priority; mach_msg_qos_t msgr_qos_ovrd; } mach_msg_recv_result_t; xnu_static_assert_struct_size(mach_msg_recv_result_t, 40); extern mach_msg_return_t mach_msg_receive_results( mach_msg_recv_result_t *msg); /* out only, can be NULL */ #endif /* KERNEL */ __END_DECLS #endif /* _MACH_MESSAGE_H_ */ |