| # Copyright (C) 2019 Apple Inc. All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions |
| # are met: |
| # 1. Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # 2. Redistributions in binary form must reproduce the above copyright |
| # notice, this list of conditions and the following disclaimer in the |
| # documentation and/or other materials provided with the distribution. |
| # |
| # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND |
| # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR |
| # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| import linecache |
| import logging |
| import os |
| import signal |
| import sys |
| |
| _log = logging.getLogger(__name__) |
| |
| |
| def log_stack_trace(frame, file): |
| file.write('Traceback(most recent call last):\n') |
| |
| def func(frame): |
| if not frame: |
| return |
| func(frame.f_back) |
| file.write(' File "{}", line {}, in {}\n'.format(frame.f_code.co_filename, frame.f_lineno, frame.f_code.co_name)) |
| file.write(' {}\n'.format(linecache.getline(frame.f_code.co_filename, frame.f_lineno).lstrip().rstrip())) |
| |
| func(frame) |
| |
| |
| class StackTraceFileContext(object): |
| def __init__(self, output_file=None): |
| self.file_name = None |
| if output_file: |
| self.file_name = os.path.join(os.path.dirname(output_file), '{}-{}'.format(os.getpid(), os.path.basename(output_file))) |
| self.file = sys.stderr |
| |
| def __enter__(self): |
| if self.file_name: |
| self.file = open(self.file_name, 'w') |
| _log.critical('Stack trace saved to {}'.format(self.file_name)) |
| else: |
| self.file.write('\n') |
| return self.file |
| |
| def __exit__(self, *args): |
| if self.file_name: |
| self.file.close() |
| self.file = sys.stderr |
| |
| |
| def log_stack_trace_on_signal(sigattr, output_file=None): |
| signum = getattr(signal, sigattr) |
| if not signum: |
| return None |
| |
| previous = signal.getsignal(signum) |
| |
| def handler(signum_, frame): |
| with StackTraceFileContext(output_file=output_file) as file: |
| file.write('{} signal received'.format(sigattr)) |
| log_stack_trace(frame, file) |
| |
| if previous in (None, getattr(signal, 'SIG_IGN')): |
| return |
| if previous == getattr(signal, 'SIG_DFL'): |
| if sigattr == 'SIGTERM': |
| sys.exit(-1) |
| if sigattr == 'SIGINT': |
| raise KeyboardInterrupt |
| return previous(signum_, frame) |
| |
| return signal.signal(signum, handler) |
