Package SCons :: Module Debug
[hide private]
[frames] | no frames]

Source Code for Module 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 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 3842 2008/12/20 22:59:52 scons" 
 33   
 34  import os 
 35  import string 
 36  import sys 
 37   
 38  # Recipe 14.10 from the Python Cookbook. 
 39  try: 
 40      import weakref 
 41  except ImportError: 
42 - def logInstanceCreation(instance, name=None):
43 pass
44 else:
45 - def logInstanceCreation(instance, name=None):
46 if name is None: 47 name = instance.__class__.__name__ 48 if not tracked_classes.has_key(name): 49 tracked_classes[name] = [] 50 tracked_classes[name].append(weakref.ref(instance))
51 52 53 54 tracked_classes = {} 55
56 -def string_to_classes(s):
57 if s == '*': 58 c = tracked_classes.keys() 59 c.sort() 60 return c 61 else: 62 return string.split(s)
63
64 -def fetchLoggedInstances(classes="*"):
65 classnames = string_to_classes(classes) 66 return map(lambda cn: (cn, len(tracked_classes[cn])), classnames)
67
68 -def countLoggedInstances(classes, file=sys.stdout):
69 for classname in string_to_classes(classes): 70 file.write("%s: %d\n" % (classname, len(tracked_classes[classname])))
71
72 -def listLoggedInstances(classes, file=sys.stdout):
73 for classname in string_to_classes(classes): 74 file.write('\n%s:\n' % classname) 75 for ref in tracked_classes[classname]: 76 obj = ref() 77 if obj is not None: 78 file.write(' %s\n' % repr(obj))
79
80 -def dumpLoggedInstances(classes, file=sys.stdout):
81 for classname in string_to_classes(classes): 82 file.write('\n%s:\n' % classname) 83 for ref in tracked_classes[classname]: 84 obj = ref() 85 if obj is not None: 86 file.write(' %s:\n' % obj) 87 for key, value in obj.__dict__.items(): 88 file.write(' %20s : %s\n' % (key, value))
89 90 91 92 if sys.platform[:5] == "linux": 93 # Linux doesn't actually support memory usage stats from getrusage().
94 - def memory():
95 mstr = open('/proc/self/stat').read() 96 mstr = string.split(mstr)[22] 97 return int(mstr)
98 else: 99 try: 100 import resource 101 except ImportError: 102 try: 103 import win32process 104 import win32api 105 except ImportError:
106 - def memory():
107 return 0
108 else:
109 - def memory():
110 process_handle = win32api.GetCurrentProcess() 111 memory_info = win32process.GetProcessMemoryInfo( process_handle ) 112 return memory_info['PeakWorkingSetSize']
113 else:
114 - def memory():
115 res = resource.getrusage(resource.RUSAGE_SELF) 116 return res[4]
117 118 # returns caller's stack
119 -def caller_stack(*backlist):
120 import traceback 121 if not backlist: 122 backlist = [0] 123 result = [] 124 for back in backlist: 125 tb = traceback.extract_stack(limit=3+back) 126 key = tb[0][:3] 127 result.append('%s:%d(%s)' % func_shorten(key)) 128 return result
129 130 caller_bases = {} 131 caller_dicts = {} 132 133 # trace a caller's stack
134 -def caller_trace(back=0):
135 import traceback 136 tb = traceback.extract_stack(limit=3+back) 137 tb.reverse() 138 callee = tb[1][:3] 139 caller_bases[callee] = caller_bases.get(callee, 0) + 1 140 for caller in tb[2:]: 141 caller = callee + caller[:3] 142 try: 143 entry = caller_dicts[callee] 144 except KeyError: 145 caller_dicts[callee] = entry = {} 146 entry[caller] = entry.get(caller, 0) + 1 147 callee = caller
148 149 # print a single caller and its callers, if any
150 -def _dump_one_caller(key, file, level=0):
151 l = [] 152 for c,v in caller_dicts[key].items(): 153 l.append((-v,c)) 154 l.sort() 155 leader = ' '*level 156 for v,c in l: 157 file.write("%s %6d %s:%d(%s)\n" % ((leader,-v) + func_shorten(c[-3:]))) 158 if caller_dicts.has_key(c): 159 _dump_one_caller(c, file, level+1)
160 161 # print each call tree
162 -def dump_caller_counts(file=sys.stdout):
163 keys = caller_bases.keys() 164 keys.sort() 165 for k in keys: 166 file.write("Callers of %s:%d(%s), %d calls:\n" 167 % (func_shorten(k) + (caller_bases[k],))) 168 _dump_one_caller(k, file)
169 170 shorten_list = [ 171 ( '/scons/SCons/', 1), 172 ( '/src/engine/SCons/', 1), 173 ( '/usr/lib/python', 0), 174 ] 175 176 if os.sep != '/':
177 - def platformize(t):
178 return (string.replace(t[0], '/', os.sep), t[1])
179 shorten_list = map(platformize, shorten_list) 180 del platformize 181
182 -def func_shorten(func_tuple):
183 f = func_tuple[0] 184 for t in shorten_list: 185 i = string.find(f, t[0]) 186 if i >= 0: 187 if t[1]: 188 i = i + len(t[0]) 189 return (f[i:],)+func_tuple[1:] 190 return func_tuple
191 192 193 TraceFP = {} 194 if sys.platform == 'win32': 195 TraceDefault = 'con' 196 else: 197 TraceDefault = '/dev/tty' 198
199 -def Trace(msg, file=None, mode='w'):
200 """Write a trace message to a file. Whenever a file is specified, 201 it becomes the default for the next call to Trace().""" 202 global TraceDefault 203 if file is None: 204 file = TraceDefault 205 else: 206 TraceDefault = file 207 try: 208 fp = TraceFP[file] 209 except KeyError: 210 try: 211 fp = TraceFP[file] = open(file, mode) 212 except TypeError: 213 # Assume we were passed an open file pointer. 214 fp = file 215 fp.write(msg) 216 fp.flush()
217