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 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141
|
// SPDX-License-Identifier: GPL-2.0-or-later
#define _GNU_SOURCE
#include "../kselftest_harness.h"
#include <asm-generic/mman.h> /* Force the import of the tools version. */
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <linux/limits.h>
#include <linux/userfaultfd.h>
#include <linux/fs.h>
#include <setjmp.h>
#include <signal.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <sys/mman.h>
#include <sys/syscall.h>
#include <sys/uio.h>
#include <unistd.h>
#include "vm_util.h"
#include "../pidfd/pidfd.h"
/*
* Ignore the checkpatch warning, as per the C99 standard, section 7.14.1.1:
*
* "If the signal occurs other than as the result of calling the abort or raise
* function, the behavior is undefined if the signal handler refers to any
* object with static storage duration other than by assigning a value to an
* object declared as volatile sig_atomic_t"
*/
static volatile sig_atomic_t signal_jump_set;
static sigjmp_buf signal_jmp_buf;
/*
* How is the test backing the mapping being tested?
*/
enum backing_type {
ANON_BACKED,
SHMEM_BACKED,
LOCAL_FILE_BACKED,
};
FIXTURE(guard_regions)
{
unsigned long page_size;
char path[PATH_MAX];
int fd;
};
FIXTURE_VARIANT(guard_regions)
{
enum backing_type backing;
};
FIXTURE_VARIANT_ADD(guard_regions, anon)
{
.backing = ANON_BACKED,
};
FIXTURE_VARIANT_ADD(guard_regions, shmem)
{
.backing = SHMEM_BACKED,
};
FIXTURE_VARIANT_ADD(guard_regions, file)
{
.backing = LOCAL_FILE_BACKED,
};
static bool is_anon_backed(const FIXTURE_VARIANT(guard_regions) * variant)
{
switch (variant->backing) {
case ANON_BACKED:
case SHMEM_BACKED:
return true;
default:
return false;
}
}
static void *mmap_(FIXTURE_DATA(guard_regions) * self,
const FIXTURE_VARIANT(guard_regions) * variant,
void *addr, size_t length, int prot, int extra_flags,
off_t offset)
{
int fd;
int flags = extra_flags;
switch (variant->backing) {
case ANON_BACKED:
flags |= MAP_PRIVATE | MAP_ANON;
fd = -1;
break;
case SHMEM_BACKED:
case LOCAL_FILE_BACKED:
flags |= MAP_SHARED;
fd = self->fd;
break;
default:
ksft_exit_fail();
break;
}
return mmap(addr, length, prot, flags, fd, offset);
}
static int userfaultfd(int flags)
{
return syscall(SYS_userfaultfd, flags);
}
static void handle_fatal(int c)
{
if (!signal_jump_set)
return;
siglongjmp(signal_jmp_buf, c);
}
static ssize_t sys_process_madvise(int pidfd, const struct iovec *iovec,
size_t n, int advice, unsigned int flags)
{
return syscall(__NR_process_madvise, pidfd, iovec, n, advice, flags);
}
/*
* Enable our signal catcher and try to read/write the specified buffer. The
* return value indicates whether the read/write succeeds without a fatal
* signal.
*/
static bool try_access_buf(char *ptr, bool write)
{
bool failed;
/* Tell signal handler to jump back here on fatal signal. */
signal_jump_set = true;
/* If a fatal signal arose, we will jump back here and failed is set. */
failed = sigsetjmp(signal_jmp_buf, 0) != 0;
if (!failed) {
if (write)
*ptr = 'x';
else
FORCE_READ(*ptr);
}
signal_jump_set = false;
return !failed;
}
/* Try and read from a buffer, return true if no fatal signal. */
static bool try_read_buf(char *ptr)
{
return try_access_buf(ptr, false);
}
/* Try and write to a buffer, return true if no fatal signal. */
static bool try_write_buf(char *ptr)
{
return try_access_buf(ptr, true);
}
/*
* Try and BOTH read from AND write to a buffer, return true if BOTH operations
* succeed.
*/
static bool try_read_write_buf(char *ptr)
{
return try_read_buf(ptr) && try_write_buf(ptr);
}
static void setup_sighandler(void)
{
struct sigaction act = {
.sa_handler = &handle_fatal,
.sa_flags = SA_NODEFER,
};
sigemptyset(&act.sa_mask);
if (sigaction(SIGSEGV, &act, NULL))
ksft_exit_fail_perror("sigaction");
}
static void teardown_sighandler(void)
{
struct sigaction act = {
.sa_handler = SIG_DFL,
.sa_flags = SA_NODEFER,
};
sigemptyset(&act.sa_mask);
sigaction(SIGSEGV, &act, NULL);
}
static int open_file(const char *prefix, char *path)
{
int fd;
snprintf(path, PATH_MAX, "%sguard_regions_test_file_XXXXXX", prefix);
fd = mkstemp(path);
if (fd < 0)
ksft_exit_fail_perror("mkstemp");
return fd;
}
/* Establish a varying pattern in a buffer. */
static void set_pattern(char *ptr, size_t num_pages, size_t page_size)
{
size_t i;
for (i = 0; i < num_pages; i++) {
char *ptr2 = &ptr[i * page_size];
memset(ptr2, 'a' + (i % 26), page_size);
}
}
/*
* Check that a buffer contains the pattern set by set_pattern(), starting at a
* page offset of pgoff within the buffer.
*/
static bool check_pattern_offset(char *ptr, size_t num_pages, size_t page_size,
size_t pgoff)
{
size_t i;
for (i = 0; i < num_pages * page_size; i++) {
size_t offset = pgoff * page_size + i;
char actual = ptr[offset];
char expected = 'a' + ((offset / page_size) % 26);
if (actual != expected)
return false;
}
return true;
}
/* Check that a buffer contains the pattern set by set_pattern(). */
static bool check_pattern(char *ptr, size_t num_pages, size_t page_size)
{
return check_pattern_offset(ptr, num_pages, page_size, 0);
}
/* Determine if a buffer contains only repetitions of a specified char. */
static bool is_buf_eq(char *buf, size_t size, char chr)
{
size_t i;
for (i = 0; i < size; i++) {
if (buf[i] != chr)
return false;
}
return true;
}
FIXTURE_SETUP(guard_regions)
{
self->page_size = (unsigned long)sysconf(_SC_PAGESIZE);
setup_sighandler();
switch (variant->backing) {
case ANON_BACKED:
return;
case LOCAL_FILE_BACKED:
self->fd = open_file("", self->path);
break;
case SHMEM_BACKED:
self->fd = memfd_create(self->path, 0);
break;
}
/* We truncate file to at least 100 pages, tests can modify as needed. */
ASSERT_EQ(ftruncate(self->fd, 100 * self->page_size), 0);
};
FIXTURE_TEARDOWN_PARENT(guard_regions)
{
teardown_sighandler();
if (variant->backing == ANON_BACKED)
return;
if (self->fd >= 0)
close(self->fd);
if (self->path[0] != '\0')
unlink(self->path);
}
TEST_F(guard_regions, basic)
{
const unsigned long NUM_PAGES = 10;
const unsigned long page_size = self->page_size;
char *ptr;
int i;
ptr = mmap_(self, variant, NULL, NUM_PAGES * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Trivially assert we can touch the first page. */
ASSERT_TRUE(try_read_write_buf(ptr));
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
/* Establish that 1st page SIGSEGV's. */
ASSERT_FALSE(try_read_write_buf(ptr));
/* Ensure we can touch everything else.*/
for (i = 1; i < NUM_PAGES; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Establish a guard page at the end of the mapping. */
ASSERT_EQ(madvise(&ptr[(NUM_PAGES - 1) * page_size], page_size,
MADV_GUARD_INSTALL), 0);
/* Check that both guard pages result in SIGSEGV. */
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[(NUM_PAGES - 1) * page_size]));
/* Remove the first guard page. */
ASSERT_FALSE(madvise(ptr, page_size, MADV_GUARD_REMOVE));
/* Make sure we can touch it. */
ASSERT_TRUE(try_read_write_buf(ptr));
/* Remove the last guard page. */
ASSERT_FALSE(madvise(&ptr[(NUM_PAGES - 1) * page_size], page_size,
MADV_GUARD_REMOVE));
/* Make sure we can touch it. */
ASSERT_TRUE(try_read_write_buf(&ptr[(NUM_PAGES - 1) * page_size]));
/*
* Test setting a _range_ of pages, namely the first 3. The first of
* these be faulted in, so this also tests that we can install guard
* pages over backed pages.
*/
ASSERT_EQ(madvise(ptr, 3 * page_size, MADV_GUARD_INSTALL), 0);
/* Make sure they are all guard pages. */
for (i = 0; i < 3; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Make sure the rest are not. */
for (i = 3; i < NUM_PAGES; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Remove guard pages. */
ASSERT_EQ(madvise(ptr, NUM_PAGES * page_size, MADV_GUARD_REMOVE), 0);
/* Now make sure we can touch everything. */
for (i = 0; i < NUM_PAGES; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/*
* Now remove all guard pages, make sure we don't remove existing
* entries.
*/
ASSERT_EQ(madvise(ptr, NUM_PAGES * page_size, MADV_GUARD_REMOVE), 0);
for (i = 0; i < NUM_PAGES * page_size; i += page_size) {
char chr = ptr[i];
ASSERT_EQ(chr, 'x');
}
ASSERT_EQ(munmap(ptr, NUM_PAGES * page_size), 0);
}
/* Assert that operations applied across multiple VMAs work as expected. */
TEST_F(guard_regions, multi_vma)
{
const unsigned long page_size = self->page_size;
char *ptr_region, *ptr, *ptr1, *ptr2, *ptr3;
int i;
/* Reserve a 100 page region over which we can install VMAs. */
ptr_region = mmap_(self, variant, NULL, 100 * page_size,
PROT_NONE, 0, 0);
ASSERT_NE(ptr_region, MAP_FAILED);
/* Place a VMA of 10 pages size at the start of the region. */
ptr1 = mmap_(self, variant, ptr_region, 10 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr1, MAP_FAILED);
/* Place a VMA of 5 pages size 50 pages into the region. */
ptr2 = mmap_(self, variant, &ptr_region[50 * page_size], 5 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr2, MAP_FAILED);
/* Place a VMA of 20 pages size at the end of the region. */
ptr3 = mmap_(self, variant, &ptr_region[80 * page_size], 20 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr3, MAP_FAILED);
/* Unmap gaps. */
ASSERT_EQ(munmap(&ptr_region[10 * page_size], 40 * page_size), 0);
ASSERT_EQ(munmap(&ptr_region[55 * page_size], 25 * page_size), 0);
/*
* We end up with VMAs like this:
*
* 0 10 .. 50 55 .. 80 100
* [---] [---] [---]
*/
/*
* Now mark the whole range as guard pages and make sure all VMAs are as
* such.
*/
/*
* madvise() is certifiable and lets you perform operations over gaps,
* everything works, but it indicates an error and errno is set to
* -ENOMEM. Also if anything runs out of memory it is set to
* -ENOMEM. You are meant to guess which is which.
*/
ASSERT_EQ(madvise(ptr_region, 100 * page_size, MADV_GUARD_INSTALL), -1);
ASSERT_EQ(errno, ENOMEM);
for (i = 0; i < 10; i++) {
char *curr = &ptr1[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
for (i = 0; i < 5; i++) {
char *curr = &ptr2[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
for (i = 0; i < 20; i++) {
char *curr = &ptr3[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Now remove guar pages over range and assert the opposite. */
ASSERT_EQ(madvise(ptr_region, 100 * page_size, MADV_GUARD_REMOVE), -1);
ASSERT_EQ(errno, ENOMEM);
for (i = 0; i < 10; i++) {
char *curr = &ptr1[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
for (i = 0; i < 5; i++) {
char *curr = &ptr2[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
for (i = 0; i < 20; i++) {
char *curr = &ptr3[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Now map incompatible VMAs in the gaps. */
ptr = mmap_(self, variant, &ptr_region[10 * page_size], 40 * page_size,
PROT_READ | PROT_WRITE | PROT_EXEC, MAP_FIXED, 0);
ASSERT_NE(ptr, MAP_FAILED);
ptr = mmap_(self, variant, &ptr_region[55 * page_size], 25 * page_size,
PROT_READ | PROT_WRITE | PROT_EXEC, MAP_FIXED, 0);
ASSERT_NE(ptr, MAP_FAILED);
/*
* We end up with VMAs like this:
*
* 0 10 .. 50 55 .. 80 100
* [---][xxxx][---][xxxx][---]
*
* Where 'x' signifies VMAs that cannot be merged with those adjacent to
* them.
*/
/* Multiple VMAs adjacent to one another should result in no error. */
ASSERT_EQ(madvise(ptr_region, 100 * page_size, MADV_GUARD_INSTALL), 0);
for (i = 0; i < 100; i++) {
char *curr = &ptr_region[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
ASSERT_EQ(madvise(ptr_region, 100 * page_size, MADV_GUARD_REMOVE), 0);
for (i = 0; i < 100; i++) {
char *curr = &ptr_region[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr_region, 100 * page_size), 0);
}
/*
* Assert that batched operations performed using process_madvise() work as
* expected.
*/
TEST_F(guard_regions, process_madvise)
{
const unsigned long page_size = self->page_size;
char *ptr_region, *ptr1, *ptr2, *ptr3;
ssize_t count;
struct iovec vec[6];
/* Reserve region to map over. */
ptr_region = mmap_(self, variant, NULL, 100 * page_size,
PROT_NONE, 0, 0);
ASSERT_NE(ptr_region, MAP_FAILED);
/*
* 10 pages offset 1 page into reserve region. We MAP_POPULATE so we
* overwrite existing entries and test this code path against
* overwriting existing entries.
*/
ptr1 = mmap_(self, variant, &ptr_region[page_size], 10 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED | MAP_POPULATE, 0);
ASSERT_NE(ptr1, MAP_FAILED);
/* We want guard markers at start/end of each VMA. */
vec[0].iov_base = ptr1;
vec[0].iov_len = page_size;
vec[1].iov_base = &ptr1[9 * page_size];
vec[1].iov_len = page_size;
/* 5 pages offset 50 pages into reserve region. */
ptr2 = mmap_(self, variant, &ptr_region[50 * page_size], 5 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr2, MAP_FAILED);
vec[2].iov_base = ptr2;
vec[2].iov_len = page_size;
vec[3].iov_base = &ptr2[4 * page_size];
vec[3].iov_len = page_size;
/* 20 pages offset 79 pages into reserve region. */
ptr3 = mmap_(self, variant, &ptr_region[79 * page_size], 20 * page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr3, MAP_FAILED);
vec[4].iov_base = ptr3;
vec[4].iov_len = page_size;
vec[5].iov_base = &ptr3[19 * page_size];
vec[5].iov_len = page_size;
/* Free surrounding VMAs. */
ASSERT_EQ(munmap(ptr_region, page_size), 0);
ASSERT_EQ(munmap(&ptr_region[11 * page_size], 39 * page_size), 0);
ASSERT_EQ(munmap(&ptr_region[55 * page_size], 24 * page_size), 0);
ASSERT_EQ(munmap(&ptr_region[99 * page_size], page_size), 0);
/* Now guard in one step. */
count = sys_process_madvise(PIDFD_SELF, vec, 6, MADV_GUARD_INSTALL, 0);
/* OK we don't have permission to do this, skip. */
if (count == -1 && errno == EPERM)
SKIP(return, "No process_madvise() permissions, try running as root.\n");
/* Returns the number of bytes advised. */
ASSERT_EQ(count, 6 * page_size);
/* Now make sure the guarding was applied. */
ASSERT_FALSE(try_read_write_buf(ptr1));
ASSERT_FALSE(try_read_write_buf(&ptr1[9 * page_size]));
ASSERT_FALSE(try_read_write_buf(ptr2));
ASSERT_FALSE(try_read_write_buf(&ptr2[4 * page_size]));
ASSERT_FALSE(try_read_write_buf(ptr3));
ASSERT_FALSE(try_read_write_buf(&ptr3[19 * page_size]));
/* Now do the same with unguard... */
count = sys_process_madvise(PIDFD_SELF, vec, 6, MADV_GUARD_REMOVE, 0);
/* ...and everything should now succeed. */
ASSERT_TRUE(try_read_write_buf(ptr1));
ASSERT_TRUE(try_read_write_buf(&ptr1[9 * page_size]));
ASSERT_TRUE(try_read_write_buf(ptr2));
ASSERT_TRUE(try_read_write_buf(&ptr2[4 * page_size]));
ASSERT_TRUE(try_read_write_buf(ptr3));
ASSERT_TRUE(try_read_write_buf(&ptr3[19 * page_size]));
/* Cleanup. */
ASSERT_EQ(munmap(ptr1, 10 * page_size), 0);
ASSERT_EQ(munmap(ptr2, 5 * page_size), 0);
ASSERT_EQ(munmap(ptr3, 20 * page_size), 0);
}
/* Assert that unmapping ranges does not leave guard markers behind. */
TEST_F(guard_regions, munmap)
{
const unsigned long page_size = self->page_size;
char *ptr, *ptr_new1, *ptr_new2;
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard first and last pages. */
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
ASSERT_EQ(madvise(&ptr[9 * page_size], page_size, MADV_GUARD_INSTALL), 0);
/* Assert that they are guarded. */
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[9 * page_size]));
/* Unmap them. */
ASSERT_EQ(munmap(ptr, page_size), 0);
ASSERT_EQ(munmap(&ptr[9 * page_size], page_size), 0);
/* Map over them.*/
ptr_new1 = mmap_(self, variant, ptr, page_size, PROT_READ | PROT_WRITE,
MAP_FIXED, 0);
ASSERT_NE(ptr_new1, MAP_FAILED);
ptr_new2 = mmap_(self, variant, &ptr[9 * page_size], page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr_new2, MAP_FAILED);
/* Assert that they are now not guarded. */
ASSERT_TRUE(try_read_write_buf(ptr_new1));
ASSERT_TRUE(try_read_write_buf(ptr_new2));
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Assert that mprotect() operations have no bearing on guard markers. */
TEST_F(guard_regions, mprotect)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard the middle of the range. */
ASSERT_EQ(madvise(&ptr[5 * page_size], 2 * page_size,
MADV_GUARD_INSTALL), 0);
/* Assert that it is indeed guarded. */
ASSERT_FALSE(try_read_write_buf(&ptr[5 * page_size]));
ASSERT_FALSE(try_read_write_buf(&ptr[6 * page_size]));
/* Now make these pages read-only. */
ASSERT_EQ(mprotect(&ptr[5 * page_size], 2 * page_size, PROT_READ), 0);
/* Make sure the range is still guarded. */
ASSERT_FALSE(try_read_buf(&ptr[5 * page_size]));
ASSERT_FALSE(try_read_buf(&ptr[6 * page_size]));
/* Make sure we can guard again without issue.*/
ASSERT_EQ(madvise(&ptr[5 * page_size], 2 * page_size,
MADV_GUARD_INSTALL), 0);
/* Make sure the range is, yet again, still guarded. */
ASSERT_FALSE(try_read_buf(&ptr[5 * page_size]));
ASSERT_FALSE(try_read_buf(&ptr[6 * page_size]));
/* Now unguard the whole range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Make sure the whole range is readable. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Split and merge VMAs and make sure guard pages still behave. */
TEST_F(guard_regions, split_merge)
{
const unsigned long page_size = self->page_size;
char *ptr, *ptr_new;
int i;
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard the whole range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Make sure the whole range is guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Now unmap some pages in the range so we split. */
ASSERT_EQ(munmap(&ptr[2 * page_size], page_size), 0);
ASSERT_EQ(munmap(&ptr[5 * page_size], page_size), 0);
ASSERT_EQ(munmap(&ptr[8 * page_size], page_size), 0);
/* Make sure the remaining ranges are guarded post-split. */
for (i = 0; i < 2; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
for (i = 2; i < 5; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
for (i = 6; i < 8; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
for (i = 9; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Now map them again - the unmap will have cleared the guards. */
ptr_new = mmap_(self, variant, &ptr[2 * page_size], page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr_new, MAP_FAILED);
ptr_new = mmap_(self, variant, &ptr[5 * page_size], page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr_new, MAP_FAILED);
ptr_new = mmap_(self, variant, &ptr[8 * page_size], page_size,
PROT_READ | PROT_WRITE, MAP_FIXED, 0);
ASSERT_NE(ptr_new, MAP_FAILED);
/* Now make sure guard pages are established. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_write_buf(curr);
bool expect_true = i == 2 || i == 5 || i == 8;
ASSERT_TRUE(expect_true ? result : !result);
}
/* Now guard everything again. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Make sure the whole range is guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Now split the range into three. */
ASSERT_EQ(mprotect(ptr, 3 * page_size, PROT_READ), 0);
ASSERT_EQ(mprotect(&ptr[7 * page_size], 3 * page_size, PROT_READ), 0);
/* Make sure the whole range is guarded for read. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_buf(curr));
}
/* Now reset protection bits so we merge the whole thing. */
ASSERT_EQ(mprotect(ptr, 3 * page_size, PROT_READ | PROT_WRITE), 0);
ASSERT_EQ(mprotect(&ptr[7 * page_size], 3 * page_size,
PROT_READ | PROT_WRITE), 0);
/* Make sure the whole range is still guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Split range into 3 again... */
ASSERT_EQ(mprotect(ptr, 3 * page_size, PROT_READ), 0);
ASSERT_EQ(mprotect(&ptr[7 * page_size], 3 * page_size, PROT_READ), 0);
/* ...and unguard the whole range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Make sure the whole range is remedied for read. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_buf(curr));
}
/* Merge them again. */
ASSERT_EQ(mprotect(ptr, 3 * page_size, PROT_READ | PROT_WRITE), 0);
ASSERT_EQ(mprotect(&ptr[7 * page_size], 3 * page_size,
PROT_READ | PROT_WRITE), 0);
/* Now ensure the merged range is remedied for read/write. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Assert that MADV_DONTNEED does not remove guard markers. */
TEST_F(guard_regions, dontneed)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Back the whole range. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
*curr = 'y';
}
/* Guard every other page. */
for (i = 0; i < 10; i += 2) {
char *curr = &ptr[i * page_size];
int res = madvise(curr, page_size, MADV_GUARD_INSTALL);
ASSERT_EQ(res, 0);
}
/* Indicate that we don't need any of the range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_DONTNEED), 0);
/* Check to ensure guard markers are still in place. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_buf(curr);
if (i % 2 == 0) {
ASSERT_FALSE(result);
} else {
ASSERT_TRUE(result);
switch (variant->backing) {
case ANON_BACKED:
/* If anon, then we get a zero page. */
ASSERT_EQ(*curr, '\0');
break;
default:
/* Otherwise, we get the file data. */
ASSERT_EQ(*curr, 'y');
break;
}
}
/* Now write... */
result = try_write_buf(&ptr[i * page_size]);
/* ...and make sure same result. */
ASSERT_TRUE(i % 2 != 0 ? result : !result);
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Assert that mlock()'ed pages work correctly with guard markers. */
TEST_F(guard_regions, mlock)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Populate. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
*curr = 'y';
}
/* Lock. */
ASSERT_EQ(mlock(ptr, 10 * page_size), 0);
/* Now try to guard, should fail with EINVAL. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), -1);
ASSERT_EQ(errno, EINVAL);
/* OK unlock. */
ASSERT_EQ(munlock(ptr, 10 * page_size), 0);
/* Guard first half of range, should now succeed. */
ASSERT_EQ(madvise(ptr, 5 * page_size, MADV_GUARD_INSTALL), 0);
/* Make sure guard works. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_write_buf(curr);
if (i < 5) {
ASSERT_FALSE(result);
} else {
ASSERT_TRUE(result);
ASSERT_EQ(*curr, 'x');
}
}
/*
* Now lock the latter part of the range. We can't lock the guard pages,
* as this would result in the pages being populated and the guarding
* would cause this to error out.
*/
ASSERT_EQ(mlock(&ptr[5 * page_size], 5 * page_size), 0);
/*
* Now remove guard pages, we permit mlock()'d ranges to have guard
* pages removed as it is a non-destructive operation.
*/
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Now check that no guard pages remain. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Assert that moving, extending and shrinking memory via mremap() retains
* guard markers where possible.
*
* - Moving a mapping alone should retain markers as they are.
*/
TEST_F(guard_regions, mremap_move)
{
const unsigned long page_size = self->page_size;
char *ptr, *ptr_new;
/* Map 5 pages. */
ptr = mmap_(self, variant, NULL, 5 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Place guard markers at both ends of the 5 page span. */
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
ASSERT_EQ(madvise(&ptr[4 * page_size], page_size, MADV_GUARD_INSTALL), 0);
/* Make sure the guard pages are in effect. */
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[4 * page_size]));
/* Map a new region we will move this range into. Doing this ensures
* that we have reserved a range to map into.
*/
ptr_new = mmap_(self, variant, NULL, 5 * page_size, PROT_NONE, 0, 0);
ASSERT_NE(ptr_new, MAP_FAILED);
ASSERT_EQ(mremap(ptr, 5 * page_size, 5 * page_size,
MREMAP_MAYMOVE | MREMAP_FIXED, ptr_new), ptr_new);
/* Make sure the guard markers are retained. */
ASSERT_FALSE(try_read_write_buf(ptr_new));
ASSERT_FALSE(try_read_write_buf(&ptr_new[4 * page_size]));
/*
* Clean up - we only need reference the new pointer as we overwrote the
* PROT_NONE range and moved the existing one.
*/
munmap(ptr_new, 5 * page_size);
}
/*
* Assert that moving, extending and shrinking memory via mremap() retains
* guard markers where possible.
*
* Expanding should retain guard pages, only now in different position. The user
* will have to remove guard pages manually to fix up (they'd have to do the
* same if it were a PROT_NONE mapping).
*/
TEST_F(guard_regions, mremap_expand)
{
const unsigned long page_size = self->page_size;
char *ptr, *ptr_new;
/* Map 10 pages... */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* ...But unmap the last 5 so we can ensure we can expand into them. */
ASSERT_EQ(munmap(&ptr[5 * page_size], 5 * page_size), 0);
/* Place guard markers at both ends of the 5 page span. */
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
ASSERT_EQ(madvise(&ptr[4 * page_size], page_size, MADV_GUARD_INSTALL), 0);
/* Make sure the guarding is in effect. */
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[4 * page_size]));
/* Now expand to 10 pages. */
ptr = mremap(ptr, 5 * page_size, 10 * page_size, 0);
ASSERT_NE(ptr, MAP_FAILED);
/*
* Make sure the guard markers are retained in their original positions.
*/
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[4 * page_size]));
/* Reserve a region which we can move to and expand into. */
ptr_new = mmap_(self, variant, NULL, 20 * page_size, PROT_NONE, 0, 0);
ASSERT_NE(ptr_new, MAP_FAILED);
/* Now move and expand into it. */
ptr = mremap(ptr, 10 * page_size, 20 * page_size,
MREMAP_MAYMOVE | MREMAP_FIXED, ptr_new);
ASSERT_EQ(ptr, ptr_new);
/*
* Again, make sure the guard markers are retained in their original positions.
*/
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[4 * page_size]));
/*
* A real user would have to remove guard markers, but would reasonably
* expect all characteristics of the mapping to be retained, including
* guard markers.
*/
/* Cleanup. */
munmap(ptr, 20 * page_size);
}
/*
* Assert that moving, extending and shrinking memory via mremap() retains
* guard markers where possible.
*
* Shrinking will result in markers that are shrunk over being removed. Again,
* if the user were using a PROT_NONE mapping they'd have to manually fix this
* up also so this is OK.
*/
TEST_F(guard_regions, mremap_shrink)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
/* Map 5 pages. */
ptr = mmap_(self, variant, NULL, 5 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Place guard markers at both ends of the 5 page span. */
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
ASSERT_EQ(madvise(&ptr[4 * page_size], page_size, MADV_GUARD_INSTALL), 0);
/* Make sure the guarding is in effect. */
ASSERT_FALSE(try_read_write_buf(ptr));
ASSERT_FALSE(try_read_write_buf(&ptr[4 * page_size]));
/* Now shrink to 3 pages. */
ptr = mremap(ptr, 5 * page_size, 3 * page_size, MREMAP_MAYMOVE);
ASSERT_NE(ptr, MAP_FAILED);
/* We expect the guard marker at the start to be retained... */
ASSERT_FALSE(try_read_write_buf(ptr));
/* ...But remaining pages will not have guard markers. */
for (i = 1; i < 3; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/*
* As with expansion, a real user would have to remove guard pages and
* fixup. But you'd have to do similar manual things with PROT_NONE
* mappings too.
*/
/*
* If we expand back to the original size, the end marker will, of
* course, no longer be present.
*/
ptr = mremap(ptr, 3 * page_size, 5 * page_size, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Again, we expect the guard marker at the start to be retained... */
ASSERT_FALSE(try_read_write_buf(ptr));
/* ...But remaining pages will not have guard markers. */
for (i = 1; i < 5; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
/* Cleanup. */
munmap(ptr, 5 * page_size);
}
/*
* Assert that forking a process with VMAs that do not have VM_WIPEONFORK set
* retain guard pages.
*/
TEST_F(guard_regions, fork)
{
const unsigned long page_size = self->page_size;
char *ptr;
pid_t pid;
int i;
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Establish guard pages in the first 5 pages. */
ASSERT_EQ(madvise(ptr, 5 * page_size, MADV_GUARD_INSTALL), 0);
pid = fork();
ASSERT_NE(pid, -1);
if (!pid) {
/* This is the child process now. */
/* Assert that the guarding is in effect. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_write_buf(curr);
ASSERT_TRUE(i >= 5 ? result : !result);
}
/* Now unguard the range.*/
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
exit(0);
}
/* Parent process. */
/* Parent simply waits on child. */
waitpid(pid, NULL, 0);
/* Child unguard does not impact parent page table state. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_write_buf(curr);
ASSERT_TRUE(i >= 5 ? result : !result);
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Assert expected behaviour after we fork populated ranges of anonymous memory
* and then guard and unguard the range.
*/
TEST_F(guard_regions, fork_cow)
{
const unsigned long page_size = self->page_size;
char *ptr;
pid_t pid;
int i;
if (variant->backing != ANON_BACKED)
SKIP(return, "CoW only supported on anon mappings");
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Populate range. */
for (i = 0; i < 10 * page_size; i++) {
char chr = 'a' + (i % 26);
ptr[i] = chr;
}
pid = fork();
ASSERT_NE(pid, -1);
if (!pid) {
/* This is the child process now. */
/* Ensure the range is as expected. */
for (i = 0; i < 10 * page_size; i++) {
char expected = 'a' + (i % 26);
char actual = ptr[i];
ASSERT_EQ(actual, expected);
}
/* Establish guard pages across the whole range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Remove it. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/*
* By removing the guard pages, the page tables will be
* cleared. Assert that we are looking at the zero page now.
*/
for (i = 0; i < 10 * page_size; i++) {
char actual = ptr[i];
ASSERT_EQ(actual, '\0');
}
exit(0);
}
/* Parent process. */
/* Parent simply waits on child. */
waitpid(pid, NULL, 0);
/* Ensure the range is unchanged in parent anon range. */
for (i = 0; i < 10 * page_size; i++) {
char expected = 'a' + (i % 26);
char actual = ptr[i];
ASSERT_EQ(actual, expected);
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Assert that forking a process with VMAs that do have VM_WIPEONFORK set
* behave as expected.
*/
TEST_F(guard_regions, fork_wipeonfork)
{
const unsigned long page_size = self->page_size;
char *ptr;
pid_t pid;
int i;
if (variant->backing != ANON_BACKED)
SKIP(return, "Wipe on fork only supported on anon mappings");
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Mark wipe on fork. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_WIPEONFORK), 0);
/* Guard the first 5 pages. */
ASSERT_EQ(madvise(ptr, 5 * page_size, MADV_GUARD_INSTALL), 0);
pid = fork();
ASSERT_NE(pid, -1);
if (!pid) {
/* This is the child process now. */
/* Guard will have been wiped. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_TRUE(try_read_write_buf(curr));
}
exit(0);
}
/* Parent process. */
waitpid(pid, NULL, 0);
/* Guard markers should be in effect.*/
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
bool result = try_read_write_buf(curr);
ASSERT_TRUE(i >= 5 ? result : !result);
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Ensure that MADV_FREE retains guard entries as expected. */
TEST_F(guard_regions, lazyfree)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing != ANON_BACKED)
SKIP(return, "MADV_FREE only supported on anon mappings");
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Ensure guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Lazyfree range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_FREE), 0);
/* This should leave the guard markers in place. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Ensure that MADV_POPULATE_READ, MADV_POPULATE_WRITE behave as expected. */
TEST_F(guard_regions, populate)
{
const unsigned long page_size = self->page_size;
char *ptr;
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Populate read should error out... */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_POPULATE_READ), -1);
ASSERT_EQ(errno, EFAULT);
/* ...as should populate write. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_POPULATE_WRITE), -1);
ASSERT_EQ(errno, EFAULT);
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Ensure that MADV_COLD, MADV_PAGEOUT do not remove guard markers. */
TEST_F(guard_regions, cold_pageout)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Guard range. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* Ensured guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Now mark cold. This should have no impact on guard markers. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_COLD), 0);
/* Should remain guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* OK, now page out. This should equally, have no effect on markers. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_PAGEOUT), 0);
/* Should remain guarded. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/* Ensure that guard pages do not break userfaultd. */
TEST_F(guard_regions, uffd)
{
const unsigned long page_size = self->page_size;
int uffd;
char *ptr;
int i;
struct uffdio_api api = {
.api = UFFD_API,
.features = 0,
};
struct uffdio_register reg;
struct uffdio_range range;
if (!is_anon_backed(variant))
SKIP(return, "uffd only works on anon backing");
/* Set up uffd. */
uffd = userfaultfd(0);
if (uffd == -1) {
switch (errno) {
case EPERM:
SKIP(return, "No userfaultfd permissions, try running as root.");
break;
case ENOSYS:
SKIP(return, "userfaultfd is not supported/not enabled.");
break;
default:
ksft_exit_fail_msg("userfaultfd failed with %s\n",
strerror(errno));
break;
}
}
ASSERT_NE(uffd, -1);
ASSERT_EQ(ioctl(uffd, UFFDIO_API, &api), 0);
/* Map 10 pages. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Register the range with uffd. */
range.start = (unsigned long)ptr;
range.len = 10 * page_size;
reg.range = range;
reg.mode = UFFDIO_REGISTER_MODE_MISSING;
ASSERT_EQ(ioctl(uffd, UFFDIO_REGISTER, ®), 0);
/* Guard the range. This should not trigger the uffd. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_INSTALL), 0);
/* The guarding should behave as usual with no uffd intervention. */
for (i = 0; i < 10; i++) {
char *curr = &ptr[i * page_size];
ASSERT_FALSE(try_read_write_buf(curr));
}
/* Cleanup. */
ASSERT_EQ(ioctl(uffd, UFFDIO_UNREGISTER, &range), 0);
close(uffd);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Mark a region within a file-backed mapping using MADV_SEQUENTIAL so we
* aggressively read-ahead, then install guard regions and assert that it
* behaves correctly.
*
* We page out using MADV_PAGEOUT before checking guard regions so we drop page
* cache folios, meaning we maximise the possibility of some broken readahead.
*/
TEST_F(guard_regions, madvise_sequential)
{
char *ptr;
int i;
const unsigned long page_size = self->page_size;
if (variant->backing == ANON_BACKED)
SKIP(return, "MADV_SEQUENTIAL meaningful only for file-backed");
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Establish a pattern of data in the file. */
set_pattern(ptr, 10, page_size);
ASSERT_TRUE(check_pattern(ptr, 10, page_size));
/* Mark it as being accessed sequentially. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_SEQUENTIAL), 0);
/* Mark every other page a guard page. */
for (i = 0; i < 10; i += 2) {
char *ptr2 = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr2, page_size, MADV_GUARD_INSTALL), 0);
}
/* Now page it out. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_PAGEOUT), 0);
/* Now make sure pages are as expected. */
for (i = 0; i < 10; i++) {
char *chrp = &ptr[i * page_size];
if (i % 2 == 0) {
bool result = try_read_write_buf(chrp);
ASSERT_FALSE(result);
} else {
ASSERT_EQ(*chrp, 'a' + i);
}
}
/* Now remove guard pages. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Now make sure all data is as expected. */
if (!check_pattern(ptr, 10, page_size))
ASSERT_TRUE(false);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Check that file-backed mappings implement guard regions with MAP_PRIVATE
* correctly.
*/
TEST_F(guard_regions, map_private)
{
const unsigned long page_size = self->page_size;
char *ptr_shared, *ptr_private;
int i;
if (variant->backing == ANON_BACKED)
SKIP(return, "MAP_PRIVATE test specific to file-backed");
ptr_shared = mmap_(self, variant, NULL, 10 * page_size, PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr_shared, MAP_FAILED);
/* Manually mmap(), do not use mmap_() wrapper so we can force MAP_PRIVATE. */
ptr_private = mmap(NULL, 10 * page_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, self->fd, 0);
ASSERT_NE(ptr_private, MAP_FAILED);
/* Set pattern in shared mapping. */
set_pattern(ptr_shared, 10, page_size);
/* Install guard regions in every other page in the shared mapping. */
for (i = 0; i < 10; i += 2) {
char *ptr = &ptr_shared[i * page_size];
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
}
for (i = 0; i < 10; i++) {
/* Every even shared page should be guarded. */
ASSERT_EQ(try_read_buf(&ptr_shared[i * page_size]), i % 2 != 0);
/* Private mappings should always be readable. */
ASSERT_TRUE(try_read_buf(&ptr_private[i * page_size]));
}
/* Install guard regions in every other page in the private mapping. */
for (i = 0; i < 10; i += 2) {
char *ptr = &ptr_private[i * page_size];
ASSERT_EQ(madvise(ptr, page_size, MADV_GUARD_INSTALL), 0);
}
for (i = 0; i < 10; i++) {
/* Every even shared page should be guarded. */
ASSERT_EQ(try_read_buf(&ptr_shared[i * page_size]), i % 2 != 0);
/* Every odd private page should be guarded. */
ASSERT_EQ(try_read_buf(&ptr_private[i * page_size]), i % 2 != 0);
}
/* Remove guard regions from shared mapping. */
ASSERT_EQ(madvise(ptr_shared, 10 * page_size, MADV_GUARD_REMOVE), 0);
for (i = 0; i < 10; i++) {
/* Shared mappings should always be readable. */
ASSERT_TRUE(try_read_buf(&ptr_shared[i * page_size]));
/* Every even private page should be guarded. */
ASSERT_EQ(try_read_buf(&ptr_private[i * page_size]), i % 2 != 0);
}
/* Remove guard regions from private mapping. */
ASSERT_EQ(madvise(ptr_private, 10 * page_size, MADV_GUARD_REMOVE), 0);
for (i = 0; i < 10; i++) {
/* Shared mappings should always be readable. */
ASSERT_TRUE(try_read_buf(&ptr_shared[i * page_size]));
/* Private mappings should always be readable. */
ASSERT_TRUE(try_read_buf(&ptr_private[i * page_size]));
}
/* Ensure patterns are intact. */
ASSERT_TRUE(check_pattern(ptr_shared, 10, page_size));
ASSERT_TRUE(check_pattern(ptr_private, 10, page_size));
/* Now write out every other page to MAP_PRIVATE. */
for (i = 0; i < 10; i += 2) {
char *ptr = &ptr_private[i * page_size];
memset(ptr, 'a' + i, page_size);
}
/*
* At this point the mapping is:
*
* 0123456789
* SPSPSPSPSP
*
* Where S = shared, P = private mappings.
*/
/* Now mark the beginning of the mapping guarded. */
ASSERT_EQ(madvise(ptr_private, 5 * page_size, MADV_GUARD_INSTALL), 0);
/*
* This renders the mapping:
*
* 0123456789
* xxxxxPSPSP
*/
for (i = 0; i < 10; i++) {
char *ptr = &ptr_private[i * page_size];
/* Ensure guard regions as expected. */
ASSERT_EQ(try_read_buf(ptr), i >= 5);
/* The shared mapping should always succeed. */
ASSERT_TRUE(try_read_buf(&ptr_shared[i * page_size]));
}
/* Remove the guard regions altogether. */
ASSERT_EQ(madvise(ptr_private, 10 * page_size, MADV_GUARD_REMOVE), 0);
/*
*
* We now expect the mapping to be:
*
* 0123456789
* SSSSSPSPSP
*
* As we removed guard regions, the private pages from the first 5 will
* have been zapped, so on fault will reestablish the shared mapping.
*/
for (i = 0; i < 10; i++) {
char *ptr = &ptr_private[i * page_size];
/*
* Assert that shared mappings in the MAP_PRIVATE mapping match
* the shared mapping.
*/
if (i < 5 || i % 2 == 0) {
char *ptr_s = &ptr_shared[i * page_size];
ASSERT_EQ(memcmp(ptr, ptr_s, page_size), 0);
continue;
}
/* Everything else is a private mapping. */
ASSERT_TRUE(is_buf_eq(ptr, page_size, 'a' + i));
}
ASSERT_EQ(munmap(ptr_shared, 10 * page_size), 0);
ASSERT_EQ(munmap(ptr_private, 10 * page_size), 0);
}
/* Test that guard regions established over a read-only mapping function correctly. */
TEST_F(guard_regions, readonly_file)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing != LOCAL_FILE_BACKED)
SKIP(return, "Read-only test specific to file-backed");
/* Map shared so we can populate with pattern, populate it, unmap. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
set_pattern(ptr, 10, page_size);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
/* Close the fd so we can re-open read-only. */
ASSERT_EQ(close(self->fd), 0);
/* Re-open read-only. */
self->fd = open(self->path, O_RDONLY);
ASSERT_NE(self->fd, -1);
/* Re-map read-only. */
ptr = mmap_(self, variant, NULL, 10 * page_size, PROT_READ, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Mark every other page guarded. */
for (i = 0; i < 10; i += 2) {
char *ptr_pg = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_pg, page_size, MADV_GUARD_INSTALL), 0);
}
/* Assert that the guard regions are in place.*/
for (i = 0; i < 10; i++) {
char *ptr_pg = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_pg), i % 2 != 0);
}
/* Remove guard regions. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Ensure the data is as expected. */
ASSERT_TRUE(check_pattern(ptr, 10, page_size));
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
TEST_F(guard_regions, fault_around)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing == ANON_BACKED)
SKIP(return, "Fault-around test specific to file-backed");
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Establish a pattern in the backing file. */
set_pattern(ptr, 10, page_size);
/*
* Now drop it from the page cache so we get major faults when next we
* map it.
*/
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_PAGEOUT), 0);
/* Unmap and remap 'to be sure'. */
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Now make every even page guarded. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/* Now fault in every odd page. This should trigger fault-around. */
for (i = 1; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_TRUE(try_read_buf(ptr_p));
}
/* Finally, ensure that guard regions are intact as expected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_p), i % 2 != 0);
}
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
TEST_F(guard_regions, truncation)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing == ANON_BACKED)
SKIP(return, "Truncation test specific to file-backed");
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/*
* Establish a pattern in the backing file, just so there is data
* there.
*/
set_pattern(ptr, 10, page_size);
/* Now make every even page guarded. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/* Now assert things are as expected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_write_buf(ptr_p), i % 2 != 0);
}
/* Now truncate to actually used size (initialised to 100). */
ASSERT_EQ(ftruncate(self->fd, 10 * page_size), 0);
/* Here the guard regions will remain intact. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_write_buf(ptr_p), i % 2 != 0);
}
/* Now truncate to half the size, then truncate again to the full size. */
ASSERT_EQ(ftruncate(self->fd, 5 * page_size), 0);
ASSERT_EQ(ftruncate(self->fd, 10 * page_size), 0);
/* Again, guard pages will remain intact. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_write_buf(ptr_p), i % 2 != 0);
}
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
TEST_F(guard_regions, hole_punch)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing == ANON_BACKED)
SKIP(return, "Truncation test specific to file-backed");
/* Establish pattern in mapping. */
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
set_pattern(ptr, 10, page_size);
/* Install a guard region in the middle of the mapping. */
ASSERT_EQ(madvise(&ptr[3 * page_size], 4 * page_size,
MADV_GUARD_INSTALL), 0);
/*
* The buffer will now be:
*
* 0123456789
* ***xxxx***
*
* Where * is data and x is the guard region.
*/
/* Ensure established. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_p), i < 3 || i >= 7);
}
/* Now hole punch the guarded region. */
ASSERT_EQ(madvise(&ptr[3 * page_size], 4 * page_size,
MADV_REMOVE), 0);
/* Ensure guard regions remain. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_p), i < 3 || i >= 7);
}
/* Now remove guard region throughout. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Check that the pattern exists in non-hole punched region. */
ASSERT_TRUE(check_pattern(ptr, 3, page_size));
/* Check that hole punched region is zeroed. */
ASSERT_TRUE(is_buf_eq(&ptr[3 * page_size], 4 * page_size, '\0'));
/* Check that the pattern exists in the remainder of the file. */
ASSERT_TRUE(check_pattern_offset(ptr, 3, page_size, 7));
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Ensure that a memfd works correctly with guard regions, that we can write
* seal it then open the mapping read-only and still establish guard regions
* within, remove those guard regions and have everything work correctly.
*/
TEST_F(guard_regions, memfd_write_seal)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (variant->backing != SHMEM_BACKED)
SKIP(return, "memfd write seal test specific to shmem");
/* OK, we need a memfd, so close existing one. */
ASSERT_EQ(close(self->fd), 0);
/* Create and truncate memfd. */
self->fd = memfd_create("guard_regions_memfd_seals_test",
MFD_ALLOW_SEALING);
ASSERT_NE(self->fd, -1);
ASSERT_EQ(ftruncate(self->fd, 10 * page_size), 0);
/* Map, set pattern, unmap. */
ptr = mmap_(self, variant, NULL, 10 * page_size, PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
set_pattern(ptr, 10, page_size);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
/* Write-seal the memfd. */
ASSERT_EQ(fcntl(self->fd, F_ADD_SEALS, F_SEAL_WRITE), 0);
/* Now map the memfd readonly. */
ptr = mmap_(self, variant, NULL, 10 * page_size, PROT_READ, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Ensure pattern is as expected. */
ASSERT_TRUE(check_pattern(ptr, 10, page_size));
/* Now make every even page guarded. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/* Now assert things are as expected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_p), i % 2 != 0);
}
/* Now remove guard regions. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Ensure pattern is as expected. */
ASSERT_TRUE(check_pattern(ptr, 10, page_size));
/* Ensure write seal intact. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_FALSE(try_write_buf(ptr_p));
}
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Since we are now permitted to establish guard regions in read-only anonymous
* mappings, for the sake of thoroughness, though it probably has no practical
* use, test that guard regions function with a mapping to the anonymous zero
* page.
*/
TEST_F(guard_regions, anon_zeropage)
{
const unsigned long page_size = self->page_size;
char *ptr;
int i;
if (!is_anon_backed(variant))
SKIP(return, "anon zero page test specific to anon/shmem");
/* Obtain a read-only i.e. anon zero page mapping. */
ptr = mmap_(self, variant, NULL, 10 * page_size, PROT_READ, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Now make every even page guarded. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/* Now assert things are as expected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(try_read_buf(ptr_p), i % 2 != 0);
}
/* Now remove all guard regions. */
ASSERT_EQ(madvise(ptr, 10 * page_size, MADV_GUARD_REMOVE), 0);
/* Now assert things are as expected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
ASSERT_TRUE(try_read_buf(ptr_p));
}
/* Ensure zero page...*/
ASSERT_TRUE(is_buf_eq(ptr, 10 * page_size, '\0'));
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Assert that /proc/$pid/pagemap correctly identifies guard region ranges.
*/
TEST_F(guard_regions, pagemap)
{
const unsigned long page_size = self->page_size;
int proc_fd;
char *ptr;
int i;
proc_fd = open("/proc/self/pagemap", O_RDONLY);
ASSERT_NE(proc_fd, -1);
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
/* Read from pagemap, and assert no guard regions are detected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
unsigned long entry = pagemap_get_entry(proc_fd, ptr_p);
unsigned long masked = entry & PM_GUARD_REGION;
ASSERT_EQ(masked, 0);
}
/* Install a guard region in every other page. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(madvise(ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/* Re-read from pagemap, and assert guard regions are detected. */
for (i = 0; i < 10; i++) {
char *ptr_p = &ptr[i * page_size];
unsigned long entry = pagemap_get_entry(proc_fd, ptr_p);
unsigned long masked = entry & PM_GUARD_REGION;
ASSERT_EQ(masked, i % 2 == 0 ? PM_GUARD_REGION : 0);
}
ASSERT_EQ(close(proc_fd), 0);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
/*
* Assert that PAGEMAP_SCAN correctly reports guard region ranges.
*/
TEST_F(guard_regions, pagemap_scan)
{
const unsigned long page_size = self->page_size;
struct page_region pm_regs[10];
struct pm_scan_arg pm_scan_args = {
.size = sizeof(struct pm_scan_arg),
.category_anyof_mask = PAGE_IS_GUARD,
.return_mask = PAGE_IS_GUARD,
.vec = (long)&pm_regs,
.vec_len = ARRAY_SIZE(pm_regs),
};
int proc_fd, i;
char *ptr;
proc_fd = open("/proc/self/pagemap", O_RDONLY);
ASSERT_NE(proc_fd, -1);
ptr = mmap_(self, variant, NULL, 10 * page_size,
PROT_READ | PROT_WRITE, 0, 0);
ASSERT_NE(ptr, MAP_FAILED);
pm_scan_args.start = (long)ptr;
pm_scan_args.end = (long)ptr + 10 * page_size;
ASSERT_EQ(ioctl(proc_fd, PAGEMAP_SCAN, &pm_scan_args), 0);
ASSERT_EQ(pm_scan_args.walk_end, (long)ptr + 10 * page_size);
/* Install a guard region in every other page. */
for (i = 0; i < 10; i += 2) {
char *ptr_p = &ptr[i * page_size];
ASSERT_EQ(syscall(__NR_madvise, ptr_p, page_size, MADV_GUARD_INSTALL), 0);
}
/*
* Assert ioctl() returns the count of located regions, where each
* region spans every other page within the range of 10 pages.
*/
ASSERT_EQ(ioctl(proc_fd, PAGEMAP_SCAN, &pm_scan_args), 5);
ASSERT_EQ(pm_scan_args.walk_end, (long)ptr + 10 * page_size);
/* Re-read from pagemap, and assert guard regions are detected. */
for (i = 0; i < 5; i++) {
long ptr_p = (long)&ptr[2 * i * page_size];
ASSERT_EQ(pm_regs[i].start, ptr_p);
ASSERT_EQ(pm_regs[i].end, ptr_p + page_size);
ASSERT_EQ(pm_regs[i].categories, PAGE_IS_GUARD);
}
ASSERT_EQ(close(proc_fd), 0);
ASSERT_EQ(munmap(ptr, 10 * page_size), 0);
}
TEST_HARNESS_MAIN
|