Problem 1:
[dyninst.git] / dyninstAPI / src / util.h
1 /*
2  * Copyright (c) 1996-2004 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 // $Id: util.h,v 1.34 2006/02/14 23:50:16 jaw Exp $
43
44 #ifndef UTIL_H
45 #define UTIL_H
46
47 #define FILE__ strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__
48 #include "common/h/headers.h"
49 #include "common/h/Time.h"
50 #include "common/h/Types.h"
51 #include "common/h/String.h"
52
53 bool waitForFileToExist(char *fname, int timeout_seconds);
54 int openFileWhenNotBusy(char *fname, int flags, int mode, int timeout_seconds);
55
56 #ifndef BPATCH_LIBRARY
57 // DON'T access through this global variable
58 extern timeStamp *pFirstRecordTime;
59
60 // ACCESS through these functions
61 void setFirstRecordTime(const timeStamp &ts);
62 bool isInitFirstRecordTime();
63 const timeStamp &getFirstRecordTime();
64 #endif
65
66 #if defined (os_windows)
67 #define VSNPRINTF _vsnprintf
68 #define SNPRINTF _snprinf
69 #else
70 #define VSNPRINTF vsnprintf
71 #define SNPRINTF snprinf
72 #endif
73 #define BPFATAL(x) bpfatal_lf(__FILE__, __LINE__, x)
74 extern void logLine(const char *line);
75 extern void statusLine(const char *line, bool force = false);
76 extern char errorLine[];
77 extern int bpfatal(const char *format, ...);
78 extern int bperr(const char *format, ...);
79 extern int bpwarn(const char *format, ...);
80 extern int bpinfo(const char *format, ...);
81
82 extern int bpfatal_lf(const char *__file__, unsigned int __line__, const char *format, ...);
83 inline unsigned uiHash(const unsigned &val) {
84   return val;
85 }
86
87 inline unsigned CThash(const unsigned &val) {
88   return val % 1048573;
89 }
90
91 unsigned addrHash4(const Address &addr);
92    // use when you know the address is divisible by 4 (lo 2 bits 0)
93 unsigned addrHash16(const Address &addr);
94    // use when you know the address is divisible by 16 (lo 4 bits 0)
95 unsigned addrHash(const Address &addr);
96    // use when you cannot assume anything about the address
97
98 unsigned ptrHash4(void *ptr);
99 unsigned ptrHash16(void *ptr);
100
101 inline unsigned intHash(const int &val) {
102   return val;
103 }
104
105 void
106 pd_log_perror(const char* msg);
107
108 #endif /* UTIL_H */