1# Copyright (C) 2011 Google Inc. All rights reserved. 2# 3# Redistribution and use in source and binary forms, with or without 4# modification, are permitted provided that the following conditions are 5# met: 6# 7# * Redistributions of source code must retain the above copyright 8# notice, this list of conditions and the following disclaimer. 9# * Redistributions in binary form must reproduce the above 10# copyright notice, this list of conditions and the following disclaimer 11# in the documentation and/or other materials provided with the 12# distribution. 13# * Neither the name of Google Inc. nor the names of its 14# contributors may be used to endorse or promote products derived from 15# this software without specific prior written permission. 16# 17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29"""Simple routines for logging, obtaining thread stack information.""" 30 31import sys 32import traceback 33 34 35def log_thread_state(logger, name, thread_id, msg=''): 36 """Log information about the given thread state.""" 37 stack = _find_thread_stack(thread_id) 38 assert(stack is not None) 39 logger("") 40 logger("%s (tid %d) %s" % (name, thread_id, msg)) 41 _log_stack(logger, stack) 42 logger("") 43 44 45def _find_thread_stack(thread_id): 46 """Returns a stack object that can be used to dump a stack trace for 47 the given thread id (or None if the id is not found).""" 48 for tid, stack in sys._current_frames().items(): 49 if tid == thread_id: 50 return stack 51 return None 52 53 54def _log_stack(logger, stack): 55 """Log a stack trace to the logger callback.""" 56 for filename, lineno, name, line in traceback.extract_stack(stack): 57 logger('File: "%s", line %d, in %s' % (filename, lineno, name)) 58 if line: 59 logger(' %s' % line.strip()) 60 61 62def log_traceback(logger, tb): 63 stack = traceback.extract_tb(tb) 64 for frame_str in traceback.format_list(stack): 65 for line in frame_str.split('\n'): 66 if line: 67 logger(" %s" % line) 68