2012-01-20 Pedro Alves <palves@redhat.com>
[platform/upstream/binutils.git] / gdb / utils.c
1 /* General utility routines for GDB, the GNU debugger.
2
3    Copyright (C) 1986, 1988-2012 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "dyn-string.h"
22 #include "gdb_assert.h"
23 #include <ctype.h>
24 #include "gdb_string.h"
25 #include "gdb_wait.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
29 #ifdef HAVE_SYS_RESOURCE_H
30 #include <sys/resource.h>
31 #endif /* HAVE_SYS_RESOURCE_H */
32
33 #ifdef TUI
34 #include "tui/tui.h"            /* For tui_get_command_dimension.   */
35 #endif
36
37 #ifdef __GO32__
38 #include <pc.h>
39 #endif
40
41 /* SunOS's curses.h has a '#define reg register' in it.  Thank you Sun.  */
42 #ifdef reg
43 #undef reg
44 #endif
45
46 #include <signal.h>
47 #include "timeval-utils.h"
48 #include "gdbcmd.h"
49 #include "serial.h"
50 #include "bfd.h"
51 #include "target.h"
52 #include "gdb-demangle.h"
53 #include "expression.h"
54 #include "language.h"
55 #include "charset.h"
56 #include "annotate.h"
57 #include "filenames.h"
58 #include "symfile.h"
59 #include "gdb_obstack.h"
60 #include "gdbcore.h"
61 #include "top.h"
62 #include "main.h"
63 #include "solist.h"
64
65 #include "inferior.h"           /* for signed_pointer_to_address */
66
67 #include <sys/param.h>          /* For MAXPATHLEN */
68
69 #include "gdb_curses.h"
70
71 #include "readline/readline.h"
72
73 #include <sys/time.h>
74 #include <time.h>
75
76 #include "gdb_usleep.h"
77 #include "interps.h"
78 #include "gdb_regex.h"
79
80 #if !HAVE_DECL_MALLOC
81 extern PTR malloc ();           /* ARI: PTR */
82 #endif
83 #if !HAVE_DECL_REALLOC
84 extern PTR realloc ();          /* ARI: PTR */
85 #endif
86 #if !HAVE_DECL_FREE
87 extern void free ();
88 #endif
89
90 /* readline defines this.  */
91 #undef savestring
92
93 void (*deprecated_error_begin_hook) (void);
94
95 /* Prototypes for local functions */
96
97 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
98                                      va_list, int) ATTRIBUTE_PRINTF (2, 0);
99
100 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
101
102 static void do_my_cleanups (struct cleanup **, struct cleanup *);
103
104 static void prompt_for_continue (void);
105
106 static void set_screen_size (void);
107 static void set_width (void);
108
109 /* A flag indicating whether to timestamp debugging messages.  */
110
111 static int debug_timestamp = 0;
112
113 /* Chain of cleanup actions established with make_cleanup,
114    to be executed if an error happens.  */
115
116 static struct cleanup *cleanup_chain;   /* cleaned up after a failed command */
117 static struct cleanup *final_cleanup_chain;     /* cleaned up when gdb exits */
118
119 /* Nonzero if we have job control.  */
120
121 int job_control;
122
123 /* Nonzero means a quit has been requested.  */
124
125 int quit_flag;
126
127 /* Nonzero means quit immediately if Control-C is typed now, rather
128    than waiting until QUIT is executed.  Be careful in setting this;
129    code which executes with immediate_quit set has to be very careful
130    about being able to deal with being interrupted at any time.  It is
131    almost always better to use QUIT; the only exception I can think of
132    is being able to quit out of a system call (using EINTR loses if
133    the SIGINT happens between the previous QUIT and the system call).
134    To immediately quit in the case in which a SIGINT happens between
135    the previous QUIT and setting immediate_quit (desirable anytime we
136    expect to block), call QUIT after setting immediate_quit.  */
137
138 int immediate_quit;
139
140 /* Nonzero means that strings with character values >0x7F should be printed
141    as octal escapes.  Zero means just print the value (e.g. it's an
142    international character, and the terminal or window can cope.)  */
143
144 int sevenbit_strings = 0;
145 static void
146 show_sevenbit_strings (struct ui_file *file, int from_tty,
147                        struct cmd_list_element *c, const char *value)
148 {
149   fprintf_filtered (file, _("Printing of 8-bit characters "
150                             "in strings as \\nnn is %s.\n"),
151                     value);
152 }
153
154 /* String to be printed before error messages, if any.  */
155
156 char *error_pre_print;
157
158 /* String to be printed before quit messages, if any.  */
159
160 char *quit_pre_print;
161
162 /* String to be printed before warning messages, if any.  */
163
164 char *warning_pre_print = "\nwarning: ";
165
166 int pagination_enabled = 1;
167 static void
168 show_pagination_enabled (struct ui_file *file, int from_tty,
169                          struct cmd_list_element *c, const char *value)
170 {
171   fprintf_filtered (file, _("State of pagination is %s.\n"), value);
172 }
173
174 \f
175
176 /* Add a new cleanup to the cleanup_chain,
177    and return the previous chain pointer
178    to be passed later to do_cleanups or discard_cleanups.
179    Args are FUNCTION to clean up with, and ARG to pass to it.  */
180
181 struct cleanup *
182 make_cleanup (make_cleanup_ftype *function, void *arg)
183 {
184   return make_my_cleanup (&cleanup_chain, function, arg);
185 }
186
187 struct cleanup *
188 make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
189                    void (*dtor) (void *))
190 {
191   return make_my_cleanup2 (&cleanup_chain,
192                            function, arg, dtor);
193 }
194
195 struct cleanup *
196 make_final_cleanup (make_cleanup_ftype *function, void *arg)
197 {
198   return make_my_cleanup (&final_cleanup_chain, function, arg);
199 }
200
201 static void
202 do_freeargv (void *arg)
203 {
204   freeargv ((char **) arg);
205 }
206
207 struct cleanup *
208 make_cleanup_freeargv (char **arg)
209 {
210   return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
211 }
212
213 static void
214 do_dyn_string_delete (void *arg)
215 {
216   dyn_string_delete ((dyn_string_t) arg);
217 }
218
219 struct cleanup *
220 make_cleanup_dyn_string_delete (dyn_string_t arg)
221 {
222   return make_my_cleanup (&cleanup_chain, do_dyn_string_delete, arg);
223 }
224
225 static void
226 do_bfd_close_cleanup (void *arg)
227 {
228   bfd_close (arg);
229 }
230
231 struct cleanup *
232 make_cleanup_bfd_close (bfd *abfd)
233 {
234   return make_cleanup (do_bfd_close_cleanup, abfd);
235 }
236
237 static void
238 do_close_cleanup (void *arg)
239 {
240   int *fd = arg;
241
242   close (*fd);
243 }
244
245 struct cleanup *
246 make_cleanup_close (int fd)
247 {
248   int *saved_fd = xmalloc (sizeof (fd));
249
250   *saved_fd = fd;
251   return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
252 }
253
254 /* Helper function which does the work for make_cleanup_fclose.  */
255
256 static void
257 do_fclose_cleanup (void *arg)
258 {
259   FILE *file = arg;
260
261   fclose (file);
262 }
263
264 /* Return a new cleanup that closes FILE.  */
265
266 struct cleanup *
267 make_cleanup_fclose (FILE *file)
268 {
269   return make_cleanup (do_fclose_cleanup, file);
270 }
271
272 /* Helper function which does the work for make_cleanup_obstack_free.  */
273
274 static void
275 do_obstack_free (void *arg)
276 {
277   struct obstack *ob = arg;
278
279   obstack_free (ob, NULL);
280 }
281
282 /* Return a new cleanup that frees OBSTACK.  */
283
284 struct cleanup *
285 make_cleanup_obstack_free (struct obstack *obstack)
286 {
287   return make_cleanup (do_obstack_free, obstack);
288 }
289
290 static void
291 do_ui_file_delete (void *arg)
292 {
293   ui_file_delete (arg);
294 }
295
296 struct cleanup *
297 make_cleanup_ui_file_delete (struct ui_file *arg)
298 {
299   return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
300 }
301
302 /* Helper function for make_cleanup_ui_out_redirect_pop.  */
303
304 static void
305 do_ui_out_redirect_pop (void *arg)
306 {
307   struct ui_out *uiout = arg;
308
309   if (ui_out_redirect (uiout, NULL) < 0)
310     warning (_("Cannot restore redirection of the current output protocol"));
311 }
312
313 /* Return a new cleanup that pops the last redirection by ui_out_redirect
314    with NULL parameter.  */
315
316 struct cleanup *
317 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
318 {
319   return make_my_cleanup (&cleanup_chain, do_ui_out_redirect_pop, uiout);
320 }
321
322 static void
323 do_free_section_addr_info (void *arg)
324 {
325   free_section_addr_info (arg);
326 }
327
328 struct cleanup *
329 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
330 {
331   return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
332 }
333
334 struct restore_integer_closure
335 {
336   int *variable;
337   int value;
338 };
339
340 static void
341 restore_integer (void *p)
342 {
343   struct restore_integer_closure *closure = p;
344
345   *(closure->variable) = closure->value;
346 }
347
348 /* Remember the current value of *VARIABLE and make it restored when
349    the cleanup is run.  */
350
351 struct cleanup *
352 make_cleanup_restore_integer (int *variable)
353 {
354   struct restore_integer_closure *c =
355     xmalloc (sizeof (struct restore_integer_closure));
356
357   c->variable = variable;
358   c->value = *variable;
359
360   return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
361                            xfree);
362 }
363
364 /* Remember the current value of *VARIABLE and make it restored when
365    the cleanup is run.  */
366
367 struct cleanup *
368 make_cleanup_restore_uinteger (unsigned int *variable)
369 {
370   return make_cleanup_restore_integer ((int *) variable);
371 }
372
373 /* Helper for make_cleanup_unpush_target.  */
374
375 static void
376 do_unpush_target (void *arg)
377 {
378   struct target_ops *ops = arg;
379
380   unpush_target (ops);
381 }
382
383 /* Return a new cleanup that unpushes OPS.  */
384
385 struct cleanup *
386 make_cleanup_unpush_target (struct target_ops *ops)
387 {
388   return make_my_cleanup (&cleanup_chain, do_unpush_target, ops);
389 }
390
391 /* Helper for make_cleanup_htab_delete compile time checking the types.  */
392
393 static void
394 do_htab_delete_cleanup (void *htab_voidp)
395 {
396   htab_t htab = htab_voidp;
397
398   htab_delete (htab);
399 }
400
401 /* Return a new cleanup that deletes HTAB.  */
402
403 struct cleanup *
404 make_cleanup_htab_delete (htab_t htab)
405 {
406   return make_cleanup (do_htab_delete_cleanup, htab);
407 }
408
409 struct restore_ui_file_closure
410 {
411   struct ui_file **variable;
412   struct ui_file *value;
413 };
414
415 static void
416 do_restore_ui_file (void *p)
417 {
418   struct restore_ui_file_closure *closure = p;
419
420   *(closure->variable) = closure->value;
421 }
422
423 /* Remember the current value of *VARIABLE and make it restored when
424    the cleanup is run.  */
425
426 struct cleanup *
427 make_cleanup_restore_ui_file (struct ui_file **variable)
428 {
429   struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
430
431   c->variable = variable;
432   c->value = *variable;
433
434   return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
435 }
436
437 /* Helper for make_cleanup_value_free_to_mark.  */
438
439 static void
440 do_value_free_to_mark (void *value)
441 {
442   value_free_to_mark ((struct value *) value);
443 }
444
445 /* Free all values allocated since MARK was obtained by value_mark
446    (except for those released) when the cleanup is run.  */
447
448 struct cleanup *
449 make_cleanup_value_free_to_mark (struct value *mark)
450 {
451   return make_my_cleanup (&cleanup_chain, do_value_free_to_mark, mark);
452 }
453
454 /* Helper for make_cleanup_value_free.  */
455
456 static void
457 do_value_free (void *value)
458 {
459   value_free (value);
460 }
461
462 /* Free VALUE.  */
463
464 struct cleanup *
465 make_cleanup_value_free (struct value *value)
466 {
467   return make_my_cleanup (&cleanup_chain, do_value_free, value);
468 }
469
470 /* Helper for make_cleanup_free_so.  */
471
472 static void
473 do_free_so (void *arg)
474 {
475   struct so_list *so = arg;
476
477   free_so (so);
478 }
479
480 /* Make cleanup handler calling free_so for SO.  */
481
482 struct cleanup *
483 make_cleanup_free_so (struct so_list *so)
484 {
485   return make_my_cleanup (&cleanup_chain, do_free_so, so);
486 }
487
488 struct cleanup *
489 make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
490                   void *arg,  void (*free_arg) (void *))
491 {
492   struct cleanup *new
493     = (struct cleanup *) xmalloc (sizeof (struct cleanup));
494   struct cleanup *old_chain = *pmy_chain;
495
496   new->next = *pmy_chain;
497   new->function = function;
498   new->free_arg = free_arg;
499   new->arg = arg;
500   *pmy_chain = new;
501
502   return old_chain;
503 }
504
505 struct cleanup *
506 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
507                  void *arg)
508 {
509   return make_my_cleanup2 (pmy_chain, function, arg, NULL);
510 }
511
512 /* Discard cleanups and do the actions they describe
513    until we get back to the point OLD_CHAIN in the cleanup_chain.  */
514
515 void
516 do_cleanups (struct cleanup *old_chain)
517 {
518   do_my_cleanups (&cleanup_chain, old_chain);
519 }
520
521 void
522 do_final_cleanups (struct cleanup *old_chain)
523 {
524   do_my_cleanups (&final_cleanup_chain, old_chain);
525 }
526
527 static void
528 do_my_cleanups (struct cleanup **pmy_chain,
529                 struct cleanup *old_chain)
530 {
531   struct cleanup *ptr;
532
533   while ((ptr = *pmy_chain) != old_chain)
534     {
535       *pmy_chain = ptr->next;   /* Do this first in case of recursion.  */
536       (*ptr->function) (ptr->arg);
537       if (ptr->free_arg)
538         (*ptr->free_arg) (ptr->arg);
539       xfree (ptr);
540     }
541 }
542
543 /* Discard cleanups, not doing the actions they describe,
544    until we get back to the point OLD_CHAIN in the cleanup_chain.  */
545
546 void
547 discard_cleanups (struct cleanup *old_chain)
548 {
549   discard_my_cleanups (&cleanup_chain, old_chain);
550 }
551
552 void
553 discard_final_cleanups (struct cleanup *old_chain)
554 {
555   discard_my_cleanups (&final_cleanup_chain, old_chain);
556 }
557
558 void
559 discard_my_cleanups (struct cleanup **pmy_chain,
560                      struct cleanup *old_chain)
561 {
562   struct cleanup *ptr;
563
564   while ((ptr = *pmy_chain) != old_chain)
565     {
566       *pmy_chain = ptr->next;
567       if (ptr->free_arg)
568         (*ptr->free_arg) (ptr->arg);
569       xfree (ptr);
570     }
571 }
572
573 /* Set the cleanup_chain to 0, and return the old cleanup chain.  */
574 struct cleanup *
575 save_cleanups (void)
576 {
577   return save_my_cleanups (&cleanup_chain);
578 }
579
580 struct cleanup *
581 save_final_cleanups (void)
582 {
583   return save_my_cleanups (&final_cleanup_chain);
584 }
585
586 struct cleanup *
587 save_my_cleanups (struct cleanup **pmy_chain)
588 {
589   struct cleanup *old_chain = *pmy_chain;
590
591   *pmy_chain = 0;
592   return old_chain;
593 }
594
595 /* Restore the cleanup chain from a previously saved chain.  */
596 void
597 restore_cleanups (struct cleanup *chain)
598 {
599   restore_my_cleanups (&cleanup_chain, chain);
600 }
601
602 void
603 restore_final_cleanups (struct cleanup *chain)
604 {
605   restore_my_cleanups (&final_cleanup_chain, chain);
606 }
607
608 void
609 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
610 {
611   *pmy_chain = chain;
612 }
613
614 /* This function is useful for cleanups.
615    Do
616
617    foo = xmalloc (...);
618    old_chain = make_cleanup (free_current_contents, &foo);
619
620    to arrange to free the object thus allocated.  */
621
622 void
623 free_current_contents (void *ptr)
624 {
625   void **location = ptr;
626
627   if (location == NULL)
628     internal_error (__FILE__, __LINE__,
629                     _("free_current_contents: NULL pointer"));
630   if (*location != NULL)
631     {
632       xfree (*location);
633       *location = NULL;
634     }
635 }
636
637 /* Provide a known function that does nothing, to use as a base for
638    a possibly long chain of cleanups.  This is useful where we
639    use the cleanup chain for handling normal cleanups as well as dealing
640    with cleanups that need to be done as a result of a call to error().
641    In such cases, we may not be certain where the first cleanup is, unless
642    we have a do-nothing one to always use as the base.  */
643
644 void
645 null_cleanup (void *arg)
646 {
647 }
648
649 /* If nonzero, display time usage both at startup and for each command.  */
650
651 static int display_time;
652
653 /* If nonzero, display space usage both at startup and for each command.  */
654
655 static int display_space;
656
657 /* Records a run time and space usage to be used as a base for
658    reporting elapsed time or change in space.  In addition,
659    the msg_type field indicates whether the saved time is from the
660    beginning of GDB execution (0) or the beginning of an individual 
661    command execution (1).  */
662 struct cmd_stats 
663 {
664   int msg_type;
665   long start_cpu_time;
666   struct timeval start_wall_time;
667   long start_space;
668 };
669
670 /* Set whether to display time statistics to NEW_VALUE (non-zero 
671    means true).  */
672 void
673 set_display_time (int new_value)
674 {
675   display_time = new_value;
676 }
677
678 /* Set whether to display space statistics to NEW_VALUE (non-zero
679    means true).  */
680 void
681 set_display_space (int new_value)
682 {
683   display_space = new_value;
684 }
685
686 /* As indicated by display_time and display_space, report GDB's elapsed time
687    and space usage from the base time and space provided in ARG, which
688    must be a pointer to a struct cmd_stat.  This function is intended
689    to be called as a cleanup.  */
690 static void
691 report_command_stats (void *arg)
692 {
693   struct cmd_stats *start_stats = (struct cmd_stats *) arg;
694   int msg_type = start_stats->msg_type;
695
696   if (display_time)
697     {
698       long cmd_time = get_run_time () - start_stats->start_cpu_time;
699       struct timeval now_wall_time, delta_wall_time;
700
701       gettimeofday (&now_wall_time, NULL);
702       timeval_sub (&delta_wall_time,
703                    &now_wall_time, &start_stats->start_wall_time);
704
705       printf_unfiltered (msg_type == 0
706                          ? _("Startup time: %ld.%06ld (cpu), %ld.%06ld (wall)\n")
707                          : _("Command execution time: %ld.%06ld (cpu), %ld.%06ld (wall)\n"),
708                          cmd_time / 1000000, cmd_time % 1000000,
709                          (long) delta_wall_time.tv_sec,
710                          (long) delta_wall_time.tv_usec);
711     }
712
713   if (display_space)
714     {
715 #ifdef HAVE_SBRK
716       char *lim = (char *) sbrk (0);
717
718       long space_now = lim - lim_at_start;
719       long space_diff = space_now - start_stats->start_space;
720
721       printf_unfiltered (msg_type == 0
722                          ? _("Space used: %ld (%s%ld during startup)\n")
723                          : _("Space used: %ld (%s%ld for this command)\n"),
724                          space_now,
725                          (space_diff >= 0 ? "+" : ""),
726                          space_diff);
727 #endif
728     }
729 }
730
731 /* Create a cleanup that reports time and space used since its
732    creation.  Precise messages depend on MSG_TYPE:
733       0:  Initial time/space
734       1:  Individual command time/space.  */
735 struct cleanup *
736 make_command_stats_cleanup (int msg_type)
737 {
738   struct cmd_stats *new_stat = XMALLOC (struct cmd_stats);
739   
740 #ifdef HAVE_SBRK
741   char *lim = (char *) sbrk (0);
742   new_stat->start_space = lim - lim_at_start;
743 #endif
744
745   new_stat->msg_type = msg_type;
746   new_stat->start_cpu_time = get_run_time ();
747   gettimeofday (&new_stat->start_wall_time, NULL);
748
749   return make_cleanup_dtor (report_command_stats, new_stat, xfree);
750 }
751 \f
752
753
754 /* Print a warning message.  The first argument STRING is the warning
755    message, used as an fprintf format string, the second is the
756    va_list of arguments for that string.  A warning is unfiltered (not
757    paginated) so that the user does not need to page through each
758    screen full of warnings when there are lots of them.  */
759
760 void
761 vwarning (const char *string, va_list args)
762 {
763   if (deprecated_warning_hook)
764     (*deprecated_warning_hook) (string, args);
765   else
766     {
767       target_terminal_ours ();
768       wrap_here ("");           /* Force out any buffered output.  */
769       gdb_flush (gdb_stdout);
770       if (warning_pre_print)
771         fputs_unfiltered (warning_pre_print, gdb_stderr);
772       vfprintf_unfiltered (gdb_stderr, string, args);
773       fprintf_unfiltered (gdb_stderr, "\n");
774       va_end (args);
775     }
776 }
777
778 /* Print a warning message.
779    The first argument STRING is the warning message, used as a fprintf string,
780    and the remaining args are passed as arguments to it.
781    The primary difference between warnings and errors is that a warning
782    does not force the return to command level.  */
783
784 void
785 warning (const char *string, ...)
786 {
787   va_list args;
788
789   va_start (args, string);
790   vwarning (string, args);
791   va_end (args);
792 }
793
794 /* Print an error message and return to command level.
795    The first argument STRING is the error message, used as a fprintf string,
796    and the remaining args are passed as arguments to it.  */
797
798 void
799 verror (const char *string, va_list args)
800 {
801   throw_verror (GENERIC_ERROR, string, args);
802 }
803
804 void
805 error (const char *string, ...)
806 {
807   va_list args;
808
809   va_start (args, string);
810   throw_verror (GENERIC_ERROR, string, args);
811   va_end (args);
812 }
813
814 /* Print an error message and quit.
815    The first argument STRING is the error message, used as a fprintf string,
816    and the remaining args are passed as arguments to it.  */
817
818 void
819 vfatal (const char *string, va_list args)
820 {
821   throw_vfatal (string, args);
822 }
823
824 void
825 fatal (const char *string, ...)
826 {
827   va_list args;
828
829   va_start (args, string);
830   throw_vfatal (string, args);
831   va_end (args);
832 }
833
834 void
835 error_stream (struct ui_file *stream)
836 {
837   char *message = ui_file_xstrdup (stream, NULL);
838
839   make_cleanup (xfree, message);
840   error (("%s"), message);
841 }
842
843 /* Dump core trying to increase the core soft limit to hard limit first.  */
844
845 static void
846 dump_core (void)
847 {
848 #ifdef HAVE_SETRLIMIT
849   struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
850
851   setrlimit (RLIMIT_CORE, &rlim);
852 #endif /* HAVE_SETRLIMIT */
853
854   abort ();             /* NOTE: GDB has only three calls to abort().  */
855 }
856
857 /* Check whether GDB will be able to dump core using the dump_core
858    function.  */
859
860 static int
861 can_dump_core (const char *reason)
862 {
863 #ifdef HAVE_GETRLIMIT
864   struct rlimit rlim;
865
866   /* Be quiet and assume we can dump if an error is returned.  */
867   if (getrlimit (RLIMIT_CORE, &rlim) != 0)
868     return 1;
869
870   if (rlim.rlim_max == 0)
871     {
872       fprintf_unfiltered (gdb_stderr,
873                           _("%s\nUnable to dump core, use `ulimit -c"
874                             " unlimited' before executing GDB next time.\n"),
875                           reason);
876       return 0;
877     }
878 #endif /* HAVE_GETRLIMIT */
879
880   return 1;
881 }
882
883 /* Allow the user to configure the debugger behavior with respect to
884    what to do when an internal problem is detected.  */
885
886 const char internal_problem_ask[] = "ask";
887 const char internal_problem_yes[] = "yes";
888 const char internal_problem_no[] = "no";
889 static const char *internal_problem_modes[] =
890 {
891   internal_problem_ask,
892   internal_problem_yes,
893   internal_problem_no,
894   NULL
895 };
896
897 /* Print a message reporting an internal error/warning.  Ask the user
898    if they want to continue, dump core, or just exit.  Return
899    something to indicate a quit.  */
900
901 struct internal_problem
902 {
903   const char *name;
904   const char *should_quit;
905   const char *should_dump_core;
906 };
907
908 /* Report a problem, internal to GDB, to the user.  Once the problem
909    has been reported, and assuming GDB didn't quit, the caller can
910    either allow execution to resume or throw an error.  */
911
912 static void ATTRIBUTE_PRINTF (4, 0)
913 internal_vproblem (struct internal_problem *problem,
914                    const char *file, int line, const char *fmt, va_list ap)
915 {
916   static int dejavu;
917   int quit_p;
918   int dump_core_p;
919   char *reason;
920
921   /* Don't allow infinite error/warning recursion.  */
922   {
923     static char msg[] = "Recursive internal problem.\n";
924
925     switch (dejavu)
926       {
927       case 0:
928         dejavu = 1;
929         break;
930       case 1:
931         dejavu = 2;
932         fputs_unfiltered (msg, gdb_stderr);
933         abort ();       /* NOTE: GDB has only three calls to abort().  */
934       default:
935         dejavu = 3;
936         /* Newer GLIBC versions put the warn_unused_result attribute
937            on write, but this is one of those rare cases where
938            ignoring the return value is correct.  Casting to (void)
939            does not fix this problem.  This is the solution suggested
940            at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509.  */
941         if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
942           abort (); /* NOTE: GDB has only three calls to abort().  */
943         exit (1);
944       }
945   }
946
947   /* Try to get the message out and at the start of a new line.  */
948   target_terminal_ours ();
949   begin_line ();
950
951   /* Create a string containing the full error/warning message.  Need
952      to call query with this full string, as otherwize the reason
953      (error/warning) and question become separated.  Format using a
954      style similar to a compiler error message.  Include extra detail
955      so that the user knows that they are living on the edge.  */
956   {
957     char *msg;
958
959     msg = xstrvprintf (fmt, ap);
960     reason = xstrprintf ("%s:%d: %s: %s\n"
961                          "A problem internal to GDB has been detected,\n"
962                          "further debugging may prove unreliable.",
963                          file, line, problem->name, msg);
964     xfree (msg);
965     make_cleanup (xfree, reason);
966   }
967
968   if (problem->should_quit == internal_problem_ask)
969     {
970       /* Default (yes/batch case) is to quit GDB.  When in batch mode
971          this lessens the likelihood of GDB going into an infinite
972          loop.  */
973       if (caution == 0)
974         {
975           /* Emit the message and quit.  */
976           fputs_unfiltered (reason, gdb_stderr);
977           fputs_unfiltered ("\n", gdb_stderr);
978           quit_p = 1;
979         }
980       else
981         quit_p = query (_("%s\nQuit this debugging session? "), reason);
982     }
983   else if (problem->should_quit == internal_problem_yes)
984     quit_p = 1;
985   else if (problem->should_quit == internal_problem_no)
986     quit_p = 0;
987   else
988     internal_error (__FILE__, __LINE__, _("bad switch"));
989
990   if (problem->should_dump_core == internal_problem_ask)
991     {
992       if (!can_dump_core (reason))
993         dump_core_p = 0;
994       else
995         {
996           /* Default (yes/batch case) is to dump core.  This leaves a GDB
997              `dropping' so that it is easier to see that something went
998              wrong in GDB.  */
999           dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
1000         }
1001     }
1002   else if (problem->should_dump_core == internal_problem_yes)
1003     dump_core_p = can_dump_core (reason);
1004   else if (problem->should_dump_core == internal_problem_no)
1005     dump_core_p = 0;
1006   else
1007     internal_error (__FILE__, __LINE__, _("bad switch"));
1008
1009   if (quit_p)
1010     {
1011       if (dump_core_p)
1012         dump_core ();
1013       else
1014         exit (1);
1015     }
1016   else
1017     {
1018       if (dump_core_p)
1019         {
1020 #ifdef HAVE_WORKING_FORK
1021           if (fork () == 0)
1022             dump_core ();
1023 #endif
1024         }
1025     }
1026
1027   dejavu = 0;
1028 }
1029
1030 static struct internal_problem internal_error_problem = {
1031   "internal-error", internal_problem_ask, internal_problem_ask
1032 };
1033
1034 void
1035 internal_verror (const char *file, int line, const char *fmt, va_list ap)
1036 {
1037   internal_vproblem (&internal_error_problem, file, line, fmt, ap);
1038   deprecated_throw_reason (RETURN_ERROR);
1039 }
1040
1041 void
1042 internal_error (const char *file, int line, const char *string, ...)
1043 {
1044   va_list ap;
1045
1046   va_start (ap, string);
1047   internal_verror (file, line, string, ap);
1048   va_end (ap);
1049 }
1050
1051 static struct internal_problem internal_warning_problem = {
1052   "internal-warning", internal_problem_ask, internal_problem_ask
1053 };
1054
1055 void
1056 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1057 {
1058   internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1059 }
1060
1061 void
1062 internal_warning (const char *file, int line, const char *string, ...)
1063 {
1064   va_list ap;
1065
1066   va_start (ap, string);
1067   internal_vwarning (file, line, string, ap);
1068   va_end (ap);
1069 }
1070
1071 /* Dummy functions to keep add_prefix_cmd happy.  */
1072
1073 static void
1074 set_internal_problem_cmd (char *args, int from_tty)
1075 {
1076 }
1077
1078 static void
1079 show_internal_problem_cmd (char *args, int from_tty)
1080 {
1081 }
1082
1083 /* When GDB reports an internal problem (error or warning) it gives
1084    the user the opportunity to quit GDB and/or create a core file of
1085    the current debug session.  This function registers a few commands
1086    that make it possible to specify that GDB should always or never
1087    quit or create a core file, without asking.  The commands look
1088    like:
1089
1090    maint set PROBLEM-NAME quit ask|yes|no
1091    maint show PROBLEM-NAME quit
1092    maint set PROBLEM-NAME corefile ask|yes|no
1093    maint show PROBLEM-NAME corefile
1094
1095    Where PROBLEM-NAME is currently "internal-error" or
1096    "internal-warning".  */
1097
1098 static void
1099 add_internal_problem_command (struct internal_problem *problem)
1100 {
1101   struct cmd_list_element **set_cmd_list;
1102   struct cmd_list_element **show_cmd_list;
1103   char *set_doc;
1104   char *show_doc;
1105
1106   set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1107   show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1108   *set_cmd_list = NULL;
1109   *show_cmd_list = NULL;
1110
1111   set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1112                         problem->name);
1113
1114   show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1115                          problem->name);
1116
1117   add_prefix_cmd ((char*) problem->name,
1118                   class_maintenance, set_internal_problem_cmd, set_doc,
1119                   set_cmd_list,
1120                   concat ("maintenance set ", problem->name, " ",
1121                           (char *) NULL),
1122                   0/*allow-unknown*/, &maintenance_set_cmdlist);
1123
1124   add_prefix_cmd ((char*) problem->name,
1125                   class_maintenance, show_internal_problem_cmd, show_doc,
1126                   show_cmd_list,
1127                   concat ("maintenance show ", problem->name, " ",
1128                           (char *) NULL),
1129                   0/*allow-unknown*/, &maintenance_show_cmdlist);
1130
1131   set_doc = xstrprintf (_("Set whether GDB should quit "
1132                           "when an %s is detected"),
1133                         problem->name);
1134   show_doc = xstrprintf (_("Show whether GDB will quit "
1135                            "when an %s is detected"),
1136                          problem->name);
1137   add_setshow_enum_cmd ("quit", class_maintenance,
1138                         internal_problem_modes,
1139                         &problem->should_quit,
1140                         set_doc,
1141                         show_doc,
1142                         NULL, /* help_doc */
1143                         NULL, /* setfunc */
1144                         NULL, /* showfunc */
1145                         set_cmd_list,
1146                         show_cmd_list);
1147
1148   xfree (set_doc);
1149   xfree (show_doc);
1150
1151   set_doc = xstrprintf (_("Set whether GDB should create a core "
1152                           "file of GDB when %s is detected"),
1153                         problem->name);
1154   show_doc = xstrprintf (_("Show whether GDB will create a core "
1155                            "file of GDB when %s is detected"),
1156                          problem->name);
1157   add_setshow_enum_cmd ("corefile", class_maintenance,
1158                         internal_problem_modes,
1159                         &problem->should_dump_core,
1160                         set_doc,
1161                         show_doc,
1162                         NULL, /* help_doc */
1163                         NULL, /* setfunc */
1164                         NULL, /* showfunc */
1165                         set_cmd_list,
1166                         show_cmd_list);
1167
1168   xfree (set_doc);
1169   xfree (show_doc);
1170 }
1171
1172 /* Print the system error message for errno, and also mention STRING
1173    as the file name for which the error was encountered.
1174    Then return to command level.  */
1175
1176 void
1177 perror_with_name (const char *string)
1178 {
1179   char *err;
1180   char *combined;
1181
1182   err = safe_strerror (errno);
1183   combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1184   strcpy (combined, string);
1185   strcat (combined, ": ");
1186   strcat (combined, err);
1187
1188   /* I understand setting these is a matter of taste.  Still, some people
1189      may clear errno but not know about bfd_error.  Doing this here is not
1190      unreasonable.  */
1191   bfd_set_error (bfd_error_no_error);
1192   errno = 0;
1193
1194   error (_("%s."), combined);
1195 }
1196
1197 /* Print the system error message for ERRCODE, and also mention STRING
1198    as the file name for which the error was encountered.  */
1199
1200 void
1201 print_sys_errmsg (const char *string, int errcode)
1202 {
1203   char *err;
1204   char *combined;
1205
1206   err = safe_strerror (errcode);
1207   combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1208   strcpy (combined, string);
1209   strcat (combined, ": ");
1210   strcat (combined, err);
1211
1212   /* We want anything which was printed on stdout to come out first, before
1213      this message.  */
1214   gdb_flush (gdb_stdout);
1215   fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1216 }
1217
1218 /* Control C eventually causes this to be called, at a convenient time.  */
1219
1220 void
1221 quit (void)
1222 {
1223 #ifdef __MSDOS__
1224   /* No steenking SIGINT will ever be coming our way when the
1225      program is resumed.  Don't lie.  */
1226   fatal ("Quit");
1227 #else
1228   if (job_control
1229       /* If there is no terminal switching for this target, then we can't
1230          possibly get screwed by the lack of job control.  */
1231       || current_target.to_terminal_ours == NULL)
1232     fatal ("Quit");
1233   else
1234     fatal ("Quit (expect signal SIGINT when the program is resumed)");
1235 #endif
1236 }
1237
1238 \f
1239 /* Called when a memory allocation fails, with the number of bytes of
1240    memory requested in SIZE.  */
1241
1242 void
1243 malloc_failure (long size)
1244 {
1245   if (size > 0)
1246     {
1247       internal_error (__FILE__, __LINE__,
1248                       _("virtual memory exhausted: can't allocate %ld bytes."),
1249                       size);
1250     }
1251   else
1252     {
1253       internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1254     }
1255 }
1256
1257 /* My replacement for the read system call.
1258    Used like `read' but keeps going if `read' returns too soon.  */
1259
1260 int
1261 myread (int desc, char *addr, int len)
1262 {
1263   int val;
1264   int orglen = len;
1265
1266   while (len > 0)
1267     {
1268       val = read (desc, addr, len);
1269       if (val < 0)
1270         return val;
1271       if (val == 0)
1272         return orglen - len;
1273       len -= val;
1274       addr += val;
1275     }
1276   return orglen;
1277 }
1278
1279 /* Make a copy of the string at PTR with SIZE characters
1280    (and add a null character at the end in the copy).
1281    Uses malloc to get the space.  Returns the address of the copy.  */
1282
1283 char *
1284 savestring (const char *ptr, size_t size)
1285 {
1286   char *p = (char *) xmalloc (size + 1);
1287
1288   memcpy (p, ptr, size);
1289   p[size] = 0;
1290   return p;
1291 }
1292
1293 void
1294 print_spaces (int n, struct ui_file *file)
1295 {
1296   fputs_unfiltered (n_spaces (n), file);
1297 }
1298
1299 /* Print a host address.  */
1300
1301 void
1302 gdb_print_host_address (const void *addr, struct ui_file *stream)
1303 {
1304   fprintf_filtered (stream, "%s", host_address_to_string (addr));
1305 }
1306 \f
1307
1308 /* A cleanup function that calls regfree.  */
1309
1310 static void
1311 do_regfree_cleanup (void *r)
1312 {
1313   regfree (r);
1314 }
1315
1316 /* Create a new cleanup that frees the compiled regular expression R.  */
1317
1318 struct cleanup *
1319 make_regfree_cleanup (regex_t *r)
1320 {
1321   return make_cleanup (do_regfree_cleanup, r);
1322 }
1323
1324 /* Return an xmalloc'd error message resulting from a regular
1325    expression compilation failure.  */
1326
1327 char *
1328 get_regcomp_error (int code, regex_t *rx)
1329 {
1330   size_t length = regerror (code, rx, NULL, 0);
1331   char *result = xmalloc (length);
1332
1333   regerror (code, rx, result, length);
1334   return result;
1335 }
1336
1337 \f
1338
1339 /* This function supports the query, nquery, and yquery functions.
1340    Ask user a y-or-n question and return 0 if answer is no, 1 if
1341    answer is yes, or default the answer to the specified default
1342    (for yquery or nquery).  DEFCHAR may be 'y' or 'n' to provide a
1343    default answer, or '\0' for no default.
1344    CTLSTR is the control string and should end in "? ".  It should
1345    not say how to answer, because we do that.
1346    ARGS are the arguments passed along with the CTLSTR argument to
1347    printf.  */
1348
1349 static int ATTRIBUTE_PRINTF (1, 0)
1350 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1351 {
1352   int answer;
1353   int ans2;
1354   int retval;
1355   int def_value;
1356   char def_answer, not_def_answer;
1357   char *y_string, *n_string, *question;
1358
1359   /* Set up according to which answer is the default.  */
1360   if (defchar == '\0')
1361     {
1362       def_value = 1;
1363       def_answer = 'Y';
1364       not_def_answer = 'N';
1365       y_string = "y";
1366       n_string = "n";
1367     }
1368   else if (defchar == 'y')
1369     {
1370       def_value = 1;
1371       def_answer = 'Y';
1372       not_def_answer = 'N';
1373       y_string = "[y]";
1374       n_string = "n";
1375     }
1376   else
1377     {
1378       def_value = 0;
1379       def_answer = 'N';
1380       not_def_answer = 'Y';
1381       y_string = "y";
1382       n_string = "[n]";
1383     }
1384
1385   /* Automatically answer the default value if the user did not want
1386      prompts or the command was issued with the server prefix.  */
1387   if (! caution || server_command)
1388     return def_value;
1389
1390   /* If input isn't coming from the user directly, just say what
1391      question we're asking, and then answer the default automatically.  This
1392      way, important error messages don't get lost when talking to GDB
1393      over a pipe.  */
1394   if (! input_from_terminal_p ())
1395     {
1396       wrap_here ("");
1397       vfprintf_filtered (gdb_stdout, ctlstr, args);
1398
1399       printf_filtered (_("(%s or %s) [answered %c; "
1400                          "input not from terminal]\n"),
1401                        y_string, n_string, def_answer);
1402       gdb_flush (gdb_stdout);
1403
1404       return def_value;
1405     }
1406
1407   if (deprecated_query_hook)
1408     {
1409       return deprecated_query_hook (ctlstr, args);
1410     }
1411
1412   /* Format the question outside of the loop, to avoid reusing args.  */
1413   question = xstrvprintf (ctlstr, args);
1414
1415   while (1)
1416     {
1417       wrap_here ("");           /* Flush any buffered output.  */
1418       gdb_flush (gdb_stdout);
1419
1420       if (annotation_level > 1)
1421         printf_filtered (("\n\032\032pre-query\n"));
1422
1423       fputs_filtered (question, gdb_stdout);
1424       printf_filtered (_("(%s or %s) "), y_string, n_string);
1425
1426       if (annotation_level > 1)
1427         printf_filtered (("\n\032\032query\n"));
1428
1429       wrap_here ("");
1430       gdb_flush (gdb_stdout);
1431
1432       answer = fgetc (stdin);
1433
1434       /* We expect fgetc to block until a character is read.  But
1435          this may not be the case if the terminal was opened with
1436          the NONBLOCK flag.  In that case, if there is nothing to
1437          read on stdin, fgetc returns EOF, but also sets the error
1438          condition flag on stdin and errno to EAGAIN.  With a true
1439          EOF, stdin's error condition flag is not set.
1440
1441          A situation where this behavior was observed is a pseudo
1442          terminal on AIX.  */
1443       while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1444         {
1445           /* Not a real EOF.  Wait a little while and try again until
1446              we read something.  */
1447           clearerr (stdin);
1448           gdb_usleep (10000);
1449           answer = fgetc (stdin);
1450         }
1451
1452       clearerr (stdin);         /* in case of C-d */
1453       if (answer == EOF)        /* C-d */
1454         {
1455           printf_filtered ("EOF [assumed %c]\n", def_answer);
1456           retval = def_value;
1457           break;
1458         }
1459       /* Eat rest of input line, to EOF or newline.  */
1460       if (answer != '\n')
1461         do
1462           {
1463             ans2 = fgetc (stdin);
1464             clearerr (stdin);
1465           }
1466         while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1467
1468       if (answer >= 'a')
1469         answer -= 040;
1470       /* Check answer.  For the non-default, the user must specify
1471          the non-default explicitly.  */
1472       if (answer == not_def_answer)
1473         {
1474           retval = !def_value;
1475           break;
1476         }
1477       /* Otherwise, if a default was specified, the user may either
1478          specify the required input or have it default by entering
1479          nothing.  */
1480       if (answer == def_answer
1481           || (defchar != '\0' &&
1482               (answer == '\n' || answer == '\r' || answer == EOF)))
1483         {
1484           retval = def_value;
1485           break;
1486         }
1487       /* Invalid entries are not defaulted and require another selection.  */
1488       printf_filtered (_("Please answer %s or %s.\n"),
1489                        y_string, n_string);
1490     }
1491
1492   xfree (question);
1493   if (annotation_level > 1)
1494     printf_filtered (("\n\032\032post-query\n"));
1495   return retval;
1496 }
1497 \f
1498
1499 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1500    answer is yes, or 0 if answer is defaulted.
1501    Takes three args which are given to printf to print the question.
1502    The first, a control string, should end in "? ".
1503    It should not say how to answer, because we do that.  */
1504
1505 int
1506 nquery (const char *ctlstr, ...)
1507 {
1508   va_list args;
1509   int ret;
1510
1511   va_start (args, ctlstr);
1512   ret = defaulted_query (ctlstr, 'n', args);
1513   va_end (args);
1514   return ret;
1515 }
1516
1517 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1518    answer is yes, or 1 if answer is defaulted.
1519    Takes three args which are given to printf to print the question.
1520    The first, a control string, should end in "? ".
1521    It should not say how to answer, because we do that.  */
1522
1523 int
1524 yquery (const char *ctlstr, ...)
1525 {
1526   va_list args;
1527   int ret;
1528
1529   va_start (args, ctlstr);
1530   ret = defaulted_query (ctlstr, 'y', args);
1531   va_end (args);
1532   return ret;
1533 }
1534
1535 /* Ask user a y-or-n question and return 1 iff answer is yes.
1536    Takes three args which are given to printf to print the question.
1537    The first, a control string, should end in "? ".
1538    It should not say how to answer, because we do that.  */
1539
1540 int
1541 query (const char *ctlstr, ...)
1542 {
1543   va_list args;
1544   int ret;
1545
1546   va_start (args, ctlstr);
1547   ret = defaulted_query (ctlstr, '\0', args);
1548   va_end (args);
1549   return ret;
1550 }
1551
1552 /* A helper for parse_escape that converts a host character to a
1553    target character.  C is the host character.  If conversion is
1554    possible, then the target character is stored in *TARGET_C and the
1555    function returns 1.  Otherwise, the function returns 0.  */
1556
1557 static int
1558 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1559 {
1560   struct obstack host_data;
1561   char the_char = c;
1562   struct cleanup *cleanups;
1563   int result = 0;
1564
1565   obstack_init (&host_data);
1566   cleanups = make_cleanup_obstack_free (&host_data);
1567
1568   convert_between_encodings (target_charset (gdbarch), host_charset (),
1569                              &the_char, 1, 1, &host_data, translit_none);
1570
1571   if (obstack_object_size (&host_data) == 1)
1572     {
1573       result = 1;
1574       *target_c = *(char *) obstack_base (&host_data);
1575     }
1576
1577   do_cleanups (cleanups);
1578   return result;
1579 }
1580
1581 /* Parse a C escape sequence.  STRING_PTR points to a variable
1582    containing a pointer to the string to parse.  That pointer
1583    should point to the character after the \.  That pointer
1584    is updated past the characters we use.  The value of the
1585    escape sequence is returned.
1586
1587    A negative value means the sequence \ newline was seen,
1588    which is supposed to be equivalent to nothing at all.
1589
1590    If \ is followed by a null character, we return a negative
1591    value and leave the string pointer pointing at the null character.
1592
1593    If \ is followed by 000, we return 0 and leave the string pointer
1594    after the zeros.  A value of 0 does not mean end of string.  */
1595
1596 int
1597 parse_escape (struct gdbarch *gdbarch, char **string_ptr)
1598 {
1599   int target_char = -2; /* Initialize to avoid GCC warnings.  */
1600   int c = *(*string_ptr)++;
1601
1602   switch (c)
1603     {
1604       case '\n':
1605         return -2;
1606       case 0:
1607         (*string_ptr)--;
1608         return 0;
1609
1610       case '0':
1611       case '1':
1612       case '2':
1613       case '3':
1614       case '4':
1615       case '5':
1616       case '6':
1617       case '7':
1618         {
1619           int i = host_hex_value (c);
1620           int count = 0;
1621           while (++count < 3)
1622             {
1623               c = (**string_ptr);
1624               if (isdigit (c) && c != '8' && c != '9')
1625                 {
1626                   (*string_ptr)++;
1627                   i *= 8;
1628                   i += host_hex_value (c);
1629                 }
1630               else
1631                 {
1632                   break;
1633                 }
1634             }
1635           return i;
1636         }
1637
1638     case 'a':
1639       c = '\a';
1640       break;
1641     case 'b':
1642       c = '\b';
1643       break;
1644     case 'f':
1645       c = '\f';
1646       break;
1647     case 'n':
1648       c = '\n';
1649       break;
1650     case 'r':
1651       c = '\r';
1652       break;
1653     case 't':
1654       c = '\t';
1655       break;
1656     case 'v':
1657       c = '\v';
1658       break;
1659
1660     default:
1661       break;
1662     }
1663
1664   if (!host_char_to_target (gdbarch, c, &target_char))
1665     error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1666              " which has no equivalent\nin the `%s' character set."),
1667            c, c, target_charset (gdbarch));
1668   return target_char;
1669 }
1670 \f
1671 /* Print the character C on STREAM as part of the contents of a literal
1672    string whose delimiter is QUOTER.  Note that this routine should only
1673    be call for printing things which are independent of the language
1674    of the program being debugged.  */
1675
1676 static void
1677 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1678            void (*do_fprintf) (struct ui_file *, const char *, ...)
1679            ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1680 {
1681   c &= 0xFF;                    /* Avoid sign bit follies */
1682
1683   if (c < 0x20 ||               /* Low control chars */
1684       (c >= 0x7F && c < 0xA0) ||        /* DEL, High controls */
1685       (sevenbit_strings && c >= 0x80))
1686     {                           /* high order bit set */
1687       switch (c)
1688         {
1689         case '\n':
1690           do_fputs ("\\n", stream);
1691           break;
1692         case '\b':
1693           do_fputs ("\\b", stream);
1694           break;
1695         case '\t':
1696           do_fputs ("\\t", stream);
1697           break;
1698         case '\f':
1699           do_fputs ("\\f", stream);
1700           break;
1701         case '\r':
1702           do_fputs ("\\r", stream);
1703           break;
1704         case '\033':
1705           do_fputs ("\\e", stream);
1706           break;
1707         case '\007':
1708           do_fputs ("\\a", stream);
1709           break;
1710         default:
1711           do_fprintf (stream, "\\%.3o", (unsigned int) c);
1712           break;
1713         }
1714     }
1715   else
1716     {
1717       if (c == '\\' || c == quoter)
1718         do_fputs ("\\", stream);
1719       do_fprintf (stream, "%c", c);
1720     }
1721 }
1722
1723 /* Print the character C on STREAM as part of the contents of a
1724    literal string whose delimiter is QUOTER.  Note that these routines
1725    should only be call for printing things which are independent of
1726    the language of the program being debugged.  */
1727
1728 void
1729 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1730 {
1731   while (*str)
1732     printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1733 }
1734
1735 void
1736 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1737 {
1738   while (*str)
1739     printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1740 }
1741
1742 void
1743 fputstrn_filtered (const char *str, int n, int quoter,
1744                    struct ui_file *stream)
1745 {
1746   int i;
1747
1748   for (i = 0; i < n; i++)
1749     printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1750 }
1751
1752 void
1753 fputstrn_unfiltered (const char *str, int n, int quoter,
1754                      struct ui_file *stream)
1755 {
1756   int i;
1757
1758   for (i = 0; i < n; i++)
1759     printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1760 }
1761 \f
1762
1763 /* Number of lines per page or UINT_MAX if paging is disabled.  */
1764 static unsigned int lines_per_page;
1765 static void
1766 show_lines_per_page (struct ui_file *file, int from_tty,
1767                      struct cmd_list_element *c, const char *value)
1768 {
1769   fprintf_filtered (file,
1770                     _("Number of lines gdb thinks are in a page is %s.\n"),
1771                     value);
1772 }
1773
1774 /* Number of chars per line or UINT_MAX if line folding is disabled.  */
1775 static unsigned int chars_per_line;
1776 static void
1777 show_chars_per_line (struct ui_file *file, int from_tty,
1778                      struct cmd_list_element *c, const char *value)
1779 {
1780   fprintf_filtered (file,
1781                     _("Number of characters gdb thinks "
1782                       "are in a line is %s.\n"),
1783                     value);
1784 }
1785
1786 /* Current count of lines printed on this page, chars on this line.  */
1787 static unsigned int lines_printed, chars_printed;
1788
1789 /* Buffer and start column of buffered text, for doing smarter word-
1790    wrapping.  When someone calls wrap_here(), we start buffering output
1791    that comes through fputs_filtered().  If we see a newline, we just
1792    spit it out and forget about the wrap_here().  If we see another
1793    wrap_here(), we spit it out and remember the newer one.  If we see
1794    the end of the line, we spit out a newline, the indent, and then
1795    the buffered output.  */
1796
1797 /* Malloc'd buffer with chars_per_line+2 bytes.  Contains characters which
1798    are waiting to be output (they have already been counted in chars_printed).
1799    When wrap_buffer[0] is null, the buffer is empty.  */
1800 static char *wrap_buffer;
1801
1802 /* Pointer in wrap_buffer to the next character to fill.  */
1803 static char *wrap_pointer;
1804
1805 /* String to indent by if the wrap occurs.  Must not be NULL if wrap_column
1806    is non-zero.  */
1807 static char *wrap_indent;
1808
1809 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1810    is not in effect.  */
1811 static int wrap_column;
1812 \f
1813
1814 /* Inialize the number of lines per page and chars per line.  */
1815
1816 void
1817 init_page_info (void)
1818 {
1819   if (batch_flag)
1820     {
1821       lines_per_page = UINT_MAX;
1822       chars_per_line = UINT_MAX;
1823     }
1824   else
1825 #if defined(TUI)
1826   if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1827 #endif
1828     {
1829       int rows, cols;
1830
1831 #if defined(__GO32__)
1832       rows = ScreenRows ();
1833       cols = ScreenCols ();
1834       lines_per_page = rows;
1835       chars_per_line = cols;
1836 #else
1837       /* Make sure Readline has initialized its terminal settings.  */
1838       rl_reset_terminal (NULL);
1839
1840       /* Get the screen size from Readline.  */
1841       rl_get_screen_size (&rows, &cols);
1842       lines_per_page = rows;
1843       chars_per_line = cols;
1844
1845       /* Readline should have fetched the termcap entry for us.  */
1846       if (tgetnum ("li") < 0 || getenv ("EMACS"))
1847         {
1848           /* The number of lines per page is not mentioned in the
1849              terminal description.  This probably means that paging is
1850              not useful (e.g. emacs shell window), so disable paging.  */
1851           lines_per_page = UINT_MAX;
1852         }
1853
1854       /* FIXME: Get rid of this junk.  */
1855 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1856       SIGWINCH_HANDLER (SIGWINCH);
1857 #endif
1858
1859       /* If the output is not a terminal, don't paginate it.  */
1860       if (!ui_file_isatty (gdb_stdout))
1861         lines_per_page = UINT_MAX;
1862 #endif
1863     }
1864
1865   set_screen_size ();
1866   set_width ();
1867 }
1868
1869 /* Helper for make_cleanup_restore_page_info.  */
1870
1871 static void
1872 do_restore_page_info_cleanup (void *arg)
1873 {
1874   set_screen_size ();
1875   set_width ();
1876 }
1877
1878 /* Provide cleanup for restoring the terminal size.  */
1879
1880 struct cleanup *
1881 make_cleanup_restore_page_info (void)
1882 {
1883   struct cleanup *back_to;
1884
1885   back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1886   make_cleanup_restore_uinteger (&lines_per_page);
1887   make_cleanup_restore_uinteger (&chars_per_line);
1888
1889   return back_to;
1890 }
1891
1892 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1893    Provide cleanup for restoring the original state.  */
1894
1895 struct cleanup *
1896 set_batch_flag_and_make_cleanup_restore_page_info (void)
1897 {
1898   struct cleanup *back_to = make_cleanup_restore_page_info ();
1899   
1900   make_cleanup_restore_integer (&batch_flag);
1901   batch_flag = 1;
1902   init_page_info ();
1903
1904   return back_to;
1905 }
1906
1907 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE.  */
1908
1909 static void
1910 set_screen_size (void)
1911 {
1912   int rows = lines_per_page;
1913   int cols = chars_per_line;
1914
1915   if (rows <= 0)
1916     rows = INT_MAX;
1917
1918   if (cols <= 0)
1919     cols = INT_MAX;
1920
1921   /* Update Readline's idea of the terminal size.  */
1922   rl_set_screen_size (rows, cols);
1923 }
1924
1925 /* Reinitialize WRAP_BUFFER according to the current value of
1926    CHARS_PER_LINE.  */
1927
1928 static void
1929 set_width (void)
1930 {
1931   if (chars_per_line == 0)
1932     init_page_info ();
1933
1934   if (!wrap_buffer)
1935     {
1936       wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1937       wrap_buffer[0] = '\0';
1938     }
1939   else
1940     wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1941   wrap_pointer = wrap_buffer;   /* Start it at the beginning.  */
1942 }
1943
1944 static void
1945 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1946 {
1947   set_screen_size ();
1948   set_width ();
1949 }
1950
1951 static void
1952 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1953 {
1954   set_screen_size ();
1955 }
1956
1957 /* Wait, so the user can read what's on the screen.  Prompt the user
1958    to continue by pressing RETURN.  */
1959
1960 static void
1961 prompt_for_continue (void)
1962 {
1963   char *ignore;
1964   char cont_prompt[120];
1965
1966   if (annotation_level > 1)
1967     printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1968
1969   strcpy (cont_prompt,
1970           "---Type <return> to continue, or q <return> to quit---");
1971   if (annotation_level > 1)
1972     strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1973
1974   /* We must do this *before* we call gdb_readline, else it will eventually
1975      call us -- thinking that we're trying to print beyond the end of the 
1976      screen.  */
1977   reinitialize_more_filter ();
1978
1979   immediate_quit++;
1980   /* On a real operating system, the user can quit with SIGINT.
1981      But not on GO32.
1982
1983      'q' is provided on all systems so users don't have to change habits
1984      from system to system, and because telling them what to do in
1985      the prompt is more user-friendly than expecting them to think of
1986      SIGINT.  */
1987   /* Call readline, not gdb_readline, because GO32 readline handles control-C
1988      whereas control-C to gdb_readline will cause the user to get dumped
1989      out to DOS.  */
1990   ignore = gdb_readline_wrapper (cont_prompt);
1991
1992   if (annotation_level > 1)
1993     printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1994
1995   if (ignore)
1996     {
1997       char *p = ignore;
1998
1999       while (*p == ' ' || *p == '\t')
2000         ++p;
2001       if (p[0] == 'q')
2002         async_request_quit (0);
2003       xfree (ignore);
2004     }
2005   immediate_quit--;
2006
2007   /* Now we have to do this again, so that GDB will know that it doesn't
2008      need to save the ---Type <return>--- line at the top of the screen.  */
2009   reinitialize_more_filter ();
2010
2011   dont_repeat ();               /* Forget prev cmd -- CR won't repeat it.  */
2012 }
2013
2014 /* Reinitialize filter; ie. tell it to reset to original values.  */
2015
2016 void
2017 reinitialize_more_filter (void)
2018 {
2019   lines_printed = 0;
2020   chars_printed = 0;
2021 }
2022
2023 /* Indicate that if the next sequence of characters overflows the line,
2024    a newline should be inserted here rather than when it hits the end.
2025    If INDENT is non-null, it is a string to be printed to indent the
2026    wrapped part on the next line.  INDENT must remain accessible until
2027    the next call to wrap_here() or until a newline is printed through
2028    fputs_filtered().
2029
2030    If the line is already overfull, we immediately print a newline and
2031    the indentation, and disable further wrapping.
2032
2033    If we don't know the width of lines, but we know the page height,
2034    we must not wrap words, but should still keep track of newlines
2035    that were explicitly printed.
2036
2037    INDENT should not contain tabs, as that will mess up the char count
2038    on the next line.  FIXME.
2039
2040    This routine is guaranteed to force out any output which has been
2041    squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2042    used to force out output from the wrap_buffer.  */
2043
2044 void
2045 wrap_here (char *indent)
2046 {
2047   /* This should have been allocated, but be paranoid anyway.  */
2048   if (!wrap_buffer)
2049     internal_error (__FILE__, __LINE__,
2050                     _("failed internal consistency check"));
2051
2052   if (wrap_buffer[0])
2053     {
2054       *wrap_pointer = '\0';
2055       fputs_unfiltered (wrap_buffer, gdb_stdout);
2056     }
2057   wrap_pointer = wrap_buffer;
2058   wrap_buffer[0] = '\0';
2059   if (chars_per_line == UINT_MAX)       /* No line overflow checking.  */
2060     {
2061       wrap_column = 0;
2062     }
2063   else if (chars_printed >= chars_per_line)
2064     {
2065       puts_filtered ("\n");
2066       if (indent != NULL)
2067         puts_filtered (indent);
2068       wrap_column = 0;
2069     }
2070   else
2071     {
2072       wrap_column = chars_printed;
2073       if (indent == NULL)
2074         wrap_indent = "";
2075       else
2076         wrap_indent = indent;
2077     }
2078 }
2079
2080 /* Print input string to gdb_stdout, filtered, with wrap, 
2081    arranging strings in columns of n chars.  String can be
2082    right or left justified in the column.  Never prints 
2083    trailing spaces.  String should never be longer than
2084    width.  FIXME: this could be useful for the EXAMINE 
2085    command, which currently doesn't tabulate very well.  */
2086
2087 void
2088 puts_filtered_tabular (char *string, int width, int right)
2089 {
2090   int spaces = 0;
2091   int stringlen;
2092   char *spacebuf;
2093
2094   gdb_assert (chars_per_line > 0);
2095   if (chars_per_line == UINT_MAX)
2096     {
2097       fputs_filtered (string, gdb_stdout);
2098       fputs_filtered ("\n", gdb_stdout);
2099       return;
2100     }
2101
2102   if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2103     fputs_filtered ("\n", gdb_stdout);
2104
2105   if (width >= chars_per_line)
2106     width = chars_per_line - 1;
2107
2108   stringlen = strlen (string);
2109
2110   if (chars_printed > 0)
2111     spaces = width - (chars_printed - 1) % width - 1;
2112   if (right)
2113     spaces += width - stringlen;
2114
2115   spacebuf = alloca (spaces + 1);
2116   spacebuf[spaces] = '\0';
2117   while (spaces--)
2118     spacebuf[spaces] = ' ';
2119
2120   fputs_filtered (spacebuf, gdb_stdout);
2121   fputs_filtered (string, gdb_stdout);
2122 }
2123
2124
2125 /* Ensure that whatever gets printed next, using the filtered output
2126    commands, starts at the beginning of the line.  I.e. if there is
2127    any pending output for the current line, flush it and start a new
2128    line.  Otherwise do nothing.  */
2129
2130 void
2131 begin_line (void)
2132 {
2133   if (chars_printed > 0)
2134     {
2135       puts_filtered ("\n");
2136     }
2137 }
2138
2139
2140 /* Like fputs but if FILTER is true, pause after every screenful.
2141
2142    Regardless of FILTER can wrap at points other than the final
2143    character of a line.
2144
2145    Unlike fputs, fputs_maybe_filtered does not return a value.
2146    It is OK for LINEBUFFER to be NULL, in which case just don't print
2147    anything.
2148
2149    Note that a longjmp to top level may occur in this routine (only if
2150    FILTER is true) (since prompt_for_continue may do so) so this
2151    routine should not be called when cleanups are not in place.  */
2152
2153 static void
2154 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2155                       int filter)
2156 {
2157   const char *lineptr;
2158
2159   if (linebuffer == 0)
2160     return;
2161
2162   /* Don't do any filtering if it is disabled.  */
2163   if (stream != gdb_stdout
2164       || !pagination_enabled
2165       || batch_flag
2166       || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2167       || top_level_interpreter () == NULL
2168       || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2169     {
2170       fputs_unfiltered (linebuffer, stream);
2171       return;
2172     }
2173
2174   /* Go through and output each character.  Show line extension
2175      when this is necessary; prompt user for new page when this is
2176      necessary.  */
2177
2178   lineptr = linebuffer;
2179   while (*lineptr)
2180     {
2181       /* Possible new page.  */
2182       if (filter && (lines_printed >= lines_per_page - 1))
2183         prompt_for_continue ();
2184
2185       while (*lineptr && *lineptr != '\n')
2186         {
2187           /* Print a single line.  */
2188           if (*lineptr == '\t')
2189             {
2190               if (wrap_column)
2191                 *wrap_pointer++ = '\t';
2192               else
2193                 fputc_unfiltered ('\t', stream);
2194               /* Shifting right by 3 produces the number of tab stops
2195                  we have already passed, and then adding one and
2196                  shifting left 3 advances to the next tab stop.  */
2197               chars_printed = ((chars_printed >> 3) + 1) << 3;
2198               lineptr++;
2199             }
2200           else
2201             {
2202               if (wrap_column)
2203                 *wrap_pointer++ = *lineptr;
2204               else
2205                 fputc_unfiltered (*lineptr, stream);
2206               chars_printed++;
2207               lineptr++;
2208             }
2209
2210           if (chars_printed >= chars_per_line)
2211             {
2212               unsigned int save_chars = chars_printed;
2213
2214               chars_printed = 0;
2215               lines_printed++;
2216               /* If we aren't actually wrapping, don't output newline --
2217                  if chars_per_line is right, we probably just overflowed
2218                  anyway; if it's wrong, let us keep going.  */
2219               if (wrap_column)
2220                 fputc_unfiltered ('\n', stream);
2221
2222               /* Possible new page.  */
2223               if (lines_printed >= lines_per_page - 1)
2224                 prompt_for_continue ();
2225
2226               /* Now output indentation and wrapped string.  */
2227               if (wrap_column)
2228                 {
2229                   fputs_unfiltered (wrap_indent, stream);
2230                   *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2231                   fputs_unfiltered (wrap_buffer, stream); /* and eject it.  */
2232                   /* FIXME, this strlen is what prevents wrap_indent from
2233                      containing tabs.  However, if we recurse to print it
2234                      and count its chars, we risk trouble if wrap_indent is
2235                      longer than (the user settable) chars_per_line.
2236                      Note also that this can set chars_printed > chars_per_line
2237                      if we are printing a long string.  */
2238                   chars_printed = strlen (wrap_indent)
2239                     + (save_chars - wrap_column);
2240                   wrap_pointer = wrap_buffer;   /* Reset buffer */
2241                   wrap_buffer[0] = '\0';
2242                   wrap_column = 0;      /* And disable fancy wrap */
2243                 }
2244             }
2245         }
2246
2247       if (*lineptr == '\n')
2248         {
2249           chars_printed = 0;
2250           wrap_here ((char *) 0);       /* Spit out chars, cancel
2251                                            further wraps.  */
2252           lines_printed++;
2253           fputc_unfiltered ('\n', stream);
2254           lineptr++;
2255         }
2256     }
2257 }
2258
2259 void
2260 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2261 {
2262   fputs_maybe_filtered (linebuffer, stream, 1);
2263 }
2264
2265 int
2266 putchar_unfiltered (int c)
2267 {
2268   char buf = c;
2269
2270   ui_file_write (gdb_stdout, &buf, 1);
2271   return c;
2272 }
2273
2274 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2275    May return nonlocally.  */
2276
2277 int
2278 putchar_filtered (int c)
2279 {
2280   return fputc_filtered (c, gdb_stdout);
2281 }
2282
2283 int
2284 fputc_unfiltered (int c, struct ui_file *stream)
2285 {
2286   char buf = c;
2287
2288   ui_file_write (stream, &buf, 1);
2289   return c;
2290 }
2291
2292 int
2293 fputc_filtered (int c, struct ui_file *stream)
2294 {
2295   char buf[2];
2296
2297   buf[0] = c;
2298   buf[1] = 0;
2299   fputs_filtered (buf, stream);
2300   return c;
2301 }
2302
2303 /* puts_debug is like fputs_unfiltered, except it prints special
2304    characters in printable fashion.  */
2305
2306 void
2307 puts_debug (char *prefix, char *string, char *suffix)
2308 {
2309   int ch;
2310
2311   /* Print prefix and suffix after each line.  */
2312   static int new_line = 1;
2313   static int return_p = 0;
2314   static char *prev_prefix = "";
2315   static char *prev_suffix = "";
2316
2317   if (*string == '\n')
2318     return_p = 0;
2319
2320   /* If the prefix is changing, print the previous suffix, a new line,
2321      and the new prefix.  */
2322   if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2323     {
2324       fputs_unfiltered (prev_suffix, gdb_stdlog);
2325       fputs_unfiltered ("\n", gdb_stdlog);
2326       fputs_unfiltered (prefix, gdb_stdlog);
2327     }
2328
2329   /* Print prefix if we printed a newline during the previous call.  */
2330   if (new_line)
2331     {
2332       new_line = 0;
2333       fputs_unfiltered (prefix, gdb_stdlog);
2334     }
2335
2336   prev_prefix = prefix;
2337   prev_suffix = suffix;
2338
2339   /* Output characters in a printable format.  */
2340   while ((ch = *string++) != '\0')
2341     {
2342       switch (ch)
2343         {
2344         default:
2345           if (isprint (ch))
2346             fputc_unfiltered (ch, gdb_stdlog);
2347
2348           else
2349             fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2350           break;
2351
2352         case '\\':
2353           fputs_unfiltered ("\\\\", gdb_stdlog);
2354           break;
2355         case '\b':
2356           fputs_unfiltered ("\\b", gdb_stdlog);
2357           break;
2358         case '\f':
2359           fputs_unfiltered ("\\f", gdb_stdlog);
2360           break;
2361         case '\n':
2362           new_line = 1;
2363           fputs_unfiltered ("\\n", gdb_stdlog);
2364           break;
2365         case '\r':
2366           fputs_unfiltered ("\\r", gdb_stdlog);
2367           break;
2368         case '\t':
2369           fputs_unfiltered ("\\t", gdb_stdlog);
2370           break;
2371         case '\v':
2372           fputs_unfiltered ("\\v", gdb_stdlog);
2373           break;
2374         }
2375
2376       return_p = ch == '\r';
2377     }
2378
2379   /* Print suffix if we printed a newline.  */
2380   if (new_line)
2381     {
2382       fputs_unfiltered (suffix, gdb_stdlog);
2383       fputs_unfiltered ("\n", gdb_stdlog);
2384     }
2385 }
2386
2387
2388 /* Print a variable number of ARGS using format FORMAT.  If this
2389    information is going to put the amount written (since the last call
2390    to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2391    call prompt_for_continue to get the users permision to continue.
2392
2393    Unlike fprintf, this function does not return a value.
2394
2395    We implement three variants, vfprintf (takes a vararg list and stream),
2396    fprintf (takes a stream to write on), and printf (the usual).
2397
2398    Note also that a longjmp to top level may occur in this routine
2399    (since prompt_for_continue may do so) so this routine should not be
2400    called when cleanups are not in place.  */
2401
2402 static void
2403 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2404                          va_list args, int filter)
2405 {
2406   char *linebuffer;
2407   struct cleanup *old_cleanups;
2408
2409   linebuffer = xstrvprintf (format, args);
2410   old_cleanups = make_cleanup (xfree, linebuffer);
2411   fputs_maybe_filtered (linebuffer, stream, filter);
2412   do_cleanups (old_cleanups);
2413 }
2414
2415
2416 void
2417 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2418 {
2419   vfprintf_maybe_filtered (stream, format, args, 1);
2420 }
2421
2422 void
2423 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2424 {
2425   char *linebuffer;
2426   struct cleanup *old_cleanups;
2427
2428   linebuffer = xstrvprintf (format, args);
2429   old_cleanups = make_cleanup (xfree, linebuffer);
2430   if (debug_timestamp && stream == gdb_stdlog)
2431     {
2432       struct timeval tm;
2433       char *timestamp;
2434       int len, need_nl;
2435
2436       gettimeofday (&tm, NULL);
2437
2438       len = strlen (linebuffer);
2439       need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2440
2441       timestamp = xstrprintf ("%ld:%ld %s%s",
2442                               (long) tm.tv_sec, (long) tm.tv_usec,
2443                               linebuffer,
2444                               need_nl ? "\n": "");
2445       make_cleanup (xfree, timestamp);
2446       fputs_unfiltered (timestamp, stream);
2447     }
2448   else
2449     fputs_unfiltered (linebuffer, stream);
2450   do_cleanups (old_cleanups);
2451 }
2452
2453 void
2454 vprintf_filtered (const char *format, va_list args)
2455 {
2456   vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2457 }
2458
2459 void
2460 vprintf_unfiltered (const char *format, va_list args)
2461 {
2462   vfprintf_unfiltered (gdb_stdout, format, args);
2463 }
2464
2465 void
2466 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2467 {
2468   va_list args;
2469
2470   va_start (args, format);
2471   vfprintf_filtered (stream, format, args);
2472   va_end (args);
2473 }
2474
2475 void
2476 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2477 {
2478   va_list args;
2479
2480   va_start (args, format);
2481   vfprintf_unfiltered (stream, format, args);
2482   va_end (args);
2483 }
2484
2485 /* Like fprintf_filtered, but prints its result indented.
2486    Called as fprintfi_filtered (spaces, stream, format, ...);  */
2487
2488 void
2489 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2490                    ...)
2491 {
2492   va_list args;
2493
2494   va_start (args, format);
2495   print_spaces_filtered (spaces, stream);
2496
2497   vfprintf_filtered (stream, format, args);
2498   va_end (args);
2499 }
2500
2501
2502 void
2503 printf_filtered (const char *format, ...)
2504 {
2505   va_list args;
2506
2507   va_start (args, format);
2508   vfprintf_filtered (gdb_stdout, format, args);
2509   va_end (args);
2510 }
2511
2512
2513 void
2514 printf_unfiltered (const char *format, ...)
2515 {
2516   va_list args;
2517
2518   va_start (args, format);
2519   vfprintf_unfiltered (gdb_stdout, format, args);
2520   va_end (args);
2521 }
2522
2523 /* Like printf_filtered, but prints it's result indented.
2524    Called as printfi_filtered (spaces, format, ...);  */
2525
2526 void
2527 printfi_filtered (int spaces, const char *format, ...)
2528 {
2529   va_list args;
2530
2531   va_start (args, format);
2532   print_spaces_filtered (spaces, gdb_stdout);
2533   vfprintf_filtered (gdb_stdout, format, args);
2534   va_end (args);
2535 }
2536
2537 /* Easy -- but watch out!
2538
2539    This routine is *not* a replacement for puts()!  puts() appends a newline.
2540    This one doesn't, and had better not!  */
2541
2542 void
2543 puts_filtered (const char *string)
2544 {
2545   fputs_filtered (string, gdb_stdout);
2546 }
2547
2548 void
2549 puts_unfiltered (const char *string)
2550 {
2551   fputs_unfiltered (string, gdb_stdout);
2552 }
2553
2554 /* Return a pointer to N spaces and a null.  The pointer is good
2555    until the next call to here.  */
2556 char *
2557 n_spaces (int n)
2558 {
2559   char *t;
2560   static char *spaces = 0;
2561   static int max_spaces = -1;
2562
2563   if (n > max_spaces)
2564     {
2565       if (spaces)
2566         xfree (spaces);
2567       spaces = (char *) xmalloc (n + 1);
2568       for (t = spaces + n; t != spaces;)
2569         *--t = ' ';
2570       spaces[n] = '\0';
2571       max_spaces = n;
2572     }
2573
2574   return spaces + max_spaces - n;
2575 }
2576
2577 /* Print N spaces.  */
2578 void
2579 print_spaces_filtered (int n, struct ui_file *stream)
2580 {
2581   fputs_filtered (n_spaces (n), stream);
2582 }
2583 \f
2584 /* C++/ObjC demangler stuff.  */
2585
2586 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2587    LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2588    If the name is not mangled, or the language for the name is unknown, or
2589    demangling is off, the name is printed in its "raw" form.  */
2590
2591 void
2592 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2593                          enum language lang, int arg_mode)
2594 {
2595   char *demangled;
2596
2597   if (name != NULL)
2598     {
2599       /* If user wants to see raw output, no problem.  */
2600       if (!demangle)
2601         {
2602           fputs_filtered (name, stream);
2603         }
2604       else
2605         {
2606           demangled = language_demangle (language_def (lang), name, arg_mode);
2607           fputs_filtered (demangled ? demangled : name, stream);
2608           if (demangled != NULL)
2609             {
2610               xfree (demangled);
2611             }
2612         }
2613     }
2614 }
2615
2616 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2617    differences in whitespace.  Returns 0 if they match, non-zero if they
2618    don't (slightly different than strcmp()'s range of return values).
2619
2620    As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2621    This "feature" is useful when searching for matching C++ function names
2622    (such as if the user types 'break FOO', where FOO is a mangled C++
2623    function).  */
2624
2625 int
2626 strcmp_iw (const char *string1, const char *string2)
2627 {
2628   while ((*string1 != '\0') && (*string2 != '\0'))
2629     {
2630       while (isspace (*string1))
2631         {
2632           string1++;
2633         }
2634       while (isspace (*string2))
2635         {
2636           string2++;
2637         }
2638       if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2639         break;
2640       if (case_sensitivity == case_sensitive_off
2641           && (tolower ((unsigned char) *string1)
2642               != tolower ((unsigned char) *string2)))
2643         break;
2644       if (*string1 != '\0')
2645         {
2646           string1++;
2647           string2++;
2648         }
2649     }
2650   return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2651 }
2652
2653 /* This is like strcmp except that it ignores whitespace and treats
2654    '(' as the first non-NULL character in terms of ordering.  Like
2655    strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2656    STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2657    according to that ordering.
2658
2659    If a list is sorted according to this function and if you want to
2660    find names in the list that match some fixed NAME according to
2661    strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2662    where this function would put NAME.
2663
2664    This function must be neutral to the CASE_SENSITIVITY setting as the user
2665    may choose it during later lookup.  Therefore this function always sorts
2666    primarily case-insensitively and secondarily case-sensitively.
2667
2668    Here are some examples of why using strcmp to sort is a bad idea:
2669
2670    Whitespace example:
2671
2672    Say your partial symtab contains: "foo<char *>", "goo".  Then, if
2673    we try to do a search for "foo<char*>", strcmp will locate this
2674    after "foo<char *>" and before "goo".  Then lookup_partial_symbol
2675    will start looking at strings beginning with "goo", and will never
2676    see the correct match of "foo<char *>".
2677
2678    Parenthesis example:
2679
2680    In practice, this is less like to be an issue, but I'll give it a
2681    shot.  Let's assume that '$' is a legitimate character to occur in
2682    symbols.  (Which may well even be the case on some systems.)  Then
2683    say that the partial symbol table contains "foo$" and "foo(int)".
2684    strcmp will put them in this order, since '$' < '('.  Now, if the
2685    user searches for "foo", then strcmp will sort "foo" before "foo$".
2686    Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2687    "foo") is false, so it won't proceed to the actual match of
2688    "foo(int)" with "foo".  */
2689
2690 int
2691 strcmp_iw_ordered (const char *string1, const char *string2)
2692 {
2693   const char *saved_string1 = string1, *saved_string2 = string2;
2694   enum case_sensitivity case_pass = case_sensitive_off;
2695
2696   for (;;)
2697     {
2698       /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2699          Provide stub characters if we are already at the end of one of the
2700          strings.  */
2701       char c1 = 'X', c2 = 'X';
2702
2703       while (*string1 != '\0' && *string2 != '\0')
2704         {
2705           while (isspace (*string1))
2706             string1++;
2707           while (isspace (*string2))
2708             string2++;
2709
2710           switch (case_pass)
2711           {
2712             case case_sensitive_off:
2713               c1 = tolower ((unsigned char) *string1);
2714               c2 = tolower ((unsigned char) *string2);
2715               break;
2716             case case_sensitive_on:
2717               c1 = *string1;
2718               c2 = *string2;
2719               break;
2720           }
2721           if (c1 != c2)
2722             break;
2723
2724           if (*string1 != '\0')
2725             {
2726               string1++;
2727               string2++;
2728             }
2729         }
2730
2731       switch (*string1)
2732         {
2733           /* Characters are non-equal unless they're both '\0'; we want to
2734              make sure we get the comparison right according to our
2735              comparison in the cases where one of them is '\0' or '('.  */
2736         case '\0':
2737           if (*string2 == '\0')
2738             break;
2739           else
2740             return -1;
2741         case '(':
2742           if (*string2 == '\0')
2743             return 1;
2744           else
2745             return -1;
2746         default:
2747           if (*string2 == '\0' || *string2 == '(')
2748             return 1;
2749           else if (c1 > c2)
2750             return 1;
2751           else if (c1 < c2)
2752             return -1;
2753           /* PASSTHRU */
2754         }
2755
2756       if (case_pass == case_sensitive_on)
2757         return 0;
2758       
2759       /* Otherwise the strings were equal in case insensitive way, make
2760          a more fine grained comparison in a case sensitive way.  */
2761
2762       case_pass = case_sensitive_on;
2763       string1 = saved_string1;
2764       string2 = saved_string2;
2765     }
2766 }
2767
2768 /* A simple comparison function with opposite semantics to strcmp.  */
2769
2770 int
2771 streq (const char *lhs, const char *rhs)
2772 {
2773   return !strcmp (lhs, rhs);
2774 }
2775 \f
2776
2777 /*
2778    ** subset_compare()
2779    **    Answer whether string_to_compare is a full or partial match to
2780    **    template_string.  The partial match must be in sequence starting
2781    **    at index 0.
2782  */
2783 int
2784 subset_compare (char *string_to_compare, char *template_string)
2785 {
2786   int match;
2787
2788   if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2789       && strlen (string_to_compare) <= strlen (template_string))
2790     match =
2791       (strncmp
2792        (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2793   else
2794     match = 0;
2795   return match;
2796 }
2797
2798 static void
2799 pagination_on_command (char *arg, int from_tty)
2800 {
2801   pagination_enabled = 1;
2802 }
2803
2804 static void
2805 pagination_off_command (char *arg, int from_tty)
2806 {
2807   pagination_enabled = 0;
2808 }
2809
2810 static void
2811 show_debug_timestamp (struct ui_file *file, int from_tty,
2812                       struct cmd_list_element *c, const char *value)
2813 {
2814   fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2815                     value);
2816 }
2817 \f
2818
2819 void
2820 initialize_utils (void)
2821 {
2822   add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2823 Set number of characters gdb thinks are in a line."), _("\
2824 Show number of characters gdb thinks are in a line."), NULL,
2825                             set_width_command,
2826                             show_chars_per_line,
2827                             &setlist, &showlist);
2828
2829   add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2830 Set number of lines gdb thinks are in a page."), _("\
2831 Show number of lines gdb thinks are in a page."), NULL,
2832                             set_height_command,
2833                             show_lines_per_page,
2834                             &setlist, &showlist);
2835
2836   init_page_info ();
2837
2838   add_setshow_boolean_cmd ("pagination", class_support,
2839                            &pagination_enabled, _("\
2840 Set state of pagination."), _("\
2841 Show state of pagination."), NULL,
2842                            NULL,
2843                            show_pagination_enabled,
2844                            &setlist, &showlist);
2845
2846   if (xdb_commands)
2847     {
2848       add_com ("am", class_support, pagination_on_command,
2849                _("Enable pagination"));
2850       add_com ("sm", class_support, pagination_off_command,
2851                _("Disable pagination"));
2852     }
2853
2854   add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2855                            &sevenbit_strings, _("\
2856 Set printing of 8-bit characters in strings as \\nnn."), _("\
2857 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2858                            NULL,
2859                            show_sevenbit_strings,
2860                            &setprintlist, &showprintlist);
2861
2862   add_setshow_boolean_cmd ("timestamp", class_maintenance,
2863                             &debug_timestamp, _("\
2864 Set timestamping of debugging messages."), _("\
2865 Show timestamping of debugging messages."), _("\
2866 When set, debugging messages will be marked with seconds and microseconds."),
2867                            NULL,
2868                            show_debug_timestamp,
2869                            &setdebuglist, &showdebuglist);
2870 }
2871
2872 /* Machine specific function to handle SIGWINCH signal.  */
2873
2874 #ifdef  SIGWINCH_HANDLER_BODY
2875 SIGWINCH_HANDLER_BODY
2876 #endif
2877 /* Print routines to handle variable size regs, etc.  */
2878 /* Temporary storage using circular buffer.  */
2879 #define NUMCELLS 16
2880 #define CELLSIZE 50
2881 static char *
2882 get_cell (void)
2883 {
2884   static char buf[NUMCELLS][CELLSIZE];
2885   static int cell = 0;
2886
2887   if (++cell >= NUMCELLS)
2888     cell = 0;
2889   return buf[cell];
2890 }
2891
2892 const char *
2893 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2894 {
2895   /* Truncate address to the size of a target address, avoiding shifts
2896      larger or equal than the width of a CORE_ADDR.  The local
2897      variable ADDR_BIT stops the compiler reporting a shift overflow
2898      when it won't occur.  */
2899   /* NOTE: This assumes that the significant address information is
2900      kept in the least significant bits of ADDR - the upper bits were
2901      either zero or sign extended.  Should gdbarch_address_to_pointer or
2902      some ADDRESS_TO_PRINTABLE() be used to do the conversion?  */
2903
2904   int addr_bit = gdbarch_addr_bit (gdbarch);
2905
2906   if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2907     addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2908   return hex_string (addr);
2909 }
2910
2911 /* This function is described in "defs.h".  */
2912
2913 const char *
2914 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2915 {
2916   int addr_bit = gdbarch_addr_bit (gdbarch);
2917
2918   if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2919     address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2920
2921   /* FIXME: cagney/2002-05-03: Need local_address_string() function
2922      that returns the language localized string formatted to a width
2923      based on gdbarch_addr_bit.  */
2924   if (addr_bit <= 32)
2925     return hex_string_custom (address, 8);
2926   else
2927     return hex_string_custom (address, 16);
2928 }
2929
2930 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex.  */
2931
2932 hashval_t
2933 core_addr_hash (const void *ap)
2934 {
2935   const CORE_ADDR *addrp = ap;
2936
2937   return *addrp;
2938 }
2939
2940 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex.  */
2941
2942 int
2943 core_addr_eq (const void *ap, const void *bp)
2944 {
2945   const CORE_ADDR *addr_ap = ap;
2946   const CORE_ADDR *addr_bp = bp;
2947
2948   return *addr_ap == *addr_bp;
2949 }
2950
2951 static char *
2952 decimal2str (char *sign, ULONGEST addr, int width)
2953 {
2954   /* Steal code from valprint.c:print_decimal().  Should this worry
2955      about the real size of addr as the above does?  */
2956   unsigned long temp[3];
2957   char *str = get_cell ();
2958   int i = 0;
2959
2960   do
2961     {
2962       temp[i] = addr % (1000 * 1000 * 1000);
2963       addr /= (1000 * 1000 * 1000);
2964       i++;
2965       width -= 9;
2966     }
2967   while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2968
2969   width += 9;
2970   if (width < 0)
2971     width = 0;
2972
2973   switch (i)
2974     {
2975     case 1:
2976       xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2977       break;
2978     case 2:
2979       xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2980                  temp[1], temp[0]);
2981       break;
2982     case 3:
2983       xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2984                  temp[2], temp[1], temp[0]);
2985       break;
2986     default:
2987       internal_error (__FILE__, __LINE__,
2988                       _("failed internal consistency check"));
2989     }
2990
2991   return str;
2992 }
2993
2994 static char *
2995 octal2str (ULONGEST addr, int width)
2996 {
2997   unsigned long temp[3];
2998   char *str = get_cell ();
2999   int i = 0;
3000
3001   do
3002     {
3003       temp[i] = addr % (0100000 * 0100000);
3004       addr /= (0100000 * 0100000);
3005       i++;
3006       width -= 10;
3007     }
3008   while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
3009
3010   width += 10;
3011   if (width < 0)
3012     width = 0;
3013
3014   switch (i)
3015     {
3016     case 1:
3017       if (temp[0] == 0)
3018         xsnprintf (str, CELLSIZE, "%*o", width, 0);
3019       else
3020         xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
3021       break;
3022     case 2:
3023       xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
3024       break;
3025     case 3:
3026       xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
3027                  temp[2], temp[1], temp[0]);
3028       break;
3029     default:
3030       internal_error (__FILE__, __LINE__,
3031                       _("failed internal consistency check"));
3032     }
3033
3034   return str;
3035 }
3036
3037 char *
3038 pulongest (ULONGEST u)
3039 {
3040   return decimal2str ("", u, 0);
3041 }
3042
3043 char *
3044 plongest (LONGEST l)
3045 {
3046   if (l < 0)
3047     return decimal2str ("-", -l, 0);
3048   else
3049     return decimal2str ("", l, 0);
3050 }
3051
3052 /* Eliminate warning from compiler on 32-bit systems.  */
3053 static int thirty_two = 32;
3054
3055 char *
3056 phex (ULONGEST l, int sizeof_l)
3057 {
3058   char *str;
3059
3060   switch (sizeof_l)
3061     {
3062     case 8:
3063       str = get_cell ();
3064       xsnprintf (str, CELLSIZE, "%08lx%08lx",
3065                  (unsigned long) (l >> thirty_two),
3066                  (unsigned long) (l & 0xffffffff));
3067       break;
3068     case 4:
3069       str = get_cell ();
3070       xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
3071       break;
3072     case 2:
3073       str = get_cell ();
3074       xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
3075       break;
3076     default:
3077       str = phex (l, sizeof (l));
3078       break;
3079     }
3080
3081   return str;
3082 }
3083
3084 char *
3085 phex_nz (ULONGEST l, int sizeof_l)
3086 {
3087   char *str;
3088
3089   switch (sizeof_l)
3090     {
3091     case 8:
3092       {
3093         unsigned long high = (unsigned long) (l >> thirty_two);
3094
3095         str = get_cell ();
3096         if (high == 0)
3097           xsnprintf (str, CELLSIZE, "%lx",
3098                      (unsigned long) (l & 0xffffffff));
3099         else
3100           xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3101                      (unsigned long) (l & 0xffffffff));
3102         break;
3103       }
3104     case 4:
3105       str = get_cell ();
3106       xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3107       break;
3108     case 2:
3109       str = get_cell ();
3110       xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3111       break;
3112     default:
3113       str = phex_nz (l, sizeof (l));
3114       break;
3115     }
3116
3117   return str;
3118 }
3119
3120 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3121    in a static string.  Returns a pointer to this string.  */
3122 char *
3123 hex_string (LONGEST num)
3124 {
3125   char *result = get_cell ();
3126
3127   xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3128   return result;
3129 }
3130
3131 /* Converts a LONGEST number to a C-format hexadecimal literal and
3132    stores it in a static string.  Returns a pointer to this string
3133    that is valid until the next call.  The number is padded on the
3134    left with 0s to at least WIDTH characters.  */
3135 char *
3136 hex_string_custom (LONGEST num, int width)
3137 {
3138   char *result = get_cell ();
3139   char *result_end = result + CELLSIZE - 1;
3140   const char *hex = phex_nz (num, sizeof (num));
3141   int hex_len = strlen (hex);
3142
3143   if (hex_len > width)
3144     width = hex_len;
3145   if (width + 2 >= CELLSIZE)
3146     internal_error (__FILE__, __LINE__, _("\
3147 hex_string_custom: insufficient space to store result"));
3148
3149   strcpy (result_end - width - 2, "0x");
3150   memset (result_end - width, '0', width);
3151   strcpy (result_end - hex_len, hex);
3152   return result_end - width - 2;
3153 }
3154
3155 /* Convert VAL to a numeral in the given radix.  For
3156  * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3157  * otherwise VAL is interpreted as unsigned.  If WIDTH is supplied, 
3158  * it is the minimum width (0-padded if needed).  USE_C_FORMAT means
3159  * to use C format in all cases.  If it is false, then 'x' 
3160  * and 'o' formats do not include a prefix (0x or leading 0).  */
3161
3162 char *
3163 int_string (LONGEST val, int radix, int is_signed, int width, 
3164             int use_c_format)
3165 {
3166   switch (radix) 
3167     {
3168     case 16:
3169       {
3170         char *result;
3171
3172         if (width == 0)
3173           result = hex_string (val);
3174         else
3175           result = hex_string_custom (val, width);
3176         if (! use_c_format)
3177           result += 2;
3178         return result;
3179       }
3180     case 10:
3181       {
3182         if (is_signed && val < 0)
3183           return decimal2str ("-", -val, width);
3184         else
3185           return decimal2str ("", val, width);
3186       }
3187     case 8:
3188       {
3189         char *result = octal2str (val, width);
3190
3191         if (use_c_format || val == 0)
3192           return result;
3193         else
3194           return result + 1;
3195       }
3196     default:
3197       internal_error (__FILE__, __LINE__,
3198                       _("failed internal consistency check"));
3199     }
3200 }       
3201
3202 /* Convert a CORE_ADDR into a string.  */
3203 const char *
3204 core_addr_to_string (const CORE_ADDR addr)
3205 {
3206   char *str = get_cell ();
3207
3208   strcpy (str, "0x");
3209   strcat (str, phex (addr, sizeof (addr)));
3210   return str;
3211 }
3212
3213 const char *
3214 core_addr_to_string_nz (const CORE_ADDR addr)
3215 {
3216   char *str = get_cell ();
3217
3218   strcpy (str, "0x");
3219   strcat (str, phex_nz (addr, sizeof (addr)));
3220   return str;
3221 }
3222
3223 /* Convert a string back into a CORE_ADDR.  */
3224 CORE_ADDR
3225 string_to_core_addr (const char *my_string)
3226 {
3227   CORE_ADDR addr = 0;
3228
3229   if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3230     {
3231       /* Assume that it is in hex.  */
3232       int i;
3233
3234       for (i = 2; my_string[i] != '\0'; i++)
3235         {
3236           if (isdigit (my_string[i]))
3237             addr = (my_string[i] - '0') + (addr * 16);
3238           else if (isxdigit (my_string[i]))
3239             addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3240           else
3241             error (_("invalid hex \"%s\""), my_string);
3242         }
3243     }
3244   else
3245     {
3246       /* Assume that it is in decimal.  */
3247       int i;
3248
3249       for (i = 0; my_string[i] != '\0'; i++)
3250         {
3251           if (isdigit (my_string[i]))
3252             addr = (my_string[i] - '0') + (addr * 10);
3253           else
3254             error (_("invalid decimal \"%s\""), my_string);
3255         }
3256     }
3257
3258   return addr;
3259 }
3260
3261 const char *
3262 host_address_to_string (const void *addr)
3263 {
3264   char *str = get_cell ();
3265
3266   xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3267   return str;
3268 }
3269
3270 char *
3271 gdb_realpath (const char *filename)
3272 {
3273   /* Method 1: The system has a compile time upper bound on a filename
3274      path.  Use that and realpath() to canonicalize the name.  This is
3275      the most common case.  Note that, if there isn't a compile time
3276      upper bound, you want to avoid realpath() at all costs.  */
3277 #if defined(HAVE_REALPATH)
3278   {
3279 # if defined (PATH_MAX)
3280     char buf[PATH_MAX];
3281 #  define USE_REALPATH
3282 # elif defined (MAXPATHLEN)
3283     char buf[MAXPATHLEN];
3284 #  define USE_REALPATH
3285 # endif
3286 # if defined (USE_REALPATH)
3287     const char *rp = realpath (filename, buf);
3288
3289     if (rp == NULL)
3290       rp = filename;
3291     return xstrdup (rp);
3292 # endif
3293   }
3294 #endif /* HAVE_REALPATH */
3295
3296   /* Method 2: The host system (i.e., GNU) has the function
3297      canonicalize_file_name() which malloc's a chunk of memory and
3298      returns that, use that.  */
3299 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3300   {
3301     char *rp = canonicalize_file_name (filename);
3302
3303     if (rp == NULL)
3304       return xstrdup (filename);
3305     else
3306       return rp;
3307   }
3308 #endif
3309
3310   /* FIXME: cagney/2002-11-13:
3311
3312      Method 2a: Use realpath() with a NULL buffer.  Some systems, due
3313      to the problems described in method 3, have modified their
3314      realpath() implementation so that it will allocate a buffer when
3315      NULL is passed in.  Before this can be used, though, some sort of
3316      configure time test would need to be added.  Otherwize the code
3317      will likely core dump.  */
3318
3319   /* Method 3: Now we're getting desperate!  The system doesn't have a
3320      compile time buffer size and no alternative function.  Query the
3321      OS, using pathconf(), for the buffer limit.  Care is needed
3322      though, some systems do not limit PATH_MAX (return -1 for
3323      pathconf()) making it impossible to pass a correctly sized buffer
3324      to realpath() (it could always overflow).  On those systems, we
3325      skip this.  */
3326 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3327   {
3328     /* Find out the max path size.  */
3329     long path_max = pathconf ("/", _PC_PATH_MAX);
3330
3331     if (path_max > 0)
3332       {
3333         /* PATH_MAX is bounded.  */
3334         char *buf = alloca (path_max);
3335         char *rp = realpath (filename, buf);
3336
3337         return xstrdup (rp ? rp : filename);
3338       }
3339   }
3340 #endif
3341
3342   /* The MS Windows method.  If we don't have realpath, we assume we
3343      don't have symlinks and just canonicalize to a Windows absolute
3344      path.  GetFullPath converts ../ and ./ in relative paths to
3345      absolute paths, filling in current drive if one is not given
3346      or using the current directory of a specified drive (eg, "E:foo").
3347      It also converts all forward slashes to back slashes.  */
3348   /* The file system is case-insensitive but case-preserving.
3349      So we do not lowercase the path.  Otherwise, we might not
3350      be able to display the original casing in a given path.  */
3351 #if defined (_WIN32)
3352   {
3353     char buf[MAX_PATH];
3354     DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
3355
3356     if (len > 0 && len < MAX_PATH)
3357       return xstrdup (buf);
3358   }
3359 #endif
3360
3361   /* This system is a lost cause, just dup the buffer.  */
3362   return xstrdup (filename);
3363 }
3364
3365 /* Return a copy of FILENAME, with its directory prefix canonicalized
3366    by gdb_realpath.  */
3367
3368 char *
3369 xfullpath (const char *filename)
3370 {
3371   const char *base_name = lbasename (filename);
3372   char *dir_name;
3373   char *real_path;
3374   char *result;
3375
3376   /* Extract the basename of filename, and return immediately 
3377      a copy of filename if it does not contain any directory prefix.  */
3378   if (base_name == filename)
3379     return xstrdup (filename);
3380
3381   dir_name = alloca ((size_t) (base_name - filename + 2));
3382   /* Allocate enough space to store the dir_name + plus one extra
3383      character sometimes needed under Windows (see below), and
3384      then the closing \000 character.  */
3385   strncpy (dir_name, filename, base_name - filename);
3386   dir_name[base_name - filename] = '\000';
3387
3388 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3389   /* We need to be careful when filename is of the form 'd:foo', which
3390      is equivalent of d:./foo, which is totally different from d:/foo.  */
3391   if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3392     {
3393       dir_name[2] = '.';
3394       dir_name[3] = '\000';
3395     }
3396 #endif
3397
3398   /* Canonicalize the directory prefix, and build the resulting
3399      filename.  If the dirname realpath already contains an ending
3400      directory separator, avoid doubling it.  */
3401   real_path = gdb_realpath (dir_name);
3402   if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3403     result = concat (real_path, base_name, (char *) NULL);
3404   else
3405     result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3406
3407   xfree (real_path);
3408   return result;
3409 }
3410
3411
3412 /* This is the 32-bit CRC function used by the GNU separate debug
3413    facility.  An executable may contain a section named
3414    .gnu_debuglink, which holds the name of a separate executable file
3415    containing its debug info, and a checksum of that file's contents,
3416    computed using this function.  */
3417 unsigned long
3418 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3419 {
3420   static const unsigned int crc32_table[256] = {
3421     0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3422     0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3423     0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3424     0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3425     0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3426     0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3427     0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3428     0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3429     0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3430     0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3431     0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3432     0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3433     0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3434     0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3435     0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3436     0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3437     0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3438     0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3439     0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3440     0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3441     0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3442     0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3443     0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3444     0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3445     0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3446     0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3447     0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3448     0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3449     0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3450     0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3451     0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3452     0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3453     0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3454     0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3455     0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3456     0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3457     0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3458     0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3459     0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3460     0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3461     0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3462     0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3463     0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3464     0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3465     0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3466     0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3467     0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3468     0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3469     0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3470     0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3471     0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3472     0x2d02ef8d
3473   };
3474   unsigned char *end;
3475
3476   crc = ~crc & 0xffffffff;
3477   for (end = buf + len; buf < end; ++buf)
3478     crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3479   return ~crc & 0xffffffff;
3480 }
3481
3482 ULONGEST
3483 align_up (ULONGEST v, int n)
3484 {
3485   /* Check that N is really a power of two.  */
3486   gdb_assert (n && (n & (n-1)) == 0);
3487   return (v + n - 1) & -n;
3488 }
3489
3490 ULONGEST
3491 align_down (ULONGEST v, int n)
3492 {
3493   /* Check that N is really a power of two.  */
3494   gdb_assert (n && (n & (n-1)) == 0);
3495   return (v & -n);
3496 }
3497
3498 /* Allocation function for the libiberty hash table which uses an
3499    obstack.  The obstack is passed as DATA.  */
3500
3501 void *
3502 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3503 {
3504   unsigned int total = size * count;
3505   void *ptr = obstack_alloc ((struct obstack *) data, total);
3506
3507   memset (ptr, 0, total);
3508   return ptr;
3509 }
3510
3511 /* Trivial deallocation function for the libiberty splay tree and hash
3512    table - don't deallocate anything.  Rely on later deletion of the
3513    obstack.  DATA will be the obstack, although it is not needed
3514    here.  */
3515
3516 void
3517 dummy_obstack_deallocate (void *object, void *data)
3518 {
3519   return;
3520 }
3521
3522 /* The bit offset of the highest byte in a ULONGEST, for overflow
3523    checking.  */
3524
3525 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3526
3527 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3528    where 2 <= BASE <= 36.  */
3529
3530 static int
3531 is_digit_in_base (unsigned char digit, int base)
3532 {
3533   if (!isalnum (digit))
3534     return 0;
3535   if (base <= 10)
3536     return (isdigit (digit) && digit < base + '0');
3537   else
3538     return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3539 }
3540
3541 static int
3542 digit_to_int (unsigned char c)
3543 {
3544   if (isdigit (c))
3545     return c - '0';
3546   else
3547     return tolower (c) - 'a' + 10;
3548 }
3549
3550 /* As for strtoul, but for ULONGEST results.  */
3551
3552 ULONGEST
3553 strtoulst (const char *num, const char **trailer, int base)
3554 {
3555   unsigned int high_part;
3556   ULONGEST result;
3557   int minus = 0;
3558   int i = 0;
3559
3560   /* Skip leading whitespace.  */
3561   while (isspace (num[i]))
3562     i++;
3563
3564   /* Handle prefixes.  */
3565   if (num[i] == '+')
3566     i++;
3567   else if (num[i] == '-')
3568     {
3569       minus = 1;
3570       i++;
3571     }
3572
3573   if (base == 0 || base == 16)
3574     {
3575       if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3576         {
3577           i += 2;
3578           if (base == 0)
3579             base = 16;
3580         }
3581     }
3582
3583   if (base == 0 && num[i] == '0')
3584     base = 8;
3585
3586   if (base == 0)
3587     base = 10;
3588
3589   if (base < 2 || base > 36)
3590     {
3591       errno = EINVAL;
3592       return 0;
3593     }
3594
3595   result = high_part = 0;
3596   for (; is_digit_in_base (num[i], base); i += 1)
3597     {
3598       result = result * base + digit_to_int (num[i]);
3599       high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3600       result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3601       if (high_part > 0xff)
3602         {
3603           errno = ERANGE;
3604           result = ~ (ULONGEST) 0;
3605           high_part = 0;
3606           minus = 0;
3607           break;
3608         }
3609     }
3610
3611   if (trailer != NULL)
3612     *trailer = &num[i];
3613
3614   result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3615   if (minus)
3616     return -result;
3617   else
3618     return result;
3619 }
3620
3621 /* Simple, portable version of dirname that does not modify its
3622    argument.  */
3623
3624 char *
3625 ldirname (const char *filename)
3626 {
3627   const char *base = lbasename (filename);
3628   char *dirname;
3629
3630   while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3631     --base;
3632
3633   if (base == filename)
3634     return NULL;
3635
3636   dirname = xmalloc (base - filename + 2);
3637   memcpy (dirname, filename, base - filename);
3638
3639   /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3640      create "d:./bar" later instead of the (different) "d:/bar".  */
3641   if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3642       && !IS_DIR_SEPARATOR (filename[0]))
3643     dirname[base++ - filename] = '.';
3644
3645   dirname[base - filename] = '\0';
3646   return dirname;
3647 }
3648
3649 /* Call libiberty's buildargv, and return the result.
3650    If buildargv fails due to out-of-memory, call nomem.
3651    Therefore, the returned value is guaranteed to be non-NULL,
3652    unless the parameter itself is NULL.  */
3653
3654 char **
3655 gdb_buildargv (const char *s)
3656 {
3657   char **argv = buildargv (s);
3658
3659   if (s != NULL && argv == NULL)
3660     malloc_failure (0);
3661   return argv;
3662 }
3663
3664 int
3665 compare_positive_ints (const void *ap, const void *bp)
3666 {
3667   /* Because we know we're comparing two ints which are positive,
3668      there's no danger of overflow here.  */
3669   return * (int *) ap - * (int *) bp;
3670 }
3671
3672 /* String compare function for qsort.  */
3673
3674 int
3675 compare_strings (const void *arg1, const void *arg2)
3676 {
3677   const char **s1 = (const char **) arg1;
3678   const char **s2 = (const char **) arg2;
3679
3680   return strcmp (*s1, *s2);
3681 }
3682
3683 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3684 #define AMBIGUOUS_MESS2 \
3685   ".\nUse \"set gnutarget format-name\" to specify the format."
3686
3687 const char *
3688 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3689 {
3690   char *ret, *retp;
3691   int ret_len;
3692   char **p;
3693
3694   /* Check if errmsg just need simple return.  */
3695   if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3696     return bfd_errmsg (error_tag);
3697
3698   ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3699             + strlen (AMBIGUOUS_MESS2);
3700   for (p = matching; *p; p++)
3701     ret_len += strlen (*p) + 1;
3702   ret = xmalloc (ret_len + 1);
3703   retp = ret;
3704   make_cleanup (xfree, ret);
3705
3706   strcpy (retp, bfd_errmsg (error_tag));
3707   retp += strlen (retp);
3708
3709   strcpy (retp, AMBIGUOUS_MESS1);
3710   retp += strlen (retp);
3711
3712   for (p = matching; *p; p++)
3713     {
3714       sprintf (retp, " %s", *p);
3715       retp += strlen (retp);
3716     }
3717   xfree (matching);
3718
3719   strcpy (retp, AMBIGUOUS_MESS2);
3720
3721   return ret;
3722 }
3723
3724 /* Return ARGS parsed as a valid pid, or throw an error.  */
3725
3726 int
3727 parse_pid_to_attach (char *args)
3728 {
3729   unsigned long pid;
3730   char *dummy;
3731
3732   if (!args)
3733     error_no_arg (_("process-id to attach"));
3734
3735   dummy = args;
3736   pid = strtoul (args, &dummy, 0);
3737   /* Some targets don't set errno on errors, grrr!  */
3738   if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3739     error (_("Illegal process-id: %s."), args);
3740
3741   return pid;
3742 }
3743
3744 /* Helper for make_bpstat_clear_actions_cleanup.  */
3745
3746 static void
3747 do_bpstat_clear_actions_cleanup (void *unused)
3748 {
3749   bpstat_clear_actions ();
3750 }
3751
3752 /* Call bpstat_clear_actions for the case an exception is throw.  You should
3753    discard_cleanups if no exception is caught.  */
3754
3755 struct cleanup *
3756 make_bpstat_clear_actions_cleanup (void)
3757 {
3758   return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3759 }
3760
3761 /* Check for GCC >= 4.x according to the symtab->producer string.  Return minor
3762    version (x) of 4.x in such case.  If it is not GCC or it is GCC older than
3763    4.x return -1.  If it is GCC 5.x or higher return INT_MAX.  */
3764
3765 int
3766 producer_is_gcc_ge_4 (const char *producer)
3767 {
3768   const char *cs;
3769   int major, minor;
3770
3771   if (producer == NULL)
3772     {
3773       /* For unknown compilers expect their behavior is not compliant.  For GCC
3774          this case can also happen for -gdwarf-4 type units supported since
3775          gcc-4.5.  */
3776
3777       return -1;
3778     }
3779
3780   /* Skip any identifier after "GNU " - such as "C++" or "Java".  */
3781
3782   if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3783     {
3784       /* For non-GCC compilers expect their behavior is not compliant.  */
3785
3786       return -1;
3787     }
3788   cs = &producer[strlen ("GNU ")];
3789   while (*cs && !isdigit (*cs))
3790     cs++;
3791   if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3792     {
3793       /* Not recognized as GCC.  */
3794
3795       return -1;
3796     }
3797
3798   if (major < 4)
3799     return -1;
3800   if (major > 4)
3801     return INT_MAX;
3802   return minor;
3803 }
3804
3805 #ifdef HAVE_WAITPID
3806
3807 #ifdef SIGALRM
3808
3809 /* SIGALRM handler for waitpid_with_timeout.  */
3810
3811 static void
3812 sigalrm_handler (int signo)
3813 {
3814   /* Nothing to do.  */
3815 }
3816
3817 #endif
3818
3819 /* Wrapper to wait for child PID to die with TIMEOUT.
3820    TIMEOUT is the time to stop waiting in seconds.
3821    If TIMEOUT is zero, pass WNOHANG to waitpid.
3822    Returns PID if it was successfully waited for, otherwise -1.
3823
3824    Timeouts are currently implemented with alarm and SIGALRM.
3825    If the host does not support them, this waits "forever".
3826    It would be odd though for a host to have waitpid and not SIGALRM.  */
3827
3828 pid_t
3829 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3830 {
3831   pid_t waitpid_result;
3832
3833   gdb_assert (pid > 0);
3834   gdb_assert (timeout >= 0);
3835
3836   if (timeout > 0)
3837     {
3838 #ifdef SIGALRM
3839 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3840       struct sigaction sa, old_sa;
3841
3842       sa.sa_handler = sigalrm_handler;
3843       sigemptyset (&sa.sa_mask);
3844       sa.sa_flags = 0;
3845       sigaction (SIGALRM, &sa, &old_sa);
3846 #else
3847       void (*ofunc) ();
3848
3849       ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3850 #endif
3851
3852       alarm (timeout);
3853 #endif
3854
3855       waitpid_result = waitpid (pid, status, 0);
3856
3857 #ifdef SIGALRM
3858       alarm (0);
3859 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3860       sigaction (SIGALRM, &old_sa, NULL);
3861 #else
3862       signal (SIGALRM, ofunc);
3863 #endif
3864 #endif
3865     }
3866   else
3867     waitpid_result = waitpid (pid, status, WNOHANG);
3868
3869   if (waitpid_result == pid)
3870     return pid;
3871   else
3872     return -1;
3873 }
3874
3875 #endif /* HAVE_WAITPID */
3876
3877 /* Provide a prototype to silence -Wmissing-prototypes.  */
3878 extern initialize_file_ftype _initialize_utils;
3879
3880 void
3881 _initialize_utils (void)
3882 {
3883   add_internal_problem_command (&internal_error_problem);
3884   add_internal_problem_command (&internal_warning_problem);
3885 }