SCons.Debug

1 """SCons.Debug 2 3 Code for debugging SCons internal things. Not everything here is 4 guaranteed to work all the way back to Python 1.5.2, and shouldn't be 5 needed by most users. 6 7 """ 8 9 # 10 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation 11 # 12 # Permission is hereby granted, free of charge, to any person obtaining 13 # a copy of this software and associated documentation files (the 14 # "Software"), to deal in the Software without restriction, including 15 # without limitation the rights to use, copy, modify, merge, publish, 16 # distribute, sublicense, and/or sell copies of the Software, and to 17 # permit persons to whom the Software is furnished to do so, subject to 18 # the following conditions: 19 # 20 # The above copyright notice and this permission notice shall be included 21 # in all copies or substantial portions of the Software. 22 # 23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY 24 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 25 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 26 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 27 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 28 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 29 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 30 # 31 32 __revision__ = "src/engine/SCons/Debug.py 4720 2010/03/24 03:14:11 jars" 33 34 import os 35 import string 36 import sys 37 import time 38 39 # Recipe 14.10 from the Python Cookbook. 40 try: 41 import weakref 42 except ImportError:

43 - def logInstanceCreation(instance, name=None):

44 pass

45 else:

46 - def logInstanceCreation(instance, name=None):

47 if name is None: 48 name = instance.__class__.__name__ 49 if not tracked_classes.has_key(name): 50 tracked_classes[name] = [] 51 tracked_classes[name].append(weakref.ref(instance))

52 53 54 55 tracked_classes = {} 56

57 -def string_to_classes(s):

58 if s == '*': 59 c = tracked_classes.keys() 60 c.sort() 61 return c 62 else: 63 return string.split(s)

64

65 -def fetchLoggedInstances(classes="*"):

66 classnames = string_to_classes(classes) 67 return map(lambda cn: (cn, len(tracked_classes[cn])), classnames)

68

69 -def countLoggedInstances(classes, file=sys.stdout):

70 for classname in string_to_classes(classes): 71 file.write("%s: %d\n" % (classname, len(tracked_classes[classname])))

72

73 -def listLoggedInstances(classes, file=sys.stdout):

74 for classname in string_to_classes(classes): 75 file.write('\n%s:\n' % classname) 76 for ref in tracked_classes[classname]: 77 obj = ref() 78 if obj is not None: 79 file.write(' %s\n' % repr(obj))

80

81 -def dumpLoggedInstances(classes, file=sys.stdout):

82 for classname in string_to_classes(classes): 83 file.write('\n%s:\n' % classname) 84 for ref in tracked_classes[classname]: 85 obj = ref() 86 if obj is not None: 87 file.write(' %s:\n' % obj) 88 for key, value in obj.__dict__.items(): 89 file.write(' %20s : %s\n' % (key, value))

90 91 92 93 if sys.platform[:5] == "linux": 94 # Linux doesn't actually support memory usage stats from getrusage().

95 - def memory():

96 mstr = open('/proc/self/stat').read() 97 mstr = string.split(mstr)[22] 98 return int(mstr)

99 else: 100 try: 101 import resource 102 except ImportError: 103 try: 104 import win32process 105 import win32api 106 except ImportError:

107 - def memory():

108 return 0

109 else:

110 - def memory():

111 process_handle = win32api.GetCurrentProcess() 112 memory_info = win32process.GetProcessMemoryInfo( process_handle ) 113 return memory_info['PeakWorkingSetSize']

114 else:

115 - def memory():

116 res = resource.getrusage(resource.RUSAGE_SELF) 117 return res[4]

118 119 # returns caller's stack

120 -def caller_stack(*backlist):

121 import traceback 122 if not backlist: 123 backlist = [0] 124 result = [] 125 for back in backlist: 126 tb = traceback.extract_stack(limit=3+back) 127 key = tb[0][:3] 128 result.append('%s:%d(%s)' % func_shorten(key)) 129 return result

130 131 caller_bases = {} 132 caller_dicts = {} 133 134 # trace a caller's stack

135 -def caller_trace(back=0):

136 import traceback 137 tb = traceback.extract_stack(limit=3+back) 138 tb.reverse() 139 callee = tb[1][:3] 140 caller_bases[callee] = caller_bases.get(callee, 0) + 1 141 for caller in tb[2:]: 142 caller = callee + caller[:3] 143 try: 144 entry = caller_dicts[callee] 145 except KeyError: 146 caller_dicts[callee] = entry = {} 147 entry[caller] = entry.get(caller, 0) + 1 148 callee = caller

149 150 # print a single caller and its callers, if any

151 -def _dump_one_caller(key, file, level=0):

152 l = [] 153 for c,v in caller_dicts[key].items(): 154 l.append((-v,c)) 155 l.sort() 156 leader = ' '*level 157 for v,c in l: 158 file.write("%s %6d %s:%d(%s)\n" % ((leader,-v) + func_shorten(c[-3:]))) 159 if caller_dicts.has_key(c): 160 _dump_one_caller(c, file, level+1)

161 162 # print each call tree

163 -def dump_caller_counts(file=sys.stdout):

164 keys = caller_bases.keys() 165 keys.sort() 166 for k in keys: 167 file.write("Callers of %s:%d(%s), %d calls:\n" 168 % (func_shorten(k) + (caller_bases[k],))) 169 _dump_one_caller(k, file)

170 171 shorten_list = [ 172 ( '/scons/SCons/', 1), 173 ( '/src/engine/SCons/', 1), 174 ( '/usr/lib/python', 0), 175 ] 176 177 if os.sep != '/':

178 - def platformize(t):

179 return (string.replace(t[0], '/', os.sep), t[1])

180 shorten_list = map(platformize, shorten_list) 181 del platformize 182

183 -def func_shorten(func_tuple):

184 f = func_tuple[0] 185 for t in shorten_list: 186 i = string.find(f, t[0]) 187 if i >= 0: 188 if t[1]: 189 i = i + len(t[0]) 190 return (f[i:],)+func_tuple[1:] 191 return func_tuple

192 193 194 TraceFP = {} 195 if sys.platform == 'win32': 196 TraceDefault = 'con' 197 else: 198 TraceDefault = '/dev/tty' 199 200 TimeStampDefault = None 201 StartTime = time.time() 202 PreviousTime = StartTime 203

204 -def Trace(msg, file=None, mode='w', tstamp=None):

205 """Write a trace message to a file. Whenever a file is specified, 206 it becomes the default for the next call to Trace().""" 207 global TraceDefault 208 global TimeStampDefault 209 global PreviousTime 210 if file is None: 211 file = TraceDefault 212 else: 213 TraceDefault = file 214 if tstamp is None: 215 tstamp = TimeStampDefault 216 else: 217 TimeStampDefault = tstamp 218 try: 219 fp = TraceFP[file] 220 except KeyError: 221 try: 222 fp = TraceFP[file] = open(file, mode) 223 except TypeError: 224 # Assume we were passed an open file pointer. 225 fp = file 226 if tstamp: 227 now = time.time() 228 fp.write('%8.4f %8.4f: ' % (now - StartTime, now - PreviousTime)) 229 PreviousTime = now 230 fp.write(msg) 231 fp.flush()

232 233 # Local Variables: 234 # tab-width:4 235 # indent-tabs-mode:nil 236 # End: 237 # vim: set expandtab tabstop=4 shiftwidth=4: 238

Source Code for Module SCons.Debug