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 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
|
/*
* bltWinPipe.c --
*
* Lifted from tclPipe.c and tclWinPipe.c in the Tcl
* distribution, this is the first step toward freedom from the
* tyranny of the former Tcl_CreatePipeline API.
*
* This file contains the generic portion of the command channel
* driver as well as various utility routines used in managing
* subprocesses.
*
* [It's not clear why we needed a whole new API for I/O. Channels
* are one of the few losing propositions in Tcl. While it's easy
* to see that one needs to handle the different platform I/O
* semantics in a coherent fashion, it's usually better to pick
* an API from one of platforms (hopefully a mature, well-known model)
* and crowbar the other platforms to follow that. At least then
* you're working from a known set of sematics. With Tcl Channels,
* no one's an expert and the interface is incomplete.]
*
* Copyright (c) 1997 by Sun Microsystems, Inc.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*
*/
/*
* Todo:
* Test on win95
* Does terminating bltwish kill child processes?
* Handle EOL translation more cleanly.
*/
#include "bltInt.h"
#include "bltChain.h"
#include <fcntl.h>
#define PEEK_DEBUG 0
#define QUEUE_DEBUG 0
#define READER_DEBUG 0
#define ASYNC_DEBUG 0
#define KILL_DEBUG 0
typedef struct {
DWORD pid;
HANDLE hProcess;
} Process;
/*
* The following type identifies the various types of applications that
* run under windows. There is special case code for the various types.
*/
typedef enum ApplicationTypes {
APPL_NONE, APPL_DOS, APPL_WIN3X, APPL_WIN32, APPL_INTERP
} ApplicationType;
#ifndef IMAGE_OS2_SIGNATURE
# define IMAGE_OS2_SIGNATURE (0x454E)
#endif
#ifndef IMAGE_VXD_SIGNATURE
# define IMAGE_VXD_SIGNATURE (0x454C)
#endif
#define PIPE_BUFSIZ (BUFSIZ*2) /* Size of pipe read buffer. */
#define PIPE_PENDING (1<<13) /* Message is pending in the queue. */
#define PIPE_EOF (1<<14) /* Pipe has reached EOF. */
#define PIPE_DELETED (1<<15) /* Indicates if the pipe has been deleted
* but its memory hasn't been freed yet. */
typedef struct {
int flags; /* State flags, see above for a list. */
HANDLE hPipe; /* Pipe handle */
HANDLE thread; /* Thread watching I/O on this pipe. */
HANDLE parent; /* Handle of main thread. */
DWORD parentId; /* Main thread ID. */
HWND hWindow; /* Notifier window in main thread. Used to
* goose the Tcl notifier system indicating
* that an event has occurred that it
* needs to process. */
HANDLE idleEvent; /* Signals that the pipe is idle (no one
* is reading/writing from it). */
HANDLE readyEvent; /* Signals that the pipe is ready for
* the next I/O operation. */
DWORD lastError; /* Error. */
char *buffer; /* Current background output buffer. */
size_t start, end; /* Pointers into the output buffer */
size_t size; /* Size of buffer. */
Tcl_FileProc *proc;
ClientData clientData;
} PipeHandler;
typedef struct {
Tcl_Event header; /* Information that is standard for
* all events. */
PipeHandler *pipePtr; /* Pointer to pipe handler structure.
* Note that we still have to verify
* that the pipe exists before
* dereferencing this pointer. */
} PipeEvent;
static int initialized = 0;
static Blt_Chain pipeChain;
static CRITICAL_SECTION pipeCriticalSection;
static DWORD WINAPI PipeWriterThread(void *clientData);
static DWORD WINAPI PipeReaderThread(void *clientData);
static Tcl_FreeProc DestroyPipe;
extern void Blt_MapPid(HANDLE hProcess, DWORD pid);
extern HINSTANCE TclWinGetTclInstance(void);
extern void TclWinConvertError(DWORD lastError);
/*
*----------------------------------------------------------------------
*
* NotifierWindowProc --
*
* This procedure is called to "goose" the Tcl notifier layer to
* service pending events. The notifier layer is built upon the
* Windows message system. It may need to be awakened if it's
* blocked waiting on messages, since synthetic events (i.e.
* data available on a pipe) won't do that. There may be events
* pending in the Tcl queue, but the Windows message system knows
* nothing about Tcl events and won't unblock until the next
* message arrives (whenever that may be).
*
* This callback is triggered by messages posted to the notifier
* window (we set up earlier) from the reader/writer pipe
* threads. It's purpose is to 1) unblock Windows (posting the
* message does that) and 2) call Tcl_ServiceAll from the main
* thread. It has to be called from the main thread, not
* directly from the pipe threads.
*
* Results:
* A standard Windows result.
*
* Side effects:
* Services any pending Tcl events.
*
*----------------------------------------------------------------------
*/
static LRESULT CALLBACK
NotifierWindowProc(
HWND hWindow,
UINT message,
WPARAM wParam,
LPARAM lParam)
{
switch (message) {
case WM_USER:
case WM_TIMER:
break;
default:
return DefWindowProc(hWindow, message, wParam, lParam);
}
Tcl_ServiceAll(); /* Process all run-able events. */
return 0;
}
static void
WakeupNotifier(HWND hWindow)
{
PostMessage(hWindow, WM_USER, 0, 0);
}
/*
*----------------------------------------------------------------------
*
* GetNotifierWindow --
*
* Initializes the platform specific notifier state.
*
* Results:
* Returns a handle to the notifier state for this thread..
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static HWND
GetNotifierWindow(void)
{
static HWND hWindow = NULL;
/*
* Register Notifier window class if this is the first thread to
* use this module.
*/
if (hWindow == NULL) {
WNDCLASS class;
HINSTANCE hInstance;
memset(&class, 0, sizeof(WNDCLASS));
hInstance = TclWinGetTclInstance();
class.hInstance = hInstance;
class.lpszClassName = "PipeNotifier";
class.lpfnWndProc = NotifierWindowProc;
if (!RegisterClassA(&class)) {
panic("Unable to register PipeNotifier window class");
}
/*
* Create a window for communication with the notifier.
*/
hWindow = CreateWindowA("PipeNotifier", "PipeNotifier", WS_TILED,
0, 0, 0, 0, NULL, NULL, hInstance, NULL);
}
return hWindow;
}
/*
*----------------------------------------------------------------------
*
* PeekOnPipe --
*
* See if some data is available, the pipe is at EOF, or the
* reader thread is currently blocked waiting for data.
*
* Results:
* Return TRUE if data is available, FALSE if otherwise. Note
* that errors and EOF always return TRUE. We always make the
* condition available until the caller handles it by deleting
* the pipe event handler.
*
* On TRUE, the number of bytes returned indicates the following:
* 0 EOF.
* -1 An error has occured or the thread is currently
* blocked reading. In that last case, errno is set
* to EAGAIN.
* >0 Number of bytes of data in the buffer.
*
*----------------------------------------------------------------------
*/
static int
PeekOnPipe(
PipeHandler *pipePtr, /* Pipe state. */
int *nAvailPtr)
{
int state;
*nAvailPtr = -1;
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): waiting for reader\n", pipePtr->hPipe);
#endif
state = WaitForSingleObject(pipePtr->readyEvent, 0);
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): state is %d\n", pipePtr->hPipe, state);
#endif
if (state == WAIT_TIMEOUT) {
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): try again, %d\n", pipePtr->hPipe, state);
#endif
errno = EAGAIN;
return FALSE; /* Reader thread is currently blocked. */
}
/*
* At this point the two threads are synchronized. So it's safe
* to access shared information.
*/
if (state == WAIT_OBJECT_0) {
int nAvail;
nAvail = pipePtr->end - pipePtr->start;
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): Found %d bytes available\n",
pipePtr->hPipe, nAvail);
#endif
if ((nAvail <= 0) && !(pipePtr->flags & PIPE_EOF)) {
TclWinConvertError(pipePtr->lastError);
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): Error = %d\n",
pipePtr->hPipe, pipePtr->lastError);
#endif
nAvail = -1;
}
*nAvailPtr = nAvail;
}
#if PEEK_DEBUG
PurifyPrintf("PEEK(%d): Reseting events\n", pipePtr->hPipe);
#endif
return TRUE;
}
/*
*----------------------------------------------------------------------
*
* PipeEventProc --
*
* This function is invoked by Tcl_ServiceEvent when a file event
* reaches the front of the event queue. This procedure calls back
* the handler procedure designated for this pipe.
*
* Results:
* Returns 1 if the event was handled, meaning it should be removed
* from the queue. Returns 0 if the event was not handled, meaning
* it should stay on the queue. The only time the event isn't
* handled is if the TCL_FILE_EVENTS flag bit isn't set.
*
* Side effects:
* Whatever the pipe handler callback does.
*
*----------------------------------------------------------------------
*/
static int
PipeEventProc(Tcl_Event * eventPtr, int flags)
{
PipeHandler *pipePtr;
if (!(flags & TCL_FILE_EVENTS)) {
return 0;
}
pipePtr = ((PipeEvent *) eventPtr)->pipePtr;
if ((pipePtr != NULL) && !(pipePtr->flags & PIPE_DELETED)) {
Tcl_Preserve(pipePtr);
if (pipePtr->proc != NULL) {
(*pipePtr->proc) (pipePtr->clientData, flags);
}
/* Allow more events again. */
pipePtr->flags &= ~PIPE_PENDING;
Tcl_Release(pipePtr);
}
return 1;
}
/*
*----------------------------------------------------------------------
*
* SetupHandlers --
*
* This procedure is invoked before Tcl_DoOneEvent blocks waiting
* for an event.
*
* Results:
* None.
*
* Side effects:
* Adjusts the block time if needed.
*
*----------------------------------------------------------------------
*/
void
SetupHandlers(ClientData clientData, int flags)
{
Blt_Chain *chainPtr = (Blt_Chain *) clientData;
register PipeHandler *pipePtr;
Blt_ChainLink *linkPtr;
int dontBlock, nBytes;
Tcl_Time blockTime;
if (!(flags & TCL_FILE_EVENTS)) {
return;
}
/*
* Loop through the list of pipe handlers. Check if any I/O
* events are currently pending.
*/
dontBlock = FALSE;
blockTime.sec = blockTime.usec = 0L;
#if QUEUE_DEBUG
PurifyPrintf("SetupHandlers: before loop\n");
#endif
for (linkPtr = Blt_ChainFirstLink(chainPtr); linkPtr != NULL;
linkPtr = Blt_ChainNextLink(linkPtr)) {
pipePtr = Blt_ChainGetValue(linkPtr);
if (pipePtr->flags & PIPE_DELETED) {
continue; /* Ignore pipes pending to be freed. */
}
if (pipePtr->flags & TCL_READABLE) {
if (PeekOnPipe(pipePtr, &nBytes)) {
dontBlock = TRUE;
}
}
if (pipePtr->flags & TCL_WRITABLE) {
if (WaitForSingleObject(pipePtr->readyEvent, 0) != WAIT_TIMEOUT) {
dontBlock = TRUE;
}
}
}
#if QUEUE_DEBUG
PurifyPrintf("SetupHandlers: after loop\n");
#endif
if (dontBlock) {
Tcl_SetMaxBlockTime(&blockTime);
}
}
/*
*----------------------------------------------------------------------
*
* CheckHandlers --
*
* This procedure is called by Tcl_DoOneEvent to check the pipe
* event source for events.
*
* Results:
* None.
*
* Side effects:
* May queue an event.
*
*----------------------------------------------------------------------
*/
static void
CheckHandlers(ClientData clientData, int flags)
{
Blt_Chain *chainPtr = (Blt_Chain *) clientData;
PipeHandler *pipePtr;
Blt_ChainLink *linkPtr;
int queueEvent, nBytes;
if ((flags & TCL_FILE_EVENTS) == 0) {
return;
}
/* Queue events for any ready pipes that aren't already queued. */
for (linkPtr = Blt_ChainFirstLink(chainPtr); linkPtr != NULL;
linkPtr = Blt_ChainNextLink(linkPtr)) {
pipePtr = Blt_ChainGetValue(linkPtr);
if (pipePtr->flags & (PIPE_PENDING | PIPE_DELETED)) {
continue; /* If this pipe already is scheduled to
* service an event, wait for it to handle
* it. */
}
/* Queue an event if the pipe is signaled for reading or writing. */
queueEvent = FALSE;
if (pipePtr->flags & TCL_READABLE) {
if (PeekOnPipe(pipePtr, &nBytes)) {
queueEvent = TRUE;
}
}
if (pipePtr->flags & TCL_WRITABLE) {
if (WaitForSingleObject(pipePtr->readyEvent, 0) != WAIT_TIMEOUT) {
queueEvent = TRUE;
}
}
#if QUEUE_DEBUG
PurifyPrintf("Queue event is %d \n", queueEvent);
#endif
if (queueEvent) {
PipeEvent *eventPtr;
pipePtr->flags |= PIPE_PENDING;
eventPtr = Blt_Malloc(sizeof(PipeEvent));
assert(eventPtr);
eventPtr->header.proc = PipeEventProc;
eventPtr->pipePtr = pipePtr;
Tcl_QueueEvent((Tcl_Event *) eventPtr, TCL_QUEUE_TAIL);
}
}
}
static PipeHandler *
CreatePipeHandler(HANDLE hFile, int flags)
{
DWORD id;
PipeHandler *pipePtr;
LPTHREAD_START_ROUTINE threadProc;
pipePtr = Blt_Calloc(1, sizeof(PipeHandler));
assert(pipePtr);
pipePtr->hPipe = hFile;
pipePtr->flags = flags;
pipePtr->parentId = GetCurrentThreadId();
pipePtr->parent = GetCurrentThread();
pipePtr->hWindow = GetNotifierWindow();
pipePtr->readyEvent = CreateEvent(
NULL, /* Security attributes. */
TRUE, /* Manual reset event */
FALSE, /* Initially not signaled. */
NULL); /* Event object's name. */
pipePtr->idleEvent = CreateEvent(
NULL, /* Security attributes. */
FALSE, /* Auto reset event. */
TRUE, /* Initially signaled. */
NULL); /* Event object's name. */
if (flags & TCL_READABLE) {
threadProc = (LPTHREAD_START_ROUTINE) PipeReaderThread;
pipePtr->buffer = Blt_Calloc(1, PIPE_BUFSIZ);
pipePtr->size = PIPE_BUFSIZ;
} else {
threadProc = (LPTHREAD_START_ROUTINE) PipeWriterThread;
}
pipePtr->thread = CreateThread(
NULL, /* Security attributes */
8000, /* Initial stack size. */
threadProc, /* Starting address of thread routine */
(DWORD *) pipePtr, /* One-word of data passed to routine. */
0, /* Creation flags */
&id); /* (out) Will contain Id of new thread. */
return pipePtr;
}
static void
DestroyPipe(DestroyData data)
{
PipeHandler *pipePtr = (PipeHandler *)data;
if (pipePtr->buffer != NULL) {
Blt_Free(pipePtr->buffer);
}
Blt_Free(pipePtr);
}
static void
DeletePipeHandler(PipeHandler * pipePtr)
{
#if KILL_DEBUG
PurifyPrintf("DestroyPipeHandler(%d)\n", pipePtr->hPipe);
#endif
if ((pipePtr->flags & TCL_WRITABLE) &&
(pipePtr->hPipe != INVALID_HANDLE_VALUE)) {
/* Wait for the writer thread to finish with the current buffer */
WaitForSingleObject(pipePtr->idleEvent, INFINITE);
}
if (pipePtr->hPipe != INVALID_HANDLE_VALUE) {
CloseHandle(pipePtr->hPipe);
}
CloseHandle(pipePtr->readyEvent);
CloseHandle(pipePtr->idleEvent);
CloseHandle(pipePtr->thread);
pipePtr->idleEvent = pipePtr->readyEvent = INVALID_HANDLE_VALUE;
pipePtr->thread = pipePtr->hPipe = INVALID_HANDLE_VALUE;
pipePtr->flags |= PIPE_DELETED; /* Mark the pipe has deleted. */
Tcl_EventuallyFree(pipePtr, DestroyPipe);
}
/*
*----------------------------------------------------------------------
*
* PipeInit --
*
* This function initializes the static variables for this file.
*
* Results:
* None.
*
* Side effects:
* Creates a new event source.
*
*----------------------------------------------------------------------
*/
static void
PipeInit(void)
{
initialized = TRUE;
InitializeCriticalSection(&pipeCriticalSection);
Blt_ChainInit(&pipeChain);
Tcl_CreateEventSource(SetupHandlers, CheckHandlers, &pipeChain);
}
static PipeHandler *
GetPipeHandler(HANDLE hPipe)
{
PipeHandler *pipePtr;
Blt_ChainLink *linkPtr;
for (linkPtr = Blt_ChainFirstLink(&pipeChain); linkPtr != NULL;
linkPtr = Blt_ChainNextLink(linkPtr)) {
pipePtr = Blt_ChainGetValue(linkPtr);
if ((pipePtr->hPipe == hPipe) && !(pipePtr->flags & PIPE_DELETED)){
return pipePtr;
}
}
return NULL;
}
/*
*----------------------------------------------------------------------
*
* Blt_PipeTeardown --
*
* This function releases any storage allocated for this file.
*
* Results:
* None.
*
* Side effects:
* Creates a new event source.
*
*----------------------------------------------------------------------
*/
void
Blt_PipeTeardown(void)
{
Blt_ChainLink *linkPtr;
PipeHandler *pipePtr;
if (!initialized) {
return; /* Was never initialized. */
}
initialized = FALSE;
EnterCriticalSection(&pipeCriticalSection);
for (linkPtr = Blt_ChainFirstLink(&pipeChain); linkPtr != NULL;
linkPtr = Blt_ChainNextLink(linkPtr)) {
pipePtr = Blt_ChainGetValue(linkPtr);
if ((pipePtr != NULL) && !(pipePtr->flags & PIPE_DELETED)) {
DeletePipeHandler(pipePtr);
}
}
DestroyWindow(GetNotifierWindow());
UnregisterClassA("PipeNotifier", TclWinGetTclInstance());
Blt_ChainReset(&pipeChain);
LeaveCriticalSection(&pipeCriticalSection);
Tcl_DeleteEventSource(SetupHandlers, CheckHandlers, &pipeChain);
DeleteCriticalSection(&pipeCriticalSection);
}
/*
*----------------------------------------------------------------------
*
* PipeReaderThread --
*
* This function runs in a separate thread and waits for input
* to become available on a pipe.
*
* Results:
* None.
*
* Side effects:
* Signals the main thread when input become available. May
* cause the main thread to wake up by posting a message.
*
*----------------------------------------------------------------------
*/
static DWORD WINAPI
PipeReaderThread(void *clientData)
{
PipeHandler *pipePtr = (PipeHandler *) clientData;
DWORD count;
BOOL result;
for (;;) {
if (pipePtr->flags & PIPE_DELETED) {
break;
}
/* Synchronize with the main thread so that we don't try to
* read from the pipe while it's copying to the buffer. */
#if READER_DEBUG
PurifyPrintf("READER(%d): waiting\n", pipePtr->hPipe);
#endif
WaitForSingleObject(pipePtr->idleEvent, INFINITE);
#if READER_DEBUG
PurifyPrintf("READER(%d): ok\n", pipePtr->hPipe);
#endif
/* Read from the pipe. The thread will block here until some
* data is read into its buffer. */
#if READER_DEBUG
PurifyPrintf("READER(%d): before read\n", pipePtr->hPipe);
#endif
assert(pipePtr->start == pipePtr->end);
result = ReadFile(
pipePtr->hPipe, /* Handle to anonymous pipe. */
pipePtr->buffer, /* Data buffer. */
pipePtr->size, /* Requested number of bytes (the size
* of the buffer) */
&count, /* (out) Number of bytes actually read. */
NULL); /* Overlapping I/O */
if (result) {
#if READER_DEBUG
PurifyPrintf("READER(%d): after read. status=%d, count=%d\n",
pipePtr->hPipe, result, count);
#endif
}
/*
* Reset counters to indicate that the buffer has been refreshed.
*/
pipePtr->start = 0;
pipePtr->end = count;
if (count == 0) {
/* We've hit EOF or an error. */
pipePtr->lastError = GetLastError();
if ((pipePtr->lastError == ERROR_BROKEN_PIPE) ||
(pipePtr->lastError == ERROR_HANDLE_EOF)) {
pipePtr->flags |= PIPE_EOF;
}
#if READER_DEBUG
PurifyPrintf("READER(%d): error is %s\n",
pipePtr->hPipe, Blt_LastError());
#endif
}
WakeupNotifier(pipePtr->hWindow);
SetEvent(pipePtr->readyEvent);
if (count == 0) {
#if READER_DEBUG
PurifyPrintf("READER(%d): exiting\n", pipePtr->hPipe);
#endif
ExitThread(0);
}
}
/* NOTREACHED */
return 0;
}
/*
*----------------------------------------------------------------------
*
* PipeWriterThread --
*
* This function runs in a separate thread and writes data
* to the process' standard input pipe.
*
* Results:
* Always returns 0.
*
* Side effects:
* Signals the main thread when an output operation is completed.
* May cause the main thread to wake up by posting a message.
*
*----------------------------------------------------------------------
*/
static DWORD WINAPI
PipeWriterThread(void *clientData)
{
PipeHandler *pipePtr = (PipeHandler *) clientData;
DWORD count, bytesLeft;
register char *ptr;
for (;;) {
if (pipePtr->flags & PIPE_DELETED) {
break;
}
/*
* Synchronize with the main thread so that we don't test the
* pipe until its done writing.
*/
WaitForSingleObject(pipePtr->idleEvent, INFINITE);
ptr = pipePtr->buffer;
bytesLeft = pipePtr->end;
/* Loop until all of the bytes are written or an error occurs. */
while (bytesLeft > 0) {
if (!WriteFile(pipePtr->hPipe, ptr, bytesLeft, &count, NULL)) {
pipePtr->lastError = GetLastError();
break;
}
bytesLeft -= count;
ptr += count;
}
/* Tell the main thread that data can be written to the pipe.
* Remember to wake up the notifier thread. */
SetEvent(pipePtr->readyEvent);
WakeupNotifier(pipePtr->hWindow);
}
/* NOTREACHED */
return 0;
}
/*
*----------------------------------------------------------------------
*
* TempFileName --
*
* Gets a temporary file name and deals with the fact that the
* temporary file path provided by Windows may not actually exist
* if the TMP or TEMP environment variables refer to a
* non-existent directory.
*
* Results:
* 0 if error, non-zero otherwise. If non-zero is returned, the
* name buffer will be filled with a name that can be used to
* construct a temporary file.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static int
TempFileName(char *name) /* (out) Buffer to hold name of
* temporary file. */
{
if ((GetTempPath(MAX_PATH, name) > 0) &&
(GetTempFileName(name, "TCL", 0, name))) {
return 1;
}
/* Bail out and use the current working directory. */
return GetTempFileName(".", "TCL", 0, name);
}
/*
*----------------------------------------------------------------------
*
* OpenRedirectFile --
*
* Open a file for use in a pipeline.
*
* Results:
* Returns a new handle or NULL on failure.
*
* Side effects:
* May cause a file to be created on the file system.
*
*----------------------------------------------------------------------
*/
static HANDLE
OpenRedirectFile(
const char *path,
DWORD accessFlags,
DWORD createFlags)
{
HANDLE hFile;
DWORD attribFlags;
int useExisting;
attribFlags = 0;
useExisting = (createFlags & (TRUNCATE_EXISTING | OPEN_EXISTING));
if (useExisting) {
attribFlags = GetFileAttributes(path);
if (attribFlags == 0xFFFFFFFF) {
attribFlags = 0;
}
}
hFile = CreateFile(path,
accessFlags, /* Access mode flags */
FILE_SHARE_READ | FILE_SHARE_WRITE,
NULL, /* No security */
createFlags, /* Creation attributes */
attribFlags, /* File attribute flags */
NULL); /* Template file */
if (hFile == INVALID_HANDLE_VALUE) {
DWORD lastError;
lastError = GetLastError();
if ((lastError & 0xffffL) == ERROR_OPEN_FAILED) {
lastError = (useExisting)
? ERROR_FILE_NOT_FOUND : ERROR_FILE_EXISTS;
}
TclWinConvertError(lastError);
return INVALID_HANDLE_VALUE;
}
/*
* Seek to the end of file if we are writing.
*/
if (createFlags & GENERIC_WRITE) {
SetFilePointer(hFile, 0, NULL, FILE_END);
}
return hFile;
}
/*
*----------------------------------------------------------------------
*
* CreateTempFile --
*
* This function creates a temporary file initialized with an
* optional string, and returns a file handle with the file pointer
* at the beginning of the file.
*
* Results:
* A handle to a file.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static HANDLE
CreateTempFile(const char *data) /* String to write into temp file, or
* NULL. */
{
char fileName[MAX_PATH + 1];
HANDLE hFile;
DWORD lastError;
if (!TempFileName(fileName)) {
return INVALID_HANDLE_VALUE;
}
hFile = CreateFile(
fileName, /* File path */
GENERIC_READ | GENERIC_WRITE, /* Access mode */
0, /* No sharing. */
NULL, /* Security attributes */
CREATE_ALWAYS, /* Overwrite any existing file */
FILE_ATTRIBUTE_TEMPORARY | FILE_FLAG_DELETE_ON_CLOSE,
NULL); /* No template file */
if (hFile == INVALID_HANDLE_VALUE) {
goto error;
}
if (data != NULL) {
DWORD result, length;
const char *p;
const char *string;
string = data;
for (p = string; *p != '\0'; p++) {
if (*p == '\n') {
length = p - string;
if (length > 0) {
if (!WriteFile(hFile, string, length, &result, NULL)) {
goto error;
}
}
if (!WriteFile(hFile, "\r\n", 2, &result, NULL)) {
goto error;
}
string = p + 1;
}
}
length = p - string;
if (length > 0) {
if (!WriteFile(hFile, string, length, &result, NULL)) {
goto error;
}
}
if (SetFilePointer(hFile, 0, NULL, FILE_BEGIN) == (DWORD) - 1) {
goto error;
}
}
return hFile;
error:
lastError = GetLastError();
CloseHandle(hFile);
DeleteFile(fileName); /* Do I need this? Delete on close? */
TclWinConvertError(lastError);
return INVALID_HANDLE_VALUE;
}
/*
*----------------------------------------------------------------------
*
* HasConsole --
*
* Determines whether the current application is attached to a
* console.
*
* Results:
* Returns TRUE if this application has a console, else FALSE.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static BOOL
HasConsole(void)
{
HANDLE hFile;
hFile = CreateFileA("CONOUT$", GENERIC_WRITE, FILE_SHARE_WRITE, NULL,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile == INVALID_HANDLE_VALUE) {
return FALSE;
}
CloseHandle(hFile);
return TRUE;
}
static ApplicationType
GetApplicationType(const char *file, char *cmdPrefix)
{
char *dot;
HANDLE hFile;
IMAGE_DOS_HEADER imageDosHeader;
ULONG signature;
BOOL result;
DWORD offset;
DWORD nBytes;
ApplicationType type;
dot = strrchr(file, '.');
if ((dot != NULL) && (strcasecmp(dot, ".bat") == 0)) {
return APPL_DOS;
}
/* Work a little harder. Open the binary and read the header */
hFile = CreateFileA(file, GENERIC_READ, FILE_SHARE_READ, NULL,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile == INVALID_HANDLE_VALUE) {
return APPL_NONE;
}
type = APPL_NONE;
result = ReadFile(hFile, &imageDosHeader, sizeof(IMAGE_DOS_HEADER),
&nBytes, NULL);
if ((!result) || (nBytes != sizeof(IMAGE_DOS_HEADER))) {
goto done;
}
#if KILL_DEBUG
PurifyPrintf("magic number is %x\n", imageDosHeader.e_magic);
#endif
if (imageDosHeader.e_magic == 0x2123) { /* #! */
register char *p;
register unsigned int i;
offset = SetFilePointer(hFile, 2, NULL, FILE_BEGIN);
if (offset == (DWORD) - 1) {
goto done;
}
result = ReadFile(hFile, cmdPrefix, MAX_PATH + 1, &nBytes, NULL);
if ((!result) || (nBytes < 1)) {
goto done;
}
for (p = cmdPrefix, i = 0; i < nBytes; i++, p++) {
if ((*p == '\n') || (*p == '\r')) {
break;
}
}
*p = '\0';
type = APPL_INTERP;
goto done;
}
/*
* Doesn't have the magic number for relocatable executables. If
* filename ends with .com, assume it's a DOS application anyhow.
* Note that we didn't make this assumption at first, because some
* supposed .com files are really 32-bit executables with all the
* magic numbers and everything.
*/
if ((dot != NULL) && (strcmp(dot, ".com") == 0)) {
#if KILL_DEBUG
PurifyPrintf(".com\n");
#endif
type = APPL_DOS;
goto done;
}
if (imageDosHeader.e_magic != IMAGE_DOS_SIGNATURE) {
#if KILL_DEBUG
PurifyPrintf("Application doesn't have correct sig?\n");
#endif
}
if (imageDosHeader.e_lfarlc != sizeof(IMAGE_DOS_HEADER)) {
/* This assumes that all 3.x and Win32 programs have their
* file relocation table immediately following this header. */
/*
* All Windows 3.X and Win32 and some DOS programs have this value
* set here. If it doesn't, assume that since it already had the
* other magic number it was a DOS application.
*/
#if KILL_DEBUG
PurifyPrintf("wrong reloc table address\n");
#endif
type = APPL_DOS;
goto done;
}
offset = SetFilePointer(hFile, imageDosHeader.e_lfanew, NULL, FILE_BEGIN);
if (offset == (DWORD) - 1) {
goto done;
}
result = ReadFile(hFile, &signature, sizeof(ULONG), &nBytes, NULL);
if ((!result) || (nBytes != sizeof(ULONG))) {
goto done;
}
#if KILL_DEBUG
PurifyPrintf("signature is %x\n", signature);
#endif
switch (signature) {
case IMAGE_NT_SIGNATURE:
type = APPL_WIN32;
break;
case IMAGE_OS2_SIGNATURE:
type = APPL_WIN3X;
break;
case IMAGE_VXD_SIGNATURE:
type = APPL_WIN32;
break;
default:
type = APPL_DOS;
break;
}
done:
CloseHandle(hFile);
return type;
}
/*
*----------------------------------------------------------------------
*
* GetFullPath --
*
* Look for the program as an external program. First try the
* name as it is, then try adding .com, .exe, and .bat, in that
* order, to the name, looking for an executable.
*
* Using the raw SearchPath() procedure doesn't do quite what is
* necessary. If the name of the executable already contains a
* '.' character, it will not try appending the specified
* extension when searching (in other words, SearchPath will
* not find the program "a.b.exe" if the arguments specified
* "a.b" and ".exe"). So, first look for the file as it is
* named. Then manually append extensions, looking for a
* match.
*
* Results:
* Always returns TCL_OK.
*
* Side Effects:
*
*----------------------------------------------------------------------
*/
static int
GetFullPath(
Tcl_Interp *interp, /* Interpreter to report errors to */
const char *program, /* Name of program. */
char *fullPath, /* (out) Returned full path. */
char *cmdPrefix, /* (out) If program is a script, this contains
* the name of the interpreter. */
ApplicationType * typePtr)
{ /* (out) Type of program */
TCHAR *rest;
DWORD attr;
int length;
char cmd[MAX_PATH + 5];
register char **p;
static char *dosExts[] =
{
"", ".com", ".exe", ".bat", NULL
};
*typePtr = APPL_NONE;
length = strlen(program);
strcpy(cmd, program);
cmdPrefix[0] = '\0';
for (p = dosExts; *p != NULL; p++) {
cmd[length] = '\0'; /* Reset to original program name. */
strcat(cmd, *p); /* Append the DOS extension to the
* program name. */
if (!SearchPath(
NULL, /* Use standard Windows search paths */
cmd, /* Program name */
NULL, /* Extension provided by program name. */
MAX_PATH, /* Buffer size */
fullPath, /* Buffer for absolute path of program */
&rest)) {
continue; /* Can't find program with that extension */
}
/*
* Ignore matches on directories or data files.
* Return when we identify a known program type.
*/
attr = GetFileAttributesA(fullPath);
if ((attr == (DWORD)-1) || (attr & FILE_ATTRIBUTE_DIRECTORY)) {
continue;
}
*typePtr = GetApplicationType(fullPath, cmdPrefix);
if (*typePtr != APPL_NONE) {
break;
}
}
if (*typePtr == APPL_NONE) {
/*
* Can't find the program. Check if it's an internal shell command
* like "copy" or "dir" and let cmd.exe deal with it.
*/
static char *shellCmds[] =
{
"copy", "del", "dir", "echo", "edit", "erase", "label",
"md", "rd", "ren", "start", "time", "type", "ver", "vol", NULL
};
for (p = shellCmds; *p != NULL; p++) {
if (((*p)[0] == program[0]) && (strcmp(*p, program) == 0)) {
break;
}
}
if (*p == NULL) {
Tcl_AppendResult(interp, "can't execute \"", program,
"\": no such file or directory", (char *)NULL);
return TCL_ERROR;
}
*typePtr = APPL_DOS;
strcpy(fullPath, program);
}
if ((*typePtr == APPL_DOS) || (*typePtr == APPL_WIN3X)) {
/* For 16-bit applications, convert the long executable path
* name to a short one. Otherwise the application may not be
* able to correctly parse its own command line. */
GetShortPathName(fullPath, fullPath, MAX_PATH);
}
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* ConcatCmdArgs --
*
* Concatonates command line arguments parsed from Tcl into a
* single string. If an argument contain spaces, it is grouped
* with surrounding double quotes. Must also escape any quotes we
* find.
*
* Results:
* Returns a malloc-ed string containing the concatonated command
* line.
*
*----------------------------------------------------------------------
*/
static char *
ConcatCmdArgs(
int argc,
char **argv,
Tcl_DString *resultPtr)
{
BOOL needQuote;
register const char *s;
register char *cp;
char *string; /* Will contain the new command line */
register int count;
register int i;
/*
* Pass 1. Compute how much space we need for an array to hold the entire
* command line. Then allocate the string.
*/
count = 0;
for (i = 0; i < argc; i++) {
needQuote = FALSE;
if (*argv[i] == '\0') {
needQuote = TRUE; /* Zero length args also need quotes. */
}
for (s = argv[i]; *s != '\0'; s++) {
if (*s == '"') {
register const char *bp;
count++; /* +1 Backslash needed to escape quote */
for (bp = s - 1; (*bp == '\\') && (bp >= argv[i]); bp--) {
count++; /* +? one for each preceding backslash */
}
} else if (isspace(*s)) {
needQuote = TRUE;
}
count++; /* +1 Normal character */
}
if (needQuote) {
count += 2; /* +2 Pair of quotes */
}
count++; /* +1 Space separating arguments */
}
string = Blt_Malloc(count + 1);
assert(string);
/*
* Pass 2. Copy the arguments, quoting arguments with embedded spaces and
* escaping all other quotes in the string.
*/
cp = string;
for (i = 0; i < argc; i++) {
needQuote = FALSE;
if (*argv[i] == '\0') {
needQuote = TRUE;
}
for (s = argv[i]; *s != '\0'; s++) {
if (isspace(*s)) {
needQuote = TRUE;
}
}
if (needQuote) {
*cp++ = '"';
}
for (s = argv[i]; *s; s++) {
if (*s == '"') {
register const char *bp;
for (bp = s - 1; (*bp == '\\') && (bp >= argv[i]); bp--) {
*cp++ = '\\';
}
*cp++ = '\\';
}
*cp++ = *s;
}
if (needQuote) {
*cp++ = '"';
}
*cp++ = ' ';
}
*cp = '\0';
assert((cp - string) == count);
Tcl_DStringAppend(resultPtr, string, count);
Blt_Free(string);
return Tcl_DStringValue(resultPtr);
}
/*
*----------------------------------------------------------------------
*
* StartProcess --
*
* Create a child process that has the specified files as its
* standard input, output, and error.
*
* The complete Windows search path is searched to find the specified
* executable. If an executable by the given name is not found,
* automatically tries appending ".com", ".exe", and ".bat" to the
* executable name.
*
* Results:
* The return value is TCL_ERROR and an error message is left in
* the interp's result if there was a problem creating the child
* process. Otherwise, the return value is TCL_OK and *pidPtr is
* filled with the process id of the child process.
*
* Side effects:
* A process is created.
*
*----------------------------------------------------------------------
*/
static int
StartProcess(
Tcl_Interp *interp, /* Interpreter to report errors that
* occurred when creating the child process.
* Error messages from the child process
* itself are sent to errorFile. */
int argc, /* Number of arguments. */
char **argv, /* Command line arguments. */
HANDLE hStdin, /* File handle to use as input (stdin) for the
* child process. If handle is -1, no
* standard input. */
HANDLE hStdout, /* File handle to receive output (stdout)
* from the child process. If -1, output
* is discarded. */
HANDLE hStderr, /* File handle to receive errors (stderr)
* from the child process. If -1, stderr
* will be discarded. Can be the same handle
* as hStdOut */
HANDLE *hProcessPtr, /* (out) Handle of child process. */
DWORD *pidPtr) /* (out) Id of child process. */
{
int result, createFlags;
ApplicationType applType;
Tcl_DString dString; /* Complete command line */
char *command;
BOOL hasConsole;
#ifdef notdef
DWORD idleResult;
#endif
STARTUPINFOA si;
PROCESS_INFORMATION pi;
SECURITY_ATTRIBUTES securityAttrs;
HANDLE hProcess, hPipe;
char progPath[MAX_PATH];
char cmdPrefix[MAX_PATH];
*hProcessPtr = INVALID_HANDLE_VALUE;
GetFullPath(interp, argv[0], progPath, cmdPrefix, &applType);
#if KILL_DEBUG
PurifyPrintf("Application type is %d\n", (int)applType);
#endif
if (applType == APPL_NONE) {
return TCL_ERROR;
}
result = TCL_ERROR;
hProcess = GetCurrentProcess();
ZeroMemory(&si, sizeof(STARTUPINFOA));
si.cb = sizeof(STARTUPINFOA);
/*
* The flag STARTF_USESTDHANDLES must be set to pass handles to
* the child process. Using SetStdHandle and/or dup2 works only
* when a console mode parent process is spawning an attached
* console mode child process.
*/
si.dwFlags = STARTF_USESTDHANDLES;
si.hStdInput = si.hStdOutput = si.hStdError = INVALID_HANDLE_VALUE;
securityAttrs.nLength = sizeof(SECURITY_ATTRIBUTES);
securityAttrs.lpSecurityDescriptor = NULL;
securityAttrs.bInheritHandle = TRUE;
/*
* Duplicate all the handles to be passed off as stdin, stdout and
* stderr of the child process. The duplicate handles are set to
* be inheritable, so the child process can use them.
*/
if (hStdin == INVALID_HANDLE_VALUE) {
/*
* If handle was not set, stdin should return immediate EOF.
* Under Windows95, some applications (both 16 and 32 bit!)
* can't read from the NUL device; they read from console
* instead. When running tk, this is fatal because the child
* process would hang forever waiting for EOF from the unmapped
* console window used by the helper application.
*
* Fortunately, the helper application detects a closed pipe
* as an immediate EOF and can pass that information to the
* child process.
*/
if (CreatePipe(&si.hStdInput, &hPipe, &securityAttrs, 0)) {
CloseHandle(hPipe);
}
} else {
DuplicateHandle(hProcess, hStdin, hProcess, &si.hStdInput, 0, TRUE,
DUPLICATE_SAME_ACCESS);
}
if (si.hStdInput == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp, "can't duplicate input handle: ",
Blt_LastError(), (char *)NULL);
goto closeHandles;
}
if (hStdout == INVALID_HANDLE_VALUE) {
/*
* If handle was not set, output should be sent to an infinitely
* deep sink. Under Windows 95, some 16 bit applications cannot
* have stdout redirected to NUL; they send their output to
* the console instead. Some applications, like "more" or "dir /p",
* when outputting multiple pages to the console, also then try and
* read from the console to go the next page. When running tk, this
* is fatal because the child process would hang forever waiting
* for input from the unmapped console window used by the helper
* application.
*
* Fortunately, the helper application will detect a closed pipe
* as a sink.
*/
if ((Blt_GetPlatformId() == VER_PLATFORM_WIN32_WINDOWS)
&& (applType == APPL_DOS)) {
if (CreatePipe(&hPipe, &si.hStdOutput, &securityAttrs, 0)) {
CloseHandle(hPipe);
}
} else {
si.hStdOutput = CreateFileA("NUL:", GENERIC_WRITE, 0,
&securityAttrs, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
}
} else {
DuplicateHandle(hProcess, hStdout, hProcess, &si.hStdOutput, 0, TRUE,
DUPLICATE_SAME_ACCESS);
}
if (si.hStdOutput == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp, "can't duplicate output handle: ",
Blt_LastError(), (char *)NULL);
goto closeHandles;
}
if (hStderr == INVALID_HANDLE_VALUE) {
/*
* If handle was not set, errors should be sent to an infinitely
* deep sink.
*/
si.hStdError = CreateFileA("NUL:", GENERIC_WRITE, 0,
&securityAttrs, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
} else {
DuplicateHandle(hProcess, hStderr, hProcess, &si.hStdError, 0, TRUE,
DUPLICATE_SAME_ACCESS);
}
if (si.hStdError == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp, "can't duplicate error handle: ",
Blt_LastError(), (char *)NULL);
goto closeHandles;
}
Tcl_DStringInit(&dString);
createFlags = 0;
hasConsole = HasConsole();
if (!hasConsole) {
createFlags |= DETACHED_PROCESS;
}
/*
* If we do not have a console window, then we must run DOS and
* WIN32 console mode applications as detached processes. This tells
* the loader that the child application should not inherit the
* console, and that it should not create a new console window for
* the child application. The child application should get its stdio
* from the redirection handles provided by this application, and run
* in the background.
*
* If we are starting a GUI process, they don't automatically get a
* console, so it doesn't matter if they are started as foreground or
* detached processes. The GUI window will still pop up to the
* foreground.
*/
if (applType == APPL_DOS) {
if (Blt_GetPlatformId() == VER_PLATFORM_WIN32_NT) {
/*
* Under NT, 16-bit DOS applications will not run unless they
* can be attached to a console. If we are running without a
* console, run the 16-bit program as an normal process inside
* of a hidden console application, and then run that hidden
* console as a detached process.
*/
si.wShowWindow = SW_HIDE;
si.dwFlags |= STARTF_USESHOWWINDOW;
createFlags = CREATE_NEW_CONSOLE;
Tcl_DStringAppend(&dString, "cmd.exe /c ", -1);
} else {
/*
* Under Windows 95, 16-bit DOS applications do not work well
* with pipes:
*
* 1. EOF on a pipe between a detached 16-bit DOS application
* and another application is not seen at the other
* end of the pipe, so the listening process blocks forever on
* reads. This inablity to detect EOF happens when either a
* 16-bit app or the 32-bit app is the listener.
*
* 2. If a 16-bit DOS application (detached or not) blocks when
* writing to a pipe, it will never wake up again, and it
* eventually brings the whole system down around it.
*
* The 16-bit application is run as a normal process
* inside of a hidden helper console app, and this helper
* may be run as a detached process. If a stdio handle is
* a pipe, the helper application accumulates information
* into temp files and forwards it to or from the DOS
* application as appropriate. This means that DOS apps
* must receive EOF from a stdin pipe before they will
* actually begin, and must finish generating stdout or
* stderr before the data will be sent to the next stage
* of the pipe.
*
* The helper app should be located in the same directory
* as the tcl dll.
*/
if (!hasConsole) {
si.wShowWindow = SW_HIDE;
si.dwFlags |= STARTF_USESHOWWINDOW;
createFlags = CREATE_NEW_CONSOLE;
}
Tcl_DStringAppend(&dString, "tclpip" STRINGIFY(TCL_MAJOR_VERSION)
STRINGIFY(TCL_MINOR_VERSION) ".dll ", -1);
}
} else if (applType == APPL_INTERP) {
Tcl_DStringAppend(&dString, cmdPrefix, -1);
Tcl_DStringAppend(&dString, " ", -1);
}
argv[0] = progPath;
command = ConcatCmdArgs(argc, argv, &dString);
#if KILL_DEBUG
PurifyPrintf("command is %s\n", command);
#endif
result = CreateProcess(
NULL, /* Module name. */
(TCHAR *)command, /* Command line */
NULL, /* Process security */
NULL, /* Thread security */
TRUE, /* Inherit handles */
createFlags, /* Creation flags */
NULL, /* Environment */
NULL, /* Current working directory */
&si, /* Initialization for process: includes
* standard handles, appearance and location
* of window */
&pi); /* (out) Information about newly
created process */
Tcl_DStringFree(&dString);
if (!result) {
Tcl_AppendResult(interp, "can't execute \"", argv[0], "\": ",
Blt_LastError(), (char *)NULL);
goto closeHandles;
}
#if KILL_DEBUG
PurifyPrintf("Starting process with handle of %d\n", pi.hProcess);
PurifyPrintf("Starting process with id of %d\n", pi.dwProcessId);
#endif
if (applType == APPL_DOS) {
/* Force the OS to give some time to the DOS process. */
WaitForSingleObject(hProcess, 50);
}
#ifdef notdef /* FIXME: I don't think this actually
* ever worked. WaitForInputIdle
* usually fails with "Access is
* denied" (maybe the process handle
* isn't valid yet?). When you add a
* delay, WaitForInputIdle will time
* out instead. */
/*
* PSS ID Number: Q124121
*
* "When an application spawns a process repeatedly, a new
* thread instance will be created for each process but the
* previous instances may not be cleaned up. This results in
* a significant virtual memory loss each time the process is
* spawned. If there is a WaitForInputIdle() call between
* CreateProcess() and CloseHandle(), the problem does not
* occur." */
idleResult = WaitForInputIdle(pi.hProcess, 1000);
if (idleResult == (DWORD) - 1) {
#if KILL_DEBUG
PurifyPrintf("wait failed on %d: %s\n", pi.hProcess, Blt_LastError());
#endif
}
#endif
CloseHandle(pi.hThread);
*hProcessPtr = pi.hProcess;
/*
* Add the entry to mapping table. Its purpose is to translate
* process handles to process ids. Most things we do with the
* Win32 API take handles, but we still want to present process
* ids to the user. */
*pidPtr = pi.dwProcessId;
result = TCL_OK;
closeHandles:
if (si.hStdInput != INVALID_HANDLE_VALUE) {
CloseHandle(si.hStdInput);
}
if (si.hStdOutput != INVALID_HANDLE_VALUE) {
CloseHandle(si.hStdOutput);
}
if (si.hStdError != INVALID_HANDLE_VALUE) {
CloseHandle(si.hStdError);
}
return result;
}
/*
*----------------------------------------------------------------------
*
* FileForRedirect --
*
* This procedure does much of the work of parsing redirection
* operators. It handles "@" if specified and allowed, and a file
* name, and opens the file if necessary.
*
* Results:
* The return value is the descriptor number for the file. If an
* error occurs then NULL is returned and an error message is left
* in interp->result. Several arguments are side-effected; see
* the argument list below for details.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static HANDLE
FileForRedirect(
Tcl_Interp *interp, /* Intepreter to use for error reporting. */
char *spec, /* Points to character just after
* redirection character. */
BOOL atOK, /* Non-zero means that '@' notation can be
* used to specify a channel, zero means that
* it isn't. */
char *arg, /* Pointer to entire argument containing
* spec: used for error reporting. */
char *nextArg, /* Next argument in argc/argv array, if needed
* for file name or channel name. May be
* NULL. */
DWORD accessFlags, /* Flags to use for opening file or to
* specify mode for channel. */
DWORD createFlags, /* Flags to use for opening file or to
* specify mode for channel. */
int *skipPtr, /* Filled with 1 if redirection target was
* in spec, 2 if it was in nextArg. */
int *closePtr) /* Filled with one if the caller should
* close the file when done with it, zero
* otherwise. */
{
int writing = (accessFlags & GENERIC_WRITE);
Tcl_Channel chan;
HANDLE hFile;
*skipPtr = 1;
*closePtr = FALSE;
if ((atOK) && (*spec == '@')) {
spec++;
if (*spec == '\0') {
spec = nextArg;
if (spec == NULL) {
goto badLastArg;
}
*skipPtr = 2;
}
if (*spec == '1' && spec[1] == 0) {
spec = "stdout";
}
chan = Tcl_GetChannel(interp, spec, NULL);
if (chan == NULL) {
return INVALID_HANDLE_VALUE;
}
if (Tcl_GetChannelHandle(chan, (writing) ? TCL_WRITABLE : TCL_READABLE,
(ClientData *)&hFile) != TCL_OK) {
hFile = INVALID_HANDLE_VALUE;
}
if (hFile == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp, "channel \"", Tcl_GetChannelName(chan),
"\" wasn't opened for ",
((writing) ? "writing" : "reading"), (char *)NULL);
return INVALID_HANDLE_VALUE;
}
if (writing) {
/*
* Be sure to flush output to the file, so that anything
* written by the child appears after stuff we've already
* written.
*/
Tcl_Flush(chan);
}
} else {
char *name;
Tcl_DString dString;
if (*spec == '\0') {
spec = nextArg;
if (spec == NULL) {
goto badLastArg;
}
*skipPtr = 2;
}
name = Tcl_TranslateFileName(interp, spec, &dString);
if (name != NULL) {
hFile = OpenRedirectFile(name, accessFlags, createFlags);
} else {
hFile = INVALID_HANDLE_VALUE;
}
Tcl_DStringFree(&dString);
if (hFile == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp, "can't ", (writing) ? "write" : "read",
" file \"", spec, "\": ", Tcl_PosixError(interp),
(char *)NULL);
return INVALID_HANDLE_VALUE;
}
*closePtr = TRUE;
}
return hFile;
badLastArg:
Tcl_AppendResult(interp, "can't specify \"", arg,
"\" as last word in command", (char *)NULL);
return INVALID_HANDLE_VALUE;
}
/*
*----------------------------------------------------------------------
*
* Blt_CreatePipeline --
*
* Given an argc/argv array, instantiate a pipeline of processes
* as described by the argv.
*
* Results:
* The return value is a count of the number of new processes
* created, or -1 if an error occurred while creating the pipeline.
* *pidArrayPtr is filled in with the address of a dynamically
* allocated array giving the ids of all of the processes. It
* is up to the caller to free this array when it isn't needed
* anymore. If inPipePtr is non-NULL, *inPipePtr is filled in
* with the file id for the input pipe for the pipeline (if any):
* the caller must eventually close this file. If outPipePtr
* isn't NULL, then *outPipePtr is filled in with the file id
* for the output pipe from the pipeline: the caller must close
* this file. If errPipePtr isn't NULL, then *errPipePtr is filled
* with a file id that may be used to read error output after the
* pipeline completes.
*
* Side effects:
* Processes and pipes are created.
*
*----------------------------------------------------------------------
*/
int
Blt_CreatePipeline(
Tcl_Interp *interp, /* Interpreter to use for error reporting. */
int argc, /* Number of entries in argv. */
char **argv, /* Array of strings describing commands in
* pipeline plus I/O redirection with <,
* <<, >, etc. Argv[argc] must be NULL. */
Process **procArrPtr, /* *procArrPtr gets filled in with
* address of array of pids for processes
* in pipeline (first pid is first process
* in pipeline). */
int *inPipePtr, /* If non-NULL, input to the pipeline comes
* from a pipe (unless overridden by
* redirection in the command). The file
* id with which to write to this pipe is
* stored at *inPipePtr. NULL means command
* specified its own input source. */
int *outPipePtr, /* If non-NULL, output to the pipeline goes
* to a pipe, unless overriden by redirection
* in the command. The file id with which to
* read frome this pipe is stored at
* *outPipePtr. NULL means command specified
* its own output sink. */
int *errPipePtr) /* If non-NULL, all stderr output from the
* pipeline will go to a temporary file
* created here, and a descriptor to read
* the file will be left at *errPipePtr.
* The file will be removed already, so
* closing this descriptor will be the end
* of the file. If this is NULL, then
* all stderr output goes to our stderr.
* If the pipeline specifies redirection
* then the file will still be created
* but it will never get any data. */
{
Process *procArr = NULL; /* Points to malloc-ed array holding all
* the handles of child processes. */
int nPids; /* Actual number of processes that exist
* at *procArr right now. */
int cmdCount; /* Count of number of distinct commands
* found in argc/argv. */
char *inputLiteral = NULL; /* If non-null, then this points to a
* string containing input data (specified
* via <<) to be piped to the first process
* in the pipeline. */
HANDLE hStdin; /* If != -1, gives file to use as input for
* first process in pipeline (specified via <
* or <@). */
BOOL closeStdin; /* If non-zero, then hStdin should be
* closed when cleaning up. */
HANDLE hStdout; /* Writable file for output from last command
* in pipeline (could be file or pipe). NULL
* means use stdout. */
BOOL closeStdout; /* If non-zero, then hStdout should be
* closed when cleaning up. */
HANDLE hStderr; /* Writable file for error output from all
* commands in pipeline. NULL means use
* stderr. */
BOOL closeStderr; /* If non-zero, then hStderr should be
* closed when cleaning up. */
HANDLE hInPipe, hOutPipe, hErrPipe;
char *p;
int skip, lastBar, lastArg, i, j, flags;
int pid;
BOOL atOK, errorToOutput;
Tcl_DString dString;
HANDLE hPipe;
HANDLE thisInput, thisOutput, thisError;
if (inPipePtr != NULL) {
*inPipePtr = -1;
}
if (outPipePtr != NULL) {
*outPipePtr = -1;
}
if (errPipePtr != NULL) {
*errPipePtr = -1;
}
Tcl_DStringInit(&dString);
hStdin = hStdout = hStderr = INVALID_HANDLE_VALUE;
hPipe = thisInput = thisOutput = INVALID_HANDLE_VALUE;
hInPipe = hOutPipe = hErrPipe = INVALID_HANDLE_VALUE;
closeStdin = closeStdout = closeStderr = FALSE;
nPids = 0;
/*
* First, scan through all the arguments to figure out the structure
* of the pipeline. Process all of the input and output redirection
* arguments and remove them from the argument list in the pipeline.
* Count the number of distinct processes (it's the number of "|"
* arguments plus one) but don't remove the "|" arguments because
* they'll be used in the second pass to seperate the individual
* child processes. Cannot start the child processes in this pass
* because the redirection symbols may appear anywhere in the
* command line -- e.g., the '<' that specifies the input to the
* entire pipe may appear at the very end of the argument list.
*/
lastBar = -1;
cmdCount = 1;
for (i = 0; i < argc; i++) {
skip = 0;
p = argv[i];
switch (*p++) {
case '|':
if (*p == '&') {
p++;
}
if (*p == '\0') {
if ((i == (lastBar + 1)) || (i == (argc - 1))) {
Tcl_AppendResult(interp,
"illegal use of | or |& in command",
(char *)NULL);
goto error;
}
}
lastBar = i;
cmdCount++;
break;
case '<':
if (closeStdin) {
closeStdin = FALSE;
CloseHandle(hStdin);
}
if (*p == '<') {
hStdin = INVALID_HANDLE_VALUE;
inputLiteral = p + 1;
skip = 1;
if (*inputLiteral == '\0') {
inputLiteral = argv[i + 1];
if (inputLiteral == NULL) {
Tcl_AppendResult(interp, "can't specify \"", argv[i],
"\" as last word in command", (char *)NULL);
goto error;
}
skip = 2;
}
} else {
inputLiteral = NULL;
hStdin = FileForRedirect(interp, p, TRUE, argv[i], argv[i + 1],
GENERIC_READ, OPEN_EXISTING, &skip, &closeStdin);
if (hStdin == INVALID_HANDLE_VALUE) {
goto error;
}
}
break;
case '>':
atOK = 1;
flags = CREATE_ALWAYS;
errorToOutput = FALSE;
if (*p == '>') {
p++;
atOK = 0;
flags = OPEN_ALWAYS;
}
if (*p == '&') {
if (closeStderr) {
closeStderr = FALSE;
CloseHandle(hStderr);
}
errorToOutput = TRUE;
p++;
}
if (closeStdout) {
closeStdout = FALSE;
CloseHandle(hStdout);
}
hStdout = FileForRedirect(interp, p, atOK, argv[i], argv[i + 1],
GENERIC_WRITE, flags, &skip, &closeStdout);
if (hStdout == INVALID_HANDLE_VALUE) {
goto error;
}
if (errorToOutput) {
closeStderr = FALSE;
hStderr = hStdout;
}
break;
case '2':
if (*p != '>') {
break;
}
p++;
atOK = TRUE;
flags = CREATE_ALWAYS;
if (*p == '>') {
p++;
atOK = FALSE;
flags = OPEN_ALWAYS;
}
if (closeStderr) {
closeStderr = FALSE;
CloseHandle(hStderr);
}
hStderr = FileForRedirect(interp, p, atOK, argv[i], argv[i + 1],
GENERIC_WRITE, flags, &skip, &closeStderr);
if (hStderr == INVALID_HANDLE_VALUE) {
goto error;
}
break;
}
if (skip != 0) {
for (j = i + skip; j < argc; j++) {
argv[j - skip] = argv[j];
}
argc -= skip;
i -= 1;
}
}
if (hStdin == INVALID_HANDLE_VALUE) {
if (inputLiteral != NULL) {
/*
* The input for the first process is immediate data coming from
* Tcl. Create a temporary file for it and put the data into the
* file.
*/
hStdin = CreateTempFile(inputLiteral);
if (hStdin == INVALID_HANDLE_VALUE) {
Tcl_AppendResult(interp,
"can't create input file for command: ",
Tcl_PosixError(interp), (char *)NULL);
goto error;
}
closeStdin = TRUE;
} else if (inPipePtr != NULL) {
/*
* The input for the first process in the pipeline is to
* come from a pipe that can be written from by the caller.
*/
if (!CreatePipe(&hStdin, &hInPipe, NULL, 0)) {
Tcl_AppendResult(interp,
"can't create input pipe for command: ",
Tcl_PosixError(interp), (char *)NULL);
goto error;
}
closeStdin = TRUE;
} else {
/*
* The input for the first process comes from stdin.
*/
}
}
if (hStdout == INVALID_HANDLE_VALUE) {
if (outPipePtr != NULL) {
/*
* Output from the last process in the pipeline is to go to a
* pipe that can be read by the caller.
*/
if (!CreatePipe(&hOutPipe, &hStdout, NULL, 0)) {
Tcl_AppendResult(interp,
"can't create output pipe for command: ",
Tcl_PosixError(interp), (char *)NULL);
goto error;
}
closeStdout = TRUE;
} else {
/*
* The output for the last process goes to stdout.
*/
}
}
if (hStderr == INVALID_HANDLE_VALUE) {
if (errPipePtr != NULL) {
/*
* Stderr from the last process in the pipeline is to go to a
* pipe that can be read by the caller.
*/
if (CreatePipe(&hErrPipe, &hStderr, NULL, 0) == 0) {
Tcl_AppendResult(interp,
"can't create error pipe for command: ",
Tcl_PosixError(interp), (char *)NULL);
goto error;
}
closeStderr = TRUE;
} else {
/*
* Errors from the pipeline go to stderr.
*/
}
}
/*
* Scan through the argc array, creating a process for each
* group of arguments between the "|" characters.
*/
Tcl_ReapDetachedProcs();
procArr = Blt_Malloc((unsigned)((cmdCount + 1) * sizeof(Process)));
assert(procArr);
thisInput = hStdin;
if (argc == 0) {
Tcl_AppendResult(interp, "invalid null command", (char *)NULL);
goto error;
}
#ifdef notdef
lastArg = 0; /* Suppress compiler warning */
#endif
for (i = 0; i < argc; i = lastArg + 1) {
BOOL joinThisError;
HANDLE hProcess;
/* Convert the program name into native form. */
argv[i] = Tcl_TranslateFileName(interp, argv[i], &dString);
if (argv[i] == NULL) {
goto error;
}
/* Find the end of the current segment of the pipeline. */
joinThisError = FALSE;
for (lastArg = i; lastArg < argc; lastArg++) {
if (argv[lastArg][0] == '|') {
if (argv[lastArg][1] == '\0') {
break;
}
if ((argv[lastArg][1] == '&') && (argv[lastArg][2] == '\0')) {
joinThisError = TRUE;
break;
}
}
}
argv[lastArg] = NULL;
if ((lastArg - i) == 0) {
Tcl_AppendResult(interp, "invalid null command", (char *)NULL);
goto error;
}
/*
* If this is the last segment, use the specified output handle.
* Otherwise create an intermediate pipe. hPipe will become the
* input for the next segment of the pipe.
*/
if (lastArg == argc) {
thisOutput = hStdout;
} else {
if (CreatePipe(&hPipe, &thisOutput, NULL, 0) == 0) {
Tcl_AppendResult(interp, "can't create pipe: ",
Tcl_PosixError(interp), (char *)NULL);
goto error;
}
}
if (joinThisError) {
thisError = thisOutput;
} else {
thisError = hStderr;
}
if (StartProcess(interp, lastArg - i, argv + i, thisInput, thisOutput,
thisError, &hProcess, (DWORD *)&pid) != TCL_OK) {
goto error;
}
Tcl_DStringFree(&dString);
procArr[nPids].hProcess = hProcess;
procArr[nPids].pid = pid;
nPids++;
/*
* Close off our copies of file descriptors that were set up for
* this child, then set up the input for the next child.
*/
if ((thisInput != INVALID_HANDLE_VALUE) && (thisInput != hStdin)) {
CloseHandle(thisInput);
}
thisInput = hPipe;
hPipe = INVALID_HANDLE_VALUE;
if ((thisOutput != INVALID_HANDLE_VALUE) && (thisOutput != hStdout)) {
CloseHandle(thisOutput);
}
thisOutput = INVALID_HANDLE_VALUE;
}
*procArrPtr = (Process *)procArr;
if (inPipePtr != NULL) {
*inPipePtr = (int)hInPipe;
}
if (outPipePtr != NULL) {
*outPipePtr = (int)hOutPipe;
}
if (errPipePtr != NULL) {
*errPipePtr = (int)hErrPipe;
}
/*
* All done. Cleanup open files lying around and then return.
*/
cleanup:
Tcl_DStringFree(&dString);
if (closeStdin) {
CloseHandle(hStdin);
}
if (closeStdout) {
CloseHandle(hStdout);
}
if (closeStderr) {
CloseHandle(hStderr);
}
return nPids;
/*
* An error occurred. There could have been extra files open, such
* as pipes between children. Clean them all up. Detach any child
* processes that have been created.
*/
error:
if (hPipe != INVALID_HANDLE_VALUE) {
CloseHandle(hPipe);
}
if ((thisOutput != INVALID_HANDLE_VALUE) && (thisOutput != hStdout)) {
CloseHandle(thisOutput);
}
if ((thisInput != INVALID_HANDLE_VALUE) && (thisInput != hStdin)) {
CloseHandle(thisInput);
}
if (hInPipe != INVALID_HANDLE_VALUE) {
CloseHandle(hInPipe);
}
if (hOutPipe != INVALID_HANDLE_VALUE) {
CloseHandle(hOutPipe);
}
if (hErrPipe != INVALID_HANDLE_VALUE) {
CloseHandle(hErrPipe);
}
if (procArr != NULL) {
for (i = 0; i < nPids; i++) {
if (procArr[i].hProcess != INVALID_HANDLE_VALUE) {
/* It's Ok to use Tcl_DetachPids, since for WIN32 it's really
* using process handles, not process ids. */
Tcl_DetachPids(1, (Tcl_Pid *)&(procArr[i].pid));
}
}
Blt_Free(procArr);
}
nPids = -1;
goto cleanup;
}
/*
*----------------------------------------------------------------------
*
* Blt_CreateFileHandler --
*
* Limited emulation Tcl_CreateFileHandler for Win32. Works
* with pipes. Don't know if anything else will (such as sockets).
*
* Results:
* None.
*
* Side Effects:
* Registers procedure and data to call back when data
* is available on the pipe.
*
*----------------------------------------------------------------------
*/
void
Blt_CreateFileHandler(
int fd, /* Descriptor or handle of file */
int flags, /* TCL_READABLE or TCL_WRITABLE */
Tcl_FileProc *proc,
ClientData clientData)
{
PipeHandler *pipePtr;
if (!initialized) {
PipeInit();
}
if ((flags != TCL_READABLE) && (flags != TCL_WRITABLE)) {
return; /* Only one of the flags can be set. */
}
pipePtr = CreatePipeHandler((HANDLE) fd, flags);
pipePtr->proc = proc;
pipePtr->clientData = clientData;
/* Add the handler to the list of managed pipes. */
EnterCriticalSection(&pipeCriticalSection);
Blt_ChainAppend(&pipeChain, pipePtr);
LeaveCriticalSection(&pipeCriticalSection);
}
/*
*----------------------------------------------------------------------
*
* Blt_DeleteFileHandler --
*
* Win32 emulation Tcl_DeleteFileHandler. Cleans up resources
* used.
*
* Results:
* None.
*
*----------------------------------------------------------------------
*/
void
Blt_DeleteFileHandler(int fd) /* Descriptor or handle of file */
{
PipeHandler *pipePtr;
Blt_ChainLink *linkPtr;
HANDLE hPipe;
if (!initialized) {
PipeInit();
}
#if KILL_DEBUG
PurifyPrintf("Blt_DeleteFileHandler(%d)\n", fd);
#endif
hPipe = (HANDLE) fd;
EnterCriticalSection(&pipeCriticalSection);
for (linkPtr = Blt_ChainFirstLink(&pipeChain); linkPtr != NULL;
linkPtr = Blt_ChainNextLink(linkPtr)) {
pipePtr = Blt_ChainGetValue(linkPtr);
if ((pipePtr->hPipe == hPipe) && !(pipePtr->flags & PIPE_DELETED)) {
Blt_ChainDeleteLink(&pipeChain, linkPtr);
DeletePipeHandler(pipePtr);
break;
}
}
LeaveCriticalSection(&pipeCriticalSection);
#if KILL_DEBUG
PurifyPrintf("Blt_DeleteFileHandler: done\n");
#endif
}
/*
*----------------------------------------------------------------------
*
* Blt_AsyncRead --
*
* Reads input from the pipe into the given buffer.
*
* Results:
* Returns the number of bytes read.
*
*----------------------------------------------------------------------
*/
int
Blt_AsyncRead(
int f,
char *buffer,
unsigned int size)
{
register PipeHandler *pipePtr;
unsigned int count;
int nBytes;
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead(f=%d)\n", f);
#endif
pipePtr = GetPipeHandler((HANDLE) f);
if ((pipePtr == NULL) || (pipePtr->flags & PIPE_DELETED)) {
errno = EBADF;
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: bad file\n");
#endif
return -1;
}
if (!PeekOnPipe(pipePtr, &nBytes)) {
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: pipe is drained (nBytes=%d).\n", nBytes);
#endif
return -1; /* No data available. */
}
/*
* nBytes is 0 EOF found.
* -1 Error occured.
* 1+ Number of bytes available.
*/
if (nBytes == -1) {
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: Error\n");
#endif
return -1;
}
if (nBytes == 0) {
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: EOF\n");
#endif
return 0;
}
count = pipePtr->end - pipePtr->start;
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: nBytes is %d, %d\n", nBytes, count);
#endif
assert(count == (unsigned int)nBytes);
if (size > count) {
size = count; /* Reset request to what's available. */
}
memcpy(buffer, pipePtr->buffer + pipePtr->start, size);
pipePtr->start += size;
if (pipePtr->start == pipePtr->end) {
#if ASYNC_DEBUG
PurifyPrintf("Blt_AsyncRead: signaling idle\n");
#endif
ResetEvent(pipePtr->readyEvent);
SetEvent(pipePtr->idleEvent);
}
return size;
}
/*
*----------------------------------------------------------------------
*
* Blt_AsyncWrite --
*
* Writes output to the pipe from the given buffer.
*
* Results:
* Returns the number of bytes written.
*
*----------------------------------------------------------------------
*/
int
Blt_AsyncWrite(
int f,
char *buffer,
unsigned int size)
{
register PipeHandler *pipePtr;
pipePtr = GetPipeHandler((HANDLE) f);
if ((pipePtr == NULL) || (pipePtr->flags & PIPE_DELETED)) {
errno = EBADF;
return -1;
}
if (WaitForSingleObject(pipePtr->readyEvent, 0) == WAIT_TIMEOUT) {
/*
* Writer thread is currently blocked waiting for a write to
* complete.
*/
errno = EAGAIN;
return -1;
}
/* Check for a background error on the last write. */
if (pipePtr->lastError) {
TclWinConvertError(pipePtr->lastError);
pipePtr->lastError = 0;
return -1;
}
/* Reallocate the buffer to be large enough to hold the data. */
if (size > pipePtr->size) {
char *ptr;
ptr = Blt_Malloc(size);
assert(ptr);
Blt_Free(pipePtr->buffer);
pipePtr->buffer = ptr;
}
memcpy(pipePtr->buffer, buffer, size);
pipePtr->end = pipePtr->size = size;
ResetEvent(pipePtr->readyEvent);
SetEvent(pipePtr->idleEvent);
return size;
}
|