* hpux-core.c (thread_section_p): New function.
[external/binutils.git] / bfd / hpux-core.c
1 /* BFD back-end for HP/UX core files.
2    Copyright 1993, 1994, 1996, 1998, 1999, 2001, 2002, 2003, 2004
3    Free Software Foundation, Inc.
4    Written by Stu Grossman, Cygnus Support.
5    Converted to back-end form by Ian Lance Taylor, Cygnus SUpport
6
7 This file is part of BFD, the Binary File Descriptor library.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
22
23 /* This file can only be compiled on systems which use HP/UX style
24    core files.  */
25
26 #include "bfd.h"
27 #include "sysdep.h"
28 #include "libbfd.h"
29
30 #if defined (HOST_HPPAHPUX) || defined (HOST_HP300HPUX) || defined (HOST_HPPAMPEIX)
31
32 /* FIXME: sys/core.h doesn't exist for HPUX version 7.  HPUX version
33    5, 6, and 7 core files seem to be standard trad-core.c type core
34    files; can we just use trad-core.c in addition to this file?  */
35
36 #include <sys/core.h>
37 #include <sys/utsname.h>
38
39 #endif /* HOST_HPPAHPUX */
40
41 #ifdef HOST_HPPABSD
42
43 /* Not a very swift place to put it, but that's where the BSD port
44    puts them.  */
45 #include "/hpux/usr/include/sys/core.h"
46
47 #endif /* HOST_HPPABSD */
48
49 #include <sys/param.h>
50 #ifdef HAVE_DIRENT_H
51 # include <dirent.h>
52 #else
53 # ifdef HAVE_SYS_NDIR_H
54 #  include <sys/ndir.h>
55 # endif
56 # ifdef HAVE_SYS_DIR_H
57 #  include <sys/dir.h>
58 # endif
59 # ifdef HAVE_NDIR_H
60 #  include <ndir.h>
61 # endif
62 #endif
63 #include <signal.h>
64 #include <machine/reg.h>
65 #include <sys/user.h>           /* After a.out.h  */
66 #include <sys/file.h>
67
68 /* Kludge: There's no explicit mechanism provided by sys/core.h to
69    conditionally know whether a proc_info has thread id fields.
70    However, CORE_ANON_SHMEM shows up first at 10.30, which is
71    happily also when meaningful thread id's show up in proc_info. */
72 #if defined(CORE_ANON_SHMEM)
73 #define PROC_INFO_HAS_THREAD_ID (1)
74 #endif
75
76 /* This type appears at HP-UX 10.30.  Defining it if not defined
77    by sys/core.h allows us to build for older HP-UX's, and (since
78    it won't be encountered in core-dumps from older HP-UX's) is
79    harmless. */
80 #if !defined(CORE_ANON_SHMEM)
81 #define CORE_ANON_SHMEM 0x00000200         /* anonymous shared memory */
82 #endif
83
84 /* These are stored in the bfd's tdata */
85
86 /* .lwpid and .user_tid are only valid if PROC_INFO_HAS_THREAD_ID, else they
87    are set to 0.  Also, until HP-UX implements MxN threads, .user_tid and
88    .lwpid are synonymous. */
89 struct hpux_core_struct
90 {
91   int sig;
92   int lwpid;               /* Kernel thread ID. */
93   unsigned long user_tid;  /* User thread ID. */
94   char cmd[MAXCOMLEN + 1];
95 };
96
97 #define core_hdr(bfd) ((bfd)->tdata.hpux_core_data)
98 #define core_signal(bfd) (core_hdr(bfd)->sig)
99 #define core_command(bfd) (core_hdr(bfd)->cmd)
100 #define core_kernel_thread_id(bfd) (core_hdr(bfd)->lwpid)
101 #define core_user_thread_id(bfd) (core_hdr(bfd)->user_tid)
102
103 static asection *make_bfd_asection
104   PARAMS ((bfd *, const char *, flagword, bfd_size_type, bfd_vma,
105            unsigned int));
106 static const bfd_target *hpux_core_core_file_p
107   PARAMS ((bfd *));
108 static char *hpux_core_core_file_failing_command
109   PARAMS ((bfd *));
110 static int hpux_core_core_file_failing_signal
111   PARAMS ((bfd *));
112 static bfd_boolean hpux_core_core_file_matches_executable_p
113   PARAMS ((bfd *, bfd *));
114 static void swap_abort
115   PARAMS ((void));
116
117 static asection *
118 make_bfd_asection (abfd, name, flags, size, vma, alignment_power)
119      bfd *abfd;
120      const char *name;
121      flagword flags;
122      bfd_size_type size;
123      bfd_vma vma;
124      unsigned int alignment_power;
125 {
126   asection *asect;
127   char *newname;
128
129   newname = bfd_alloc (abfd, (bfd_size_type) strlen (name) + 1);
130   if (!newname)
131     return NULL;
132
133   strcpy (newname, name);
134
135   asect = bfd_make_section_anyway (abfd, newname);
136   if (!asect)
137     return NULL;
138
139   asect->flags = flags;
140   asect->size = size;
141   asect->vma = vma;
142   asect->filepos = bfd_tell (abfd);
143   asect->alignment_power = alignment_power;
144
145   return asect;
146 }
147
148 /* Return true if the given core file section corresponds to a thread,
149    based on its name.  */
150
151 static int
152 thread_section_p (bfd *abfd ATTRIBUTE_UNUSED,
153                   asection *sect,
154                   void *obj ATTRIBUTE_UNUSED)
155 {
156   return (strncmp (bfd_section_name (abfd, sect), ".reg/", 5) == 0);
157 }
158
159 /* this function builds a bfd target if the file is a corefile.
160    It returns null or 0 if it finds out thaat it is not a core file.
161    The way it checks this is by looking for allowed 'type' field values.
162    These are declared in sys/core.h
163    There are some values which are 'reserved for future use'. In particular
164    CORE_NONE is actually defined as 0. This may be a catch-all for cases
165    in which the core file is generated by some non-hpux application.
166    (I am just guessing here!)
167 */
168 static const bfd_target *
169 hpux_core_core_file_p (abfd)
170      bfd *abfd;
171 {
172   int  good_sections = 0;
173   int  unknown_sections = 0;
174
175   core_hdr (abfd) = (struct hpux_core_struct *)
176     bfd_zalloc (abfd, (bfd_size_type) sizeof (struct hpux_core_struct));
177   if (!core_hdr (abfd))
178     return NULL;
179
180   while (1)
181     {
182       int val;
183       struct corehead core_header;
184
185       val = bfd_bread ((void *) &core_header,
186                       (bfd_size_type) sizeof core_header, abfd);
187       if (val <= 0)
188         break;
189       switch (core_header.type)
190         {
191         case CORE_KERNEL:
192         case CORE_FORMAT:
193           /* Just skip this.  */
194           bfd_seek (abfd, (file_ptr) core_header.len, SEEK_CUR);
195           good_sections++;
196           break;
197         case CORE_EXEC:
198           {
199             struct proc_exec proc_exec;
200             if (bfd_bread ((void *) &proc_exec, (bfd_size_type) core_header.len,
201                           abfd) != core_header.len)
202               break;
203             strncpy (core_command (abfd), proc_exec.cmd, MAXCOMLEN + 1);
204             good_sections++;
205           }
206           break;
207         case CORE_PROC:
208           {
209             struct proc_info proc_info;
210             char  secname[100];  /* Of arbitrary size, but plenty large. */
211
212             /* We need to read this section, 'cause we need to determine
213                whether the core-dumped app was threaded before we create
214                any .reg sections. */
215             if (bfd_bread (&proc_info, (bfd_size_type) core_header.len, abfd)
216                 != core_header.len)
217               break;
218
219               /* However, we also want to create those sections with the
220                  file positioned at the start of the record, it seems. */
221             if (bfd_seek (abfd, -((file_ptr) core_header.len), SEEK_CUR) != 0)
222               break;
223
224 #if defined(PROC_INFO_HAS_THREAD_ID)
225             core_kernel_thread_id (abfd) = proc_info.lwpid;
226             core_user_thread_id (abfd) = proc_info.user_tid;
227 #else
228             core_kernel_thread_id (abfd) = 0;
229             core_user_thread_id (abfd) = 0;
230 #endif
231             /* If the program was unthreaded, then we'll just create a
232                .reg section.
233
234                If the program was threaded, then we'll create .reg/XXXXX
235                section for each thread, where XXXXX is a printable
236                representation of the kernel thread id.  We'll also
237                create a .reg section for the thread that was running
238                and signalled at the time of the core-dump (i.e., this
239                is effectively an alias, needed to keep GDB happy.)
240
241                Note that we use `.reg/XXXXX' as opposed to '.regXXXXX'
242                because GDB expects that .reg2 will be the floating-
243                point registers. */
244             if (core_kernel_thread_id (abfd) == 0)
245               {
246                 if (!make_bfd_asection (abfd, ".reg",
247                                         SEC_HAS_CONTENTS,
248                                         core_header.len,
249                                         (int) &proc_info - (int) & proc_info.hw_regs,
250                                         2))
251                   goto fail;
252               }
253             else
254               {
255                 /* There are threads.  Is this the one that caused the
256                    core-dump?  We'll claim it was the running thread. */
257                 if (proc_info.sig != -1)
258                   {
259                     if (!make_bfd_asection (abfd, ".reg",
260                                             SEC_HAS_CONTENTS,
261                                             core_header.len,
262                                             (int) &proc_info - (int) & proc_info.hw_regs,
263                                             2))
264                       goto fail;
265                   }
266                 /* We always make one of these sections, for every thread. */
267                 sprintf (secname, ".reg/%d", core_kernel_thread_id (abfd));
268                 if (!make_bfd_asection (abfd, secname,
269                                         SEC_HAS_CONTENTS,
270                                         core_header.len,
271                                         (int) &proc_info - (int) & proc_info.hw_regs,
272                                         2))
273                   goto fail;
274               }
275             core_signal (abfd) = proc_info.sig;
276             if (bfd_seek (abfd, (file_ptr) core_header.len, SEEK_CUR) != 0)
277               break;
278             good_sections++;
279           }
280           break;
281
282         case CORE_DATA:
283         case CORE_STACK:
284         case CORE_TEXT:
285         case CORE_MMF:
286         case CORE_SHM:
287         case CORE_ANON_SHMEM:
288           if (!make_bfd_asection (abfd, ".data",
289                                   SEC_ALLOC + SEC_LOAD + SEC_HAS_CONTENTS,
290                                   core_header.len,
291                                   (bfd_vma) core_header.addr, 2))
292             goto fail;
293
294           bfd_seek (abfd, (file_ptr) core_header.len, SEEK_CUR);
295           good_sections++;
296           break;
297
298         case CORE_NONE:
299           /* Let's not punt if we encounter a section of unknown
300              type.  Rather, let's make a note of it.  If we later
301              see that there were also "good" sections, then we'll
302              declare that this a core file, but we'll also warn that
303              it may be incompatible with this gdb.
304              */
305           unknown_sections++;
306           break;
307
308          default:
309            goto fail; /*unrecognized core file type */
310         }
311     }
312
313   /* OK, we believe you.  You're a core file (sure, sure).  */
314
315   /* On HP/UX, we sometimes encounter core files where none of the threads
316      was found to be the running thread (ie the signal was set to -1 for
317      all threads).  This happens when the program was aborted externally
318      via a TT_CORE ttrace system call.  In that case, we just pick one
319      thread at random to be the active thread.  */
320   if (core_kernel_thread_id (abfd) != 0
321       && bfd_get_section_by_name (abfd, ".reg") == NULL)
322     {
323       asection *asect = bfd_sections_find_if (abfd, thread_section_p, NULL);
324       asection *reg_sect;
325
326       if (asect != NULL)
327         {
328           reg_sect = make_bfd_asection (abfd, ".reg", asect->flags,
329                                         asect->size, asect->vma,
330                                         asect->alignment_power);
331           if (reg_sect == NULL)
332             goto fail;
333
334           reg_sect->filepos = asect->filepos;
335         }
336     }
337
338   /* Were there sections of unknown type?  If so, yet there were
339      at least some complete sections of known type, then, issue
340      a warning.  Possibly the core file was generated on a version
341      of HP-UX that is incompatible with that for which this gdb was
342      built.
343      */
344   if ((unknown_sections > 0) && (good_sections > 0))
345     (*_bfd_error_handler)
346       ("%s appears to be a core file,\nbut contains unknown sections.  It may have been created on an incompatible\nversion of HP-UX.  As a result, some information may be unavailable.\n",
347        abfd->filename);
348
349   return abfd->xvec;
350
351  fail:
352   bfd_release (abfd, core_hdr (abfd));
353   core_hdr (abfd) = NULL;
354   bfd_section_list_clear (abfd);
355   return NULL;
356 }
357
358 static char *
359 hpux_core_core_file_failing_command (abfd)
360      bfd *abfd;
361 {
362   return core_command (abfd);
363 }
364
365 static int
366 hpux_core_core_file_failing_signal (abfd)
367      bfd *abfd;
368 {
369   return core_signal (abfd);
370 }
371
372 static bfd_boolean
373 hpux_core_core_file_matches_executable_p (core_bfd, exec_bfd)
374      bfd *core_bfd ATTRIBUTE_UNUSED;
375      bfd *exec_bfd ATTRIBUTE_UNUSED;
376 {
377   return TRUE;                  /* FIXME, We have no way of telling at this point */
378 }
379 \f
380 /* If somebody calls any byte-swapping routines, shoot them.  */
381 static void
382 swap_abort ()
383 {
384   abort(); /* This way doesn't require any declaration for ANSI to fuck up */
385 }
386
387 #define NO_GET ((bfd_vma (*) (const void *)) swap_abort)
388 #define NO_PUT ((void (*) (bfd_vma, void *)) swap_abort)
389 #define NO_GETS ((bfd_signed_vma (*) (const void *)) swap_abort)
390 #define NO_GET64 ((bfd_uint64_t (*) (const void *)) swap_abort)
391 #define NO_PUT64 ((void (*) (bfd_uint64_t, void *)) swap_abort)
392 #define NO_GETS64 ((bfd_int64_t (*) (const void *)) swap_abort)
393
394 const bfd_target hpux_core_vec =
395   {
396     "hpux-core",
397     bfd_target_unknown_flavour,
398     BFD_ENDIAN_BIG,             /* target byte order */
399     BFD_ENDIAN_BIG,             /* target headers byte order */
400     (HAS_RELOC | EXEC_P |       /* object flags */
401      HAS_LINENO | HAS_DEBUG |
402      HAS_SYMS | HAS_LOCALS | WP_TEXT | D_PAGED),
403     (SEC_HAS_CONTENTS | SEC_ALLOC | SEC_LOAD | SEC_RELOC), /* section flags */
404     0,                                                     /* symbol prefix */
405     ' ',                                                   /* ar_pad_char */
406     16,                                                    /* ar_max_namelen */
407     NO_GET64, NO_GETS64, NO_PUT64,      /* 64 bit data */
408     NO_GET, NO_GETS, NO_PUT,            /* 32 bit data */
409     NO_GET, NO_GETS, NO_PUT,            /* 16 bit data */
410     NO_GET64, NO_GETS64, NO_PUT64,      /* 64 bit hdrs */
411     NO_GET, NO_GETS, NO_PUT,            /* 32 bit hdrs */
412     NO_GET, NO_GETS, NO_PUT,            /* 16 bit hdrs */
413
414     {                           /* bfd_check_format */
415       _bfd_dummy_target,                /* unknown format */
416       _bfd_dummy_target,                /* object file */
417       _bfd_dummy_target,                /* archive */
418       hpux_core_core_file_p             /* a core file */
419     },
420     {                           /* bfd_set_format */
421       bfd_false, bfd_false,
422       bfd_false, bfd_false
423     },
424     {                           /* bfd_write_contents */
425       bfd_false, bfd_false,
426       bfd_false, bfd_false
427     },
428
429     BFD_JUMP_TABLE_GENERIC (_bfd_generic),
430     BFD_JUMP_TABLE_COPY (_bfd_generic),
431     BFD_JUMP_TABLE_CORE (hpux_core),
432     BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
433     BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols),
434     BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
435     BFD_JUMP_TABLE_WRITE (_bfd_generic),
436     BFD_JUMP_TABLE_LINK (_bfd_nolink),
437     BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
438
439     NULL,
440
441     (PTR) 0                     /* backend_data */
442   };