unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* emacs-buffer.gdb
@ 2005-05-02  5:20 Noah Friedman
  2005-05-03 17:12 ` emacs-buffer.gdb Richard Stallman
  0 siblings, 1 reply; 9+ messages in thread
From: Noah Friedman @ 2005-05-02  5:20 UTC (permalink / raw)


[-- Attachment #1: message body text --]
[-- Type: text/plain, Size: 42 bytes --]

I thought others might find this useful.


[-- Attachment #2: emacs debuggery macros --]
[-- Type: text/plain, Size: 7237 bytes --]

# emacs-buffer.gdb --- gdb macros for recovering buffers from emacs coredumps

# Copyright (C) 1992, 93, 94, 95, 96, 97, 1998, 2000, 01, 2004
#   Free Software Foundation, Inc.
# Copyright (C) 2005 Noah S. Friedman

# Maintainer: Noah Friedman <friedman@splode.com>
# Status: tested with Emacs 22.
# Created: 2005-04-28

# $Id: emacs-buffer.gdb,v 1.1 2005/05/02 05:15:49 friedman Exp $

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, you can either send email to this
# program's maintainer or write to: The Free Software Foundation,
# Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA.

# 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.
#
# The Emacs executable must have debugging symbols for this to work.  But
# you never strip Emacs, right?  Right!
#
# The main commands of interest are `ybuffer-list' and `ysave-buffer'.  The
# `y' prefix avoids any namespace collisions with emacs/src/.gdbinit.

# Example usage:
#
#     $ gdb /usr/bin/emacs core
#     Current directory is /u/noah/
#     GNU gdb Red Hat Linux (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
#     Buffer#   Size  Name
#       0        556  mail to emacs-devel@gnu.org
#       1          0   *Minibuf-1*
#       2          0  *mail*
#       3          0  *scratch*
#       4          0   *Minibuf-0*
#       5       3244  *Messages*
#       6         27   *Echo Area 0*
#       7          4   *Echo Area 1*
#       8          8   *code-conversion-work*
#       9       3158  *Completions*
#      10     318080   *bbdb data*
#      11         39   *canonical address*
#      12         39   *extract address components*
#     (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  1 22:05 mail.save
#     $

# Code:

# Force loading of symbols, enough to give us gdb_valbits etc.
set main

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

define yinit
  set $tagmask = (((long)1 << gdb_gctypebits) - 1)
  set $valmask = gdb_use_lsb ? ~($tagmask) : ((long)1 << gdb_valbits) - 1
end

define ygetptr
  set $ptr = $arg0
  set $ptr = (gdb_use_union ? $ptr.u.val : $ptr & $valmask) | gdb_data_seg_bits
end

define ygettype
  set $type = $arg0
  set $type = gdb_use_union \
              ? $type.s.type \
              : (enum Lisp_Type) (gdb_use_lsb \
                                  ? $type & $tagmask \
                                  : $type >> gdb_valbits)
end

define ybuffer-list
  if $yverbose
    printf "Buffer#   Size  Name\n"
  end

  set $i = 0
  set $alist = Vbuffer_alist
  while $alist != Qnil
    ygetptr $alist
    set $this  = ((struct Lisp_Cons *) $ptr)->car
    set $alist = ((struct Lisp_Cons *) $ptr)->cdr

    # pair of the form (name . buffer)
    ygetptr $this
    set $name = ((struct Lisp_Cons *) $ptr)->car
    set $buf  = ((struct Lisp_Cons *) $ptr)->cdr

    ygetptr $name
    set $name = ((struct Lisp_String *) $ptr)->data

    ygetptr $buf
    set $buf = ((struct buffer *) $ptr)->text
    set $bufsize = $buf->z_byte - 1

    printf "%3d  %9d  %s\n", $i, $bufsize, $name
    set $i++
  end
end
document ybuffer-list
  Display a list of buffer names and sizes.
  The buffer number in the first column is used as an argument
  to some other emacs-buffer recovery commands, e.g. `ysave-buffer'.
end

define yset-buffer
  set $i = $arg0

  set $alist = Vbuffer_alist
  while ($alist != Qnil && $i > 0)
    ygetptr $alist
    set $alist = ((struct Lisp_Cons *) $ptr)->cdr
    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
  set $this = ((struct Lisp_Cons *) $ptr)->cdr

  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
  buffer as displayed by `ybuffer-list'.
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)

  #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
  as displayed by `ybuffer-list'.

  This also sets the current buffer using `yset-buffer' (which see).
end

define yget-current-buffer-name
  set $this = $ycurrent_buffer->name
  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
      dump   binary memory $arg1 $beg $gap-1
      append binary memory $arg1 $gap_end $end
      set $endptr = $end
    end
  end
end
document ydump-buffer
  Write contents of buffer N (as numbered according to `ybuffer-list') to
  file FILE.

  This is mainly used as an internal subroutine for `ysave-buffer' and
  `ybuffer-contents', which see.
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
  Save contents of buffer N (as numbered according to `ybuffer-list') to
  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
  Write contents of buffer N (numbered according to `ybuffer-list') to stdout.
end

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

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-05-02  5:20 emacs-buffer.gdb Noah Friedman
@ 2005-05-03 17:12 ` Richard Stallman
  0 siblings, 0 replies; 9+ messages in thread
From: Richard Stallman @ 2005-05-03 17:12 UTC (permalink / raw)
  Cc: emacs-devel

This sounds very useful.  Can you contribute this to the Emacs
distribution?

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
@ 2005-06-09  4:15 Ed Swarthout
  2005-06-09  9:10 ` emacs-buffer.gdb Andreas Schwab
  0 siblings, 1 reply; 9+ messages in thread
From: Ed Swarthout @ 2005-06-09  4:15 UTC (permalink / raw)


Even though I haven't needed it, thats an impressive gdb macro!

I'm seeing a problem with Qnil filename though:

(gdb) ybuffer-list
B# M       Size Name                 Mode       File
-- -       ---- ----                 ----       ----
 0        68954 python.el            Emacs-Lisp
/nfs/packages/packages/emacs/emacs/lisp/progmodes/python.el
 1        10317 progmodes            Dired by dateCannot access memory
at address 0x20

which is fixed by this simple patch:

--- emacs-buffer.gdb.~1.3.~	2005-05-30 12:01:09.000000000 -0500
+++ emacs-buffer.gdb	2005-06-08 22:08:03.645246008 -0500
@@ -118,7 +118,7 @@
         ygetptr $buf->filename
         set $filename = ((struct Lisp_String *) $ptr)->data
       else
-        set $filename = ' '
+        set $filename = " "
       end
 
       printf "%2d %c  %9d %-20s %-10s %s\n", \

- Ed Swarthout
- Austin, TX

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-09  4:15 emacs-buffer.gdb Ed Swarthout
@ 2005-06-09  9:10 ` Andreas Schwab
  2005-06-10  2:17   ` emacs-buffer.gdb Ed Swarthout
  0 siblings, 1 reply; 9+ messages in thread
From: Andreas Schwab @ 2005-06-09  9:10 UTC (permalink / raw)
  Cc: emacs-devel

Ed Swarthout <ed.swarthout@gmail.com> writes:

> which is fixed by this simple patch:
>
> --- emacs-buffer.gdb.~1.3.~	2005-05-30 12:01:09.000000000 -0500
> +++ emacs-buffer.gdb	2005-06-08 22:08:03.645246008 -0500
> @@ -118,7 +118,7 @@
>          ygetptr $buf->filename
>          set $filename = ((struct Lisp_String *) $ptr)->data
>        else
> -        set $filename = ' '
> +        set $filename = " "

This is dangerous because gdb needs to call malloc in the inferior in
order to allocate the string.

Andreas.

-- 
Andreas Schwab, SuSE Labs, schwab@suse.de
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-09  9:10 ` emacs-buffer.gdb Andreas Schwab
@ 2005-06-10  2:17   ` Ed Swarthout
  2005-06-10 20:48     ` emacs-buffer.gdb Juri Linkov
  0 siblings, 1 reply; 9+ messages in thread
From: Ed Swarthout @ 2005-06-10  2:17 UTC (permalink / raw)
  Cc: emacs-devel

On 6/9/05, Andreas Schwab <schwab@suse.de> wrote:
> > -        set $filename = ' '
> > +        set $filename = " "
> 
> This is dangerous because gdb needs to call malloc in the inferior in
> order to allocate the string.

Thank you.  In fact, had I tested it with a core file, I'd have gotten:
  "You can't do that without a process to debug."

Here's a better fix.

-Ed Swarthout

--- emacs-buffer.gdb    30 May 2005 17:01:09 -0000      1.3
+++ emacs-buffer.gdb    10 Jun 2005 02:05:38 -0000
@@ -117,12 +117,13 @@
       if $buf->filename != Qnil
         ygetptr $buf->filename
         set $filename = ((struct Lisp_String *) $ptr)->data
+        printf "%2d %c  %9d %-20s %-10s %s\n", \
+             $i, $modp, ($buf->text->z_byte - 1), $name, $mode, $filename
       else
-        set $filename = ' '
+        printf "%2d %c  %9d %-20s %-10ss\n", \
+             $i, $modp, ($buf->text->z_byte - 1), $name, $mode
       end

-      printf "%2d %c  %9d %-20s %-10s %s\n", \
-             $i, $modp, ($buf->text->z_byte - 1), $name, $mode, $filename
     end

     set $i++

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-10  2:17   ` emacs-buffer.gdb Ed Swarthout
@ 2005-06-10 20:48     ` Juri Linkov
  2005-06-10 22:44       ` emacs-buffer.gdb Noah Friedman
  0 siblings, 1 reply; 9+ messages in thread
From: Juri Linkov @ 2005-06-10 20:48 UTC (permalink / raw)
  Cc: schwab, emacs-devel, friedman

> +        printf "%2d %c  %9d %-20s %-10ss\n", \
                                          =
This looks like a tyop.

BTW, emacs-buffer.gdb deserves mentioning in etc/NEWS (and maybe in
etc/DEBUG as well), and a better location for this file is
src/emacs-buffer.gdb (where other gdb files are located) instead of
etc/emacs-buffer.gdb.

-- 
Juri Linkov
http://www.jurta.org/emacs/

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-10 20:48     ` emacs-buffer.gdb Juri Linkov
@ 2005-06-10 22:44       ` Noah Friedman
  2005-06-11 13:03         ` emacs-buffer.gdb Eli Zaretskii
  2005-06-11 23:38         ` emacs-buffer.gdb Kim F. Storm
  0 siblings, 2 replies; 9+ messages in thread
From: Noah Friedman @ 2005-06-10 22:44 UTC (permalink / raw)
  Cc: ed.swarthout, emacs-devel

>> +        printf "%2d %c  %9d %-20s %-10ss\n", \
>                                          =
>This looks like a tyop.
>
>BTW, emacs-buffer.gdb deserves mentioning in etc/NEWS (and maybe in
>etc/DEBUG as well), and a better location for this file is
>src/emacs-buffer.gdb (where other gdb files are located) instead of
>etc/emacs-buffer.gdb.

Ed: Thanks for finding that.  I checked in a fix.

Juri: I'm indifferent about where it goes, but rms thought etc was a
reasonable place for it.  It's documented in etc/NEWS already and in
man/trouble.texi.  I suppose it could be mentioned in etc/DEBUG also, but
that file describes much lower-level detail.  emacs-buffer.gdb is really
just a lazy-man's graverobbing tool; hopefully little to no knowledge of
emacs internals should be necessary to use it.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-10 22:44       ` emacs-buffer.gdb Noah Friedman
@ 2005-06-11 13:03         ` Eli Zaretskii
  2005-06-11 23:38         ` emacs-buffer.gdb Kim F. Storm
  1 sibling, 0 replies; 9+ messages in thread
From: Eli Zaretskii @ 2005-06-11 13:03 UTC (permalink / raw)
  Cc: juri, ed.swarthout, emacs-devel

> From: Noah Friedman <friedman@splode.com>
> Date: Fri, 10 Jun 2005 15:44:44 -0700 (PDT)
> Cc: ed.swarthout@gmail.com, emacs-devel@gnu.org
> 
> Juri: I'm indifferent about where it goes, but rms thought etc was a
> reasonable place for it.  It's documented in etc/NEWS already and in
> man/trouble.texi.  I suppose it could be mentioned in etc/DEBUG also, but
> that file describes much lower-level detail.

I added a short notice of this file to etc/DEBUG.

Thanks.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: emacs-buffer.gdb
  2005-06-10 22:44       ` emacs-buffer.gdb Noah Friedman
  2005-06-11 13:03         ` emacs-buffer.gdb Eli Zaretskii
@ 2005-06-11 23:38         ` Kim F. Storm
  1 sibling, 0 replies; 9+ messages in thread
From: Kim F. Storm @ 2005-06-11 23:38 UTC (permalink / raw)
  Cc: juri, ed.swarthout, emacs-devel

Noah Friedman <friedman@splode.com> writes:

> Juri: I'm indifferent about where it goes, but rms thought etc was a
> reasonable place for it.  It's documented in etc/NEWS already and in
> man/trouble.texi.  I suppose it could be mentioned in etc/DEBUG also, but
> that file describes much lower-level detail.  emacs-buffer.gdb is really
> just a lazy-man's graverobbing tool; hopefully little to no knowledge of
> emacs internals should be necessary to use it.

Maybe you could add a simple command to src/.gdbinit to load the file.

-- 
Kim F. Storm <storm@cua.dk> http://www.cua.dk

^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2005-06-11 23:38 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2005-05-02  5:20 emacs-buffer.gdb Noah Friedman
2005-05-03 17:12 ` emacs-buffer.gdb Richard Stallman
  -- strict thread matches above, loose matches on Subject: below --
2005-06-09  4:15 emacs-buffer.gdb Ed Swarthout
2005-06-09  9:10 ` emacs-buffer.gdb Andreas Schwab
2005-06-10  2:17   ` emacs-buffer.gdb Ed Swarthout
2005-06-10 20:48     ` emacs-buffer.gdb Juri Linkov
2005-06-10 22:44       ` emacs-buffer.gdb Noah Friedman
2005-06-11 13:03         ` emacs-buffer.gdb Eli Zaretskii
2005-06-11 23:38         ` emacs-buffer.gdb Kim F. Storm

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).