binutils-gdb/gdb/gcore.in
Sergio Durigan Junior 129eb0f1f1 Improve gcore manpage and clarify "-o" option
Ref.: https://bugs.debian.org/904628

It has been reported that gcore's manpage is a bit imprecise when it
comes to two things:

- It doesn't explicity say that the command accepts more than one PID
  on its CLI.

- It fails to mention that the argument passed through the "-o" option
  is actually a prefix that will be used to compose the corefile's
  filename, and not the actual filename.

I decided to give it a try and rewrite parts of the text to further
clarify these two points.  I ended up rewording the "Description"
section because, IMHO, it was a bit confuse to understand.

To make things consistent, I've also renamed the "$name" variable in
the gcore.in script, and expanded the usage text.

gdb/doc/ChangeLog:
2018-07-27  Sergio Durigan Junior  <sergiodj@redhat.com>

	* gdb.texinfo (gcore man): Rewrite "Description" and "-o"
	option sections to further clarify that gcore can take more
	than one PID, and that "-o" is used to specify a prefix, not a
	filename.

gdb/ChangeLog:
2018-07-27  Sergio Durigan Junior  <sergiodj@redhat.com>

	* gcore.in: Rename variable "name" to "prefix".  Expand
	"usage" text.
2018-07-27 15:56:54 -04:00

117 lines
3.5 KiB
Bash

#!/usr/bin/env bash
# Copyright (C) 2003-2018 Free Software Foundation, Inc.
# 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 3 of the License, 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, see <http://www.gnu.org/licenses/>.
#
# Script to generate a core file of a running program.
# It starts up gdb, attaches to the given PID and invokes the gcore command.
#
# Need to check for -o option, but set default basename to "core".
prefix=core
# When the -a option is present, this may hold additional commands
# to ensure gdb dumps all mappings (OS dependent).
dump_all_cmds=()
while getopts :ao: opt; do
case "$opt" in
a)
case "$OSTYPE" in
linux*)
dump_all_cmds=("-ex" "set use-coredump-filter off")
dump_all_cmds+=("-ex" "set dump-excluded-mappings on")
;;
esac
;;
o)
prefix=$OPTARG
;;
*)
echo "usage: @GCORE_TRANSFORM_NAME@ [-a] [-o prefix] pid1 [pid2...pidN]"
exit 2
;;
esac
done
shift $((OPTIND-1))
if [ "$#" -eq "0" ]
then
echo "usage: @GCORE_TRANSFORM_NAME@ [-a] [-o prefix] pid1 [pid2...pidN]"
exit 2
fi
# Attempt to fetch the absolute path to the gcore script that was
# called.
binary_path=`dirname "$0"`
if test "x$binary_path" = x. ; then
# We got "." back as a path. This means the user executed
# the gcore script locally (i.e. ./gcore) or called the
# script via a shell interpreter (i.e. sh gcore).
binary_basename=`basename "$0"`
# If the gcore script was called like "sh gcore" and the script
# lives in the current directory, "which" will not give us "gcore".
# So first we check if the script is in the current directory
# before using the output of "which".
if test -f "$binary_basename" ; then
# We have a local gcore script in ".". This covers the case of
# doing "./gcore" or "sh gcore".
binary_path="."
else
# The gcore script was not found in ".", which means the script
# was called from somewhere else in $PATH by "sh gcore".
# Extract the correct path now.
binary_path_from_env=`which "$0"`
binary_path=`dirname "$binary_path_from_env"`
fi
fi
# Check if the GDB binary is in the expected path. If not, just
# quit with a message.
if [ ! -f "$binary_path/@GDB_TRANSFORM_NAME@" ]; then
echo "gcore: GDB binary (${binary_path}/@GDB_TRANSFORM_NAME@) not found"
exit 1
fi
# Initialise return code.
rc=0
# Loop through pids
for pid in "$@"
do
# `</dev/null' to avoid touching interactive terminal if it is
# available but not accessible as GDB would get stopped on SIGTTIN.
"$binary_path/@GDB_TRANSFORM_NAME@" </dev/null --nx --batch \
-ex "set pagination off" -ex "set height 0" -ex "set width 0" \
"${dump_all_cmds[@]}" \
-ex "attach $pid" -ex "gcore $prefix.$pid" -ex detach -ex quit
if [ -r "$prefix.$pid" ] ; then
rc=0
else
echo "@GCORE_TRANSFORM_NAME@: failed to create $prefix.$pid"
rc=1
break
fi
done
exit $rc