OTF_Writer.h 84.1 KB
Newer Older
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 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
/*
 This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2010.
 Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch
*/

/** 
 *  @file OTF_Writer.h
 *
 *  @brief Transparently writes OTF traces which consist of multiple streams.
 *
 * \ingroup writer
 */

/** \defgroup writer Writer Interface
 *
 *  This interface should be used whenever a trace file is to be written as a
 *  whole.  Therefore, an initial call to the OTF_Writer_open() function
 *  allows to specify a number of streams which are going to be used to
 *  automatically partition the recorded event data. OTF than takes over the
 *  duty of distributing the data on multiple files.
 *
 *  \section writer_example A simple Example
 *
 *  \code
 *  #include <assert.h>
 *  #include "otf.h"
 *
 *  int main( int argc, char** argv ) {
 *  \endcode
 *
 *      Declare a file manager and a writer.
 *      \code
 * 	    OTF_FileManager* manager;
 * 	    OTF_Writer* writer;
 * 	    \endcode
 *
 *     	Initialize the file manager. Open at most 100 OS files.
 *     	\code
 *     	manager= OTF_FileManager_open( 100 );
 * 	    assert( manager );
 * 	    \endcode
 *
 * 	    Initialize the writer. Open file "test", writing one stream.
 * 	    \code
 * 	    writer = OTF_Writer_open( "test", 1, manager );
 *      assert( writer );
 *      \endcode
 *      
 *      Write some important Definition Records.
 *      Have a look at the specific functions to see what the parameters mean.
 *      \code
 *      OTF_Writer_writeDefTimerResolution( writer, 0, 1000 );
 *      OTF_Writer_writeDefProcess( writer, 0, 1, "proc one", 0 );
 *      OTF_Writer_writeDefFunctionGroup( writer, 0, 1000, "all functions" );
 *      OTF_Writer_writeDefFunction( writer, 0, 1, "main", 1000, 0 );
 *      \endcode
 *
 *
 *      Write an enter and a leave record.
 *      time = 10000, 20000
 *      process = 1
 *      function = 1
 *      Sourcecode location doesn't matter, so it's zero.
 *      \code
 *      OTF_Writer_writeEnter( writer, 10000, 1, 1, 0 );
 *      OTF_Writer_writeLeave( writer, 20000, 1, 1, 0 );
 *      \endcode
 *
 *      Clean up before exiting the program.
 *      \code
 *      OTF_Writer_close( writer );
 *      OTF_FileManager_close( manager );
 *
 *		return 0;
 * }
 * \endcode
 *
 * Compile this using $ gcc -o test test.c `otfconfig --libs`.
 *
 */

#ifndef OTF_WRITER_H
#define OTF_WRITER_H


#include "OTF_MasterControl.h"
#include "OTF_FileManager.h"
#include "OTF_WBuffer.h"
#include "OTF_WStream.h"


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** writer object \ingroup writer */
typedef struct struct_OTF_Writer OTF_Writer;

/* *** public member functions *** */


/**     
 * Create a new OTF_Writer instance with a given number of automatic streams.
 *
 * Setting the number of streams to 0 causes the OTF_Writer object to create a
 * separate stream for each process. Important! Explicit calls to
 * OTF_Writer_assignProcess() can lead to an overall number of streams which
 * exceeds the initial number of streams in this call. 
 * OTF can reduce its file handle usage to a given number. Therefore, an 
 * initialized file manager instance is needed as parameter. 
 * See OTF_FileManager for further details.
 *
 * @param  fileNamePrefix   File name prefix which is going to be used by 
 *                          all sub-files which belong to the trace.
 * @param  numberOfStreams  Initial number of independent data streams to 
 *                          be generated.
 * @param  fileManager      File handle manager. 
 *
 *
 * @return                  Initialized OTF_Writer instance or 0 if a failure
 *                          occurred.
 *
 * \ingroup writer
 */
OTF_Writer* OTF_Writer_open( const char* fileNamePrefix, 
                             uint32_t numberOfStreams, 
                             OTF_FileManager* fileManager );


/** 
 * Close an OTF_Writer instance and all its related files.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 * 
 * @return        1 if instance was closed successfully and 0 otherwise.       
 *
 * \ingroup writer
 */
int OTF_Writer_close( OTF_Writer* writer );


/** 
 * Close all streams that are open in this writer instance.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 *
 * @return        1 on success, 0 if an error occurs.
 * 
 * \ingroup writer
 */
int OTF_Writer_closeAllStreams( OTF_Writer* writer );


/**
 * Set the standard compression method for all buffers managed by this writer
 *
 * @param writer       Pointer to an initialized OTF_Writer object. See 
 *                     also OTF_Writer_open().
 *
 * @param compression  compression level to apply to all following streams
 *                     0-9, where 0 means no compression is applied, and 9 is
 *                     the highest level of compression.
 *
 * @return             1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_setCompression( OTF_Writer* writer, OTF_FileCompression
	compression );

	
/**
 * Return the standard compression method for all buffers managed by this writer
 *
 * @param writer       Pointer to an initialized OTF_Writer object. See 
 *                     also OTF_Writer_open().
 *
 * @return             Standard compression level for all buffers managed by
 *                     this writer.
 *
 * \ingroup writer
 */
OTF_FileCompression OTF_Writer_getCompression( OTF_Writer* writer );


/**
 * Set the default buffer size for all buffers managed by this Writer. 
 * This is only effective for future buffers and will not change already 
 * allocated buffers. Those can be changed with the buffers directly.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 * 
 * @param size    Intended buffer size.
 *
 * \ingroup writer
 */
void OTF_Writer_setBufferSizes( OTF_Writer* writer, uint32_t size );


/** 
 * Get the default buffer size for all buffers managed by this Writer.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 * 
 * @return        Default buffer size for all buffers managed by this Writer.
 *
 * \ingroup writer
 */
uint32_t OTF_Writer_getBufferSizes( OTF_Writer* writer );


/**
 * Set the default zbuffer size for all buffers managed by this Reader.
 * This is only effective for future files and will not change already
 * allocated zbuffers. Those can be changed with the files directly.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 *
 * @param size    Intended zbuffer size.
 *
 * \ingroup writer
 */
void OTF_Writer_setZBufferSizes( OTF_Writer* writer, uint32_t size );

/** 
 * Get the default zbuffer size.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 *
 * @return  zbuffer size.
 *
 * \ingroup writer
 */
uint32_t OTF_Writer_getZBufferSizes( OTF_Writer* writer );

/**
 * Set the default ouput format. The format is applied to all streams opened by
 * the writer.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 *
 * @param format  Intended output format (OTF_WSTREAM_FORMAT_{LONG,SHORT}).
 *
 * \ingroup writer
 */
void OTF_Writer_setFormat( OTF_Writer* writer, uint32_t format );


/**
 * Get the default output format of all streams managed by this writer.
 *
 * @param writer  Pointer to an initialized OTF_Writer object. See 
 *                also OTF_Writer_open().
 *
 * @return        Default output format.
 *
 * \ingroup writer
 */
uint32_t OTF_Writer_getFormat( OTF_Writer* writer );


/**     
 * Explicitly assign a given process to a specific stream.
 *
 * Mind that 0 is not a valid stream or process identifier but a reserved
 * value. By default, processes are automatically assigned to streams.
 * Therefore, this call is optional. 
 * 
 * @param writer   Pointer to an initialized OTF_Writer object. See 
 *                 also OTF_Writer_open().
 * @param process  Process identifier. See also OTF_Writer_writeDefProcess().
 * @param stream   Target stream identifier with 
 *                 0 < stream <= number of streams as defined in 
 *                 OTF_Writer_open().
 *
 * @return         1 on success, 0 if an error occurs. 
 *
 * \ingroup writer
 */
uint32_t OTF_Writer_assignProcess( OTF_Writer* writer,
                                   uint32_t process, 
                                   uint32_t stream );


/**
 * Get a pointer to the master control object of the given writer instance.
 *
 * @param writer   Pointer to an initialized OTF_Writer object. See 
 *                 also OTF_Writer_open().
 *
 * @return         Pointer to a master control object. See OTF_MasterControl.
 *
 * \ingroup writer
 */
OTF_MasterControl* OTF_Writer_getMasterControl( OTF_Writer* writer );


/**
 * Set an alternative master control object. Use this only right after 
 * initialization but never after having written some records already!
 *
 * @param writer   Pointer to an initialized OTF_Writer object. See 
 *                 also OTF_Writer_open().
 * @param mc       new master control object
 *                 
 *
 * \ingroup writer
 */
void OTF_Writer_setMasterControl( OTF_Writer* writer, OTF_MasterControl* mc );


/** For a process with id 'processId' return a stream id of the stream the
    data is to be written to. If no mapping has been set so far it is defined
    in a way such that it is added to the stream with the least processes.
	\ingroup writer */
uint32_t OTF_Writer_mapProcess( OTF_Writer* writer, uint32_t processId );


/** Return the stream with the given stream id. If there is no such stream yet
    create one and append it to 'streams'. \ingroup writer */
OTF_WStream* OTF_Writer_getStream( OTF_Writer* writer, uint32_t stream );


/* Methods for writing public definition records ************************** */


/**
 * Write a comment record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param stream    Target stream identifier with 
 *                  0 < stream <= number of streams as defined in 
 *                  OTF_Writer_open().
 * @param comment   Arbitrary comment string.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefinitionComment( OTF_Writer* writer, 
                                       uint32_t stream, 
                                       const char* comment );


/**
 * Write a comment record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefinitionComment()
 * \ingroup writer
 */
int OTF_Writer_writeDefinitionCommentKV( OTF_Writer* writer, 
                                       uint32_t stream, 
                                       const char* comment,
				       OTF_KeyValueList* list );


/**
 * Write the timer resolution definition record. All timed event records
 * will be interpreted according to this definition. By default, a timer
 * resultion of 1 us i.e. 1,000,000 clock ticks is assumed. 
 *
 * @param writer          Pointer to an initialized OTF_Writer object. See 
 *                        also OTF_Writer_open().
 * @param stream          Target stream identifier with 
 *                        0 < stream <= number of streams as defined in 
 *                        OTF_Writer_open().
 * @param ticksPerSecond  Clock ticks per second of the timer.
 *
 * @return                1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefTimerResolution( OTF_Writer* writer, 
                                        uint32_t stream,
                                        uint64_t ticksPerSecond );


/**
 * Write the timer resolution definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeTimerResolution()
 * \ingroup writer
 */
int OTF_Writer_writeDefTimerResolutionKV( OTF_Writer* writer, 
                                        uint32_t stream,
                                        uint64_t ticksPerSecond,
					OTF_KeyValueList* list );


/**
 * Write a process definition record. 
 *
 * @param writer   Pointer to an initialized OTF_Writer object. See 
 *                 also OTF_Writer_open().
 * @param stream   Target stream identifier with 
 *                 0 < stream <= number of streams as defined in 
 *                 OTF_Writer_open().
 * @param process  Arbitrary but unique process identifier > 0.        
 * @param name     Name of the process e.g. "Process X".
 * @param parent   Previously declared parent process identifier or 0 if 
 *                 process has no parent.
 *
 * @return         1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefProcess( OTF_Writer* writer, 
                                uint32_t stream,
                                uint32_t process, 
                                const char* name, 
                                uint32_t parent );


/**
 * Write a process definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefProcess()
 * \ingroup writer
 */
int OTF_Writer_writeDefProcessKV( OTF_Writer* writer, 
                                uint32_t stream,
                                uint32_t process, 
                                const char* name, 
                                uint32_t parent,
				OTF_KeyValueList* list );


/**
 * Write a process group definition record.
 *
 * OTF supports groups of processes. Their main objective is to classify
 * processes depending on arbitrary characteristics. Processes can reside
 * in multiple groups. This record type is optional.
 *
 * @param writer         Pointer to an initialized OTF_Writer object. See 
 *                       also OTF_Writer_open().
 * @param stream         Target stream identifier with 
 *                       0 < stream <= number of streams as defined in 
 *                       OTF_Writer_open().
 * @param procGroup      Arbitrary but unique process group identifier > 0.
 * @param name           Name of the process group e.g. "Well Balanced".
 * @param numberOfProcs  The number of processes in the process group.
 * @param procs          Vector of process identifiers or previously defined
 *                       process group identifiers as defined with
 *                       OTF_Writer_writeDefProcess() resp. 
 *                       OTF_Writer_writeDefProcessGroup.
 *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefProcessGroup( OTF_Writer* writer, 
                                     uint32_t stream,
                                     uint32_t procGroup, 
                                     const char* name, 
                                     uint32_t numberOfProcs, 
                                     const uint32_t* procs );


/**
 * Write a process group definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefProcessGroup()
 * \ingroup writer
 */
int OTF_Writer_writeDefProcessGroupKV( OTF_Writer* writer, 
                                     uint32_t stream,
                                     uint32_t procGroup, 
                                     const char* name, 
                                     uint32_t numberOfProcs, 
                                     const uint32_t* procs,
				     OTF_KeyValueList* list );


/**
 * Write an attribute list definition record.
 *
 * Defines a list of attributes that is assigned to a unique token.
 *
 * @param writer       Pointer to an initialized OTF_Writer object. See 
 *                     also OTF_Writer_open().
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param attr_token   Arbitrary but unique attribute list identifier > 0.
 * @param num          Number of elements in the attribute list array.
 * @param array        An array of different attributes with type of OTF_ATTR_TYPE(). 
 *
 * @return             1 on success, 0 if an error occurs.
 * 
 * \ingroup writer
 */
int OTF_Writer_writeDefAttributeList( OTF_Writer* writer,
				      uint32_t stream,
				      uint32_t attr_token,
				      uint32_t num,
				      OTF_ATTR_TYPE* array );


/**
 * Write an attribute list definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefAttributeList()
 * \ingroup writer
 */
int OTF_Writer_writeDefAttributeListKV( OTF_Writer* writer,
				      uint32_t stream,
				      uint32_t attr_token,
				      uint32_t num,
				      OTF_ATTR_TYPE* array,
				      OTF_KeyValueList* list );


/**
 * Write a process or group attributes definition record.
 *
 * @param writer       Pointer to an initialized OTF_Writer object. See 
 *                     also OTF_Writer_open().
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param proc_token   Arbitrary but unique process or process group identifier > 0.
 * @param attr_token   A unique token that was defined with OTF_Writer_writeDefAttributeList().
 *
 * @return             1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefProcessOrGroupAttributes( OTF_Writer* writer,
						 uint32_t stream,
						 uint32_t proc_token,
						 uint32_t attr_token );


/**
 * Write a process or group attributes definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefProcessOrGroupAttributes()
 * \ingroup writer
 */
int OTF_Writer_writeDefProcessOrGroupAttributesKV( OTF_Writer* writer,
						 uint32_t stream,
						 uint32_t proc_token,
						 uint32_t attr_token,
						 OTF_KeyValueList* list );


/**
 * Write a function definition record.
 *
 * Defines a function of the given name. Functions can optionally belong to a
 * certain function group to be defined with the
 * OTF_Writer_writeDefFunctionGroup() call. A source code reference can
 * be added to the definition aswell.
 *
 * @param writer     Pointer to an initialized OTF_Writer object. See 
 *                   also OTF_Writer_open().
 * @param stream     Target stream identifier with 
 *                   0 < stream <= number of streams as defined in 
 *                   OTF_Writer_open().
 * @param func       Arbitrary but unique function identifier > 0.
 * @param name       Name of the function e.g. "DoSomething".
 * @param funcGroup  A function group identifier preliminary defined with
 *                   OTF_Writer_writeDefFunctionGroup() or 0 for no
 *                   function group assignment.        
 * @param source     Reference to the function's source code location 
 *                   preliminary defined with OTF_Writer_writeDefScl() or
 *                   0 for no source code location assignment.
 *
 * @return           1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefFunction( OTF_Writer* writer, 
                                 uint32_t stream,
                                 uint32_t func, 
                                 const char* name, 
                                 uint32_t funcGroup, 
                                 uint32_t source );


/**
 * Write a function definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefFunction()
 * \ingroup writer
 */
int OTF_Writer_writeDefFunctionKV( OTF_Writer* writer, 
                                 uint32_t stream,
                                 uint32_t func, 
                                 const char* name, 
                                 uint32_t funcGroup, 
                                 uint32_t source,
				 OTF_KeyValueList* list );


/**
 * Write a function group definition record.
 *
 * @param writer     Pointer to an initialized OTF_Writer object. See 
 *                   also OTF_Writer_open().
 * @param stream     Target stream identifier with 
 *                   0 < stream <= number of streams as defined in 
 *                   OTF_Writer_open().
 * @param funcGroup  An arbitrary but unique function group identifier > 0.
 * @param name       Name of the function group e.g. "Computation".
 *
 * @return           1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefFunctionGroup( OTF_Writer* writer, 
                                      uint32_t stream,
                                      uint32_t funcGroup, 
                                      const char* name );


/**
 * Write a function group definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefFunctionGroup()
 * \ingroup writer
 */
int OTF_Writer_writeDefFunctionGroupKV( OTF_Writer* writer, 
                                      uint32_t stream,
                                      uint32_t funcGroup, 
                                      const char* name,
				      OTF_KeyValueList* list );


/**
 * Write a collective operation definition record.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param stream      Target stream identifier with 
 *                    0 < stream <= number of streams as defined in 
 *                    OTF_Writer_open().
 * @param collOp      An arbitrary but unique collective op. identifier > 0.
 * @param name        Name of the collective operation e.g. "MPI_Bcast".
 * @param type        One of the five supported collective classes:
 *                    OTF_COLLECTIVE_TYPE_UNKNOWN (default),
 *                    OTF_COLLECTIVE_TYPE_BARRIER,
 *                    OTF_COLLECTIVE_TYPE_ONE2ALL,
 *                    OTF_COLLECTIVE_TYPE_ALL2ONE,
 *                    OTF_COLLECTIVE_TYPE_ALL2ALL.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefCollectiveOperation( OTF_Writer* writer, 
                                            uint32_t stream,
                                            uint32_t collOp,
                                            const char* name,
                                            uint32_t type );


/**
 * Write a collective operation definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefCollectiveOperation()
 * \ingroup writer
 */
int OTF_Writer_writeDefCollectiveOperationKV( OTF_Writer* writer, 
                                            uint32_t stream,
                                            uint32_t collOp,
                                            const char* name,
                                            uint32_t type,
					    OTF_KeyValueList* list );


/**
 * Write a counter definition record.
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param stream        Target stream identifier with 
 *                      0 < stream <= number of streams as defined in 
 *                      OTF_Writer_open().
 * @param counter       An arbitrary but unique counter identifier.
 * @param name          Name of the counter e.g. "Cache Misses".
 * @param properties    A combination of a type and scope counter property.
 *                      OTF_COUNTER_TYPE_ACC (default) represents a counter
 *                      with monotonously increasing values e.g. a FLOP 
 *                      counter. OTF_COUNTER_TYPE_ABS on the other hand 
 *                      defines a counter with alternating absolute values e.g.
 *                      the memory usage of a process. The following counter
 *                      measurement scopes are supported: 
 *                      OTF_COUNTER_SCOPE_START (default) always refers to the 
 *                      start of the process, OTF_COUNTER_SCOPE_POINT refers
 *                      to exactly this moment in time, OTF_COUNTER_SCOPE_LAST
 *                      relates to the previous measurement, and
 *                      OTF_COUNTER_SCOPE_NEXT to the next measurement.
 *                      Examples: OTF_COUNTER_TYPE_ACC + 
 *                      OTF_COUNTER_SCOPE_START should be used for most 
 *                      standard hardware (PAPI) counters. 
 *                      OTF_COUNTER_TYPE_ABS + OTF_COUNTER_SCOPE_POINT could
 *                      be used to record information 'spikes'.
 *                      OTF_COUNTER_TYPE_ABS + OTF_COUNTER_SCOPE_NEXT works
 *                      for memory allocation recording. 
 * @param counterGroup  A previously defined counter group identifier or 0 
 *                      for no group.
 * @param unit          Unit of the counter e.g. "#" for "number of..." or 0 
 *                      for no unit. 
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefCounter( OTF_Writer* writer,
                                uint32_t stream,
                                uint32_t counter,
                                const char* name,
                                uint32_t properties, 
                                uint32_t counterGroup, 
                                const char* unit );


/**
 * Write a counter definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefCounter()
 * \ingroup writer
 */
int OTF_Writer_writeDefCounterKV( OTF_Writer* writer,
                                uint32_t stream,
                                uint32_t counter,
                                const char* name,
                                uint32_t properties, 
                                uint32_t counterGroup, 
                                const char* unit,
				OTF_KeyValueList* list );


/**
 * Write a counter group definition record.
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param counterGroup An arbitrary but unique counter group identifier.
 * @param name         Counter group name.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefCounterGroup( OTF_Writer* writer, 
                                     uint32_t stream,
                                     uint32_t counterGroup, 
                                     const char* name );


/**
 * Write a counter group definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefCounterGroup()
 * \ingroup writer
 */
int OTF_Writer_writeDefCounterGroupKV( OTF_Writer* writer, 
                                     uint32_t stream,
                                     uint32_t counterGroup, 
                                     const char* name,
				     OTF_KeyValueList* list );


/**
 * Write a source code location (SCL) record.
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param source       Arbitrary but unique source code location 
 *                     identifier > 0.
 * @param sourceFile   Previously defined source file identifier. See 
 *                     OTF_Writer_writeDefSclFile(). 
 * @param line         Line number.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefScl( OTF_Writer* writer,
                            uint32_t stream,
                            uint32_t source,
                            uint32_t sourceFile, 
                            uint32_t line );


/**
 * Write a source code location (SCL) record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefScl()
 * \ingroup writer
 */
int OTF_Writer_writeDefSclKV( OTF_Writer* writer,
                            uint32_t stream,
                            uint32_t source,
                            uint32_t sourceFile, 
                            uint32_t line,
			    OTF_KeyValueList* list );


/**
 * Write a source code location (SCL) file record.
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param sourceFile   Arbitrary but unique source code location 
 *                     identifier != 0.
 * @param name         File name. 
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefSclFile( OTF_Writer* writer,
                                uint32_t stream, 
                                uint32_t sourceFile,
                                const char* name );


/**
 * Write a source code location (SCL) file record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefSclFile()
 * \ingroup writer
 */
int OTF_Writer_writeDefSclFileKV( OTF_Writer* writer,
                                uint32_t stream, 
                                uint32_t sourceFile,
                                const char* name,
				OTF_KeyValueList* list );


/**
 * depricated. The Otf-Version-record is generated automatically at beginning of
 * tracing in the global definiton stream.
 *
 * \ingroup writer
 */
int OTF_Writer_writeOtfVersion( OTF_Writer* writer, uint32_t stream );


/**
 * Write a creator record. 
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param creator      String which identifies the creator of the 
 *                     file e.g. "TAU Version x.y.z".
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefCreator( OTF_Writer* writer, uint32_t stream,
                                const char* creator );


/**
 * Write a creator record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefCreator()
 * \ingroup writer
 */
int OTF_Writer_writeDefCreatorKV( OTF_Writer* writer, uint32_t stream,
                                const char* creator,
				OTF_KeyValueList* list );




/**
 * Write a file definition record
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param token        Arbitrary, unique identifier for the file.
 *                     Has to be > 0.
 * @param name         Name of the file.
 * @param group        File group identifier or 0 for no group.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefFile( OTF_Writer* writer,
                             uint32_t stream,
                             uint32_t token,
                             const char* name,
                             uint32_t group );


/**
 * Write a file definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefFile()
 * \ingroup writer
 */
int OTF_Writer_writeDefFileKV( OTF_Writer* writer,
                             uint32_t stream,
                             uint32_t token,
                             const char* name,
                             uint32_t group,
			     OTF_KeyValueList* list );


/**
 * Write a file group definition record
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param token        Arbitrary, unique identifier for the file group.
 *                     Has to be > 0.
 * @param name         Name of the file group.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefFileGroup( OTF_Writer* writer,
                                  uint32_t stream,
                                  uint32_t token,
                                  const char* name );


/**
 * Write a file group definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefFileGroup()
 * \ingroup writer
 */
int OTF_Writer_writeDefFileGroupKV( OTF_Writer* writer,
                                  uint32_t stream,
                                  uint32_t token,
                                  const char* name,
				  OTF_KeyValueList* list );


/**
 * Write a key value definition record
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param stream       Target stream identifier with 
 *                     0 < stream <= number of streams as defined in 
 *                     OTF_Writer_open().
 * @param key          Arbitrary, unique identifier for the key value pair.
 * @param type         Type of the key.
 * @param name         Name of the key value pair.
 * @param description  Description of the key value pair.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefKeyValue( OTF_Writer* writer,
				 uint32_t stream, 
				 uint32_t key,
				 OTF_Type type,
				 const char* name,
				 const char* description );


/**
 * Write a key value definition record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefKeyValue()
 * \ingroup writer
 */
int OTF_Writer_writeDefKeyValueKV( OTF_Writer* writer,
				 uint32_t stream, 
				 uint32_t key,			   
				 OTF_Type type,
				 const char* name,
				 const char* description,
				 OTF_KeyValueList* list );


/**
 * Write a no-operation record. This can be used to write an OTF_KeyValueList
 * that is not attached to a special event record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      The time when the NoOp event took place.
 * @param process   Process where action took place.
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeNoOpKV( OTF_Writer* writer,
			    uint64_t time,
			    uint32_t process,
                            OTF_KeyValueList* list );


/**
 * Write a function entry record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      The time when the function entry took place.
 * @param function  Function to be entered as defined with 
 *                  OTF_Writer_defFunction.
 * @param process   Process where action took place.
 * @param source    Optional reference to source code.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeEnter( OTF_Writer* writer, 
                           uint64_t time, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source );


/**
 * Write a function entry record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEnter()
 * \ingroup writer
 */
int OTF_Writer_writeEnterKV( OTF_Writer* writer, 
                           uint64_t time, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source,
			   OTF_KeyValueList* list );


/**
 * Write a function leave record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      The time when the function leave took place.
 * @param function  Function which was left or 0 if stack integrety checking
 *                  is not needed.
 * @param process   Process where action took place.
 * @param source    Explicit source code location or 0.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeLeave( OTF_Writer* writer, 
                           uint64_t time, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source );


/**
 * Write a function leave record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeLeave()
 * \ingroup writer
 */
int OTF_Writer_writeLeaveKV( OTF_Writer* writer, 
                           uint64_t time, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source,
			   OTF_KeyValueList* list );


/**
 * Write a message retrieval record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      The time when the message was received.
 * @param receiver  Identifier of receiving process.
 * @param sender    Identifier of sending process.
 * @param procGroup Optional process-group sender and receiver belong to,
 *                  '0' for no group.
 * @param tag       Optional message type information.
 * @param length    Optional message length information.
 * @param source    Optional reference to source code.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeRecvMsg( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t receiver, 
                             uint32_t sender, 
                             uint32_t procGroup, 
                             uint32_t tag, 
                             uint32_t length, 
                             uint32_t source );


/**
 * Write a message retrieval record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeRecvMsg()
 * \ingroup writer
 */
int OTF_Writer_writeRecvMsgKV( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t receiver, 
                             uint32_t sender, 
                             uint32_t procGroup, 
                             uint32_t tag, 
                             uint32_t length, 
                             uint32_t source,
			     OTF_KeyValueList* list );


/**
 * Write a message send record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      The time when the message was send.
 * @param sender    Sender of the message.
 * @param receiver  Receiver of the message.
 * @param procGroup Optional process-group sender and receiver belong to,
 *                  '0' for no group.
 * @param tag       Optional message type information.
 * @param length    Optional message length information.
 * @param source    Optional reference to source code.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeSendMsg( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t sender, 
                             uint32_t receiver, 
                             uint32_t procGroup, 
                             uint32_t tag, 
                             uint32_t length, 
                             uint32_t source );


/**
 * Write a message send record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeSendMsg()
 * \ingroup writer
 */
int OTF_Writer_writeSendMsgKV( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t sender, 
                             uint32_t receiver, 
                             uint32_t procGroup, 
                             uint32_t tag, 
                             uint32_t length, 
                             uint32_t source,
			     OTF_KeyValueList* list );


/**
 * Write a counter measurement record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Time when counter was measured.
 * @param process   Process where counter measurment took place.
 * @param counter   Counter which was measured. 
 * @param value     Counter value.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeCounter( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t process, 
                             uint32_t counter, 
                             uint64_t value );


/**
 * Write a counter measurement record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeCounter()
 * \ingroup writer
 */
int OTF_Writer_writeCounterKV( OTF_Writer* writer, 
                             uint64_t time, 
                             uint32_t process, 
                             uint32_t counter, 
                             uint64_t value,
			     OTF_KeyValueList* list );


/**
 * Write a collective operation member record.
 * @deprecated This event record has been deprecated due to usage constraints.
 *             Please use OTF_Writer_writeBeginCollectiveOperation() and
 *             OTF_Writer_writeEndCollectiveOperation(), repectively.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when collective operation was entered by member.
 * @param process     Process identifier i.e. collective member. 
 * @param collective  Collective identifier to be defined with
 *                    OTF_Writer_writeDefCollectiveOperation(). 
 * @param procGroup   Group of processes participating in this collective.
 * @param rootProc    Root process if != 0.
 * @param sent        Data volume sent by member or 0.
 * @param received    Data volumd received by member or 0.
 * @param duration    Time spent in collective operation.
 * @param source      Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeCollectiveOperation( OTF_Writer* writer, 
                                         uint64_t time, 
                                         uint32_t process, 
                                         uint32_t collective, 
                                         uint32_t procGroup, 
                                         uint32_t rootProc, 
                                         uint32_t sent, 
                                         uint32_t received, 
                                         uint64_t duration, 
                                         uint32_t source );


/**
 * Write a collective operation member record including an OTF_KeyValueList.
 * @deprecated This event record has been deprecated due to usage constraints.
 *             Please use OTF_Writer_writeBeginCollectiveOperationEV() and
 *             OTF_Writer_writeEndCollectiveOperationEV(), repectively.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeCollectiveOperation()
 * \ingroup writer
 */
int OTF_Writer_writeCollectiveOperationKV( OTF_Writer* writer, 
                                         uint64_t time, 
                                         uint32_t process, 
                                         uint32_t collective, 
                                         uint32_t procGroup, 
                                         uint32_t rootProc, 
                                         uint32_t sent, 
                                         uint32_t received, 
                                         uint64_t duration, 
                                         uint32_t source,
					 OTF_KeyValueList* list );


/**
 * Write a begin collective operation member record.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when collective operation was entered by member.
 * @param process     Process identifier i.e. collective member. 
 * @param collOp      Collective identifier to be defined with
 *                    OTF_Writer_writeDefCollectiveOperation(). 
 * @param matchingId  Identifier for finding the associated end collective event
 *                    record. It must be unique within this procGroup.
 * @param procGroup   Group of processes participating in this collective.
 * @param rootProc    Root process if != 0.
 * @param sent        Data volume sent by member or 0.
 * @param received    Data volume received by member or 0.
 * @param scltoken    Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeBeginCollectiveOperation( OTF_Writer* writer,
					      uint64_t time,
					      uint32_t process,
					      uint32_t collOp,
					      uint64_t matchingId,
					      uint32_t procGroup,
					      uint32_t rootProc,
					      uint64_t sent,
					      uint64_t received,
					      uint32_t scltoken );


/**
 * Write a begin collective operation member record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeBeginCollectiveOperation()
 * \ingroup writer
 */
int OTF_Writer_writeBeginCollectiveOperationKV( OTF_Writer* writer,
					      uint64_t time,
					      uint32_t process,
					      uint32_t collOp,
					      uint64_t matchingId,
					      uint32_t procGroup,
					      uint32_t rootProc,
					      uint64_t sent,
					      uint64_t received,
					      uint32_t scltoken,
					      OTF_KeyValueList* list );


/**
 * Write an end collective operation member record.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when collective operation was entered by member.
 * @param process     Process identifier i.e. collective member. 
 * @param matchingId  Matching identifier, must match a previous start
 *                    collective operation.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeEndCollectiveOperation( OTF_Writer* writer,
					    uint64_t time,
					    uint32_t process,
					    uint64_t matchingId );


/**
 * Write an end collective operation member record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEndCollectiveOperation()
 * \ingroup writer
 */
int OTF_Writer_writeEndCollectiveOperationKV( OTF_Writer* writer,
					    uint64_t time,
					    uint32_t process,
					    uint64_t matchingId,
					    OTF_KeyValueList* list );


/**
 * Write a comment record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Comments need a timestamp for a proper positioning in the 
 *                  trace.
 * @param process   Comments also need a process identifier for a proper 
 *                  positioning in the trace. 
 * @param comment   Arbitrary comment string.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
 
int OTF_Writer_writeEventComment( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment );


/**
 * Write a comment record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEventComment()
 * \ingroup writer
 */
int OTF_Writer_writeEventCommentKV( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment,
				  OTF_KeyValueList* list );


/**
 * Write a begin process record
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Time when process was referenced for the first time. 
 * @param process   Process identifier > 0.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
 
int OTF_Writer_writeBeginProcess( OTF_Writer* writer,
                                  uint64_t time,
                                  uint32_t process );


/**
 * Write a begin process record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeBeginProcess()
 * \ingroup writer
 */
int OTF_Writer_writeBeginProcessKV( OTF_Writer* writer,
                                  uint64_t time,
                                  uint32_t process,
				  OTF_KeyValueList* list );


/**
 * Write a end process record
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Time when process was referenced for the last time. 
 * @param process   Process identifier > 0.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
 
int OTF_Writer_writeEndProcess( OTF_Writer* writer,
                                uint64_t time,
                                uint32_t process );


/**
 * Write a end process record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEndProcess()
 * \ingroup writer
 */
int OTF_Writer_writeEndProcessKV( OTF_Writer* writer,
                                uint64_t time,
                                uint32_t process,
				OTF_KeyValueList* list );


/**
 * Write a file operation record
 * @deprecated This event record has been deprecated due to usage constraints.
 *             Please use OTF_Writer_writeBeginFileOperation() and
 *             OTF_Writer_writeEndFileOperation(), respectively.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Start time of the file operation. 
 * @param fileid    File identifier > 0.
 * @param handleid  File open identifier.
 * @param process   Process identifier > 0.
 * @param operation Type of file operation @see OTF_Handler_FileOperation()
 * @param bytes     Depends on operation @see OTF_Handler_FileOperation()
 * @param duration  time spent in the file operation
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeFileOperation( OTF_Writer* writer,
                                   uint64_t time,
                                   uint32_t fileid,
                                   uint32_t process,
                                   uint64_t handleid,
                                   uint32_t operation,
                                   uint64_t bytes,
                                   uint64_t duration,
                                   uint32_t source );


/**
 * Write a file operation record including an OTF_KeyValueList.
 * @deprecated This event record has been deprecated due to usage constraints.
 *             Please use OTF_Writer_writeBeginFileOperationKV() and
 *             OTF_Writer_writeEndFileOperationKV(), respectively.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeFileOperation()
 * \ingroup writer
 */
int OTF_Writer_writeFileOperationKV( OTF_Writer* writer,
                                   uint64_t time,
                                   uint32_t fileid,
                                   uint32_t process,
                                   uint64_t handleid,
                                   uint32_t operation,
                                   uint64_t bytes,
                                   uint64_t duration,
                                   uint32_t source,
				   OTF_KeyValueList* list );


/**
 * Write a begin file operation record
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Start time of file operation. 
 * @param process     Process identifier > 0.
 * @param matchingId  Operation identifier, used for finding the associated end
 *                    file operation event record.
 * @param scltoken    Optional reference to source code.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeBeginFileOperation( OTF_Writer* writer,
					uint64_t time,
					uint32_t process,
					uint64_t matchingId,
					uint32_t scltoken );


/**
 * Write a begin file operation record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeBeginFileOperation()
 * \ingroup writer
 */
int OTF_Writer_writeBeginFileOperationKV( OTF_Writer* writer,
					uint64_t time,
					uint32_t process,
					uint64_t matchingId,
					uint32_t scltoken,
					OTF_KeyValueList* list );


/**
 * Write an end file operation record
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        End time of file operation. 
 * @param process     Process identifier > 0.
 * @param fileid      File identifier > 0.
 * @param matchingId  Operation identifier, must match a previous start file
 *                    operation event record.
 * @param handleId    Unique file open identifier.
 * @param operation   Type of file operation @see OTF_Handler_FileOperation()
 * @param bytes       Depends on operation @see OTF_Handler_FileOperation()
 * @param scltoken    Optional reference to source code.
 *
 * @return            1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeEndFileOperation( OTF_Writer* writer,
				      uint64_t time,
				      uint32_t process,
				      uint32_t fileid,
				      uint64_t matchingId,
                      uint64_t handleId,
				      uint32_t operation,
				      uint64_t bytes,
				      uint32_t scltoken );


/**
 * Write an end file operation record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEndFileOperation()
 * \ingroup writer
 */
int OTF_Writer_writeEndFileOperationKV( OTF_Writer* writer,
				      uint64_t time,
				      uint32_t process,
				      uint32_t fileid,
				      uint64_t matchingId,
                      uint64_t handleId,
				      uint32_t operation,
				      uint64_t bytes,
				      uint32_t scltoken,
				      OTF_KeyValueList* list );


/**
 * Write a RMA put record - local end record.
 * The end of this transfer is marked by the NEXT end record on this <process>
 * with the same communicator/tag pair.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when process was referenced for the last time.
 * @param process     Process initiating the transfer.
 * @param origin      If >0, Process whose memory will be transferred, instead
                      of this <process>.
 * @param target      Process whose memory will be written.
 * @param communicator Together with tag, it is used to identify the
 *                    corresponding RMA end record.
 * @param tag         Together with communicator, it is used to identify the
 *                    corresponding RMA end record.
 * @param bytes       How many bytes have been transfered by this call.
 * @param source      Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_writeRMAPut( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t origin,
                            uint32_t target,
                            uint32_t communicator,
                            uint32_t tag,
                            uint64_t bytes,
                            uint32_t scltoken );


/**
 * Write a RMA put record - local end record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeRMAPut()
 * \ingroup writer
 */
int OTF_Writer_writeRMAPutKV( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t origin,
                            uint32_t target,
                            uint32_t communicator,
                            uint32_t tag,
                            uint64_t bytes,
                            uint32_t scltoken,
			    OTF_KeyValueList* list );


/**
 * Write a RMA put record - remote end record.
 * The end of this transfer is marked by the NEXT end record on process <target>
 * with the same communicator/tag pair.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when process was referenced for the last time.
 * @param process     Process initiating the transfer.
 * @param origin      If >0, Process whose memory will be transferred, instead
                      of this <process>.
 * @param target      Process whose memory will be written and where the end
 *                    record is located.
 * @param communicator Together with tag, it is used to identify the
 *                    corresponding RMA end record.
 * @param tag         Together with communicator, it is used to identify the
 *                    corresponding RMA end record.
 * @param bytes       How many bytes have been transfered by this call.
 * @param source      Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_writeRMAPutRemoteEnd( OTF_Writer* writer,
                                     uint64_t time,
                                     uint32_t process,
                                     uint32_t origin,
                                     uint32_t target,
                                     uint32_t communicator,
                                     uint32_t tag,
                                     uint64_t bytes,
                                     uint32_t scltoken );


/**
 * Write a RMA put record - remote end record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeRMAPutRemoteEnd()
 * \ingroup writer
 */
int OTF_Writer_writeRMAPutRemoteEndKV( OTF_Writer* writer,
                                     uint64_t time,
                                     uint32_t process,
                                     uint32_t origin,
                                     uint32_t target,
                                     uint32_t communicator,
                                     uint32_t tag,
                                     uint64_t bytes,
                                     uint32_t scltoken,
				     OTF_KeyValueList* list );


/**
 * Write a RMA get record.
 * The end of this transfer is marked by the NEXT end record on this <process>
 * with the same communicator/tag pair.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when process was referenced for the last time.
 * @param process     Process initiating the transfer.
 * @param origin      If >0, Process where data will be transferred to (instead
                      of this <process>).
 * @param target      Process whose memory will be read.
 * @param communicator Together with tag, it is used to identify the
 *                    corresponding RMA end record.
 * @param tag         Together with communicator, it is used to identify the
 *                    corresponding RMA end record.
 * @param bytes       How many bytes have been transfered by this call.
 * @param source      Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_writeRMAGet( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t origin,
                            uint32_t target,
                            uint32_t communicator,
                            uint32_t tag,
                            uint64_t bytes,
                            uint32_t scltoken );


/**
 * Write a RMA get record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeRMAGet()
 * \ingroup writer
 */
int OTF_Writer_writeRMAGetKV( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t origin,
                            uint32_t target,
                            uint32_t communicator,
                            uint32_t tag,
                            uint64_t bytes,
                            uint32_t scltoken,
			    OTF_KeyValueList* list );


/**
 * Write a RMA end record.
 * The end record marks the finalization of all put and get operations with the
 * same communicator/tag pair that occured so far for this <process>.
 *
 * @param writer      Initialized OTF_Writer instance.
 * @param time        Time when process was referenced for the last time.
 * @param process     Process identifier > 0.
 * @param remote      If >0, ends RMA transfers on Process <remote>, instead of
                      this <process>.
                      [remote!=0 is really weird crap and would never be used by
                       sane programmers ;-) -- nevertheless, the IBM Cell could
                       be programmed like this.]
 * @param communicator Together with tag, it is used to identify the
 *                    related RMA put/get records.
 * @param tag         Together with communicator, it is used to identify the
 *                    related RMA put/get records.
 * @param source      Explicit source code location or 0.
 *
 * @return            1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */
int OTF_Writer_writeRMAEnd( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t remote,
                            uint32_t communicator,
                            uint32_t tag,
                            uint32_t scltoken );


/**
 * Write a RMA end record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeRMAEnd()
 * \ingroup writer
 */
int OTF_Writer_writeRMAEndKV( OTF_Writer* writer,
                            uint64_t time,
                            uint32_t process,
                            uint32_t remote,
                            uint32_t communicator,
                            uint32_t tag,
                            uint32_t scltoken,
			    OTF_KeyValueList* list );


/* *** public snapshot record write handlers *** */

/**
 * Write a snapshot comment record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Comments need a timestamp for a proper positioning in the 
 *                  trace.
 * @param process   Comments also need a process identifier for a proper 
 *                  positioning in the trace. 
 * @param comment   Arbitrary comment string.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
 
int OTF_Writer_writeSnapshotComment( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment );


/**
 * Write a snapshot comment record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeSnapshotComment()
 * \ingroup writer
 */
int OTF_Writer_writeSnapshotCommentKV( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment,
				  OTF_KeyValueList* list );


/** 
 * Write an enter snapshot which provides information about a past
 * function call
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param time          Time when the snapshot was written(current time).
 * @param originaltime  Time when the according enter record was entered.
 *                      This call is still on the stack.(It has not been left
 *                      yet)
 * @param function      Function that the has been entered
 *                      OTF_Writer_defFunction.
 * @param process       Process where action took place.
 * @param source        Optional reference to source code.
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeEnterSnapshot( OTF_Writer* writer, 
                           uint64_t time, 
                           uint64_t originaltime, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source );


/** 
 * Write an enter snapshot including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeEnterSnapshot()
 * \ingroup writer
 */
int OTF_Writer_writeEnterSnapshotKV( OTF_Writer* writer, 
                           uint64_t time, 
                           uint64_t originaltime, 
                           uint32_t function, 
                           uint32_t process, 
                           uint32_t source,
			   OTF_KeyValueList* list );


/**
 * Write a send snapshot which provides information about a past
 * message send operation that is still pending, i.e. not yet received
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param time          Time when the snapshot was written(current time).
 * @param originaltime  Time when the message was sent
 * @param sender        Sender of the message.
 * @param receiver      Receiver of the message.
 * @param procGroup     Optional process-group sender and receiver belong to,
 *                      '0' for no group.
 * @param tag           Optional message type information.
 * @param length        Optional message length information.
 * @param source        Optional reference to source code.
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeSendSnapshot( OTF_Writer* writer,
                                  uint64_t time,
                                  uint64_t originaltime,
                                  uint32_t sender,
                                  uint32_t receiver,
                                  uint32_t procGroup,
                                  uint32_t tag,
                                  uint32_t length,
                                  uint32_t source );


/**
 * Write a send snapshot including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeSendSnapshot()
 * \ingroup writer
 */
int OTF_Writer_writeSendSnapshotKV( OTF_Writer* writer,
                                  uint64_t time,
                                  uint64_t originaltime,
                                  uint32_t sender,
                                  uint32_t receiver,
                                  uint32_t procGroup,
                                  uint32_t tag,
                                  uint32_t length,
                                  uint32_t source,
				                  OTF_KeyValueList* list );


/**
 * Write a snapshot record for an open (and not yet closed) file
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param time          Time when the snapshot was written(current time).
 * @param originaltime  Time when the message was sent.
 * @param fileid        File identifier.
 * @param process       Process where the file was opened.
 * @param handleid      Unique file open identifier. @see OTF_Handler_FileOperation()
 * @param source        Optional reference to source code.
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeOpenFileSnapshot( OTF_Writer* writer,
                                      uint64_t time,
                                      uint64_t originaltime,
                                      uint32_t fileid,
                                      uint32_t process,
                                      uint64_t handleid,
                                      uint32_t source );


/**
 * Write a snapshot record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeOpenFileSnapshot()
 * \ingroup writer
 */
int OTF_Writer_writeOpenFileSnapshotKV( OTF_Writer* writer,
                                      uint64_t time,
                                      uint64_t originaltime,
                                      uint32_t fileid,
                                      uint32_t process,
                                      uint64_t handleid,
                                      uint32_t source,
				                      OTF_KeyValueList* list );


/**
 * Write a snapshot record for an unfinished collective operation.
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param time          Time when the snapshot was written(current time).
 * @param originaltime  Time when the collective operation began.
 * @param process       Process identifier i.e. collective member. 
 * @param collOp        Collective identifier to be defined with
 *                      OTF_Writer_writeDefCollectiveOperation(). 
 * @param matchingId    Identifier for finding the associated end collective event
 *                      record. It must be unique within this procGroup.
 * @param procGroup     Group of processes participating in this collective.
 * @param rootProc      Root process if != 0.
 * @param sent          Data volume sent by member or 0.
 * @param received      Data volume received by member or 0.
 * @param scltoken      Explicit source code location or 0.
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeBeginCollopSnapshot( OTF_Writer* writer,
					      uint64_t time,
                          uint64_t originaltime,
					      uint32_t process,
					      uint32_t collOp,
					      uint64_t matchingId,
					      uint32_t procGroup,
					      uint32_t rootProc,
					      uint64_t sent,
					      uint64_t received,
					      uint32_t scltoken );


/**
 * Write a snapshot record for an unfinished collective operation including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeBeginCollopSnapshot()
 * \ingroup writer
 */
int OTF_Writer_writeBeginCollopSnapshotKV( OTF_Writer* writer,
					      uint64_t time,
                          uint64_t originaltime,
					      uint32_t process,
					      uint32_t collOp,
					      uint64_t matchingId,
					      uint32_t procGroup,
					      uint32_t rootProc,
					      uint64_t sent,
					      uint64_t received,
					      uint32_t scltoken,
					      OTF_KeyValueList* list );


/**
 * Write a snapshot for an unfinished file operation.
 *
 * @param writer        Initialized OTF_Writer instance.
 * @param time          Time when the snapshot was written(current time).
 * @param originaltime  Time when the operation began.
 * @param process       Process identifier > 0.
 * @param matchingId    Operation identifier, used for finding the associated end
 *                      file operation event record.
 * @param scltoken      Optional reference to source code.
 *
 * @return              1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeBeginFileOpSnapshot( OTF_Writer* writer,
					uint64_t time,
                    uint64_t originaltime,
					uint32_t process,
					uint64_t matchingId,
					uint32_t scltoken );


/**
 * Write a snapshot for an unfinished file operation including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeBeginFileOperation()
 * \ingroup writer
 */
int OTF_Writer_writeBeginFileOpSnapshotKV( OTF_Writer* writer,
					uint64_t time,
                    uint64_t originaltime,
					uint32_t process,
					uint64_t matchingId,
					uint32_t scltoken,
					OTF_KeyValueList* list );
                           
/* *** public statistics record write handlers *** */


/**
 * Write a summary comment record.
 *
 * @param writer    Initialized OTF_Writer instance.
 * @param time      Comments need a timestamp for a proper positioning in the 
 *                  trace.
 * @param process   Comments also need a process identifier for a proper 
 *                  positioning in the trace. 
 * @param comment   Arbitrary comment string.
 *
 * @return          1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
 
int OTF_Writer_writeSummaryComment( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment );


/**
 * Write a summary comment record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeSummaryComment()
 * \ingroup writer
 */
int OTF_Writer_writeSummaryCommentKV( OTF_Writer* writer, 
                                  uint64_t time, 
                                  uint32_t process, 
                                  const char* comment,
				  OTF_KeyValueList* list );


/**
 * Write a function summary record.
 *
 * @param writer       Initialized OTF_Writer instance.
 * @param time         Time when summary was computed. 
 * @param function     Function as defined with 
 *                     OTF_Handler_DefFunction.
 * @param process      Process of the given function.
 * @param count        Number of invocations.
 * @param excltime     Time spent exclusively in the given function.
 * @param incltime     Time spent in the given function including all
 *                     sub-routine calls.
 *
 * @return             1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */

int OTF_Writer_writeFunctionSummary( OTF_Writer* writer, 
        uint64_t time, uint32_t function, uint32_t process, 
        uint64_t count, uint64_t excltime, uint64_t incltime );


/**
 * Write a function summary record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeFunctionSummary()
 * \ingroup writer
 */
int OTF_Writer_writeFunctionSummaryKV( OTF_Writer* writer, 
        uint64_t time, uint32_t function, uint32_t process, 
        uint64_t count, uint64_t excltime, uint64_t incltime,
	OTF_KeyValueList* list );


/**
 * Write a functiongroup summary record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time when summary was computed. 
 * @param functiongroup  Function group as defined with 
 *                       OTF_Handler_DefFunctionGroup.
 * @param process        Process of the given function group.
 * @param count          Number of invocations.
 * @param excltime       Time spent exclusively in the given function group.
 * @param incltime       Time spent in the given function group including all
 *                       sub-routine calls.
 *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */

int OTF_Writer_writeFunctionGroupSummary( OTF_Writer* writer, 
        uint64_t time,  uint32_t functiongroup,  uint32_t process,  
        uint64_t count,  uint64_t excltime,  uint64_t incltime );


/**
 * Write a functiongroup summary record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeFunctionGroupSummary()
 * \ingroup writer
 */
int OTF_Writer_writeFunctionGroupSummaryKV( OTF_Writer* writer, 
        uint64_t time,  uint32_t functiongroup,  uint32_t process,  
        uint64_t count,  uint64_t excltime,  uint64_t incltime,
	OTF_KeyValueList* list );


/**
 * Write a message summary record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time when summary was computed. 
 * @param process        Process where messages originated.
 * @param peer           Process where the message is sent to
 * @param comm           Communicator of message summary
 * @param tag            Message type/tag.
 * @param number_sent    The number of messages sent.
 * @param number_recved  The number of messages received.
 * @param bytes_sent     The number of bytes sent via messages of the given
 *                       type.
 * @param bytes_recved   The number of bytes received through messages of the 
 *                       given type.
 *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */

int OTF_Writer_writeMessageSummary( OTF_Writer* writer, 
        uint64_t time, uint32_t process, uint32_t peer,
        uint32_t comm, uint32_t tag,  uint64_t number_sent,
        uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved );


/**
 * Write a message summary record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeMessageSummary()
 * \ingroup writer
 */
int OTF_Writer_writeMessageSummaryKV( OTF_Writer* writer, 
        uint64_t time, uint32_t process, uint32_t peer,
        uint32_t comm, uint32_t tag,  uint64_t number_sent,
        uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved,
	OTF_KeyValueList* list );


/**
 * Write a summary record of collective operations.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time when summary was computed.
 * @param process        Process identifier i.e. collective member.
 * @param comm		 Communicator of collective operation summary.
 * @param collective     Collective identifier to be defined with
 *                       OTF_Writer_writeDefCollectiveOperation().
 * @param number_sent    The number of messages sent by member or 0.
 * @param number_recved  The number of messages received by member or 0.
 * @param bytes_sent     The number of bytes sent by member or 0.
 * @param bytes_recved   The number of bytes received by member or 0.
 *
 * @return               1 on success, 0 if an error occurs.
 *
 * \ingroup writer
 */

int OTF_Writer_writeCollopSummary( OTF_Writer* writer, 
        uint64_t time, uint32_t process, uint32_t comm, uint32_t collective,
	uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved );


/**
 * Write a summary record of collective operations including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeCollopSummary()
 * \ingroup writer
 */
int OTF_Writer_writeCollopSummaryKV( OTF_Writer* writer, 
        uint64_t time, uint32_t process, uint32_t comm, uint32_t collective,
	uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved,
	OTF_KeyValueList* list );

/**
 * Writes a file operation summary record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time when summary was computed.
 * @param fileid         File identifier or 0 for all  files.
 * @param process        Process where file operations occured.
 * @param nopen          Number of files opened.
 * @param nclose         Number of files closed.
 * @param nread          Number of read events.
 * @param nwrite         Number of write events.
 * @param nseek          Number of seek events.
 * @param bytesread      Number of bytes read.
 * @param byteswrite     Number of bytes written.
 *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeFileOperationSummary( OTF_Writer* writer, uint64_t time,
	uint32_t fileid, uint32_t process, uint64_t nopen, uint64_t nclose,
	uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread,
	uint64_t byteswrite );


/**
 * Writes a file operation summary record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeFileOperationSummary()
 * \ingroup writer
 */
int OTF_Writer_writeFileOperationSummaryKV( OTF_Writer* writer, uint64_t time,
	uint32_t fileid, uint32_t process, uint64_t nopen, uint64_t nclose,
	uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread,
	uint64_t byteswrite, OTF_KeyValueList* list );


/**
 * Writes a file group operation summary record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time when summary was computed.
 * @param groupid        File group identifier or 0 for all  files/groups.
 * @param process        Process where file operations occured.
 * @param nopen          Number of files opened.
 * @param nclose         Number of files closed.
 * @param nread          Number of read events.
 * @param nwrite         Number of write events.
 * @param nseek          Number of seek events.
 * @param bytesread      Number of bytes read.
 * @param byteswrite     Number of bytes written.
 *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeFileGroupOperationSummary( OTF_Writer* writer, uint64_t time,
	uint32_t groupid, uint32_t process, uint64_t nopen, uint64_t nclose,
	uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread,
	uint64_t byteswrite );


/**
 * Writes a file group operation summary record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeFileGroupOperationSummary()
 * \ingroup writer
 */
int OTF_Writer_writeFileGroupOperationSummaryKV( OTF_Writer* writer, uint64_t time,
	uint32_t groupid, uint32_t process, uint64_t nopen, uint64_t nclose,
	uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread,
	uint64_t byteswrite, OTF_KeyValueList* list );
/* *** private member functions *** */


/* *** marker record types *** */


/**
 * Writes a def marker record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * qparam streamID       stream identifier that must be 0, any other value is ignored
 * @param token          The newly defined marker token.
 * @param name           Its name
 * @param type           Marker type, one of OTF_MARKER_TYPE_xxx
 * *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeDefMarker( OTF_Writer* writer, 
                               uint32_t streamID,
                               uint32_t token, 
                               const char* name, 
                               uint32_t type );


/**
 * Writes a def marker record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeDefMarker()
 * \ingroup writer
 */
int OTF_Writer_writeDefMarkerKV( OTF_Writer* writer, 
                               uint32_t streamID,
                               uint32_t token, 
                               const char* name, 
                               uint32_t type,
				OTF_KeyValueList* list );

/**
 * Writes a marker record.
 *
 * @param writer         Initialized OTF_Writer instance.
 * @param time           Time stamp of the marker record. Note that marker records are 
 *                       not sorted according to time stamps!
 * @param process        The process or process group of the marker.
 * @param token          A marker token defined by 'DefMarker' before.
 * @param text           Descriptive text. *
 * @return               1 on success, 0 if an error occurs.       
 *
 * \ingroup writer
 */
int OTF_Writer_writeMarker( OTF_Writer* writer, 
                            uint64_t time, 
                            uint32_t process, 
                            uint32_t token, 
                            const char* text );


/**
 * Writes a marker record including an OTF_KeyValueList.
 *
 * @param list      Initialized OTF_KeyValueList() instance or NULL.
 *
 * @see OTF_Writer_writeMarker()
 * \ingroup writer
 */
int OTF_Writer_writeMarkerKV( OTF_Writer* writer, 
                            uint64_t time, 
                            uint32_t process, 
                            uint32_t token, 
                            const char* text,
			    OTF_KeyValueList* list );

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* OTF_WRITER_H */