OTF_RBuffer.c 27.2 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
/*
 This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2010.
 Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch 
 also: patches by Rainer Keller, thanks a lot!
*/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif


#include <assert.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>

#include "OTF_Platform.h"
#include "OTF_RBuffer.h"
#include "OTF_Platform.h"
#include "OTF_Errno.h"

#include "OTF_Keywords.h"

/** constructor - internal use only */
int OTF_RBuffer_init( OTF_RBuffer* rbuffer );

/** destructor - internal use only */
int OTF_RBuffer_finish( OTF_RBuffer* rbuffer );

/** Fetch the next chunk from the file to buffer. Beforehand, move the
part [pos,end) to the beginning of the buffer in order to lose no record
fragments. Thus, read 'size-(end-pos)' bytes at most.
Return the number of bytes actually read. - internal use only */
size_t OTF_RBuffer_advance( OTF_RBuffer* rbuffer );


/** Check if there is a time stamp record at current buffer position. If so
read it and update the buffers time and go to the next record.
Return 1 in rbuffer case. Otherwise keep the buffer unchanged and return 0. */
char OTF_RBuffer_checkTimeRecord( OTF_RBuffer* rbuffer );


/** Check if there is a process record at current buffer position. If so
read it and update the buffers process and go to the next record.
Return 1 in rbuffer case. Otherwise keep the buffer unchanged and return 0. */
char OTF_RBuffer_checkProcessRecord( OTF_RBuffer* rbuffer );



/* *** internal functions which may be inlined ***************************** */


char OTF_RBuffer_checkTimeRecord( OTF_RBuffer* rbuffer ) {


	uint32_t p;
	char c;


	/* identify record type, assume we are at the begining of a record */
	/* tolerate leading spaces */
	/* do not change buffer or position until we are sure that rbuffer is a
	time record */

	p= rbuffer->pos;
	c= rbuffer->buffer[ p ];
	while ( ( ' ' == c ) || ( '\t' == c ) ) {
		
		++p;
		c= rbuffer->buffer[ p ];
	}

	/* check first real character c */
	if ( ( '0' <= c && c <= '9' ) || ( 'a' <= c && c <= 'f' ) ) {

		/* time stamp record affirmed */

		rbuffer->pos= p;
		rbuffer->time= OTF_RBuffer_readUint64( rbuffer );
		OTF_RBuffer_readNewline( rbuffer );
		return 1;
	}

	/* not a time record */
	return 0;
}


char OTF_RBuffer_checkProcessRecord( OTF_RBuffer* rbuffer ) {


	uint32_t p;
	char c;


	/* identify record type, assume we are at the begining of a record */
	/* tolerate leading spaces */
	/* do not change buffer or position until we are sure that rbuffer is a
	time record */

	p= rbuffer->pos;
	c= rbuffer->buffer[ p ];
	while ( ( ' ' == c ) || ( '\t' == c ) ) {

		++p;
		c= rbuffer->buffer[ p ];
	}

	/* check first real character c */
	c= rbuffer->buffer[ p ];
	if ( '*' == c ) {

		++p;
		c= rbuffer->buffer[ p ];

		/* skip spaces again */
		while ( ( ' ' == c ) || ( '\t' == c ) ) {

			++p;
			c= rbuffer->buffer[ p ];
		}

		c= rbuffer->buffer[ p ];
		if ( ( '0' <= c && c <= '9' ) || 
				( 'a' <= c && c <= 'f' ) ) {

			/* process specification record affirmed */
			rbuffer->pos= p;
			rbuffer->process= OTF_RBuffer_readUint32( rbuffer );
			OTF_RBuffer_readNewline( rbuffer );
			return 1;
		}
	}

	return 0;
}


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


int OTF_RBuffer_init( OTF_RBuffer* rbuffer ) {


	rbuffer->file = NULL;

	/* buffer is allocated on demand */
	rbuffer->buffer= NULL;
	rbuffer->pos= 0;
	rbuffer->lastnewline= 0;
	rbuffer->end= 0;
	rbuffer->size= 0;
	rbuffer->jumpsize= 1024;
	
	rbuffer->array= NULL;
	rbuffer->arraysize= 0;

	rbuffer->time= (uint64_t) -1;
	rbuffer->process= (uint32_t) -1;

	rbuffer->filesize= (uint64_t) -1;
	rbuffer->firstTime= (uint64_t) -1;
	rbuffer->lastTime= (uint64_t) -1;
	
	rbuffer->list = NULL;
	
#ifdef HAVE_ZLIB
	rbuffer->zbuffersize= 1024*10;
#endif /* HAVE_ZLIB */

	return 1;
}


int OTF_RBuffer_finish( OTF_RBuffer* rbuffer ) {


	free( rbuffer->buffer );
	rbuffer->buffer= NULL;
	
	if ( NULL != rbuffer->array ) {
		free( rbuffer->array );
		rbuffer->array= NULL;
	}

	return 1;
}


OTF_RBuffer* OTF_RBuffer_open( const char* filename, OTF_FileManager* manager ) {


	OTF_RBuffer* ret;

	/* Check the input parameters */
	if( NULL == manager ) {
		
			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"manager has not been defined.\n",
				__FUNCTION__, __FILE__, __LINE__ );

		return NULL;
	}

	ret= (OTF_RBuffer*) malloc( sizeof(OTF_RBuffer) );
	if ( NULL == ret ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"no memory left.\n",
				__FUNCTION__, __FILE__, __LINE__ );
				
		return NULL;
	}

	OTF_RBuffer_init( ret );

	ret->file= OTF_File_open( filename, manager, OTF_FILEMODE_READ );

	if ( NULL == ret->file ) {

/* *** commented because it can happen when defstream cannot be loaded
			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"OTF_File_open() failed. filename '%s'\n",
				__FUNCTION__, __FILE__, __LINE__, filename );
*/

		free( ret );
		ret= NULL;

		return ret;
	}

	ret->list = OTF_KeyValueList_new();

	if (ret->list == NULL) {

		free( ret->file );
		ret->file = NULL;

		free( ret );
		ret= NULL;
				
		return NULL;
	}

#ifdef HAVE_ZLIB
	OTF_File_setZBufferSize( ret->file, ret->zbuffersize );
#endif /* HAVE_ZLIB */

	return ret;
}


int OTF_RBuffer_close( OTF_RBuffer* rbuffer ) {


	int ret= 1;
	
	ret &= OTF_File_close( rbuffer->file );
	
	rbuffer->file= NULL;

	if( rbuffer->list != NULL) {
		OTF_KeyValueList_close( rbuffer->list);
	}

	OTF_RBuffer_finish( rbuffer );

	free( rbuffer );
	rbuffer = NULL;

	return ret;
}


int OTF_RBuffer_setSize( OTF_RBuffer* rbuffer, size_t size ) {


	if ( size < 100 ) {
	
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"buffer size %u too small, rejected.\n",
				__FUNCTION__, __FILE__, __LINE__, (uint32_t) size );

		return 0;
	}

	if ( size < rbuffer->size ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"cannot shrink buffer from %u to %u.\n",
				__FUNCTION__, __FILE__, __LINE__, (uint32_t) rbuffer->size,
				(uint32_t) size );

		return 0;
	}

	rbuffer->size= (uint32_t) size;
	rbuffer->buffer= (char*) realloc( rbuffer->buffer, 
		rbuffer->size * sizeof(char) );
	if( NULL == rbuffer->buffer ) {
		
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"no memory left.\n",
				__FUNCTION__, __FILE__, __LINE__ );

		return 0;
	}

	if ( rbuffer->jumpsize > size ) {
	
		rbuffer->jumpsize= (uint32_t) size;
	}

	return 1;
}


void OTF_RBuffer_setZBufferSize( OTF_RBuffer* rbuffer, uint32_t size ) {


#ifdef HAVE_ZLIB
	
	if ( 32 > size ) {
	
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"intended zbuffer size %u is too small, rejected.\n",
				__FUNCTION__, __FILE__, __LINE__, size );
		
		return;

	} else if ( 512 > size ) {
	
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"zbuffer size %u is very small, accepted though.\n",
				__FUNCTION__, __FILE__, __LINE__, size );

	} else if ( 10 * 1024 *1024 < size ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"zbuffer size %u is rather big, accepted though.\n",
				__FUNCTION__, __FILE__, __LINE__, size );
	}

	rbuffer->zbuffersize= size;
	
	if( NULL != rbuffer->file ) {
		OTF_File_setZBufferSize( rbuffer->file, rbuffer->zbuffersize );
	}
#endif /* HAVE_ZLIB */

}


int OTF_RBuffer_setJumpSize( OTF_RBuffer* rbuffer, size_t size ) {


	if ( size < 100 ) {
	
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"jump buffer size %u too small, rejected.\n",
				__FUNCTION__, __FILE__, __LINE__, (uint32_t) size );

		return 0;
	}

	if ( size > rbuffer->size ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"buffer size is smaller than jump size %u.\n",
				__FUNCTION__, __FILE__, __LINE__, (uint32_t) size );

		return 0;
	}

	rbuffer->jumpsize = (uint32_t) size;

	return 1;
}


/** make the next record availabe from the buffer. return the pointer to the
record string which is terminated by '\n' not '\0' !
rbuffer funktion must be called before any record access. it ensures the record 
is available completely in the buffer. furthermore, time and process 
information is kept track of. 
It is recommended to use the 'OTF_RBuffer_readXXX()' functions below to read
record components instead of parsing manually. In any case, after reading
'OTF_RBuffer_readNewline()' needs to be called which proceeds to the next
record begin no matter if there are still characters from the current record
present or not. */
char* OTF_RBuffer_getRecord( OTF_RBuffer* rbuffer ) {


	/* make sure there is a complete record in the buffer but 
	 steal silently away time and process records */

	while ( OTF_RBuffer_guaranteeRecord( rbuffer ) ) {

		if ( OTF_RBuffer_checkTimeRecord( rbuffer ) ) {
		
			continue;
		}

		if ( OTF_RBuffer_checkProcessRecord( rbuffer ) ) {

			continue;
		}

		return rbuffer->buffer + rbuffer->pos;
	}


	/* error, could not read enough from file to buffer. 
	probably file is exceeded. test elsewhere */
	return NULL;
}


int OTF_RBuffer_guaranteeRecord( OTF_RBuffer* rbuffer ) {


	size_t add;
	int ret;


	/* check if there is at least one '\n' in the buffer */
	if ( rbuffer->pos < rbuffer->lastnewline ) {
	
		return 1;
	}

	add= OTF_RBuffer_advance( rbuffer );
	if ( 0 == add ) {

		/* no complete record available! end of file. */

		/*
		OTF_fprintf( stderr, "OTF_RBuffer_guaranteeRecord() "
			"cannot read, file exceeded\n" );
		*/

		return 0;
	}
	
	/* after advancing the buffer, check if now there is a
	complete record available */
	/* check if there is at least one '\n' in the buffer */
	if ( rbuffer->pos < rbuffer->lastnewline ) {
	
		/* success */
		return 1;
	}

	/* if not try to double buffer size until a complete record fits */

	/* hard bound for maximum buffer size */
	while ( 1024*1024*100 > rbuffer->size ) {


		/*
		OTF_fprintf( stderr, "OTF_RBuffer_guaranteeRecord() double buffer size "
			"%u -> %u!\n", rbuffer->size, 2* rbuffer->size );
		*/

		ret= OTF_RBuffer_setSize( rbuffer, 2* rbuffer->size );

		if ( 1 != ret ) {

			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
					"cannot double buffer size.\n",
					__FUNCTION__, __FILE__, __LINE__ );

			return 0;
		}

		add= OTF_RBuffer_advance( rbuffer );
		if ( 0 == add ) {

			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
					"file exceeded.\n",
					__FUNCTION__, __FILE__, __LINE__ );

			return 0;
		}

		/* rbuffer->pos and rbuffer->end have changed */
		if ( rbuffer->pos < rbuffer->lastnewline ) {

			return 1;
		}
	}

	OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
			"buffer is too small. Extending buffer has finally failed.\n",
			__FUNCTION__, __FILE__, __LINE__ );

	return 0;
}

#define REALLOCSIZE 128
char *OTF_RBuffer_printRecord( OTF_RBuffer* rbuffer ) {


	char *ret= NULL;
	uint32_t pos= 0;
	uint32_t size= 0;
	uint32_t c= rbuffer->pos;
	
	
	while ( ( '\n' != rbuffer->buffer[c] ) && ( c < rbuffer->end ) ) {
	
		while( (pos+1) >= size ) {
			
			ret= (char*) realloc( ret, size + REALLOCSIZE );
			if( NULL == ret ) {
				
				OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
						"no memory left.\n",
						__FUNCTION__, __FILE__, __LINE__ );

				return NULL;
			}
			size+= REALLOCSIZE;
		}
		
		ret[pos]= rbuffer->buffer[c];
		++pos;
		++c;
	}
	
	ret[pos]= '\0';

		
	return ret;
}
#undef REALLOCSIZE

size_t OTF_RBuffer_advance( OTF_RBuffer* rbuffer ) {


	uint32_t i;
	uint32_t d;
	size_t ret;


	if( rbuffer->pos > rbuffer->end ) {
		
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
			"current position exceeds the file length.\n",
			__FUNCTION__, __FILE__, __LINE__ );

		return 0;
	}

	d= rbuffer->end - rbuffer->pos;
	
	/* move trailing buffer contents to the begining */
	for ( i= 0; i < d; ++i ) {
	
		rbuffer->buffer[i]= rbuffer->buffer[ rbuffer->pos + i ];
	}
	rbuffer->pos= 0;

	ret= OTF_File_read( rbuffer->file, rbuffer->buffer + d, rbuffer->size - d );

	rbuffer->end= d + ret;

	i= rbuffer->end;
	rbuffer->lastnewline= 0;
	
	while ( i > 0 ) {
		
		--i;
		
		if ( '\n' == rbuffer->buffer[i] ) {
		
			rbuffer->lastnewline= i;
			break;
		}
	}

	return ret;
}


/** Jump to the given file position and restore buffer and references as if
the buffer had reached the position by advancing through the file linearly.
In particular, find the next record start, then find next timestamp and
process specification in order to set 'time' and 'process' to true values.
Return 1 on success. Otherwise, when 0 is returned the file is not that large 
or there are no appropriate time and process specifications on the tail of
the file. Then the buffer contents is undefined! */
int OTF_RBuffer_jump( OTF_RBuffer* rbuffer, uint64_t filepos ) {


	int ret;
	size_t read;
	/* uint64_t currentPos; */
	uint32_t i;

	/* OTF_fprintf( stderr, "\tjump to %llu\n", (unsigned long long) filepos ); */

	ret= OTF_File_seek( rbuffer->file, filepos );

	if ( 0 != ret ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"OTF_File_seek() failed.\n",
				__FUNCTION__, __FILE__, __LINE__ );
		
		return 0;
	}

	rbuffer->pos= 0;
	read= OTF_File_read( rbuffer->file, rbuffer->buffer, rbuffer->jumpsize );

	rbuffer->end= (uint32_t) read;

	i= rbuffer->end;
	rbuffer->lastnewline= 0;

	while ( i > 0 ) {

		--i;

		if ( '\n' == rbuffer->buffer[i] ) {

			rbuffer->lastnewline= i;
			break;
		}
	}

	/* now we are somewhere in the middle of a record. read until next
	newline and take the next record which is complete */
	if ( 0 == OTF_RBuffer_guaranteeRecord( rbuffer ) ) {

		/*
		OTF_fprintf( stderr, "OTF_RBuffer_jump() "
				"ERROR: could not read far enough\n" );
		*/

		return 0;
	}

	/* with filepos == 0 we are sure to be already at the beginning of a record */
	if ( 0 != filepos ) {

		/* skip the incomplete record */
		OTF_RBuffer_readNewline( rbuffer );
	}

	/* make sure the next record is complete */
	if ( 0 == OTF_RBuffer_guaranteeRecord( rbuffer ) ) {

		/*
		OTF_fprintf( stderr, "OTF_RBuffer_jump() "
				"ERROR: could not read far enough\n" );
		*/

		return 0;
	}

	/* now we are at the begining of a record */

	rbuffer->time= (uint64_t) -1;
	rbuffer->process= (uint32_t) -1;

	/* search time stamp */

	while ( ((uint64_t) -1) == rbuffer->time ) {

		/* go on reading while time is undefined */

		if ( 0 == OTF_RBuffer_guaranteeRecord( rbuffer ) ) {

			/*
			OTF_fprintf( stderr, "OTF_RBuffer_jump() "
					"ERROR: could not read far enough\n" );
			*/
			return 0;
		}

		if ( OTF_RBuffer_checkTimeRecord( rbuffer ) ) {

			continue;
		}

		/* if no time record found, skip the current record */
		OTF_RBuffer_readNewline( rbuffer );
	}


	/* search process spec. */

	while ( ((uint32_t) -1) == rbuffer->process ) {

		/* go on reading while process is undefined */

		if ( 0 == OTF_RBuffer_guaranteeRecord( rbuffer ) ) {

			/*
			OTF_fprintf( stderr, "OTF_RBuffer_jump() "
					"ERROR: could not read far enough\n" );
			*/

			return 0;
		}

		if ( OTF_RBuffer_checkProcessRecord( rbuffer ) ) {

			continue;
		}

		/* if no time record found, skip the current record */
		OTF_RBuffer_readNewline( rbuffer );
	}

	return 1;
}


int OTF_RBuffer_readNewline( OTF_RBuffer* rbuffer ) {


	/* skip all non-newline characters */
	while ( '\n' != rbuffer->buffer[ rbuffer->pos ] ) {

		++(rbuffer->pos);

		if ( rbuffer->pos >= rbuffer->end ) {

			return 0;
		}
	}

	/* read newline */
	++(rbuffer->pos);

	/* dont need to catch ( rbuffer->pos >= rbuffer->end ) since rbuffer is
	its own error condition */

	return 1;
}


void OTF_RBuffer_skipSpaces( OTF_RBuffer* rbuffer ) {

	/* skip spaces */
	while ( ( ( ' ' == rbuffer->buffer[ rbuffer->pos ] ) ||
			( '\t' == rbuffer->buffer[ rbuffer->pos ] ) ) &&
			( rbuffer->pos < rbuffer->end ) ) {

		++(rbuffer->pos);
	}
}


uint64_t OTF_RBuffer_getCurrentTime( OTF_RBuffer* rbuffer ) {


	if ( rbuffer->time == (uint64_t) -1 ) {
		OTF_fprintf( stderr, "Warning: Invalid time\n" );
	}

	return rbuffer->time;
}


void OTF_RBuffer_setCurrentTime( OTF_RBuffer* rbuffer, uint64_t time ) {


	rbuffer->time= time;
}


uint32_t OTF_RBuffer_getCurrentProcess( OTF_RBuffer* rbuffer ) {


	return rbuffer->process;
}


void OTF_RBuffer_setCurrentProcess( OTF_RBuffer* rbuffer, uint32_t process ) {


	rbuffer->process= process;
}


uint64_t OTF_RBuffer_readUint64( OTF_RBuffer* rbuffer ) {


	char c;
	uint64_t ret = 0;


	OTF_RBuffer_skipSpaces( rbuffer );

	while( 1 ) {

		c= rbuffer->buffer[rbuffer->pos];

		if ( '0' <= c && c <= '9' ) {

			ret = (ret << 4) | ( c - '0' );
			++(rbuffer->pos);

		} else 	if ( 'a' <= c && c <= 'f' ) {

			ret = (ret << 4) | ( c - ( 'a' - 10 ) );
			++(rbuffer->pos);

		} else {

			return ret;
		}
	}
}


uint32_t OTF_RBuffer_readUint32( OTF_RBuffer* rbuffer ) {


	char c;
	uint32_t ret = 0;


	OTF_RBuffer_skipSpaces( rbuffer );

	while( 1 ) {

		c= rbuffer->buffer[rbuffer->pos];

		if ( '0' <= c && c <= '9' ) {

			ret = (ret << 4) | ( c - '0' );
			++(rbuffer->pos);

		} else if ( 'a' <= c && c <= 'f' ) {

			ret = (ret << 4) | ( c - ( 'a' - 10 ) );
			++(rbuffer->pos);

		} else {

			return ret;
		}
	}
}


int OTF_RBuffer_testChar( OTF_RBuffer* rbuffer, char c ) {


	OTF_RBuffer_skipSpaces( rbuffer );

	/* only advance the buffer position if the right character is found */
	if ( ( rbuffer->pos < rbuffer->end ) && 
			( c == rbuffer->buffer[rbuffer->pos] ) ) {

		++(rbuffer->pos);
		return 1;
	}

	return 0;
}


int OTF_RBuffer_testKeyword( OTF_RBuffer* rbuffer, const char* string ) {


	uint32_t i = 0;
	uint32_t j = rbuffer->pos;

	OTF_RBuffer_skipSpaces( rbuffer );

	/* only advance the buffer position if the right string is found */
	while ( string[i] )	{

		if ( string[i] != rbuffer->buffer[j] ) {

			return 0;

		} else {

			++i;
			++j;
		}
	}

	/* if the next character in buffer after the keyword is \in [A,Z]
	then the actual keyword is continued ==> not matching! */
	if ( ( 'A' <= rbuffer->buffer[j] ) && ( 'Z' >= rbuffer->buffer[j] ) ) {

		return 0;
	}

	rbuffer->pos = j;

	return 1;
}


int OTF_RBuffer_testPrefix( OTF_RBuffer* rbuffer, const char* string ) {


	uint32_t i = 0;
	uint32_t j = rbuffer->pos;


	OTF_RBuffer_skipSpaces( rbuffer );

	/* only advance the buffer position if the right string is found */
	while ( string[i] )	{

		if ( string[i] != rbuffer->buffer[j] ) {

			return 0;

		} else {

			++i;
			++j;
		}
	}

	rbuffer->pos = j;

	return 1;
}


/** Determine buffers firstTime and lastTime if not already set.
Return 1 on success, 0 on error. */
int OTF_RBuffer_getFileProperties( OTF_RBuffer* rbuffer ) {


/* range where the last timestamp is searched */
#define SEARCH_RANGE 1024


	uint64_t pos;
	uint32_t searchRange;


	/** if both are != -1 we assume everything is fine and return
	successful. otherwise we go fetching both. */
	if ( ( ((uint64_t) -1) != rbuffer->filesize ) ||
			( ((uint64_t) -1) != rbuffer->firstTime ) ||
			( ((uint64_t) -1) != rbuffer->lastTime ) ) {

		return 1;
	}

	rbuffer->filesize= OTF_File_size( rbuffer->file );


	/* jump to very beginning of file */
	if ( !OTF_RBuffer_jump( rbuffer, 0 ) ) {

		return 0;
	}


	/*
	OTF_fprintf( stderr, "search min/max time\n" );
	*/

	/* get very first timestamp easily */
	rbuffer->firstTime= rbuffer->time;

	/* now get the last one - rbuffer is a bit more tricky */

	/* search range must be smaller than buffer size */
	searchRange= ( SEARCH_RANGE < rbuffer->size ) ? SEARCH_RANGE : rbuffer->size;
	if( 0 >= searchRange ) {
		
		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"the search range is not allowed to be '0'.\n",
				__FUNCTION__, __FILE__, __LINE__ );

		return 0;
	}

	/* file position to jump to: a little bit before file end */
	pos= ( rbuffer->filesize > searchRange ) ? ( rbuffer->filesize - searchRange ) : 0;

	/* while unsuccessful jump */
	rbuffer->time= (uint64_t) -1;
	/*while ( ( !OTF_RBuffer_jump( rbuffer, pos ) ) && !!!!!!!!!!!!!!!!!!!!!!!!!
			( pos > searchRange ) ) {

		pos= pos - searchRange;
		OTF_fprintf( stderr, "  jumppos: %llu\n", (long long unsigned) pos );
	}*/
	while ( ( !OTF_RBuffer_jump( rbuffer, pos ) ) &&
			( pos > 0 ) ) {

		pos= (searchRange < pos) ? pos - searchRange : 0;
	}
	
	if ( ((uint64_t) -1) == rbuffer->time ) {

		/* found no time stamp -> give up */
		return 0;
	}

	/* we found a time stamp but maybe not the last one.
	so traverse to the end of the file */
	while ( OTF_RBuffer_getRecord(rbuffer) ) {

		OTF_RBuffer_readNewline( rbuffer );
	}

	rbuffer->lastTime= rbuffer->time;


#undef SEARCH_RANGE

	return 1;
}


int OTF_RBuffer_searchTime( OTF_RBuffer* rbuffer, uint64_t time ) {


	uint64_t posA;
	uint64_t posB;
	uint64_t posC;

	uint64_t timeA;
	uint64_t timeB;
	uint64_t timeC;

	int ret;
	char* ret2;
	

#define mindist 1024

	if ( 0 == OTF_RBuffer_getFileProperties( rbuffer ) ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"could not determine file size (%llu) or first/last time"
				" (%llx/%llx)\n",
				__FUNCTION__, __FILE__, __LINE__,
				(unsigned long long) rbuffer->filesize,
				(unsigned long long) rbuffer->firstTime,
				(unsigned long long) rbuffer->lastTime );

		return 0;
	}

	posA = 0;
	posB = rbuffer->filesize;

	timeA= rbuffer->firstTime;
	timeB= rbuffer->lastTime;

	/* catch cases where search time lies outside
	the file's time interval */
	if ( time <= timeA ) {
	
		ret= OTF_RBuffer_jump( rbuffer, posA );
		if ( 1 != ret ) {

			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
					"unsuccessful jump to begin pos= %llu.\n",
					__FUNCTION__, __FILE__, __LINE__, (unsigned long long) posA );
			
			return 0;
		}

		return 1;
	}

	if ( time > timeB ) {

		time= timeB;
	}


	/* do while the distance from 'posA' to 'posB' is big. 
	this works with plain or compressed file positions. */
	while ( posB - posA > mindist ) {

		/* strict half splitting. robust version, 
		maybe add proportional splitting later */
		posC= ( posA + posB ) / 2;

		ret= OTF_RBuffer_jump( rbuffer, posC );
		if (1!=ret){
		
			posB= posC;
			continue;
		}
		
		timeC= rbuffer->time;

		if ( time == timeC ) {
	
			/* hit exactly */
			return 1;
		}

		if ( time < timeC ) {

			posB= posC;
			timeB= timeC;
			/* continue; */

		} else /* if ( time > timeC ) */ {

			posA= posC;
			timeA= timeC;
			/* continue; */
		} 
	}

	/* target is nearly found, search linearly now */

	ret= OTF_RBuffer_jump( rbuffer, posA );
	if ( 1 != ret ) {

		OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
				"unsuccessful jump to begin pos= %llu.\n",
				__FUNCTION__, __FILE__, __LINE__, (unsigned long long) posA );

		return 0;
	}

	while ( rbuffer->time < time ) {

		OTF_RBuffer_readNewline( rbuffer );
		ret2= OTF_RBuffer_getRecord( rbuffer );
		if( NULL == ret2 ) {
			
			OTF_fprintf( stderr, "ERROR in function %s, file: %s, line: %i:\n "
					"OTF_RBuffer_getRecord() failed.\n",
					__FUNCTION__, __FILE__, __LINE__ );

			return 0;
		}
	}

	return 1;

#undef mindist
}


const char* OTF_RBuffer_readString( OTF_RBuffer* rbuffer ) {


	char* str;


	OTF_RBuffer_skipSpaces( rbuffer );

	if ( !OTF_RBuffer_testChar( rbuffer, '"' ) ) {

		return NULL;
	}

	str= &(rbuffer->buffer[rbuffer->pos]);

	while ( rbuffer->buffer[rbuffer->pos] != '"' ) {

		if ( rbuffer->pos < rbuffer->end ) {

			++(rbuffer->pos);

		} else {

			return NULL;
		}
	}

	rbuffer->buffer[rbuffer->pos] = '\0';
	++(rbuffer->pos);

	return str;
}


uint32_t OTF_RBuffer_readArray( OTF_RBuffer* rbuffer, uint32_t** array, uint32_t* size ) {


	uint32_t i= 0;
	uint32_t n= 0;

	const char* p= &( rbuffer->buffer[ rbuffer->pos ] );

	while ( ( ( '0' <= *p ) && ( '9' >= *p ) ) ||
			( ( 'a' <= *p ) && ( 'f' >= *p ) ) || 
			( ' '  == *p ) || 
			( '\t' == *p ) || 
			( ','  == *p ) )	{

		if ( ',' == *p ) {

			++n;
		}
		
		++p;
	}

	if ( n > (*size) ) {
		(*array)= (uint32_t*) realloc( (*array), n * sizeof(uint32_t) );
		assert( NULL != (*array) );
		(*size)= n;
	}
	
	for ( i= 0; i < n; ++i ) {

		OTF_RBuffer_skipSpaces( rbuffer );
		(*array)[i] = OTF_RBuffer_readUint32( rbuffer );
		OTF_RBuffer_testChar( rbuffer, ',' );
	}

/*
	OTF_RBuffer_skipSpaces( rbuffer );

	while ( 	( '0' <= (char) rbuffer->buffer[rbuffer->pos] &&
			(char) rbuffer->buffer[rbuffer->pos] <= '9' ) ||
			( 'a' <= (char) rbuffer->buffer[rbuffer->pos] &&
			(char) rbuffer->buffer[rbuffer->pos] <= 'f' ) )	{

		array[n] = OTF_RBuffer_readUint32( rbuffer );
		++n;
		OTF_RBuffer_testChar( rbuffer, ',' );
		OTF_RBuffer_skipSpaces( rbuffer );
	}
*/

	return n;
}


void OTF_RBuffer_skipKeyword( OTF_RBuffer* rbuffer ) {


	while ( (	(char) rbuffer->buffer[rbuffer->pos] >= 'A' &&
			(char) rbuffer->buffer[rbuffer->pos] <= 'Z' ) ||
			(char) rbuffer->buffer[rbuffer->pos] == '#') {


		++(rbuffer->pos);
	}
}


uint64_t OTF_RBuffer_getFileSize( OTF_RBuffer* rbuffer ) {


	return OTF_File_size( rbuffer->file );
}


uint64_t OTF_RBuffer_getFilePos( OTF_RBuffer* rbuffer ) {


	return OTF_File_tell( rbuffer->file );
}

uint8_t OTF_RBuffer_readBytes( OTF_RBuffer* rbuffer, uint8_t *array, uint8_t max_len ) {

	char c;
	int k = 0;
	int i = 0;

	OTF_RBuffer_skipSpaces( rbuffer );

	while( 1 ) {

		if (k == 2) {
			i++;
			k = 0;
		}

		if ( i >= max_len ) return i;

		c= rbuffer->buffer[rbuffer->pos];

		if ( '0' <= c && c <= '9' ) {

			array[i] = ( array[i] << 4) | ( c - '0' );
			++(rbuffer->pos);

		} else if ( 'a' <= c && c <= 'f' ) {

			array[i] = ( array[i] << 4) | ( c - ( 'a' - 10 ) );
			++(rbuffer->pos);

		} else {

			return i;
		}

		k++;
	}
}

uint32_t OTF_RBuffer_readKeyValueList(OTF_RBuffer* buffer ) {


	OTF_KeyValuePair pair;

	if ( buffer->list == NULL) {

		return 0;
	}

	pair.key = OTF_RBuffer_readUint32( buffer );

	if ( OTF_RBuffer_testKeyword( buffer, OTF_KEYWORD_S_LOCAL_TYPE ) ||
				OTF_RBuffer_testKeyword( buffer, OTF_KEYWORD_L_LOCAL_TYPE ) ) {

		pair.type = OTF_RBuffer_readUint32( buffer );

	} else {
		/* Parse error */
		PARSE_ERROR( buffer );
		
		return 0;
	}

	if ( OTF_RBuffer_testKeyword( buffer, OTF_KEYWORD_S_LOCAL_VALUE ) ||
				OTF_RBuffer_testKeyword( buffer, OTF_KEYWORD_L_LOCAL_VALUE ) ) {
		switch (pair.type) {
		case OTF_CHAR:
			OTF_RBuffer_readBytes( buffer, (uint8_t*) &(pair.value.otf_char), 1 );
			break;
		case OTF_INT8:
		  	pair.value.otf_int8 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_UINT8:
			pair.value.otf_uint8 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_INT16:
			pair.value.otf_int16 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_UINT16:
			pair.value.otf_uint16 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_INT32:
			pair.value.otf_int32 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_UINT32:
			pair.value.otf_uint32 = OTF_RBuffer_readUint32( buffer );
			break;
		case OTF_INT64:
			pair.value.otf_int64 = OTF_RBuffer_readUint64( buffer );
			break;
		case OTF_UINT64:
			pair.value.otf_uint64 = OTF_RBuffer_readUint64( buffer );
			break;
		case OTF_DOUBLE:
			pair.value.otf_double = OTF_Int64ToDouble( OTF_RBuffer_readUint64( buffer ) );
			break;
		case OTF_FLOAT:
			pair.value.otf_float = OTF_Int32ToFloat( OTF_RBuffer_readUint32( buffer ) );
			break;
		case OTF_BYTE_ARRAY:
			pair.value.otf_byte_array.len = OTF_RBuffer_readBytes( buffer, pair.value.otf_byte_array.array, OTF_KEYVALUE_MAX_ARRAY_LEN);
			break;
		default:

			/* Pasre error */
			PARSE_ERROR( buffer );

			return 0;
		}

	} else {

		/* Parse error */
		PARSE_ERROR( buffer );
		
		return 0;
	}

	if ( OTF_RBuffer_readNewline( buffer ) ) {

		OTF_KeyValueList_appendPair(buffer->list, pair);

	} else {

		PARSE_ERROR( buffer );
		
		return 0;
	}

	return 1;
}