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 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332
|
/* upstart
*
* job_process.c - job process handling
*
* Copyright © 2011 Canonical Ltd.
* Author: Scott James Remnant <scott@netsplit.com>.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2, as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
/* Required for pty handling */
#define _XOPEN_SOURCE 600
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/ptrace.h>
#include <sys/resource.h>
#include <sys/ioctl.h>
#include <time.h>
#include <errno.h>
#include <stdio.h>
#include <limits.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <utmp.h>
#include <utmpx.h>
#include <pwd.h>
#include <libgen.h>
#include <termios.h>
#include <grp.h>
#include <nih/macros.h>
#include <nih/alloc.h>
#include <nih/string.h>
#include <nih/signal.h>
#include <nih/io.h>
#include <nih/logging.h>
#include <nih/error.h>
#include <nih-dbus/dbus_util.h>
#include "paths.h"
#include "system.h"
#include "environ.h"
#include "process.h"
#include "job_process.h"
#include "job_class.h"
#include "job.h"
#include "errors.h"
#include "control.h"
#include "xdg.h"
#include "apparmor.h"
/**
* SHELL_CHARS:
*
* This is the list of characters that, if encountered in a process, cause
* it to always be run with a shell.
**/
#define SHELL_CHARS "~`!$^&*()=|\\{}[];\"'<>?"
/**
* JobProcessWireError:
*
* This structure is used to pass an error from the child process back to the
* parent. It contains the same basic particulars as a JobProcessError but
* without the message.
**/
typedef struct job_process_wire_error {
JobProcessErrorType type;
int arg;
int errnum;
} JobProcessWireError;
/**
* log_dir:
*
* Full path to directory where job logs are written.
*
**/
char *log_dir = NULL;
/**
* disable_respawn:
*
* If TRUE, disallow respawning.
**/
int disable_respawn = FALSE;
/* Prototypes for static functions */
static void job_process_error_abort (int fd, JobProcessErrorType type,
int arg)
__attribute__ ((noreturn));
static int job_process_error_read (int fd)
__attribute__ ((warn_unused_result));
static void job_process_remap_fd (int *fd, int reserved_fd, int error_fd);
/**
* disable_job_logging:
*
* If TRUE, do not log any job output.
*
**/
int disable_job_logging = 0;
/**
* no_inherit_env:
*
* If TRUE, do not copy the Session Inits environment variables or umask
* to that provided to jobs.
**/
int no_inherit_env = FALSE;
/* Prototypes for static functions */
static void job_process_kill_timer (Job *job, NihTimer *timer);
static void job_process_terminated (Job *job, ProcessType process,
int status);
static int job_process_catch_runaway (Job *job);
static void job_process_stopped (Job *job, ProcessType process);
static void job_process_trace_new (Job *job, ProcessType process);
static void job_process_trace_new_child (Job *job, ProcessType process);
static void job_process_trace_signal (Job *job, ProcessType process,
int signum);
static void job_process_trace_fork (Job *job, ProcessType process);
static void job_process_trace_exec (Job *job, ProcessType process);
extern char *control_server_address;
extern int user_mode;
extern int session_end;
extern time_t quiesce_phase_time;
/**
* job_process_run:
* @job: job context for process to be run in,
* @process: job process to run.
*
* This function looks up @process in the job's process table and uses
* the information there to spawn a new process for the @job, storing the
* pid in that table entry.
*
* The process is normally executed using the system shell, unless the
* script member of @process is FALSE and there are no typical shell
* characters within the command member, in which case it is executed
* directly using exec after splitting on whitespace.
*
* When executed with the shell, if the command (which may be an entire
* script) is reasonably small (less than 1KB) it is passed to the
* shell using the POSIX-specified -c option. Otherwise the shell is told
* to read commands from one of the special /proc/self/fd/NN devices and NihIo
* used to feed the script into that device. A pointer to the NihIo object
* is not kept or stored because it will automatically clean itself up should
* the script go away as the other end of the pipe will be closed.
*
* In either case the shell is run with the -e option so that commands will
* fail if their exit status is not checked.
*
* This function will block until the job_process_spawn() call succeeds or
* a non-temporary error occurs (such as file not found). It is up to the
* called to decide whether non-temporary errors are a reason to change the
* job state or not.
*
* Returns: zero on success, negative value on non-temporary error.
**/
int
job_process_run (Job *job,
ProcessType process)
{
Process *proc;
nih_local char **argv = NULL;
nih_local char **env = NULL;
nih_local char *script = NULL;
char **e;
size_t argc, envc;
int fds[2] = { -1, -1 };
int error = FALSE, trace = FALSE, shell = FALSE;
nih_assert (job != NULL);
proc = job->class->process[process];
nih_assert (proc != NULL);
nih_assert (proc->command != NULL);
/* We run the process using a shell if it says it wants to be run
* as such, or if it contains any shell-like characters; since that's
* the best way to deal with things like variables.
*/
if ((proc->script) || strpbrk (proc->command, SHELL_CHARS)) {
char *nl, *p;
argc = 0;
argv = NIH_MUST (nih_str_array_new (NULL));
NIH_MUST (nih_str_array_add (&argv, NULL, &argc, SHELL));
NIH_MUST (nih_str_array_add (&argv, NULL, &argc, "-e"));
/* If the process wasn't originally marked to be run through
* a shell, prepend exec to the script so that the shell
* gets out of the way after parsing.
*/
if (proc->script) {
script = NIH_MUST (nih_strdup (NULL, proc->command));
} else {
script = NIH_MUST (nih_sprintf (NULL, "exec %s",
proc->command));
}
/* Don't pipe single-line scripts into the shell using
* /proc/self/fd/NNN, instead just pass them over the
* command-line (taking care to strip off the trailing
* newlines).
*/
p = nl = strchr (script, '\n');
while (p && (*p == '\n'))
p++;
if ((! nl) || (! *p)) {
/* Strip off the newline(s) */
if (nl)
*nl = '\0';
NIH_MUST (nih_str_array_add (&argv, NULL,
&argc, "-c"));
NIH_MUST (nih_str_array_addp (&argv, NULL,
&argc, script));
/* Next argument is argv[0]; just pass the shell */
NIH_MUST (nih_str_array_add (&argv, NULL,
&argc, SHELL));
} else {
nih_local char *cmd = NULL;
/* Close the writing end when the child is exec'd */
NIH_ZERO (pipe (fds));
nih_io_set_cloexec (fds[1]);
shell = TRUE;
cmd = NIH_MUST (nih_sprintf (argv, "%s/%d",
"/proc/self/fd",
JOB_PROCESS_SCRIPT_FD));
NIH_MUST (nih_str_array_addp (&argv, NULL,
&argc, cmd));
}
} else {
/* Split the command on whitespace to produce a list of
* arguments that we can exec directly.
*/
argv = NIH_MUST (nih_str_split (NULL, proc->command,
" \t\r\n", TRUE));
}
/* We provide the standard job environment to all of its processes,
* except for pre-stop which also has the stop event environment,
* adding special variables that indicate which job it was -- mostly
* so that initctl can have clever behaviour when called within them.
*/
envc = 0;
env = NIH_MUST (nih_str_array_new (NULL));
if (job->env)
NIH_MUST (environ_append (&env, NULL, &envc, TRUE, job->env));
if (job->stop_env
&& ((process == PROCESS_PRE_STOP)
|| (process == PROCESS_POST_STOP)))
for (e = job->stop_env; *e; e++)
NIH_MUST (environ_set (&env, NULL, &envc, TRUE, *e));
NIH_MUST (environ_set (&env, NULL, &envc, TRUE,
"UPSTART_JOB=%s", job->class->name));
NIH_MUST (environ_set (&env, NULL, &envc, TRUE,
"UPSTART_INSTANCE=%s", job->name));
if (user_mode)
NIH_MUST (environ_set (&env, NULL, &envc, TRUE,
"UPSTART_SESSION=%s", control_server_address));
/* If we're about to spawn the main job and we expect it to become
* a daemon or fork before we can move out of spawned, we need to
* set a trace on it.
*/
if ((process == PROCESS_MAIN)
&& ((job->class->expect == EXPECT_DAEMON)
|| (job->class->expect == EXPECT_FORK)))
trace = TRUE;
/* Spawn the process, repeat until fork() works */
while ((job->pid[process] = job_process_spawn (job, argv, env,
trace, fds[0], process)) < 0) {
NihError *err;
err = nih_error_get ();
if (err->number == JOB_PROCESS_ERROR) {
/* Non-temporary error condition, we're not going
* to be able to spawn this process. Clean up after
* ourselves before returning.
*/
if (shell) {
close (fds[0]);
close (fds[1]);
}
job->pid[process] = 0;
/* Return non-temporary error condition */
nih_warn (_("Failed to spawn %s %s process: %s"),
job_name (job), process_name (process),
err->message);
nih_free (err);
return -1;
} else if (! error)
nih_warn ("%s: %s", _("Temporary process spawn error"),
err->message);
nih_free (err);
error = TRUE;
}
nih_info (_("%s %s process (%d)"),
job_name (job), process_name (process), job->pid[process]);
job->trace_forks = 0;
job->trace_state = trace ? TRACE_NEW : TRACE_NONE;
/* Feed the script to the child process */
if (shell) {
NihIo *io;
/* Clean up and close the reading end (we don't need it) */
close (fds[0]);
/* Put the entire script into an NihIo send buffer and
* then mark it for closure so that the shell gets EOF
* and the structure gets cleaned up automatically.
*/
while (! (io = nih_io_reopen (job, fds[1], NIH_IO_STREAM,
NULL, NULL, NULL, NULL))) {
NihError *err;
err = nih_error_get ();
if (err->number != ENOMEM)
nih_assert_not_reached ();
nih_free (err);
}
/* We're feeding using a pipe, which has a file descriptor
* on the child end even though it open()s it again using
* a path. Instruct the shell to close this extra fd and
* not to leak it.
*/
NIH_ZERO (nih_io_printf (io, "exec %d<&-\n",
JOB_PROCESS_SCRIPT_FD));
NIH_ZERO (nih_io_write (io, script, strlen (script)));
nih_io_shutdown (io);
}
return 0;
}
/**
* job_process_spawn:
* @job: job of process to be spawned,
* @argv: NULL-terminated list of arguments for the process,
* @env: NULL-terminated list of environment variables for the process,
* @trace: whether to trace this process,
* @script_fd: script file descriptor,
* @process: job process to spawn.
*
* This function spawns a new process using the class details in @job to set up
* the environment for it; the process is always a session and process group
* leader as we never want anything in our own group.
*
* The process to be executed is given in the @argv array which is passed
* directly to execvp(), so should be in the same NULL-terminated form with
* the first argument containing the path or filename of the binary. The
* PATH environment in the @job's associated class will be searched.
*
* If @trace is TRUE, the process will be traced with ptrace and this will
* cause the process to be stopped when the exec() call is made. You must
* wait for this and then may use it to set options before continuing the
* process.
*
* If @script_fd is not -1, this file descriptor is dup()d to the special fd 9
* (moving any other out of the way if necessary).
*
* This function only spawns the process, it is up to the caller to ensure
* that the information is saved into the job and that the process is watched,
* etc.
*
* Spawning a process may fail for temporary reasons, usually due to a failure
* of the fork() syscall or communication with the child; or more permanent
* reasons such as a failure to setup the child environment. These latter
* are always represented by a JOB_PROCESS_ERROR error.
*
* Returns: process id of new process on success, -1 on raised error
**/
pid_t
job_process_spawn (Job *job,
char * const argv[],
char * const *env,
int trace,
int script_fd,
ProcessType process)
{
sigset_t child_set, orig_set;
pid_t pid;
int i, fds[2];
int pty_master = -1;
int pty_slave = -1;
char pts_name[PATH_MAX];
char filename[PATH_MAX];
FILE *fd;
nih_local char *log_path = NULL;
JobClass *class;
uid_t job_setuid = -1;
gid_t job_setgid = -1;
struct passwd *pwd = NULL;
struct group *grp = NULL;
nih_assert (job != NULL);
nih_assert (job->class != NULL);
nih_assert (job->log != NULL);
nih_assert (process < PROCESS_LAST);
class = job->class;
nih_assert (class != NULL);
/* Create a pipe to communicate with the child process until it
* execs so we know whether that was successful or an error occurred.
*/
if (pipe (fds) < 0)
nih_return_system_error (-1);
if (class->console == CONSOLE_LOG && disable_job_logging)
class->console = CONSOLE_NONE;
if (class->console == CONSOLE_LOG) {
NihError *err;
/* Ensure log destroyed for previous matching job process
* (occurs when job restarted but previous process has not
* yet been reaped).
*/
if (job->log[process]) {
nih_free (job->log[process]);
job->log[process] = NULL;
}
log_path = job_process_log_path (job, 0);
if (! log_path) {
/* Consume and re-raise */
err = nih_error_get ();
nih_assert (err->number == ENOMEM);
nih_free (err);
close (fds[0]);
close (fds[1]);
nih_return_no_memory_error(-1);
}
pty_master = posix_openpt (O_RDWR | O_NOCTTY);
if (pty_master < 0) {
nih_error (_("Failed to create pty - disabling logging for job"));
/* Ensure that the job can still be started by
* disabling logging.
*/
class->console = CONSOLE_NONE;
close (fds[0]);
close (fds[1]);
nih_return_system_error (-1);
}
/* Stop any process created _before_ the log object below is
* freed from inheriting this fd.
*/
nih_io_set_cloexec (pty_master);
/* pty_master will be closed by log_destroy() */
job->log[process] = log_new (job->log, log_path, pty_master, 0);
if (! job->log[process]) {
close (pty_master);
close (fds[0]);
close (fds[1]);
nih_return_system_error (-1);
}
}
/* Block all signals while we fork to avoid the child process running
* our own signal handlers before we've reset them all back to the
* default.
*/
sigfillset (&child_set);
sigprocmask (SIG_BLOCK, &child_set, &orig_set);
/* Ensure that any lingering data in stdio buffers is flushed
* to avoid the child getting a copy of it.
* If not done, CONSOLE_LOG jobs may end up with unexpected data
* in their logs if we run with for example '--debug'.
*/
fflush (NULL);
/* Fork the child process, handling success and failure by resetting
* the signal mask and returning the new process id or a raised error.
*/
pid = fork ();
if (pid > 0) {
if (class->debug) {
nih_info (_("Pausing %s (%d) [pre-exec] for debug"),
class->name, pid);
}
sigprocmask (SIG_SETMASK, &orig_set, NULL);
close (fds[1]);
/* Read error from the pipe, return if one is raised */
if (job_process_error_read (fds[0]) < 0) {
if (class->console == CONSOLE_LOG) {
/* Ensure the pty_master watch gets
* removed and the fd closed.
*/
nih_free (job->log[process]);
job->log[process] = NULL;
}
close (fds[0]);
return -1;
}
/* Note that pts_master is closed automatically in the parent when the
* log object is destroyed.
*/
close (fds[0]);
return pid;
} else if (pid < 0) {
nih_error_raise_system ();
sigprocmask (SIG_SETMASK, &orig_set, NULL);
close (fds[0]);
close (fds[1]);
if (class->console == CONSOLE_LOG) {
nih_free (job->log[process]);
job->log[process] = NULL;
}
return -1;
}
/* We're now in the child process.
*
* The rest of this function sets the child up and ends by executing
* the new binary. Failures are handled by terminating the child
* and writing an error back to the parent.
*/
/* Close the reading end of the pipe with our parent and mark the
* writing end to be closed-on-exec so the parent knows we got that
* far because read() returned zero.
*/
close (fds[0]);
job_process_remap_fd (&fds[1], JOB_PROCESS_SCRIPT_FD, fds[1]);
nih_io_set_cloexec (fds[1]);
if (class->console == CONSOLE_LOG) {
struct sigaction act;
struct sigaction ignore;
job_process_remap_fd (&pty_master, JOB_PROCESS_SCRIPT_FD, fds[1]);
/* Child is the slave, so won't need this */
nih_io_set_cloexec (pty_master);
/* Temporarily disable child handler as grantpt(3) disallows one
* being in effect when called.
*/
ignore.sa_handler = SIG_DFL;
ignore.sa_flags = 0;
sigemptyset (&ignore.sa_mask);
if (sigaction (SIGCHLD, &ignore, &act) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SIGNAL, 0);
}
if (grantpt (pty_master) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_GRANTPT, 0);
}
/* Restore child handler */
if (sigaction (SIGCHLD, &act, NULL) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SIGNAL, 0);
}
if (unlockpt (pty_master) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_UNLOCKPT, 0);
}
if (ptsname_r (pty_master, pts_name, sizeof(pts_name)) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_PTSNAME, 0);
}
pty_slave = open (pts_name, O_RDWR | O_NOCTTY);
if (pty_slave < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_OPENPT_SLAVE, 0);
}
job_process_remap_fd (&pty_slave, JOB_PROCESS_SCRIPT_FD, fds[1]);
}
/* Move the script fd to special fd 9; the only gotcha is if that
* would be our error descriptor, but that's handled above.
*/
if ((script_fd != -1) && (script_fd != JOB_PROCESS_SCRIPT_FD)) {
int tmp = dup2 (script_fd, JOB_PROCESS_SCRIPT_FD);
if (tmp < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_DUP, 0);
}
close (script_fd);
script_fd = tmp;
}
/* Become the leader of a new session and process group, shedding
* any controlling tty (which we shouldn't have had anyway).
*/
setsid ();
/* Set the process environment from the function parameters. */
environ = (char **)env;
/* Set the standard file descriptors to an output of our chosing;
* any other open descriptor must be intended for the child, or have
* the FD_CLOEXEC flag so it's automatically closed when we exec()
* later.
*/
if (system_setup_console (class->console, FALSE) < 0) {
if (class->console == CONSOLE_OUTPUT) {
NihError *err;
err = nih_error_get ();
nih_warn (_("Failed to open system console: %s"),
err->message);
nih_free (err);
if (system_setup_console (CONSOLE_NONE, FALSE) < 0)
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_CONSOLE, 0);
} else
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_CONSOLE, 0);
}
if (class->console == CONSOLE_LOG) {
/* Redirect stdout and stderr to the logger fd */
if (dup2 (pty_slave, STDOUT_FILENO) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_DUP, 0);
}
if (dup2 (pty_slave, STDERR_FILENO) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_DUP, 0);
}
close (pty_slave);
}
/* Switch to the specified AppArmor profile, but only for the main
process, so we don't confine the pre- and post- processes.
*/
if ((class->apparmor_switch) && (process == PROCESS_MAIN)) {
nih_local char *profile = NULL;
/* Use the environment to expand the AppArmor profile name
*/
profile = NIH_SHOULD (environ_expand (NULL,
class->apparmor_switch,
environ));
if (! profile) {
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SECURITY, 0);
}
if (apparmor_switch (profile) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SECURITY, 0);
}
}
if (process != PROCESS_SECURITY) {
/* Set resource limits for the process, skipping over any that
* aren't set in the job class such that they inherit from
* ourselves (and we inherit from kernel defaults).
*/
for (i = 0; i < RLIMIT_NLIMITS; i++) {
if (! class->limits[i])
continue;
if (setrlimit (i, class->limits[i]) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1],
JOB_PROCESS_ERROR_RLIMIT, i);
}
}
/* Set the file mode creation mask; this is one of the few operations
* that can never fail.
*/
umask (class->umask);
/* Adjust the process priority ("nice level").
*/
if (class->nice != JOB_NICE_INVALID &&
setpriority (PRIO_PROCESS, 0, class->nice) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1],
JOB_PROCESS_ERROR_PRIORITY, 0);
}
/* Adjust the process OOM killer priority.
*/
if (class->oom_score_adj != JOB_DEFAULT_OOM_SCORE_ADJ) {
int oom_value;
snprintf (filename, sizeof (filename),
"/proc/%d/oom_score_adj", getpid ());
oom_value = class->oom_score_adj;
fd = fopen (filename, "w");
if ((! fd) && (errno == ENOENT)) {
snprintf (filename, sizeof (filename),
"/proc/%d/oom_adj", getpid ());
oom_value = (class->oom_score_adj
* ((class->oom_score_adj < 0) ? 17 : 15)) / 1000;
fd = fopen (filename, "w");
}
if (! fd) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_OOM_ADJ, 0);
} else {
fprintf (fd, "%d\n", oom_value);
if (fclose (fd)) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_OOM_ADJ, 0);
}
}
}
/* Handle changing a chroot session job prior to dealing with
* the 'chroot' stanza.
*/
if (class->session && class->session->chroot) {
if (chroot (class->session->chroot) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_CHROOT, 0);
}
}
/* Change the root directory, confining path resolution within it;
* we do this before the working directory call so that is always
* relative to the new root.
*/
if (class->chroot) {
if (chroot (class->chroot) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1],
JOB_PROCESS_ERROR_CHROOT, 0);
}
}
/* Change the working directory of the process, either to the one
* configured in the job, or to the root directory of the filesystem
* (or at least relative to the chroot).
*/
if (class->chdir || user_mode == FALSE) {
if (chdir (class->chdir ? class->chdir : "/") < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_CHDIR, 0);
}
}
/* Change the user and group of the process to the one
* configured in the job. We must wait until now to lookup the
* UID and GID from the names to accommodate both chroot
* session jobs and jobs with a chroot stanza.
*/
if (class->setuid) {
/* Without resetting errno, it's impossible to
* distinguish between a non-existent user and and
* error during lookup */
errno = 0;
pwd = getpwnam (class->setuid);
if (! pwd) {
if (errno != 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_GETPWNAM, 0);
} else {
nih_error_raise (JOB_PROCESS_INVALID_SETUID,
JOB_PROCESS_INVALID_SETUID_STR);
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_BAD_SETUID, 0);
}
}
job_setuid = pwd->pw_uid;
/* This will be overridden if setgid is also set: */
job_setgid = pwd->pw_gid;
}
if (class->setgid) {
errno = 0;
grp = getgrnam (class->setgid);
if (! grp) {
if (errno != 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_GETGRNAM, 0);
} else {
nih_error_raise (JOB_PROCESS_INVALID_SETGID,
JOB_PROCESS_INVALID_SETGID_STR);
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_BAD_SETGID, 0);
}
}
job_setgid = grp->gr_gid;
}
if (script_fd != -1 &&
(job_setuid != (uid_t) -1 || job_setgid != (gid_t) -1) &&
fchown (script_fd, job_setuid, job_setgid) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_CHOWN, 0);
}
/* Make sure we always have the needed pwd and grp structs.
* Then pass those to initgroups() to setup the user's group list.
* Only do that if we're root as initgroups() won't work when non-root. */
if (geteuid () == 0) {
if (! pwd) {
pwd = getpwuid (geteuid ());
if (! pwd) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_GETPWUID, 0);
}
}
if (! grp) {
grp = getgrgid (getegid ());
if (! grp) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_GETGRGID, 0);
}
}
if (pwd && grp) {
if (initgroups (pwd->pw_name, grp->gr_gid) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_INITGROUPS, 0);
}
}
}
/* Start dropping privileges */
if (job_setgid != (gid_t) -1 && setgid (job_setgid) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SETGID, 0);
}
if (job_setuid != (uid_t)-1 && setuid (job_setuid) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_SETUID, 0);
}
}
/* Reset all the signal handlers back to their default handling so
* the child isn't unexpectedly ignoring any, and so we won't
* surprisingly handle them before we've exec()d the new process.
*/
nih_signal_reset ();
sigprocmask (SIG_SETMASK, &orig_set, NULL);
/* Notes:
*
* - we can't use pause() here since there would then be no way to
* resume the process without killing it.
*
* - we have to close the pipe back to the parent since if we don't,
* the parent hangs until the STOP is cleared. Although this may be
* acceptable for normal operation, this causes the test suite to
* fail. Note that closing the pipe means from this point onwards,
* the parent cannot know the true outcome of the spawn: that
* responsibility lies with the debugger.
*/
if (class->debug) {
close (fds[1]);
raise (SIGSTOP);
}
/* Set up a process trace if we need to trace forks */
if (trace) {
if (ptrace (PTRACE_TRACEME, 0, NULL, 0) < 0) {
nih_error_raise_system();
job_process_error_abort (fds[1],
JOB_PROCESS_ERROR_PTRACE, 0);
}
}
/* Execute the process, if we escape from here it failed */
if (execvp (argv[0], argv) < 0) {
nih_error_raise_system ();
job_process_error_abort (fds[1], JOB_PROCESS_ERROR_EXEC, 0);
}
nih_assert_not_reached ();
}
/**
* job_process_error_abort:
* @fd: writing end of pipe,
* @type: step that failed,
* @arg: argument to @type.
*
* Abort the child process, first writing the error details in @type, @arg
* and the currently raised NihError to the writing end of the pipe specified
* by @fd.
*
* This function calls the exit() system call, so never returns.
**/
static void
job_process_error_abort (int fd,
JobProcessErrorType type,
int arg)
{
NihError *err;
JobProcessWireError wire_err;
/* Get the currently raised system error */
err = nih_error_get ();
/* Fill in the structure we send over the pipe */
wire_err.type = type;
wire_err.arg = arg;
wire_err.errnum = err->number;
/* Write structure to the pipe; in theory this should never fail, but
* if it does, we abort anyway.
*/
while (write (fd, &wire_err, sizeof (wire_err)) < 0)
;
nih_free (err);
exit (255);
}
/**
* job_process_error_read:
* @fd: reading end of pipe.
*
* Read from the reading end of the pipe specified by @fd, if we receive
* data then the child raised a process error which we reconstruct and raise
* again; otherwise no problem was found and no action is taken.
*
* The reconstructed error will be of JOB_PROCESS_ERROR type, the human-
* readable message is generated according to the type of process error
* and argument passed along with it.
*
* Returns: zero if no error was found, or negative value on raised error.
**/
static int
job_process_error_read (int fd)
{
JobProcessWireError wire_err;
ssize_t len;
JobProcessError *err;
const char *res;
/* Read the error from the pipe; a zero read indicates that the
* exec succeeded so we return success, otherwise if we don't receive
* a JobProcessWireError structure, we return a temporary error so we
* try again.
*/
len = read (fd, &wire_err, sizeof (wire_err));
if (len == 0) {
return 0;
} else if (len < 0) {
nih_return_system_error (-1);
} else if (len != sizeof (wire_err)) {
errno = EILSEQ;
nih_return_system_error (-1);
}
/* Construct a JobProcessError to be raised containing information
* from the wire, augmented with human-readable information we
* generate here.
*/
err = NIH_MUST (nih_new (NULL, JobProcessError));
err->type = wire_err.type;
err->arg = wire_err.arg;
err->errnum = wire_err.errnum;
err->error.number = JOB_PROCESS_ERROR;
switch (err->type) {
case JOB_PROCESS_ERROR_DUP:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to move script fd: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_CONSOLE:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to open console: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_RLIMIT:
switch (err->arg) {
case RLIMIT_CPU:
res = "cpu";
break;
case RLIMIT_FSIZE:
res = "fsize";
break;
case RLIMIT_DATA:
res = "data";
break;
case RLIMIT_STACK:
res = "stack";
break;
case RLIMIT_CORE:
res = "core";
break;
case RLIMIT_RSS:
res = "rss";
break;
case RLIMIT_NPROC:
res = "nproc";
break;
case RLIMIT_NOFILE:
res = "nofile";
break;
case RLIMIT_MEMLOCK:
res = "memlock";
break;
case RLIMIT_AS:
res = "as";
break;
case RLIMIT_LOCKS:
res = "locks";
break;
case RLIMIT_SIGPENDING:
res = "sigpending";
break;
case RLIMIT_MSGQUEUE:
res = "msgqueue";
break;
case RLIMIT_NICE:
res = "nice";
break;
case RLIMIT_RTPRIO:
res = "rtprio";
break;
default:
nih_assert_not_reached ();
}
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to set \"%s\" resource limit: %s"),
res, strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_PRIORITY:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to set priority: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_OOM_ADJ:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to set oom adjustment: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_CHROOT:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to change root directory: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_CHDIR:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to change working directory: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_PTRACE:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to set trace: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_EXEC:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to execute: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_GETPWNAM:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to getpwnam: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_GETGRNAM:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to getgrnam: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_GETPWUID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to getpwuid: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_GETGRGID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to getgrgid: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_BAD_SETUID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to find setuid user")));
break;
case JOB_PROCESS_ERROR_BAD_SETGID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to find setgid group")));
break;
case JOB_PROCESS_ERROR_SETUID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to setuid: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_SETGID:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to setgid: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_CHOWN:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to chown: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_UNLOCKPT:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to unlockpt: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_GRANTPT:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to granpt: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_PTSNAME:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to get ptsname: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_OPENPT_SLAVE:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to open pty slave: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_SIGNAL:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to modify signal handler: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_ALLOC:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to allocate memory: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_INITGROUPS:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to initgroups: %s"),
strerror (err->errnum)));
break;
case JOB_PROCESS_ERROR_SECURITY:
err->error.message = NIH_MUST (nih_sprintf (
err, _("unable to switch security profile: %s"),
strerror (err->errnum)));
break;
default:
nih_assert_not_reached ();
}
nih_error_raise_error (&err->error);
return -1;
}
/**
* job_process_kill:
* @job: job to kill process of,
* @process: process to be killed.
*
* This function forces a @job to leave its current state by sending
* @process the "kill signal" defined signal (TERM by default), and maybe
* later the KILL signal. The actual state changes are performed by
* job_child_reaper when the process has actually terminated.
**/
void
job_process_kill (Job *job,
ProcessType process)
{
nih_assert (job != NULL);
nih_assert (job->pid[process] > 0);
nih_assert (job->kill_timer == NULL);
nih_assert (job->kill_process == PROCESS_INVALID);
nih_info (_("Sending %s signal to %s %s process (%d)"),
nih_signal_to_name (job->class->kill_signal),
job_name (job), process_name (process), job->pid[process]);
if (system_kill (job->pid[process], job->class->kill_signal) < 0) {
NihError *err;
err = nih_error_get ();
if (err->number != ESRCH)
nih_warn (_("Failed to send %s signal to %s %s process (%d): %s"),
nih_signal_to_name (job->class->kill_signal),
job_name (job), process_name (process),
job->pid[process], err->message);
nih_free (err);
return;
}
job_process_set_kill_timer (job, process, job->class->kill_timeout);
}
/**
* job_process_jobs_running:
*
* Determine if any jobs are running. Note that simply checking if class
* instances exist is insufficient: since this call is used for shutdown
* abstract jobs must not be able to block the shutdown.
*
* Returns: TRUE if jobs are still running, else FALSE.
**/
int
job_process_jobs_running (void)
{
job_class_init ();
NIH_HASH_FOREACH (job_classes, iter) {
JobClass *class = (JobClass *)iter;
NIH_HASH_FOREACH (class->instances, job_iter) {
Job *job = (Job *)job_iter;
int i;
for (i = 0; i < PROCESS_LAST; i++) {
if (job->pid[i])
return TRUE;
}
}
}
return FALSE;
}
/**
* job_process_stop_all:
*
* Stop all running jobs.
**/
void
job_process_stop_all (void)
{
job_class_init ();
NIH_HASH_FOREACH (job_classes, iter) {
JobClass *class = (JobClass *)iter;
/* Note that instances get killed in a random order */
NIH_HASH_FOREACH (class->instances, job_iter) {
Job *job = (Job *)job_iter;
/* Request job instance stops */
job_change_goal (job, JOB_STOP);
}
}
}
/**
* job_process_set_kill_timer:
* @job: job to set kill timer for,
* @process: process to be killed,
* @timeout: timeout to apply for timer.
*
* Set kill timer for specified @job @process with timeout @timeout.
**/
void
job_process_set_kill_timer (Job *job,
ProcessType process,
time_t timeout)
{
nih_assert (job);
nih_assert (timeout);
job->kill_process = process;
job->kill_timer = NIH_MUST (nih_timer_add_timeout (
job, timeout,
(NihTimerCb)job_process_kill_timer, job));
}
/**
* job_process_adj_kill_timer:
*
* @job: job whose kill timer is to be modified,
* @due: new due time to set for job kill timer.
*
* Adjust due time for @job's kill timer to @due.
**/
void
job_process_adj_kill_timer (Job *job, time_t due)
{
nih_assert (job);
nih_assert (job->kill_timer);
nih_assert (due);
job->kill_timer->due = due;
}
/**
* job_process_kill_timer:
* @job: job to kill process of,
* @timer: timer that caused us to be called.
*
* This callback is called if the process failed to terminate within
* a particular time of being sent the TERM signal. The process is killed
* more forcibly by sending the KILL signal.
**/
static void
job_process_kill_timer (Job *job,
NihTimer *timer)
{
ProcessType process;
nih_assert (job != NULL);
nih_assert (timer != NULL);
nih_assert (job->kill_timer == timer);
nih_assert (job->kill_process != PROCESS_INVALID);
process = job->kill_process;
nih_assert (job->pid[process] > 0);
job->kill_timer = NULL;
job->kill_process = PROCESS_INVALID;
nih_info (_("Sending %s signal to %s %s process (%d)"),
"KILL",
job_name (job), process_name (process), job->pid[process]);
if (system_kill (job->pid[process], SIGKILL) < 0) {
NihError *err;
err = nih_error_get ();
if (err->number != ESRCH)
nih_warn (_("Failed to send %s signal to %s %s process (%d): %s"),
"KILL",
job_name (job), process_name (process),
job->pid[process], err->message);
nih_free (err);
}
}
/**
* job_process_handler:
* @data: unused,
* @pid: process that changed,
* @event: event that occurred on the child,
* @status: exit status, signal raised or ptrace event.
*
* This callback should be registered with nih_child_add_watch() so that
* when processes associated with jobs die, stop, receive signals or other
* ptrace events, the appropriate action is taken.
*
* Normally this is registered so it is called for all processes, and is
* safe to do as it only acts if the process is linked to a job.
**/
void
job_process_handler (void *data,
pid_t pid,
NihChildEvents event,
int status)
{
Job *job;
ProcessType process;
NihLogLevel priority;
const char *sig;
nih_assert (pid > 0);
/* Find the job that an event ocurred for, and identify which of the
* job's process it was. If we don't know about it, then we simply
* ignore the event.
*/
job = job_process_find (pid, &process);
if (! job)
return;
/* Check the job's normal exit clauses to see whether this is a failure
* worth warning about.
*/
priority = NIH_LOG_WARN;
for (size_t i = 0; i < job->class->normalexit_len; i++) {
if (job->class->normalexit[i] == status) {
priority = NIH_LOG_INFO;
break;
}
}
switch (event) {
case NIH_CHILD_EXITED:
/* Child exited; check status to see whether it exited
* normally (zero) or with a non-zero status.
*/
if (status) {
nih_log_message (priority, _("%s %s process (%d) "
"terminated with status %d"),
job_name (job), process_name (process),
pid, status);
} else {
nih_info (_("%s %s process (%d) exited normally"),
job_name (job), process_name (process), pid);
}
job_process_terminated (job, process, status);
break;
case NIH_CHILD_KILLED:
case NIH_CHILD_DUMPED:
/* Child was killed by a signal, and maybe dumped core. We
* store the signal value in the higher byte of status (it's
* safe to do that) to distinguish it from a normal exit
* status.
*/
sig = nih_signal_to_name (status);
if (sig) {
nih_log_message (priority, _("%s %s process (%d) killed by %s signal"),
job_name (job), process_name (process),
pid, sig);
} else {
nih_warn (_("%s %s process (%d) killed by signal %d"),
job_name (job), process_name (process),
pid, status);
}
status <<= 8;
job_process_terminated (job, process, status);
break;
case NIH_CHILD_STOPPED:
/* Child was stopped by a signal, make sure it was SIGSTOP
* and not a tty-related signal.
*/
sig = nih_signal_to_name (status);
if (sig) {
nih_info (_("%s %s process (%d) stopped by %s signal"),
job_name (job), process_name (process),
pid, sig);
} else {
nih_info (_("%s %s process (%d) stopped by signal %d"),
job_name (job), process_name (process),
pid, status);
}
if (status == SIGSTOP)
job_process_stopped (job, process);
break;
case NIH_CHILD_CONTINUED:
/* Child was continued by a signal.
*/
sig = nih_signal_to_name (status);
if (sig) {
nih_info (_("%s %s process (%d) continued by %s signal"),
job_name (job), process_name (process),
pid, sig);
} else {
nih_info (_("%s %s process (%d) continued by signal %d"),
job_name (job), process_name (process),
pid, status);
}
break;
case NIH_CHILD_TRAPPED:
/* Child received a signal while we were tracing it. This
* can be a signal raised inside the kernel as a side-effect
* of the trace because the child called fork() or exec();
* we only know that from our own state tracking.
*/
if ((job->trace_state == TRACE_NEW)
&& (status == SIGTRAP)) {
job_process_trace_new (job, process);
} else if ((job->trace_state == TRACE_NEW_CHILD)
&& (status == SIGSTOP)) {
job_process_trace_new_child (job, process);
} else {
job_process_trace_signal (job, process, status);
}
break;
case NIH_CHILD_PTRACE:
/* Child called an important syscall that can modify the
* state of the process trace we hold.
*/
switch (status) {
case PTRACE_EVENT_FORK:
job_process_trace_fork (job, process);
break;
case PTRACE_EVENT_EXEC:
job_process_trace_exec (job, process);
break;
default:
nih_assert_not_reached ();
}
break;
default:
nih_assert_not_reached ();
}
}
/**
* job_process_terminated:
* @job: job that changed,
* @process: specific process,
* @status: exit status or signal in higher byte.
*
* This function is called whenever a @process attached to @job terminates,
* @status should contain the exit status in the lower byte or signal in
* the higher byte.
*
* The job structure is updated and the next appropriate state for the job
* is chosen, which may involve changing the goal to stop first.
**/
static void
job_process_terminated (Job *job,
ProcessType process,
int status)
{
int failed = FALSE, stop = FALSE, state = TRUE;
struct utmpx *utmptr;
struct timeval tv;
nih_assert (job != NULL);
switch (process) {
case PROCESS_MAIN:
nih_assert ((job->state == JOB_RUNNING)
|| (job->state == JOB_SPAWNED)
|| (job->state == JOB_KILLED)
|| (job->state == JOB_STOPPING)
|| (job->state == JOB_POST_START)
|| (job->state == JOB_PRE_STOP));
/* We don't change the state if we're in post-start and there's
* a post-start process running, or if we're in pre-stop and
* there's a pre-stop process running; we wait for those to
* finish instead.
*/
if ((job->state == JOB_POST_START)
&& job->class->process[PROCESS_POST_START]
&& (job->pid[PROCESS_POST_START] > 0)) {
state = FALSE;
} else if ((job->state == JOB_PRE_STOP)
&& job->class->process[PROCESS_PRE_STOP]
&& (job->pid[PROCESS_PRE_STOP] > 0)) {
state = FALSE;
}
/* Dying when we killed it is perfectly normal and never
* considered a failure. We also don't want to tamper with
* the goal since we might be restarting the job anyway.
*/
if (job->state == JOB_KILLED)
break;
/* Yet another corner case is terminating when we were
* already stopping, we don't to tamper with the goal or
* state because we're still waiting for the stopping
* event to finish and that might restart it anyway.
* We also don't want to consider it a failure, because
* we want the stopping and stopped events to match.
*/
if (job->state == JOB_STOPPING) {
state = FALSE;
break;
}
/* We don't assume that because the primary process was
* killed or exited with a non-zero status, it failed.
* Instead we check the normalexit list to see whether
* the exit signal or status is in that list, and only
* if not, do we consider it failed.
*
* For services that can be respawned, a zero exit status is
* also a failure unless listed.
*/
if ((status || (job->class->respawn && (! job->class->task)))
&& (job->goal == JOB_START)) {
failed = TRUE;
for (size_t i = 0; i < job->class->normalexit_len; i++) {
if (job->class->normalexit[i] == status) {
failed = FALSE;
break;
}
}
/* We might be able to respawn the failed job;
* that's a simple matter of doing nothing. Check
* the job isn't running away first though.
*/
if (failed && job->class->respawn && ! disable_respawn) {
if (job_process_catch_runaway (job)) {
nih_warn (_("%s respawning too fast, stopped"),
job_name (job));
failed = FALSE;
job_failed (job, PROCESS_INVALID, 0);
} else {
nih_warn (_("%s %s process ended, respawning"),
job_name (job),
process_name (process));
failed = FALSE;
/* If we're not going to change the
* state because there's a post-start
* or pre-stop script running, we need
* to remember to do it when that
* finishes.
*/
if (! state)
job_change_goal (job, JOB_RESPAWN);
break;
}
}
}
/* Otherwise whether it's failed or not, we should
* stop the job now.
*/
stop = TRUE;
break;
case PROCESS_SECURITY:
nih_assert (job->state == JOB_SECURITY);
/* We should always fail the job if the security profile
* failed to load
*/
/* Disabled for now to emulate current Ubuntu behaviour
* in /lib/init/apparmor-profile-load to work around bug
* LP: #1058356
if (status) {
failed = TRUE;
stop = TRUE;
}
*/
break;
case PROCESS_PRE_START:
nih_assert (job->state == JOB_PRE_START);
/* If the pre-start script is killed or exits with a status
* other than zero, it's always considered a failure since
* we don't know what state the job might be in.
*/
if (status) {
failed = TRUE;
stop = TRUE;
}
break;
case PROCESS_POST_START:
nih_assert (job->state == JOB_POST_START);
/* We always want to change the state when the post-start
* script terminates; if the main process is running, we'll
* stay in that state, otherwise we'll skip through.
*
* Failure is ignored since there's not much we can do
* about it at this point.
*/
break;
case PROCESS_PRE_STOP:
nih_assert (job->state == JOB_PRE_STOP);
/* We always want to change the state when the pre-stop
* script terminates, we either want to go back into running
* or head towards killing the main process.
*
* Failure is ignored since there's not much we can do
* about it at this point.
*/
break;
case PROCESS_POST_STOP:
nih_assert (job->state == JOB_POST_STOP);
/* If the post-stop script is killed or exits with a status
* other than zero, it's always considered a failure since
* we don't know what state the job might be in.
*/
if (status) {
failed = TRUE;
stop = TRUE;
}
break;
default:
nih_assert_not_reached ();
}
/* Cancel any timer trying to kill the job, since it's just
* died. We could do this inside the main process block above, but
* leaving it here for now means we can use the timer for any
* additional process later.
*/
if (job->kill_timer) {
nih_unref (job->kill_timer, job);
job->kill_timer = NULL;
job->kill_process = PROCESS_INVALID;
}
if (job->class->console == CONSOLE_LOG && job->log[process]) {
int ret;
/* It is imperative that we free the log at this stage to ensure
* that jobs which respawn have their log written _now_
* (and not just when the overall Job object is freed at
* some distant future point).
*/
ret = log_handle_unflushed (job->log, job->log[process]);
if (ret != 0) {
if (ret < 0) {
/* Any lingering data will now be lost in what
* is probably a low-memory scenario.
*/
nih_warn (_("Failed to add log to unflushed queue"));
}
nih_free (job->log[process]);
}
/* Either the log has been freed, or it needs to be
* severed from its parent job fully.
*/
job->log[process] = NULL;
}
/* Find existing utmp entry for the process pid */
setutxent();
while ((utmptr = getutxent()) != NULL) {
if (utmptr->ut_pid == job->pid[process]) {
/* set type and clean ut_user, ut_host,
* ut_time as described in utmp(5)
*/
utmptr->ut_type = DEAD_PROCESS;
memset(utmptr->ut_user, 0, UT_NAMESIZE);
memset(utmptr->ut_host, 0, UT_HOSTSIZE);
utmptr->ut_time = 0;
/* Update existing utmp file. */
pututxline(utmptr);
/* set ut_time for log */
gettimeofday(&tv, NULL);
utmptr->ut_tv.tv_sec = tv.tv_sec;
utmptr->ut_tv.tv_usec = tv.tv_usec;
/* Write wtmp entry */
updwtmpx (_PATH_WTMP, utmptr);
break;
}
}
endutxent();
/* Clear the process pid field */
job->pid[process] = 0;
/* Mark the job as failed */
if (failed)
job_failed (job, process, status);
/* Change the goal to stop; normally this doesn't have any
* side-effects, except when we're in the RUNNING state when it'll
* change the state as well. We obviously don't want to change the
* state twice.
*/
if (stop) {
if (job->state == JOB_RUNNING)
state = FALSE;
job_change_goal (job, JOB_STOP);
}
if (state)
job_change_state (job, job_next_state (job));
}
/**
* job_process_catch_runaway
* @job: job being started.
*
* This function is called when changing the state of a job to starting,
* before emitting the event. It ensures that a job doesn't end up in
* a restart loop by limiting the number of restarts in a particular
* time limit.
*
* Returns: TRUE if the job is respawning too fast, FALSE if not.
*/
static int
job_process_catch_runaway (Job *job)
{
struct timespec now;
nih_assert (job != NULL);
if (job->class->respawn_limit && job->class->respawn_interval) {
time_t interval;
/* Time since last respawn ... this goes very large if we
* haven't done one, which is fine
*/
nih_assert (clock_gettime (CLOCK_MONOTONIC, &now) == 0);
interval = now.tv_sec - job->respawn_time;
if (interval < job->class->respawn_interval) {
job->respawn_count++;
if (job->respawn_count > job->class->respawn_limit)
return TRUE;
} else {
job->respawn_time = now.tv_sec;
job->respawn_count = 1;
}
}
return FALSE;
}
/**
* job_process_stopped:
* @job: job that changed,
* @process: specific process.
*
* This function is called whenever a @process attached to @job is stopped
* by the SIGSTOP signal (and not by a tty-related signal).
*
* Some jobs use this signal to signify that they have completed starting
* up and are now running; thus we move them out of the spawned state.
**/
static void
job_process_stopped (Job *job,
ProcessType process)
{
nih_assert (job != NULL);
/* Any process can stop on a signal, but we only care about the
* main process when the state is still spawned.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED))
return;
/* Send SIGCONT back and change the state to the next one, if this
* job behaves that way.
*/
if (job->class->expect == EXPECT_STOP) {
kill (job->pid[process], SIGCONT);
job_change_state (job, job_next_state (job));
}
}
/**
* job_process_trace_new:
* @job: job that changed,
* @process: specific process.
*
* This function is called when the traced @process attached to @job calls
* its first exec(), still within the Upstart code before passing control
* to the new executable.
*
* It sets the options for the trace so that forks and execs are reported.
**/
static void
job_process_trace_new (Job *job,
ProcessType process)
{
nih_assert (job != NULL);
nih_assert ((job->trace_state == TRACE_NEW)
|| (job->trace_state == TRACE_NEW_CHILD));
/* Any process can get us to trace them, but we only care about the
* main process when the state is still spawned.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED))
return;
/* Set options so that we are notified when the process forks, and
* get a different kind of notification when it execs to a plain
* SIGTRAP.
*/
if (ptrace (PTRACE_SETOPTIONS, job->pid[process], NULL,
PTRACE_O_TRACEFORK | PTRACE_O_TRACEEXEC) < 0) {
nih_warn (_("Failed to set ptrace options for "
"%s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
return;
}
job->trace_state = TRACE_NORMAL;
/* Allow the process to continue without delivering the
* kernel-generated signal that was for our eyes not theirs.
*/
if (ptrace (PTRACE_CONT, job->pid[process], NULL, 0) < 0)
nih_warn (_("Failed to continue traced %s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
}
/**
* job_process_trace_new_child:
* @job: job that changed,
* @process: specific process.
*
* This function is called whenever a traced @process attached to @job stops
* after the fork() so that we can set the options before continuing it.
*
* Check to see whether we've reached the number of forks we expected, if
* so detach the process and move towards the running state; otherwise we
* set our important ptrace options, update the trace state so that
* further SIGSTOP or SIGTRAP signals are treated as just that and allow
* the process to continue.
**/
static void
job_process_trace_new_child (Job *job,
ProcessType process)
{
nih_assert (job != NULL);
nih_assert (job->trace_state == TRACE_NEW_CHILD);
/* Any process can get us to trace them, but we only care about the
* main process when the state is still spawned.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED))
return;
/* We need to fork at least twice unless we're expecting a
* single fork when we only need to fork once; once that limit
* has been reached, end the trace.
*/
job->trace_forks++;
if ((job->trace_forks > 1) || (job->class->expect == EXPECT_FORK))
{
if (ptrace (PTRACE_DETACH, job->pid[process], NULL, 0) < 0)
nih_warn (_("Failed to detach traced "
"%s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
job->trace_state = TRACE_NONE;
job_change_state (job, job_next_state (job));
return;
}
job_process_trace_new (job, process);
}
/**
* job_process_trace_signal:
* @job: job that changed,
* @process: specific process.
*
* This function is called whenever a traced @process attached to @job has
* a signal sent to it.
*
* We don't care about these, they're a side effect of ptrace that we can't
* turn off, so we just deliver them untampered with.
**/
static void
job_process_trace_signal (Job *job,
ProcessType process,
int signum)
{
nih_assert (job != NULL);
/* Any process can get us to trace them, but we only care about the
* main process when the state is still spawned.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED)
|| (job->trace_state != TRACE_NORMAL))
return;
/* Deliver the signal */
if (ptrace (PTRACE_CONT, job->pid[process], NULL, signum) < 0)
nih_warn (_("Failed to deliver signal to traced "
"%s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
}
/**
* job_process_trace_fork:
* @job: job that changed,
* @process: specific process.
*
* This function is called whenever a traced @process attached to @job calls
* the fork() system call.
*
* We obtain the new child process id from the message and update the
* structure so that we follow that instead, detaching from the process that
* called fork.
**/
static void
job_process_trace_fork (Job *job,
ProcessType process)
{
unsigned long data;
nih_assert (job != NULL);
/* Any process can get us to trace them, but we only care about the
* main process when the state is still spawned.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED)
|| (job->trace_state != TRACE_NORMAL))
return;
/* Obtain the child process id from the ptrace event. */
if (ptrace (PTRACE_GETEVENTMSG, job->pid[process], NULL, &data) < 0) {
nih_warn (_("Failed to obtain child process id "
"for %s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
return;
}
nih_info (_("%s %s process (%d) became new process (%d)"),
job_name (job), process_name (process),
job->pid[process], (pid_t)data);
/* We no longer care about this process, it's the child that we're
* interested in from now on, so detach it and allow it to go about
* its business unhindered.
*/
if (ptrace (PTRACE_DETACH, job->pid[process], NULL, 0) < 0)
nih_warn (_("Failed to detach traced %s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
/* Update the process we're supervising which is about to get SIGSTOP
* so set the trace options to capture it.
*/
job->pid[process] = (pid_t)data;
job->trace_state = TRACE_NEW_CHILD;
/* We may have already had the wait notification for the new child
* waiting at SIGSTOP, in which case a ptrace() call will succeed
* for it.
*/
if (ptrace (PTRACE_SETOPTIONS, job->pid[process], NULL, 0) < 0) {
nih_debug ("Failed to set options for new %s %s process (%d), "
"probably not yet forked: %s",
job_name (job), process_name (process),
job->pid[process], strerror (errno));
return;
}
job_process_trace_new_child (job, process);
}
/**
* job_process_trace_exec:
* @job: job that changed,
* @process: specific process.
*
* This function is called whenever a traced @process attached to @job calls
* the exec() system call after we've set options on it to distinguish them
* from ordinary SIGTRAPs.
*
* We assume that if the job calls exec that it's finished forking so we can
* drop the trace entirely; we have no interest in tracing the new child.
**/
static void
job_process_trace_exec (Job *job,
ProcessType process)
{
nih_assert (job != NULL);
/* Any process can get us to trace them, but we only care about the
* main process when the state is still spawned and we're tracing it.
*/
if ((process != PROCESS_MAIN) || (job->state != JOB_SPAWNED)
|| (job->trace_state != TRACE_NORMAL))
return;
nih_info (_("%s %s process (%d) executable changed"),
job_name (job), process_name (process), job->pid[process]);
if (job->trace_forks) {
if (ptrace (PTRACE_DETACH, job->pid[process], NULL, 0) < 0)
nih_warn (_("Failed to detach traced "
"%s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
job->trace_state = TRACE_NONE;
job_change_state (job, job_next_state (job));
} else {
if (ptrace (PTRACE_CONT, job->pid[process], NULL, 0) < 0)
nih_warn (_("Failed to continue traced %s %s process (%d): %s"),
job_name (job), process_name (process),
job->pid[process], strerror (errno));
}
}
/**
* job_process_find:
* @pid: process id to find,
* @process: pointer to place process which is running @pid.
*
* Finds the job with a process of the given @pid in the jobs hash table.
* If @process is not NULL, the @process variable is set to point at the
* process entry in the table which has @pid.
*
* Returns: job found or NULL if not known.
**/
Job *
job_process_find (pid_t pid,
ProcessType *process)
{
nih_assert (pid > 0);
job_class_init ();
NIH_HASH_FOREACH (job_classes, iter) {
JobClass *class = (JobClass *)iter;
NIH_HASH_FOREACH (class->instances, job_iter) {
Job *job = (Job *)job_iter;
int i;
for (i = 0; i < PROCESS_LAST; i++) {
if (job->pid[i] == pid) {
if (process)
*process = i;
return job;
}
}
}
}
return NULL;
}
/**
* job_process_log_path:
*
* @job: Job,
* @user_job: TRUE if @job refers to a non-root job, else FALSE.
*
* Determine full path to on-disk log file for specified @job.
*
* This differs depending on whether the job is a system job or a user job.
* Instance names are appended to the log name.
*
* Returns: newly allocated log path string, or NULL on raised error.
**/
char *
job_process_log_path (Job *job, int user_job)
{
JobClass *class = NULL;
char *log_path = NULL;
nih_local char *dir = NULL;
nih_local char *class_name = NULL;
char *p;
nih_assert (job);
nih_assert (job->class);
/* Logging of user job output not currently supported */
nih_assert (user_job == 0);
class = job->class;
nih_assert (class->name);
/* Override, primarily for tests */
if (getenv (LOGDIR_ENV) && ! user_mode) {
dir = nih_strdup (NULL, getenv (LOGDIR_ENV));
nih_debug ("Using alternative directory '%s' for logs", dir);
} else {
dir = nih_strdup (NULL, log_dir ? log_dir : JOB_LOGDIR);
}
if (! dir)
nih_return_no_memory_error (NULL);
/* If the job is running inside a chroot, it must be logged to a
* file within the chroot.
*/
if (job->class->session && job->class->session->chroot) {
char *tmp = dir;
dir = nih_sprintf (NULL, "%s%s",
job->class->session->chroot,
tmp);
nih_free (tmp);
}
class_name = nih_strdup (NULL, class->name);
if (! class_name)
nih_return_no_memory_error (NULL);
/* Remap slashes since we write all logs to the
* same directory.
*/
p = class_name;
while (*p) {
if (*p == JOB_PROCESS_LOG_REMAP_FROM_CHAR)
*p = JOB_PROCESS_LOG_REMAP_TO_CHAR;
p++;
}
/* Handle jobs with multiple instances */
if (job->name && *job->name) {
nih_local char *instance_name = NULL;
instance_name = nih_strdup (NULL, job->name);
if (! instance_name)
nih_return_no_memory_error (NULL);
p = instance_name;
while (*p) {
if (*p == JOB_PROCESS_LOG_REMAP_FROM_CHAR)
*p = JOB_PROCESS_LOG_REMAP_TO_CHAR;
p++;
}
log_path = nih_sprintf (NULL, "%s/%s-%s%s",
dir,
class_name,
instance_name,
JOB_PROCESS_LOG_FILE_EXT);
} else {
log_path = nih_sprintf (NULL, "%s/%s%s",
dir,
class_name,
JOB_PROCESS_LOG_FILE_EXT);
}
if (! log_path)
nih_return_no_memory_error (NULL);
return log_path;
}
/**
* job_process_remap_fd:
*
* @fd: pointer to fd to potentially remap,
* @reserved_fd: reserved fd value,
* @error_fd: fd to report errors on,
*
* Remap @fd to a new value iff it has the same value as @reserved_fd.
*
* Errors are reported via @error_fd and are fatal.
*
* Notes:
*
* - File descriptor flags are not retained.
* - It is permissible for @error_fd to have the same value as @fd.
**/
static void
job_process_remap_fd (int *fd, int reserved_fd, int error_fd)
{
int new = -1;
nih_assert (fd);
nih_assert (reserved_fd);
nih_assert (error_fd);
if (*fd != reserved_fd)
return;
new = dup (*fd);
if (new < 0) {
nih_error_raise_system ();
job_process_error_abort (error_fd, JOB_PROCESS_ERROR_DUP, 0);
}
close (*fd);
*fd = new;
}
|