emacs-buffer.gdb 8.15 KB
Newer Older
Noah Friedman's avatar
Noah Friedman committed
1 2
# emacs-buffer.gdb --- gdb macros for recovering buffers from emacs coredumps

Paul Eggert's avatar
Paul Eggert committed
3
# Copyright (C) 2005-2016 Free Software Foundation, Inc.
Noah Friedman's avatar
Noah Friedman committed
4 5 6 7 8

# Maintainer: Noah Friedman <friedman@splode.com>
# Created: 2005-04-28

# This file is part of GNU Emacs.
9 10

# GNU Emacs is free software: you can redistribute it and/or modify
Noah Friedman's avatar
Noah Friedman committed
11
# it under the terms of the GNU General Public License as published by
12 13 14
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

Noah Friedman's avatar
Noah Friedman committed
15 16 17 18
# GNU Emacs is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
19

Noah Friedman's avatar
Noah Friedman committed
20
# You should have received a copy of the GNU General Public License
21
# along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Noah Friedman's avatar
Noah Friedman committed
22 23 24 25 26 27 28

# Commentary:

# This is a set of gdb macros for recovering the contents of buffers from
# an Emacs coredump; they may not always be file-backed or have a recent
# autosave.
#
29 30
# The Emacs executable must have debugging symbols for this to work.
# But you never strip Emacs, right?
Noah Friedman's avatar
Noah Friedman committed
31
#
32 33
# The main commands of interest are 'ybuffer-list', 'yfile-buffers',
# 'ysave-buffer', and 'ybuffer-contents'.  The 'y' prefix avoids any
Noah Friedman's avatar
Noah Friedman committed
34 35
# namespace collisions with emacs/src/.gdbinit.

36
# Since the internal data structures in Emacs change from time to
37 38 39
# time, you should use the version of this file that came with your
# particular Emacs version; older versions might not work anymore.

Noah Friedman's avatar
Noah Friedman committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
# Example usage:
#
#     $ gdb /export/src/emacs/2005-05-02--03-17/src/emacs core.emacs.6.9845
#     Current directory is /u/noah/
#     GNU gdb (6.1post-1.20040607.43rh)
#     ...
#     #0  0x400007a2 in _dl_sysinfo_int80 () from /lib/ld-linux.so.2
#     (gdb) source emacs-buffer.gdb
#     (gdb) ybuffer-list
#     B# M       Size Name                 Mode       File
#     -- -       ---- ----                 ----       ----
#      0 *        556 mail to emacs-devel@gnu.org Mail
#      1 *          0  *Minibuf-1*         Fundamental
#      2       145769 ChangeLog            Change Log /u/noah/lib/elisp/noahf/ChangeLog
#      3         6619 ascii-table.el       Elisp      /u/noah/lib/elisp/noahf/ascii-table.el
#      4 *      48396 *Messages*           Fundamental
#      5         3191 *Apropos*            Apropos
#      6        17642 init-21.el           Elisp      /u/noah/etc/init/emacs/init-21.el
#      7          333 cpuid.c              C          /u/noah/cpuid.c
#      8          230 src                  Dired
#      9          218 noah                 Dired
#     10 *         21  *Echo Area 0*       Fundamental
#     11 *          0  *Echo Area 1*       Fundamental
#     12       319952  *bbdb data*         Text       /u/noah/.bbdb
#     (gdb) ysave-buffer 0 mail.save
#     [Wrote buffer "mail to emacs-devel@gnu.org" to file mail.save]
#     (gdb) quit
#     $ ls -l mail.save
#     -rw-rw-rw-  1 noah user 556 May  2 04:05 mail.save
#     $

# Code:

73
# Force loading of symbols, enough to give us VALMASK etc.
Noah Friedman's avatar
Noah Friedman committed
74 75 76 77 78 79 80 81
set main

# When nonzero, display some extra diagnostics in various commands
set $yverbose = 1
set $yfile_buffers_only = 0

define ygetptr
  set $ptr = $arg0
Paul Eggert's avatar
Paul Eggert committed
82
  set $ptr = (CHECK_LISP_OBJECT_TYPE ? $ptr.i : $ptr) & VALMASK
Noah Friedman's avatar
Noah Friedman committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
end

define ybuffer-list
  set $files_only         = $yfile_buffers_only
  set $yfile_buffers_only = 0

  if $yverbose
    printf "B# M       Size Name                 Mode       File\n"
    printf "-- -       ---- ----                 ----       ----\n"
  end

  set $i = 0
  set $alist = Vbuffer_alist
  while $alist != Qnil
    ygetptr $alist
    set $this  = ((struct Lisp_Cons *) $ptr)->car
99
    set $alist = ((struct Lisp_Cons *) $ptr)->u.cdr
Noah Friedman's avatar
Noah Friedman committed
100 101 102

    # Vbuffer_alist elts are pairs of the form (name . buffer)
    ygetptr $this
103
    set $buf  = ((struct Lisp_Cons *) $ptr)->u.cdr
Noah Friedman's avatar
Noah Friedman committed
104 105 106
    ygetptr $buf
    set $buf = (struct buffer *) $ptr

107 108
    if ! ($files_only && $buf->filename_ == Qnil)
      ygetptr $buf->name_
Noah Friedman's avatar
Noah Friedman committed
109 110 111
      set $name = ((struct Lisp_String *) $ptr)->data
      set $modp = ($buf->text->modiff > $buf->text->save_modiff) ? '*' : ' '

112
      ygetptr $buf->mode_name_
Noah Friedman's avatar
Noah Friedman committed
113 114
      set $mode = ((struct Lisp_String *) $ptr)->data

115 116
      if $buf->filename_ != Qnil
        ygetptr $buf->filename_
117 118 119
        printf "%2d %c  %9d %-20s %-10s %s\n", \
               $i, $modp, ($buf->text->z_byte - 1), $name, $mode, \
               ((struct Lisp_String *) $ptr)->data
Noah Friedman's avatar
Noah Friedman committed
120
      else
121 122
        printf "%2d %c  %9d %-20s %-10s\n", \
               $i, $modp, ($buf->text->z_byte - 1), $name, $mode
Noah Friedman's avatar
Noah Friedman committed
123 124 125 126 127 128 129 130 131
      end
    end

    set $i++
  end
end
document ybuffer-list
  Display a list of buffer names, sizes, and other attributes.
  The buffer number in the first column is used as an argument
132
  to some other emacs-buffer recovery commands, e.g. 'ysave-buffer'.
Noah Friedman's avatar
Noah Friedman committed
133 134 135 136 137 138 139 140
end

define yfile-buffers
  set $yfile_buffers_only = 1
  ybuffer-list
end
document yfile-buffers
  Display a list of buffers which are associated with files.
141
  This is like 'ybuffer-list', but only buffers that were visiting files
Noah Friedman's avatar
Noah Friedman committed
142 143 144 145 146 147 148 149 150
  are displayed.
end

define yset-buffer
  set $i = $arg0

  set $alist = Vbuffer_alist
  while ($alist != Qnil && $i > 0)
    ygetptr $alist
151
    set $alist = ((struct Lisp_Cons *) $ptr)->u.cdr
Noah Friedman's avatar
Noah Friedman committed
152 153 154 155 156 157 158 159 160
    set $i--
  end

  # Get car of alist; this is a pair (name . buffer)
  ygetptr $alist
  set $this = ((struct Lisp_Cons *) $ptr)->car

  # Get the buffer object
  ygetptr $this
161
  set $this = ((struct Lisp_Cons *) $ptr)->u.cdr
Noah Friedman's avatar
Noah Friedman committed
162 163 164 165 166 167

  ygetptr $this
  set $ycurrent_buffer = (struct buffer *) $ptr
end
document yset-buffer
  Set current buffer (for other emacs-buffer recovery commands) to the ARG'th
168
  buffer as displayed by 'ybuffer-list'.
Noah Friedman's avatar
Noah Friedman committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
end

define yget-buffer-pointers
  yset-buffer $arg0
  set $buf = $ycurrent_buffer->text

  set $beg     = $buf->beg
  set $gap     = $beg + $buf->gpt_byte
  set $gap_end = $gap + $buf->gap_size - 1
  set $end     = $gap_end + ($buf->z_byte - $buf->gpt_byte)

  set $modp    = $buf->modiff > $buf->save_modiff

  #print *$beg@($gap - $beg)
  #print *$gap_end@($end - $gap_end)
end
document yget-buffer-pointers
  Update convenience variables with address pointers for the ARG'th buffer
187
  as displayed by 'ybuffer-list'.
Noah Friedman's avatar
Noah Friedman committed
188

189
  This also sets the current buffer using 'yset-buffer' (which see).
Noah Friedman's avatar
Noah Friedman committed
190 191 192
end

define yget-current-buffer-name
193
  set $this = $ycurrent_buffer->name_
Noah Friedman's avatar
Noah Friedman committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  ygetptr $this
  set $ycurrent_buffer_name = ((struct Lisp_String *) $ptr)->data
end
document yget-current-buffer-name
  Set $ycurrent_buffer_name to the name of the currently selected buffer.
end

define ycurrent-buffer
  yget-current-buffer-name
  printf "%s\n", $ycurrent_buffer_name
end
document ycurrent-buffer
  Display the currently selected buffer.
end

define ydump-buffer
  yget-buffer-pointers $arg0
  if $buf->z_byte > 1
    if $buf->z_byte <= $buf->gpt_byte
      set $endptr = $beg + $buf->gpt_byte - 1
      dump binary memory $arg1 $beg $endptr
    else
216 217 218 219 220 221
      if $gap - $beg > 1
        dump   binary memory $arg1 $beg $gap-1
        append binary memory $arg1 $gap_end $end
      else
        dump   binary memory $arg1 $gap_end $end
      end
Noah Friedman's avatar
Noah Friedman committed
222 223 224 225 226
      set $endptr = $end
    end
  end
end
document ydump-buffer
227
  Write contents of buffer N (as numbered according to 'ybuffer-list') to
Noah Friedman's avatar
Noah Friedman committed
228 229
  file FILE.

230 231
  This is mainly used as an internal subroutine for 'ysave-buffer' and
  'ybuffer-contents', which see.
Noah Friedman's avatar
Noah Friedman committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
end

define ysave-buffer
  ydump-buffer $arg0 $arg1
  if $yverbose
    yget-current-buffer-name
    if $buf->z_byte <= 1
      printf "[Buffer \"%s\" is empty.]\n", $ycurrent_buffer_name
    else
      # Output string broken into separate calls as necessary to avoid
      # requiring a running process for evaluation.
      printf "[Wrote buffer \"%s\" to file ", $ycurrent_buffer_name
      echo $arg1]\n
    end
  end
end
document ysave-buffer
249
  Save contents of buffer N (as numbered according to 'ybuffer-list') to
Noah Friedman's avatar
Noah Friedman committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  file FILE.
end

define ybuffer-contents
  ydump-buffer $arg0 /dev/stdout
  if $yverbose && $buf->z_byte <= 1
    yget-current-buffer-name
    printf "[Buffer \"%s\" is empty.]\n", $ycurrent_buffer_name
  else
    if *($endptr-1) != '\n'
      echo \n
    end
  end
end
document ybuffer-contents
265
  Write contents of buffer N (numbered according to 'ybuffer-list') to stdout.
Noah Friedman's avatar
Noah Friedman committed
266 267 268 269 270
end

# local variables:
# mode: gdb-script
# end: