/usr/share/ada/adainclude/gnatcoll/gnatcoll-traces.adb is in libgnatcoll16.1.0-dev 17.0.2017-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ------------------------------------------------------------------------------
-- G N A T C O L L --
-- --
-- Copyright (C) 2001-2017, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify it --
-- under terms of the GNU General Public License as published by the Free --
-- Software Foundation; either version 3, or (at your option) any later --
-- version. This library is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- --
-- --
-- --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
------------------------------------------------------------------------------
pragma Ada_2012;
with Ada.Calendar; use Ada.Calendar;
with Ada.Calendar.Formatting; use Ada.Calendar.Formatting;
with Ada.Calendar.Time_Zones; use Ada.Calendar.Time_Zones;
with Ada.Environment_Variables;
with Ada.Strings.Fixed; use Ada.Strings.Fixed;
with Ada.Exceptions.Traceback; use Ada.Exceptions.Traceback;
with Ada.IO_Exceptions;
with Ada.Unchecked_Deallocation;
with GNAT.Calendar.Time_IO; use GNAT.Calendar.Time_IO;
with GNAT.Directory_Operations; use GNAT.Directory_Operations;
with GNAT.OS_Lib; use GNAT.OS_Lib;
with GNAT.Traceback; use GNAT.Traceback;
with Interfaces.C_Streams; use Interfaces.C_Streams;
with System.Address_Image;
with System.Assertions; use System.Assertions;
with GNATCOLL.Memory;
with GNATCOLL.Mmap; use GNATCOLL.Mmap;
with GNATCOLL.Templates;
with GNATCOLL.Utils; use GNATCOLL.Utils;
package body GNATCOLL.Traces is
use type FILEs, size_t;
Max_Active_Decorators : constant := 40;
-- Maximum number of active iterators
On_Exception : On_Exception_Mode := Propagate;
-- The behavior that should be adopted when something unexpected prevent
-- the log stream to be written.
-- Note: rev 1.5 of this file has a (disabled) support for symbolic
-- tracebacks.
-- ??? We could display the stack pointer with
-- procedure Print_Sp is
-- start : aliased Integer;
-- begin
-- Put_Line (System.Address_Image (Start'Address));
-- end;
A_Zero : aliased constant String := "a" & ASCII.NUL;
W_Zero : aliased constant String := "w" & ASCII.NUL;
type Decorator_Array is
array (1 .. Max_Active_Decorators) of Trace_Decorator;
procedure Unchecked_Free is new Ada.Unchecked_Deallocation
(Trace_Handle_Record'Class, Trace_Handle);
procedure Unchecked_Free is new Ada.Unchecked_Deallocation
(Trace_Stream_Record'Class, Trace_Stream);
type Stream_Factories;
type Stream_Factories_List is access Stream_Factories;
type Stream_Factories is record
Name : GNAT.Strings.String_Access;
Factory : Stream_Factory_Access;
Next : Stream_Factories_List;
end record;
procedure Unchecked_Free is new Ada.Unchecked_Deallocation
(Stream_Factories, Stream_Factories_List);
procedure Unchecked_Free is new Ada.Unchecked_Deallocation
(Stream_Factory'Class, Stream_Factory_Access);
type Global_Vars is record
Handles_List : Trace_Handle := null;
-- The global list of all defined handles.
Active_Decorators : Decorator_Array;
Active_Last : Natural := 0;
-- Never null after parsing the config file.
-- Decorators on this list are all active, and also stored in the
-- Handles_List.
Wildcard_Handles_List : Trace_Handle := null;
-- Contains the configuration for module names containing stars, for
-- instance "*.EXCEPTIONS".
Streams_List : Trace_Stream := null;
-- The global list of all streams.
-- The default stream is the first in the list.
Factories_List : Stream_Factories_List := null;
-- The global list of all factories.
TZ : Time_Offset := UTC_Time_Offset;
-- Time zone cache, assuming that the OS will not change time zones
-- while this partition is running.
Lock : aliased Atomic_Counter := 0;
pragma Atomic (Lock);
Absolute_Time : Trace_Decorator;
Absolute_Date : Trace_Decorator;
Micro_Time : Trace_Decorator;
Colors : Trace_Decorator;
Enclosing_Entity : Trace_Decorator;
Location : Trace_Decorator;
Finalize_Traces : Trace_Decorator;
Split_Lines : Trace_Decorator;
-- The predefined decorators.
-- ??? These are also stored in the lists above, so we might not need
-- them.
Default_Activation : Boolean := False;
-- Default activation status for debug handles (ie whether the
-- configuration file contained "+").
-- ??? Could be handled via a "*" star handle
Finalized : Boolean := False;
-- Whether the package has been finalized.
-- When this is true, some trace_handles will have been freed, and it
-- is therefore illegal to access them.
end record;
Global : Global_Vars;
type Elapse_Time_Trace is new Trace_Decorator_Record with null record;
overriding procedure After_Message
(Self : in out Elapse_Time_Trace;
Handle : not null Logger;
Msg : in out Msg_Strings.XString);
type Stack_Trace is new Trace_Decorator_Record with null record;
overriding procedure After_Message
(Self : in out Stack_Trace;
Handle : not null Logger;
Msg : in out Msg_Strings.XString);
type Count_Trace is new Trace_Decorator_Record with null record;
overriding procedure Before_Message
(Self : in out Count_Trace;
Handle : not null Logger;
Msg : in out Msg_Strings.XString);
type Memory_Trace is new Trace_Decorator_Record with record
Previous : GNATCOLL.Memory.Byte_Count := 0;
end record;
overriding procedure After_Message
(Self : in out Memory_Trace;
Handle : not null Logger;
Msg : in out Msg_Strings.XString);
type Ada_Memory_Trace is new Trace_Decorator_Record with record
Previous : GNATCOLL.Memory.Byte_Count := 0;
end record;
overriding procedure After_Message
(Self : in out Ada_Memory_Trace;
Handle : not null Logger;
Msg : in out Msg_Strings.XString);
procedure Lock (The_Lock : aliased in out Atomic_Counter)
with Inline_Always;
procedure Unlock (The_Lock : aliased in out Atomic_Counter)
with Inline_Always;
-- For critical regions. A thread already owning the lock cannot try to
-- take the lock again, or it will block.
procedure Create_Exception_Handle (Handle : not null Trace_Handle);
-- Create the exception handle associated with Handle.
function Local_Sub_Second (T : Ada.Calendar.Time) return Integer;
pragma Inline (Local_Sub_Second);
-- Version of Local_Sub_Second taking advantage of the timezone cache
-- return values in range 0 .. 999
function Find_Handle (Unit_Name_Upper_Case : String) return Trace_Handle;
-- Return the debug handle associated with Unit_Name_Upper_Case,
-- or null if there is none. The case of Unit_Name_Upper_Case is
-- not changed.
-- Note: this subprogram doesn't do any locking, it is the
-- responsability of the called to make sure that not two tasks
-- can access it at the same time.
function Find_Wildcard_Handle
(Unit_Name_Upper_Case : String) return Trace_Handle;
-- Check whether there is a module name that contains a "*" and that can be
-- used to provide the default configuration for Unit_Name_Upper_Case
function Wildcard_Applies_To
(Upper_Name : String; Upper_Star : String) return Boolean;
-- Whether the module Upper_Name should take its default configuration from
-- Upper_Wildcard_Name.
function Find_Stream
(Stream_Name : String;
Config_File_Name : String;
Append : Boolean) return Trace_Stream;
-- Return the stream associated with that name (either an existing one or
-- one created by a factory), or null if the default stream should be
-- applied.
-- The Stream_Name might include the settings for the stream, as in:
-- "file.txt:buffer_size=0,async=true"
procedure Put_Absolute_Time (Msg : in out Msg_Strings.XString);
-- Print the absolute time in Handle. No locking is done, this is the
-- responsability of the caller. No colors is modified either.
function Config_File
(Filename : Virtual_File;
Default : Virtual_File)
return Virtual_File;
-- Return the name of the config file to use.
-- If Filename is specified, this is the file to use, providing it exists.
-- Otherwise, we use a .gnatdebug in the current directory, and if there is
-- none, Default if it exists.
-- The empty string is returned if no such file was found.
procedure Register_Handle
(Handle : not null Trace_Handle;
Upper_Case : String;
Finalize : Boolean := True);
-- add Handle to the internal list and set default fields
function Create_Internal
(Unit_Name : String;
Default : Default_Activation_Status := From_Config;
Stream : Trace_Stream;
Factory : Handle_Factory := null;
Finalize : Boolean := True;
From_Config_File : Boolean) return Trace_Handle;
-- Internal version of Create
function Get_Process_Id return Integer;
-- Return the process ID of the current process
pragma Import (C, Get_Process_Id, "getpid");
type File_Stream_Record is new Trace_Stream_Record with record
File : FILEs := NULL_Stream;
Lock : aliased GNATCOLL.Atomic.Atomic_Counter := 0;
end record;
overriding procedure Put
(Stream : in out File_Stream_Record;
Str : Msg_Strings.XString);
overriding procedure Close (Stream : in out File_Stream_Record);
-- Logs to a file
procedure Cache_Settings (Handle : not null Trace_Handle);
-- Cache various settings in Handle, to avoid dispatching calls in Log
-- and thus speed things up.
-- These settings are changed much less frequently.
----------
-- Lock --
----------
procedure Lock (The_Lock : aliased in out Atomic_Counter) is
begin
while True loop
-- In this package, the lock is owned during the time it takes
-- to Put a string to a stream (async streams go even faster).
-- It doesn't seem worth adding a "delay" in this loop, though
-- the standard implementation would be to have a delay on a
-- random number, and increase the delay every time we have to
-- loop until a given maximum.
while The_Lock /= 0 loop
null;
end loop;
exit when Sync_Add_And_Fetch
(The_Lock'Unchecked_Access, 1) = 1;
end loop;
end Lock;
------------
-- Unlock --
------------
procedure Unlock (The_Lock : aliased in out Atomic_Counter) is
begin
The_Lock := 0;
end Unlock;
-----------------
-- Find_Handle --
-----------------
function Find_Handle (Unit_Name_Upper_Case : String) return Trace_Handle is
Tmp : Trace_Handle := Global.Handles_List;
begin
while Tmp /= null
and then Tmp.Name.all /= Unit_Name_Upper_Case
loop
Tmp := Tmp.Next;
end loop;
return Tmp;
end Find_Handle;
-------------------------
-- Wildcard_Applies_To --
-------------------------
function Wildcard_Applies_To
(Upper_Name : String; Upper_Star : String) return Boolean
is
begin
if Upper_Star (Upper_Star'First) = '*' then
-- Test must include '.' in the suffix
if Ends_With
(Upper_Name, Upper_Star (Upper_Star'First + 1 .. Upper_Star'Last))
then
return True;
end if;
elsif Upper_Star (Upper_Star'Last) = '*' then
-- "MODULE.*" should include "MODULE" itself
if Upper_Name =
Upper_Star (Upper_Star'First .. Upper_Star'Last - 2)
then
return True;
end if;
-- Otherwise "MODULE.*" should match "MODULE.FOO" but not
-- MODULEFOO.BAR
if Starts_With
(Upper_Name, Upper_Star (Upper_Star'First .. Upper_Star'Last - 1))
then
return True;
end if;
end if;
return False;
end Wildcard_Applies_To;
--------------------------
-- Find_Wildcard_Handle --
--------------------------
function Find_Wildcard_Handle
(Unit_Name_Upper_Case : String) return Trace_Handle
is
Tmp : Trace_Handle := Global.Wildcard_Handles_List;
begin
while Tmp /= null loop
if Wildcard_Applies_To
(Upper_Name => Unit_Name_Upper_Case,
Upper_Star => Tmp.Name.all)
then
return Tmp;
end if;
Tmp := Tmp.Next;
end loop;
return null;
end Find_Wildcard_Handle;
------------------------
-- Show_Configuration --
------------------------
procedure Show_Configuration (Output : Output_Proc) is
Tmp : Trace_Handle := Global.Handles_List;
function Stream_Name return String;
-- Return the name of the stream if there is one
function Stream_Name return String is
begin
if Tmp.Stream /= null
and then Tmp.Stream /= Global.Streams_List
then
return " >" & Tmp.Stream.Name.all;
else
return "";
end if;
end Stream_Name;
begin
if Global.Streams_List /= null then
Output ("> " & Global.Streams_List.Name.all);
end if;
while Tmp /= null loop
if Tmp.Active then
Output (Tmp.Name.all & "=yes" & Stream_Name);
elsif Tmp.all not in Trace_Decorator_Record'Class then
-- Only output decorators when they are active
Output (Tmp.Name.all & "=no" & Stream_Name);
end if;
Tmp := Tmp.Next;
end loop;
end Show_Configuration;
-----------------
-- Find_Stream --
-----------------
function Find_Stream
(Stream_Name : String;
Config_File_Name : String;
Append : Boolean) return Trace_Stream
is
procedure Add_To_Streams (Tmp : Trace_Stream);
--------------------
-- Add_To_Streams --
--------------------
procedure Add_To_Streams (Tmp : Trace_Stream) is
begin
-- ??? Could use atomic operations to manipulate the
-- list directly.
Lock (Global.Lock);
-- If possible, do not put this first on the list of streams,
-- since it would become the default stream
if Global.Streams_List = null then
Global.Streams_List := Tmp;
Tmp.Next := null;
else
Tmp.Next := Global.Streams_List.Next;
Global.Streams_List.Next := Tmp;
end if;
Unlock (Global.Lock);
end Add_To_Streams;
Name : constant String := Trim (Stream_Name, Ada.Strings.Both);
Tmp : Trace_Stream;
Colon : Natural;
TmpF : Stream_Factories_List;
Supports_Buffer : Boolean := True;
begin
if Name = "" then
return null;
end if;
-- Do we have a matching existing stream?
-- Since we use a linked list and never remove elements from
-- the list, we do not need locking.
Tmp := Global.Streams_List;
while Tmp /= null loop
if Tmp.Name.all = Name then
return Tmp;
end if;
Tmp := Tmp.Next;
end loop;
Colon := Index (Name, ":");
if Colon < Name'First then
Colon := Name'Last + 1;
end if;
-- Do we have a matching factory (if we start with "&")?
if Name (Name'First .. Colon - 1) = "&1" then
Tmp := new File_Stream_Record'
(Name => new String'(Name),
File => stdout,
others => <>);
Add_To_Streams (Tmp);
Supports_Buffer := False;
elsif Name (Name'First .. Colon - 1) = "&2" then
Tmp := new File_Stream_Record'
(Name => new String'(Name),
File => stderr,
others => <>);
Add_To_Streams (Tmp);
Supports_Buffer := False;
elsif Name (Name'First) = '&' then
Tmp := null;
TmpF := Global.Factories_List;
while TmpF /= null loop
if TmpF.Name.all = Name (Name'First .. Colon - 1) then
if Colon < Name'Last then
Tmp := TmpF.Factory.New_Stream
(Name (Colon + 1 .. Name'Last));
else
Tmp := TmpF.Factory.New_Stream ("");
end if;
Tmp.Name := new String'(Name);
Add_To_Streams (Tmp);
exit;
end if;
TmpF := TmpF.Next;
end loop;
else
declare
use GNATCOLL.Templates;
Now : constant Ada.Calendar.Time := Clock;
Nam_Dollar : aliased String := "$";
Val_Dollar : aliased String :=
Trim (Get_Process_Id'Img, Ada.Strings.Both);
Nam_D : aliased String := "D";
Val_D : aliased String := Image (Now, ISO_Date);
Nam_T : aliased String := "T";
Val_T : aliased String := Val_D & Image (Now, "T%H%M%S");
Predef_Substitutions : constant Substitution_Array :=
((Name => Nam_Dollar'Unchecked_Access,
Value => Val_Dollar'Unchecked_Access),
(Name => Nam_D'Unchecked_Access,
Value => Val_D'Unchecked_Access),
(Name => Nam_T'Unchecked_Access,
Value => Val_T'Unchecked_Access));
function Substitute_Cb
(Var : String; Quoted : Boolean) return String;
-- Callback for variable substitution in Name
--------------------
-- Substitute_Cb --
--------------------
function Substitute_Cb
(Var : String; Quoted : Boolean) return String
is
pragma Unreferenced (Quoted);
use Ada.Environment_Variables;
begin
if Exists (Var) then
return Value (Var);
end if;
raise Invalid_Substitution;
end Substitute_Cb;
N : constant String := Normalize_Pathname
(Substitute
(Str => Name (Name'First .. Colon - 1),
Substrings => Predef_Substitutions,
Callback => Substitute_Cb'Unrestricted_Access,
Delimiter => '$'),
Dir_Name (Config_File_Name));
N_Zero : aliased constant String := N & ASCII.NUL;
F : FILEs;
begin
if Append then
F := fopen (N_Zero'Address, mode => A_Zero'Address);
else
F := fopen (N_Zero'Address, mode => W_Zero'Address);
end if;
if F = NULL_Stream then
F := stderr;
end if;
Tmp := new File_Stream_Record'
(Name => new String'(Name),
File => F,
others => <>);
Add_To_Streams (Tmp);
end;
end if;
if Tmp /= null and then Tmp.all in File_Stream_Record'Class then
declare
Args : String_List_Access := Split (Name, ':');
Dummy : int;
Buf_Size : size_t := 2**10;
begin
for A of Args (Args'First + 1 .. Args'Last) loop
if Starts_With (A.all, "buffer_size=") then
begin
Buf_Size := size_t'Value (A (A'First + 12 .. A'Last));
exception
when others =>
Buf_Size := 2**10;
end;
end if;
end loop;
if Supports_Buffer then
Dummy := setvbuf
(File_Stream_Record (Tmp.all).File,
System.Null_Address,
(case Buf_Size is
when 0 => IONBF, -- unbuffered
when 1 => IOLBF, -- line buffered
when others => IOFBF), -- full buffered
Buf_Size);
end if;
Free (Args);
end;
end if;
-- Else use the default stream
return Tmp;
end Find_Stream;
------------
-- Create --
------------
function Create
(Unit_Name : String;
Default : Default_Activation_Status := From_Config;
Stream : String := "";
Factory : Handle_Factory := null;
Finalize : Boolean := True) return Trace_Handle is
begin
return Create_Internal
(From_Config_File => False,
Unit_Name => Unit_Name,
Default => Default,
Stream => Find_Stream (Stream, "", Append => False),
Factory => Factory,
Finalize => Finalize);
end Create;
---------------------
-- Create_Internal --
---------------------
function Create_Internal
(Unit_Name : String;
Default : Default_Activation_Status := From_Config;
Stream : Trace_Stream;
Factory : Handle_Factory := null;
Finalize : Boolean := True;
From_Config_File : Boolean) return Trace_Handle
is
Is_Star : constant Boolean := Starts_With (Unit_Name, "*.")
or else Ends_With (Unit_Name, ".*");
Handle : Trace_Handle;
Upper_Case : constant String := To_Upper (Unit_Name);
Tmp2 : Trace_Handle;
Wildcard : Trace_Handle;
begin
-- Do we already have an existing handle ?
if Is_Star then
Handle := Find_Wildcard_Handle (Upper_Case);
else
Handle := Find_Handle (Upper_Case);
end if;
if Handle = null then
if Factory /= null then
Handle := Factory.all;
end if;
if Handle = null then
Handle := new Trace_Handle_Record;
end if;
Register_Handle
(Handle => Handle,
Upper_Case => Upper_Case,
Finalize => Finalize);
-- Unless both settings are already known, check if we have a
-- wildcard.
if Default = From_Config
or else Stream = null
then
if not Is_Star then
Wildcard := Find_Wildcard_Handle (Handle.Name.all);
if Wildcard /= null then
Set_Active (Handle, Wildcard.Active);
Handle.Forced_Active := True;
-- Unless we specified an explicit stream, inherit it
if Stream = null and then Wildcard.Stream /= null then
Handle.Stream := Wildcard.Stream;
Handle.Stream_Is_Default := Wildcard.Stream_Is_Default;
end if;
else
Set_Active (Handle, Global.Default_Activation);
end if;
end if;
end if;
end if;
if Stream /= null then
-- Only override when we are parsing the configuration file, so
-- that if we have the following:
-- Me : Trace_Handle := Create ("ME", Stream => "str1");
-- parse config file, which contains "ME=yes >str2"
-- Me := Create ("ME", Stream => "str3")
-- then "ME" is sent to "str2" (priority is given to the config
-- file.
if From_Config_File or else Handle.Stream_Is_Default then
Handle.Stream := Stream;
Handle.Stream_Is_Default := False;
end if;
-- A wildcard only impacts the stream of loggers if it has its own
-- stream.
elsif not Is_Star then
-- Use the default stream. If we are still parsing the config
-- file, we might not have this info yet, so we set Stream to
-- 'null' and it will be overridden later
if not From_Config_File and then Handle.Stream_Is_Default then
Handle.Stream := Global.Streams_List;
Handle.Stream_Is_Default := True;
end if;
end if;
-- Set activation
if not Handle.Forced_Active or else From_Config_File then
case Default is
when On =>
Handle.Forced_Active := True;
Set_Active (Handle, Active => True);
when Off =>
Handle.Forced_Active := True;
Set_Active (Handle, Active => False);
when From_Config =>
null;
end case;
end if;
-- If we are declaring a "wildcard" handle, we need to check
-- whether any existing handle would match (which will in
-- general be the case, since handles are declared at
-- elaboration time and star handles in the config file).
if Is_Star then
Tmp2 := Global.Handles_List;
while Tmp2 /= null loop
if Wildcard_Applies_To
(Tmp2.Name.all, Upper_Star => Handle.Name.all)
then
-- Always override the status of matching streams:
-- There are two scenarios here:
-- - in a given config file, we always respect the order
-- of declarations, thus wildcards should in general be put
-- at the beginning.
-- - if a wildcard is declared later on in Ada, we want
-- it to impact existing streams as well (as a convenience
-- for forcing specific settings from the code.
--
-- So do not check Tmp2.Forced_Active
Set_Active (Tmp2, Handle.Active);
if Tmp2.Stream_Is_Default and then Handle.Stream /= null then
Tmp2.Stream := Handle.Stream;
Tmp2.Stream_Is_Default := Handle.Stream_Is_Default;
end if;
end if;
Tmp2 := Tmp2.Next;
end loop;
end if;
Cache_Settings (Handle);
return Handle;
end Create_Internal;
--------------------
-- Cache_Settings --
--------------------
procedure Cache_Settings (Handle : not null Trace_Handle) is
begin
-- If we have already registered the default decorators
if Global.Colors /= null
and then Handle.Stream /= null
then
Handle.With_Time :=
(Global.Absolute_Time.Active or else Global.Absolute_Date.Active)
and then Handle.Stream.Supports_Time;
Handle.With_Colors :=
Global.Colors.Active and then Handle.Stream.Supports_Color;
end if;
end Cache_Settings;
---------------------
-- Register_Handle --
---------------------
procedure Register_Handle
(Handle : not null Trace_Handle;
Upper_Case : String;
Finalize : Boolean := True)
is
Is_Star : constant Boolean :=
Starts_With (Upper_Case, "*.")
or else Ends_With (Upper_Case, ".*");
begin
Handle.Name := new String'(Upper_Case);
Handle.Forced_Active := False;
Handle.Count := 0;
Handle.Timer := No_Time;
Handle.Finalize := Finalize;
Handle.Active := False;
Handle.Stream_Is_Default := True;
Lock (Global.Lock);
if Is_Star then
Handle.Next := Global.Wildcard_Handles_List;
Global.Wildcard_Handles_List := Handle;
else
Handle.Next := Global.Handles_List;
Global.Handles_List := Handle;
end if;
Unlock (Global.Lock);
exception
when others =>
Unlock (Global.Lock);
raise;
end Register_Handle;
----------------
-- Set_Active --
----------------
procedure Set_Active
(Handle : not null access Trace_Handle_Record'Class; Active : Boolean)
is
Tmp : Trace_Handle;
Dec : Trace_Decorator;
begin
Handle.Active := Active;
if Handle.all in Trace_Decorator_Record'Class then
Dec := Trace_Decorator (Handle);
if Dec /= Global.Colors
and then Dec /= Global.Finalize_Traces
and then Dec /= Global.Split_Lines
then
-- If active, store it in the list of active decorators
if Active then
-- ??? Should check if we have too many decorators
Global.Active_Last := Global.Active_Last + 1;
Global.Active_Decorators (Global.Active_Last) := Dec;
else
for A in 1 .. Global.Active_Last loop
if Global.Active_Decorators (A) = Dec then
Global.Active_Decorators (A .. Global.Active_Last - 1) :=
Global.Active_Decorators (A + 1 .. Global.Active_Last);
Global.Active_Last := Global.Active_Last - 1;
exit;
end if;
end loop;
end if;
end if;
if Dec = Global.Colors
or else Dec = Global.Absolute_Time
or else Dec = Global.Absolute_Date
then
Tmp := Global.Handles_List;
while Tmp /= null loop
Cache_Settings (Tmp);
Tmp := Tmp.Next;
end loop;
end if;
end if;
end Set_Active;
---------------
-- Is_Active --
---------------
function Is_Active
(Handle : not null access Trace_Handle_Record'Class) return Boolean is
begin
return not Global.Finalized and then Handle.Active;
end Is_Active;
---------------
-- Unit_Name --
---------------
function Unit_Name
(Handle : not null access Trace_Handle_Record'Class) return String is
begin
return Handle.Name.all;
end Unit_Name;
-----------------------------
-- Create_Exception_Handle --
-----------------------------
procedure Create_Exception_Handle (Handle : not null Trace_Handle) is
S : Trace_Stream;
begin
if Handle.Exception_Handle = null then
-- Unless the config file specified an explicit stream,
-- we inherit the one from Handle.
if Handle.Stream = Global.Streams_List then
S := null;
else
S := Handle.Stream;
end if;
Handle.Exception_Handle := Create_Internal
(Unit_Name => Handle.Name.all & ".EXCEPTIONS",
From_Config_File => False,
Stream => S,
Default => (if Handle.Active then On else Off));
Cache_Settings (Handle.Exception_Handle);
end if;
end Create_Exception_Handle;
-----------
-- Trace --
-----------
procedure Trace
(Handle : not null access Trace_Handle_Record'Class;
E : Ada.Exceptions.Exception_Occurrence;
Msg : String := "Unexpected exception: ";
Color : String := Default_Fg) is
begin
if Debug_Mode
and then not Global.Finalized -- module not terminated
then
Create_Exception_Handle (Handle);
Trace (Handle.Exception_Handle,
Msg & Ada.Exceptions.Exception_Information (E),
Color => Color);
end if;
end Trace;
-----------
-- Trace --
-----------
procedure Trace
(Handle : not null access Trace_Handle_Record'Class;
Message : String;
Color : String := Default_Fg;
Location : String := GNAT.Source_Info.Source_Location;
Entity : String := GNAT.Source_Info.Enclosing_Entity)
is
-- We want maximum performance for traces. This saves about 2%
-- in single-threaded applications and sometimes 1% for multi-threaded
-- apps.
pragma Suppress (All_Checks);
begin
-- Do not output anything until we have called Parse_Config_File,
-- and do not output anything after we have called Finalized and
-- potentially freed Handle.
-- The stream is null if the trace was Create-d as On by default
-- but Parse_Config_File was never called.
if not Active (Handle) or else Handle.Stream = null then
return;
end if;
declare
Start, Last : Natural;
Indent : constant Integer := Integer (Handle.Stream.Indentation);
With_Color : constant Boolean := Handle.With_Colors;
Msg : Msg_Strings.XString;
begin
for D in 1 .. Global.Active_Last loop
Global.Active_Decorators (D).Start_Of_Line
(Msg, Is_Continuation => False);
end loop;
if Indent > 0 then
Msg.Append ((1 .. Indent * 3 => ' '));
end if;
if With_Color then
Msg.Append (Cyan_Fg);
end if;
Msg.Append ('[');
Msg.Append (Handle.Name.all);
Msg.Append (']');
Msg.Append (' ');
-- Decorate before the message
for D in 1 .. Global.Active_Last loop
Global.Active_Decorators (D).Before_Message (Handle, Msg);
end loop;
-- Add the message
if Global.Split_Lines /= null and then Global.Split_Lines.Active then
Start := Message'First;
loop
Last := Start;
while Last <= Message'Last
and then Message (Last) /= ASCII.LF
loop
Last := Last + 1;
end loop;
if With_Color then
Msg.Append (Color);
end if;
Msg.Append (Message (Start .. Last - 1));
Start := Last + 1;
exit when Start > Message'Last;
Msg.Append (ASCII.LF);
for D in 1 .. Global.Active_Last loop
Global.Active_Decorators (D).Start_Of_Line
(Msg, Is_Continuation => True);
end loop;
if Indent > 0 then
Msg.Append ((1 .. Indent * 3 => ' '));
end if;
if With_Color then
Msg.Append (Purple_Fg & Default_Bg);
end if;
Msg.Append ('_');
Msg.Append (Handle.Name.all);
Msg.Append ('_');
Msg.Append (' ');
end loop;
else
if With_Color then
Msg.Append (Color);
end if;
Msg.Append (Message);
end if;
-- Decorate after the message
if Global.Active_Last /= 0 then
if With_Color then
Msg.Append (Brown_Fg & Default_Bg);
end if;
Msg.Append (' ');
for D in 1 .. Global.Active_Last loop
Global.Active_Decorators (D).After_Message (Handle, Msg);
end loop;
-- Remove trailing space if needed
if Handle.With_Time then
Put_Absolute_Time (Msg);
end if;
if Global.Location.Active then
Msg.Append ("(loc: ");
Msg.Append (Location);
Msg.Append (')');
end if;
if Global.Enclosing_Entity.Active then
Msg.Append ("(entity:");
Msg.Append (Entity);
Msg.Append (')');
end if;
Msg.Trim (Ada.Strings.Right);
end if;
if With_Color then
Msg.Append (Default_Fg & Default_Bg);
end if;
Msg.Append (ASCII.LF);
Handle.Stream.Put (Msg);
end;
exception
when others =>
case On_Exception is
when Propagate =>
raise;
when Ignore =>
null;
when Deactivate =>
begin
Close (Handle.Stream.all);
exception
when others =>
null;
end;
end case;
end Trace;
------------
-- Assert --
------------
procedure Assert
(Handle : not null access Trace_Handle_Record'Class;
Condition : Boolean;
Error_Message : String;
Message_If_Success : String := "";
Raise_Exception : Boolean := True;
Location : String := GNAT.Source_Info.Source_Location;
Entity : String := GNAT.Source_Info.Enclosing_Entity) is
begin
if Active (Handle) then
if not Condition then
Create_Exception_Handle (Handle);
Trace
(Handle.Exception_Handle,
Error_Message, Location, Entity, Red_Bg & Default_Fg);
if Raise_Exception then
Raise_Assert_Failure
(Error_Message & " (" & Entity & " at " &
Location & ")");
end if;
elsif Message_If_Success'Length /= 0 then
Trace (Handle, Message_If_Success, Location, Entity);
end if;
end if;
end Assert;
---------------------
-- Increase_Indent --
---------------------
procedure Increase_Indent
(Handle : access Trace_Handle_Record'Class := null;
Msg : String := "";
Color : String := Default_Fg;
Location : String := GNAT.Source_Info.Source_Location;
Entity : String := GNAT.Source_Info.Enclosing_Entity) is
begin
if Handle /= null and then Handle.Stream /= null then
if Msg /= "" then
Trace (Handle, Msg, Color => Color,
Location => Location, Entity => Entity);
end if;
-- ??? Should we do this when the handle is inactive ?
Increment (Handle.Stream.Indentation);
end if;
end Increase_Indent;
---------------------
-- Decrease_Indent --
---------------------
procedure Decrease_Indent
(Handle : access Trace_Handle_Record'Class := null;
Msg : String := "";
Color : String := Default_Fg;
Location : String := GNAT.Source_Info.Source_Location;
Entity : String := GNAT.Source_Info.Enclosing_Entity) is
begin
if Handle /= null and then Handle.Stream /= null then
-- The counter is a modulo type
if Sync_Sub_And_Fetch
(Handle.Stream.Indentation'Unchecked_Access, 1) = Minus_One
then
Handle.Stream.Indentation := 0;
Trace (Handle, "Indentation error: too many decrease");
end if;
if Msg /= "" then
Trace (Handle, Msg, Color, Location, Entity);
end if;
end if;
end Decrease_Indent;
----------------------
-- Local_Sub_Second --
----------------------
function Local_Sub_Second (T : Ada.Calendar.Time) return Integer is
Y : Year_Number;
M : Month_Number;
D : Day_Number;
H : Ada.Calendar.Formatting.Hour_Number;
Mi : Ada.Calendar.Formatting.Minute_Number;
S : Ada.Calendar.Formatting.Second_Number;
Ss : Ada.Calendar.Formatting.Second_Duration;
Ls : Boolean;
begin
Ada.Calendar.Formatting.Split (T, Y, M, D, H, Mi, S, Ss, Ls, Global.TZ);
if Ss > 0.999 then
return 999;
else
return Integer (Ss * 1000.0);
end if;
end Local_Sub_Second;
-----------------------
-- Put_Absolute_Time --
-----------------------
procedure Put_Absolute_Time (Msg : in out Msg_Strings.XString) is
T : constant Ada.Calendar.Time := Ada.Calendar.Clock;
Z : String (1 .. 3) := "000";
Ms : constant String := Integer'Image (Local_Sub_Second (T));
begin
Z (3 + 1 - (Ms'Length - 1) .. 3) := Ms (Ms'First + 1 .. Ms'Last);
if Global.Absolute_Date.Active then
if Global.Absolute_Time.Active then
if Global.Micro_Time.Active then
Msg.Append ("(" & Image (T, ISO_Date & " %T:%e") & ')');
else
Msg.Append ("(" & Image (T, ISO_Date & " %T.") & Z & ')');
end if;
else
Msg.Append ("(" & Image (T, ISO_Date) & ')');
end if;
else
if Global.Micro_Time.Active then
Msg.Append ("(" & Image (T, ISO_Date & " %T:%e") & ')');
else
Msg.Append ("(" & Image (T, "%T.") & Z & ')');
end if;
end if;
end Put_Absolute_Time;
--------------------
-- Before_Message --
--------------------
overriding procedure Before_Message
(Self : in out Count_Trace;
Handle : not null Trace_Handle;
Msg : in out Msg_Strings.XString)
is
-- ??? Should we lock to get consistent counters ?
Total : constant Atomic_Counter :=
Sync_Add_And_Fetch (Self.Count'Unchecked_Access, 1);
Local : constant Atomic_Counter :=
Sync_Add_And_Fetch (Handle.Count'Unchecked_Access, 1);
C : constant String := Atomic_Counter'Image (Total);
H : constant String := Atomic_Counter'Image (Local);
begin
Msg.Append (H (H'First + 1 .. H'Last)
& '/' & C (C'First + 1 .. C'Last) & ' ');
end Before_Message;
-------------------
-- After_Message --
-------------------
overriding procedure After_Message
(Self : in out Memory_Trace;
Handle : not null Trace_Handle;
Msg : in out Msg_Strings.XString)
is
pragma Unreferenced (Handle);
use GNATCOLL.Memory;
Watermark : constant Watermark_Info := Get_Allocations;
begin
Msg.Append
("[Watermark:"
& (if Watermark.Current > Self.Previous then '>' else '<')
& Watermark.Current'Img & '/'
& Watermark.High'Img & "]");
Self.Previous := Watermark.Current;
end After_Message;
-------------------
-- After_Message --
-------------------
overriding procedure After_Message
(Self : in out Ada_Memory_Trace;
Handle : not null Trace_Handle;
Msg : in out Msg_Strings.XString)
is
pragma Unreferenced (Handle);
use GNATCOLL.Memory;
Watermark : constant Watermark_Info := Get_Ada_Allocations;
begin
if Watermark.High /= 0 then
Msg.Append
("[AdaWatermark:"
& (if Watermark.Current > Self.Previous then '>' else '<')
& Watermark.Current'Img & '/'
& Watermark.High'Img & "]");
end if;
Self.Previous := Watermark.Current;
end After_Message;
-------------------
-- After_Message --
-------------------
overriding procedure After_Message
(Self : in out Elapse_Time_Trace;
Handle : not null Trace_Handle;
Msg : in out Msg_Strings.XString)
is
pragma Unreferenced (Self);
T : constant Ada.Calendar.Time := Ada.Calendar.Clock;
Dur : Integer;
begin
if Handle.Timer /= No_Time then
Dur := Integer ((T - Handle.Timer) * 1000);
Msg.Append ("(elapsed:" & Integer'Image (Dur) & "ms)");
end if;
Handle.Timer := T;
end After_Message;
-------------------
-- After_Message --
-------------------
overriding procedure After_Message
(Self : in out Stack_Trace;
Handle : not null Trace_Handle;
Msg : in out Msg_Strings.XString)
is
pragma Unreferenced (Self, Handle);
Tracebacks : GNAT.Traceback.Tracebacks_Array (1 .. 50);
Len : Natural;
begin
Call_Chain (Tracebacks, Len);
Msg.Append ("(callstack: ");
for J in Tracebacks'First .. Len loop
Msg.Append (System.Address_Image (Get_PC (Tracebacks (J))) & ' ');
end loop;
Msg.Append (")");
end After_Message;
--------------------------
-- Add_Global_Decorator --
--------------------------
procedure Add_Global_Decorator
(Decorator : not null access Trace_Decorator_Record'Class;
Name : String) is
begin
Register_Handle (Decorator, To_Upper (Name));
Decorator.Active := False;
-- Set this flag, so that a "+" in the config file has no impact on
-- decorators.
Decorator.Forced_Active := True;
end Add_Global_Decorator;
-----------------
-- Config_File --
-----------------
function Config_File
(Filename : Virtual_File;
Default : Virtual_File)
return Virtual_File
is
Env : GNAT.Strings.String_Access;
Ret : Virtual_File;
begin
if Filename /= No_File and then Filename.Is_Regular_File then
return Filename;
end if;
Env := Getenv (Config_File_Environment);
-- First test the file described in the environment variable
if Env /= null and then Env.all /= "" then
Ret := Create (+Env.all);
Free (Env);
if Ret.Is_Regular_File then
return Ret;
end if;
return No_File;
end if;
Free (Env);
-- Then the file in the current directory
Ret := Create_From_Dir (Get_Current_Dir, Default_Config_File);
if Ret.Is_Regular_File then
return Ret;
end if;
-- Then the file in the user's home directory
Ret := Create_From_Dir (Get_Home_Directory, Default_Config_File);
if Ret.Is_Regular_File then
return Ret;
end if;
-- Finally the default file
if Default /= No_File and then Is_Regular_File (Default) then
return Default;
end if;
return No_File;
end Config_File;
-----------------------------
-- Register_Stream_Factory --
-----------------------------
procedure Register_Stream_Factory
(Name : String; Factory : Stream_Factory_Access)
is
begin
Lock (Global.Lock);
Global.Factories_List := new Stream_Factories'
(Name => new String'("&" & Name),
Factory => Factory,
Next => Global.Factories_List);
Unlock (Global.Lock);
end Register_Stream_Factory;
-----------
-- Close --
-----------
procedure Close (Stream : in out Trace_Stream_Record) is
begin
Free (Stream.Name);
end Close;
---------
-- Put --
---------
overriding procedure Put
(Stream : in out File_Stream_Record;
Str : Msg_Strings.XString)
is
N : size_t;
S : Msg_Strings.Char_Array;
L : Natural;
begin
-- fwrite is thread safe on Windows and POSIX systems,
-- we should not need locking.
Str.Get_String (S, L);
-- The call to fwrite is C, so will not raise exceptions
Lock (Stream.Lock);
N := fwrite
(buffer => S.all'Address,
size => size_t (L),
count => 1,
stream => Stream.File);
Unlock (Stream.Lock);
if N /= size_t (L) then
-- ??? Could not write to file, disk full ?
null;
end if;
end Put;
-----------
-- Close --
-----------
procedure Close (Stream : in out File_Stream_Record) is
Status : int;
pragma Unreferenced (Status);
begin
if Stream.File /= stdout
and then Stream.File /= stderr
then
Status := fclose (Stream.File);
Stream.File := NULL_Stream;
end if;
Close (Trace_Stream_Record (Stream));
end Close;
-----------------------
-- Parse_Config_File --
-----------------------
procedure Parse_Config_File
(Filename : Virtual_File;
Default : Virtual_File := No_File;
On_Exception : On_Exception_Mode := Propagate;
Force_Activation : Boolean := True)
is
File_Name : constant Virtual_File := Config_File (Filename, Default);
Buffer : Str_Access;
File : Mapped_File;
Index, First, Max : Natural;
Handle : Trace_Handle;
Dec : Trace_Decorator;
procedure Skip_Spaces (Skip_Newline : Boolean := True);
-- Skip the spaces (including possibly newline), and leave Index on the
-- first non blank character.
procedure Skip_To_Newline (Stop_At_First_Blank : Boolean := False);
-- Set Index after the last significant character on the line (either
-- the ASCII.LF or after the last character in the buffer).
procedure Create_Decorators;
-- Create all default decorators, if not done yet
-----------------
-- Skip_Spaces --
-----------------
procedure Skip_Spaces (Skip_Newline : Boolean := True) is
begin
while Index <= Last (File)
and then (Buffer (Index) = ' '
or else (Buffer (Index) = ASCII.LF
and then Skip_Newline)
or else Buffer (Index) = ASCII.CR
or else Buffer (Index) = ASCII.HT)
loop
Index := Index + 1;
end loop;
end Skip_Spaces;
---------------------
-- Skip_To_Newline --
---------------------
procedure Skip_To_Newline (Stop_At_First_Blank : Boolean := False) is
begin
while Index <= Last (File)
and then Buffer (Index) /= ASCII.LF
and then (not Stop_At_First_Blank
or else (Buffer (Index) /= ' '
and then Buffer (Index) /= ASCII.HT))
loop
Index := Index + 1;
end loop;
end Skip_To_Newline;
-----------------------
-- Create_Decorators --
-----------------------
procedure Create_Decorators is
begin
if Global.Colors = null then
Set_Default_Stream ("&1");
Global.Micro_Time := new Trace_Decorator_Record;
Global.Micro_Time.Add_Global_Decorator ("DEBUG.MICRO_TIME");
Dec := new Elapse_Time_Trace;
Dec.Add_Global_Decorator ("DEBUG.ELAPSED_TIME");
Dec := new Stack_Trace;
Dec.Add_Global_Decorator ("DEBUG.STACK_TRACE");
Dec := new Count_Trace;
Dec.Add_Global_Decorator ("DEBUG.COUNT");
Dec := new Memory_Trace;
Dec.Add_Global_Decorator ("DEBUG.MEMORY");
Dec := new Ada_Memory_Trace;
Dec.Add_Global_Decorator ("DEBUG.ADA_MEMORY");
-- These are handled directly in Trace, but we should have them on
-- the active list of decorators to know whether we need to add a
-- space.
Global.Absolute_Time := new Trace_Decorator_Record;
Global.Absolute_Time.Add_Global_Decorator ("DEBUG.ABSOLUTE_TIME");
Global.Absolute_Date := new Trace_Decorator_Record;
Global.Absolute_Date.Add_Global_Decorator ("DEBUG.ABSOLUTE_DATE");
Global.Enclosing_Entity := new Trace_Decorator_Record;
Global.Enclosing_Entity.Add_Global_Decorator
("DEBUG.ENCLOSING_ENTITY");
Global.Location := new Trace_Decorator_Record;
Global.Location.Add_Global_Decorator ("DEBUG.LOCATION");
-- The following are not decorators, and handled specially
Global.Finalize_Traces := new Trace_Decorator_Record;
Global.Finalize_Traces.Add_Global_Decorator
("DEBUG.FINALIZE_TRACES");
Global.Finalize_Traces.Active := True;
Global.Split_Lines := new Trace_Decorator_Record;
Global.Split_Lines.Add_Global_Decorator ("DEBUG.SPLIT_LINES");
Global.Split_Lines.Active := True;
Global.Colors := new Trace_Decorator_Record;
Global.Colors.Add_Global_Decorator ("DEBUG.COLORS");
end if;
end Create_Decorators;
begin
if not Debug_Mode then
return;
end if;
GNATCOLL.Traces.On_Exception := On_Exception;
-- If this is the first time we call Parse_Config_File, we initialize
-- the package at the same time.
if File_Name = No_File then
if Force_Activation then
Create_Decorators;
end if;
else
begin
File := Open_Read (+File_Name.Full_Name);
exception
when Ada.IO_Exceptions.Name_Error =>
if Force_Activation then
Create_Decorators;
end if;
return;
end;
Create_Decorators;
Read (File);
Buffer := Data (File);
Index := 1;
loop
Skip_Spaces;
exit when Index > Last (File);
if Index + 1 <= Last (File)
and then String (Buffer (Index .. Index + 1)) = "--"
then
Skip_To_Newline;
else
case Buffer (Index) is
when '>' =>
declare
Save : constant Integer := Index;
begin
Skip_To_Newline;
if Buffer (Index - 1) = ASCII.CR then
Set_Default_Stream
(String (Buffer (Save .. Index - 2)),
Config_File => File_Name);
else
Set_Default_Stream
(String (Buffer (Save .. Index - 1)),
Config_File => File_Name);
end if;
end;
when '+' =>
Global.Default_Activation := True;
Skip_To_Newline;
Handle := Global.Handles_List;
while Handle /= null loop
if not Handle.Forced_Active then
Set_Active (Handle, True);
-- A later declaration of the stream in the code
-- should not be allowed to reset Active to False
Handle.Forced_Active := True;
end if;
Handle := Handle.Next;
end loop;
when others =>
First := Index;
while Index <= Last (File)
and then Buffer (Index) /= '='
and then Buffer (Index) /= '>'
and then Buffer (Index) /= '-'
and then Buffer (Index) /= ASCII.LF
and then Buffer (Index) /= ASCII.CR
loop
Index := Index + 1;
end loop;
Max := Index - 1;
while Max >= 1
and then (Buffer (Max) = ' '
or else Buffer (Max) = ASCII.HT)
loop
Max := Max - 1;
end loop;
declare
Active : Default_Activation_Status := From_Config;
Stream : Trace_Stream := null;
begin
-- Is this active ?
if Index > Last (File)
or else Buffer (Index) /= '='
then
Active := On;
else
Index := Index + 1;
Skip_Spaces;
if Index + 1 > Last (File) or else
String (Buffer (Index .. Index + 1)) /= "no"
then
Active := On;
else
Active := Off;
end if;
end if;
-- What stream is this sent to ?
while Index <= Last (File)
and then Buffer (Index) /= '>'
and then Buffer (Index) /= ASCII.LF
and then Buffer (Index) /= ASCII.CR
loop
Index := Index + 1;
end loop;
if Index <= Last (File)
and then Buffer (Index) = '>'
then
declare
Save : Integer := Index + 1;
Append : constant Boolean :=
Buffer (Index + 1) = '>';
begin
if Append then
Save := Index + 2;
end if;
Skip_To_Newline;
if Buffer (Index - 1) = ASCII.CR then
Stream := Find_Stream
(String (Buffer (Save .. Index - 2)),
+File_Name.Full_Name, Append);
else
Stream := Find_Stream
(String (Buffer (Save .. Index - 1)),
+File_Name.Full_Name, Append);
end if;
end;
else
Skip_To_Newline;
end if;
Handle := Create_Internal
(String (Buffer (First .. Max)),
From_Config_File => True,
Default => Active,
Stream => Stream);
end;
end case;
end if;
end loop;
Close (File);
end if;
end Parse_Config_File;
-----------------------
-- Parse_Config_File --
-----------------------
procedure Parse_Config_File
(Filename : String := "";
Default : String := "";
On_Exception : On_Exception_Mode := Propagate;
Force_Activation : Boolean := True)
is
F_Filename : Virtual_File;
F_Default : Virtual_File;
begin
if Filename = "" then
F_Filename := No_File;
else
F_Filename := Create_From_Base (+Filename);
end if;
if Default = "" then
F_Default := No_File;
else
F_Default := Create_From_Base (+Default);
end if;
Parse_Config_File
(F_Filename, F_Default, On_Exception, Force_Activation);
end Parse_Config_File;
--------------
-- Finalize --
--------------
procedure Finalize is
Tmp : Trace_Handle;
Next : Trace_Handle;
TmpS : Trace_Stream;
NextS : Trace_Stream;
TmpF : Stream_Factories_List;
NextF : Stream_Factories_List;
begin
if not Global.Finalized and then Global.Finalize_Traces.Active then
Lock (Global.Lock);
Tmp := Global.Handles_List;
while Tmp /= null loop
Next := Tmp.Next;
if Tmp.Finalize then
Free (Tmp.Name);
Unchecked_Free (Tmp);
end if;
Tmp := Next;
end loop;
Global.Handles_List := null;
Tmp := Global.Wildcard_Handles_List;
while Tmp /= null loop
Next := Tmp.Next;
if Tmp.Finalize then
Free (Tmp.Name);
Unchecked_Free (Tmp);
end if;
Tmp := Next;
end loop;
Global.Wildcard_Handles_List := null;
TmpS := Global.Streams_List;
while TmpS /= null loop
NextS := TmpS.Next;
Close (TmpS.all);
Unchecked_Free (TmpS);
TmpS := NextS;
end loop;
Global.Streams_List := null;
TmpF := Global.Factories_List;
while TmpF /= null loop
NextF := TmpF.Next;
Free (TmpF.Name);
Unchecked_Free (TmpF.Factory);
Unchecked_Free (TmpF);
TmpF := NextF;
end loop;
Global.Factories_List := null;
Unlock (Global.Lock);
end if;
Global.Finalized := True;
end Finalize;
------------------------
-- Set_Default_Stream --
------------------------
procedure Set_Default_Stream
(Name : String;
Config_File : Virtual_File := No_File)
is
S : Trace_Stream;
T : Trace_Stream;
H : Trace_Handle;
begin
if Name'Length > 2
and then Name (Name'First .. Name'First + 1) = ">>"
then
S := Find_Stream
(Name (Name'First + 2 .. Name'Last),
+Config_File.Full_Name.all, Append => True);
elsif Name (Name'First) = '>' then
S := Find_Stream
(Name (Name'First + 1 .. Name'Last),
+Config_File.Full_Name.all, Append => False);
else
S := Find_Stream
(Name,
+Config_File.Full_Name.all, Append => False);
end if;
if S /= null then
-- Put it first in the list
Lock (Global.Lock);
if Global.Streams_List /= S then
T := Global.Streams_List;
while T.Next /= S loop
T := T.Next;
end loop;
T.Next := S.Next;
S.Next := Global.Streams_List;
Global.Streams_List := S;
end if;
-- Apply the default stream for all streams that do not have an
-- explicit one
H := Global.Handles_List;
while H /= null loop
if H.Stream = null or else H.Stream_Is_Default then
H.Stream := S;
H.Stream_Is_Default := True;
Cache_Settings (H);
end if;
H := H.Next;
end loop;
Unlock (Global.Lock);
end if;
end Set_Default_Stream;
-----------
-- Count --
-----------
function Count
(Handler : not null access Trace_Handle_Record'Class) return Natural is
begin
return Natural (Handler.Count);
end Count;
------------
-- Create --
------------
function Create
(Handle : Trace_Handle;
Message : String := "";
Location : String := GNAT.Source_Info.Source_Location;
Entity : String := GNAT.Source_Info.Enclosing_Entity;
Color : String := Default_Fg)
return Block_Trace_Handle is
begin
return Result : Block_Trace_Handle do
if Active (Handle) then
Result.Me := Handle;
Result.Loc := new String'(Entity & ':' & Location);
if Message /= "" then
Increase_Indent
(Handle, "Entering " & Result.Loc.all & ' ' & Message,
Color => Color, Location => "", Entity => "");
else
Increase_Indent
(Handle, "Entering " & Result.Loc.all,
Color => Color, Location => "", Entity => "");
end if;
end if;
end return;
end Create;
--------------
-- Finalize --
--------------
overriding procedure Finalize (Self : in out Block_Trace_Handle) is
begin
-- If we were active when Create was called
if Self.Me /= null then
Decrease_Indent
(Self.Me, "Leaving " & Self.Loc.all,
Location => "", -- avoid duplicate info in the output
Entity => "");
end if;
Free (Self.Loc);
end Finalize;
end GNATCOLL.Traces;
|