1
 
# Copyright (C) 2006, 2007, 2009 Canonical Ltd
 
3
 
# This program is free software; you can redistribute it and/or modify
 
4
 
# it under the terms of the GNU General Public License as published by
 
5
 
# the Free Software Foundation; either version 2 of the License, or
 
6
 
# (at your option) any later version.
 
8
 
# This program is distributed in the hope that it will be useful,
 
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 
# GNU General Public License for more details.
 
13
 
# You should have received a copy of the GNU General Public License
 
14
 
# along with this program; if not, write to the Free Software
 
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
21
 
_breakin_signal_number = None
 
22
 
_breakin_signal_name = None
 
25
 
def _debug(signal_number, interrupted_frame):
 
28
 
    sys.stderr.write("** %s received, entering debugger\n"
 
29
 
            "** Type 'c' to continue or 'q' to stop the process\n"
 
30
 
            "** Or %s again to quit (and possibly dump core)\n"
 
31
 
            % (_breakin_signal_name, _breakin_signal_name))
 
32
 
    # It seems that on Windows, when sys.stderr is to a PIPE, then we need to
 
33
 
    # flush. Not sure why it is buffered, but that seems to be the case.
 
35
 
    # restore default meaning so that you can kill the process by hitting it
 
37
 
    signal.signal(_breakin_signal_number, signal.SIG_DFL)
 
41
 
        signal.signal(_breakin_signal_number, _debug)
 
45
 
    # We import this late because breakin.py is loaded as part of the main
 
46
 
    # 'bzr' script, so we want it to load as little as possible until things
 
48
 
    from bzrlib import symbol_versioning, trace
 
49
 
    trace.mutter_callsite(2, 'Deprecated function called')
 
50
 
    symbol_versioning.warn(symbol_versioning.deprecation_string(
 
51
 
        hook_sigquit, symbol_versioning.deprecated_in((1, 18, 0))),
 
52
 
        DeprecationWarning, stacklevel=2)
 
54
 
    return hook_debugger_to_signal()
 
57
 
def determine_signal():
 
58
 
    global _breakin_signal_number
 
59
 
    global _breakin_signal_name
 
60
 
    if _breakin_signal_number is not None:
 
61
 
        return _breakin_signal_number
 
62
 
    # Note: As near as I can tell, Windows is the only one to define SIGBREAK,
 
63
 
    #       and other platforms defined SIGQUIT. There doesn't seem to be a
 
64
 
    #       platform that defines both.
 
66
 
    sigquit = getattr(signal, 'SIGQUIT', None)
 
67
 
    sigbreak = getattr(signal, 'SIGBREAK', None)
 
68
 
    if sigquit is not None:
 
69
 
        _breakin_signal_number = sigquit
 
70
 
        _breakin_signal_name = 'SIGQUIT'
 
71
 
    elif sigbreak is not None:
 
72
 
        _breakin_signal_number = sigbreak
 
73
 
        _breakin_signal_name = 'SIGBREAK'
 
75
 
    return _breakin_signal_number
 
78
 
def hook_debugger_to_signal():
 
79
 
    """Add a signal handler so we drop into the debugger.
 
81
 
    On Linux and Mac, this is hooked into SIGQUIT (C-\\) on Windows, this is
 
82
 
    hooked into SIGBREAK (C-Pause).
 
85
 
    # when sigquit (C-\) or sigbreak (C-Pause) is received go into pdb
 
86
 
    if os.environ.get('BZR_SIGQUIT_PDB', '1') == '0':
 
87
 
        # User explicitly requested we don't support this
 
89
 
    sig = determine_signal()
 
92
 
    # print 'hooking into %s' % (_breakin_signal_name,)
 
93
 
    signal.signal(sig, _debug)