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
10 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
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:
20 # The above copyright notice and this permission notice shall be included
21 # in all copies or substantial portions of the Software.
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.
32 __revision__ = "src/engine/SCons/Debug.py 3842 2008/12/20 22:59:52 scons"
38 # Recipe 14.10 from the Python Cookbook.
42 def logInstanceCreation(instance, name=None):
45 def logInstanceCreation(instance, name=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))
56 def string_to_classes(s):
58 c = tracked_classes.keys()
62 return string.split(s)
64 def fetchLoggedInstances(classes="*"):
65 classnames = string_to_classes(classes)
66 return map(lambda cn: (cn, len(tracked_classes[cn])), classnames)
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])))
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]:
78 file.write(' %s\n' % repr(obj))
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]:
86 file.write(' %s:\n' % obj)
87 for key, value in obj.__dict__.items():
88 file.write(' %20s : %s\n' % (key, value))
92 if sys.platform[:5] == "linux":
93 # Linux doesn't actually support memory usage stats from getrusage().
95 mstr = open('/proc/self/stat').read()
96 mstr = string.split(mstr)[22]
110 process_handle = win32api.GetCurrentProcess()
111 memory_info = win32process.GetProcessMemoryInfo( process_handle )
112 return memory_info['PeakWorkingSetSize']
115 res = resource.getrusage(resource.RUSAGE_SELF)
118 # returns caller's stack
119 def caller_stack(*backlist):
124 for back in backlist:
125 tb = traceback.extract_stack(limit=3+back)
127 result.append('%s:%d(%s)' % func_shorten(key))
133 # trace a caller's stack
134 def caller_trace(back=0):
136 tb = traceback.extract_stack(limit=3+back)
139 caller_bases[callee] = caller_bases.get(callee, 0) + 1
140 for caller in tb[2:]:
141 caller = callee + caller[:3]
143 entry = caller_dicts[callee]
145 caller_dicts[callee] = entry = {}
146 entry[caller] = entry.get(caller, 0) + 1
149 # print a single caller and its callers, if any
150 def _dump_one_caller(key, file, level=0):
152 for c,v in caller_dicts[key].items():
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)
161 # print each call tree
162 def dump_caller_counts(file=sys.stdout):
163 keys = caller_bases.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)
171 ( '/scons/SCons/', 1),
172 ( '/src/engine/SCons/', 1),
173 ( '/usr/lib/python', 0),
178 return (string.replace(t[0], '/', os.sep), t[1])
179 shorten_list = map(platformize, shorten_list)
182 def func_shorten(func_tuple):
184 for t in shorten_list:
185 i = string.find(f, t[0])
189 return (f[i:],)+func_tuple[1:]
194 if sys.platform == 'win32':
197 TraceDefault = '/dev/tty'
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()."""
211 fp = TraceFP[file] = open(file, mode)
213 # Assume we were passed an open file pointer.