gdb/utils.h

   1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
   2                       for now.  */
   3 /* I/O, string, cleanup, and other random utilities for GDB.
   4    Copyright (C) 1986-2014 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef UTILS_H
  22 #define UTILS_H
  23
  24 #include "cleanups.h"
  25 #include "exceptions.h"
  26
  27 extern void initialize_utils (void);
  28
  29 /* String utilities.  */
  30
  31 extern int sevenbit_strings;
  32
  33 extern int strcmp_iw (const char *, const char *);
  34
  35 extern int strcmp_iw_ordered (const char *, const char *);
  36
  37 extern int streq (const char *, const char *);
  38
  39 extern int subset_compare (char *, char *);
  40
  41 ULONGEST strtoulst (const char *num, const char **trailer, int base);
  42
  43 int compare_positive_ints (const void *ap, const void *bp);
  44 int compare_strings (const void *ap, const void *bp);
  45
  46 /* This is defined in *-hdep.c, e.g., posix-hdep.c.  */
  47 extern char *safe_strerror (int);
  48
  49 /* A wrapper for bfd_errmsg to produce a more helpful error message
  50    in the case of bfd_error_file_ambiguously recognized.
  51    MATCHING, if non-NULL, is the corresponding argument to
  52    bfd_check_format_matches, and will be freed.  */
  53
  54 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
  55
  56 /* Reset the prompt_for_continue clock.  */
  57 void reset_prompt_for_continue_wait_time (void);
  58 /* Return the time spent in prompt_for_continue.  */
  59 struct timeval get_prompt_for_continue_wait_time (void);
  60 \f
  61 /* Parsing utilites.  */
  62
  63 extern int parse_pid_to_attach (const char *args);
  64
  65 extern int parse_escape (struct gdbarch *, const char **);
  66
  67 char **gdb_buildargv (const char *);
  68 \f
  69 /* Cleanup utilities.  */
  70
  71 extern struct cleanup *make_cleanup_freeargv (char **);
  72
  73 struct dyn_string;
  74 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
  75
  76 struct ui_file;
  77 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
  78
  79 struct ui_out;
  80 extern struct cleanup *
  81   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
  82
  83 struct section_addr_info;
  84 extern struct cleanup *(make_cleanup_free_section_addr_info
  85                         (struct section_addr_info *));
  86
  87 extern struct cleanup *make_cleanup_close (int fd);
  88
  89 extern struct cleanup *make_cleanup_fclose (FILE *file);
  90
  91 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
  92
  93 struct obstack;
  94 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
  95
  96 extern struct cleanup *make_cleanup_restore_integer (int *variable);
  97 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
  98
  99 struct target_ops;
 100 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 101
 102 extern struct cleanup *
 103   make_cleanup_restore_ui_file (struct ui_file **variable);
 104
 105 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 106 extern struct cleanup *make_cleanup_value_free (struct value *);
 107
 108 struct so_list;
 109 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
 110
 111 extern struct cleanup *make_cleanup_restore_current_language (void);
 112
 113 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
 114
 115 struct parser_state;
 116 extern struct cleanup *make_cleanup_clear_parser_state
 117   (struct parser_state **p);
 118
 119 extern void free_current_contents (void *);
 120
 121 extern void init_page_info (void);
 122
 123 extern struct cleanup *make_cleanup_restore_page_info (void);
 124 extern struct cleanup *
 125   set_batch_flag_and_make_cleanup_restore_page_info (void);
 126
 127 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 128 \f
 129 /* Path utilities.  */
 130
 131 extern char *gdb_realpath (const char *);
 132
 133 extern char *gdb_realpath_keepfile (const char *);
 134
 135 extern char *gdb_abspath (const char *);
 136
 137 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 138                                  int flags);
 139
 140 extern void substitute_path_component (char **stringp, const char *from,
 141                                        const char *to);
 142
 143 char *ldirname (const char *filename);
 144 \f
 145 /* GDB output, ui_file utilities.  */
 146
 147 struct ui_file;
 148
 149 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 150 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 151 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 152
 153 extern void begin_line (void);
 154
 155 extern void wrap_here (char *);
 156
 157 extern void reinitialize_more_filter (void);
 158
 159 extern int pagination_enabled;
 160
 161 /* Global ui_file streams.  These are all defined in main.c.  */
 162 /* Normal results */
 163 extern struct ui_file *gdb_stdout;
 164 /* Input stream */
 165 extern struct ui_file *gdb_stdin;
 166 /* Serious error notifications */
 167 extern struct ui_file *gdb_stderr;
 168 /* Log/debug/trace messages that should bypass normal stdout/stderr
 169    filtering.  For moment, always call this stream using
 170    *_unfiltered.  In the very near future that restriction shall be
 171    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 172 extern struct ui_file *gdb_stdlog;
 173 /* Target output that should bypass normal stdout/stderr filtering.
 174    For moment, always call this stream using *_unfiltered.  In the
 175    very near future that restriction shall be removed - either call
 176    shall be unfiltered.  (cagney 1999-07-02).  */
 177 extern struct ui_file *gdb_stdtarg;
 178 extern struct ui_file *gdb_stdtargerr;
 179 extern struct ui_file *gdb_stdtargin;
 180
 181 /* More generic printf like operations.  Filtered versions may return
 182    non-locally on error.  */
 183
 184 extern void fputs_filtered (const char *, struct ui_file *);
 185
 186 extern void fputs_unfiltered (const char *, struct ui_file *);
 187
 188 extern int fputc_filtered (int c, struct ui_file *);
 189
 190 extern int fputc_unfiltered (int c, struct ui_file *);
 191
 192 extern int putchar_filtered (int c);
 193
 194 extern int putchar_unfiltered (int c);
 195
 196 extern void puts_filtered (const char *);
 197
 198 extern void puts_unfiltered (const char *);
 199
 200 extern void puts_filtered_tabular (char *string, int width, int right);
 201
 202 extern void puts_debug (char *prefix, char *string, char *suffix);
 203
 204 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 205
 206 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 207   ATTRIBUTE_PRINTF (2, 0);
 208
 209 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 210   ATTRIBUTE_PRINTF (2, 3);
 211
 212 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 213   ATTRIBUTE_PRINTF (3, 4);
 214
 215 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 216
 217 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 218
 219 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 220
 221 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 222   ATTRIBUTE_PRINTF (2, 0);
 223
 224 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 225   ATTRIBUTE_PRINTF (2, 3);
 226
 227 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 228
 229 extern void print_spaces (int, struct ui_file *);
 230
 231 extern void print_spaces_filtered (int, struct ui_file *);
 232
 233 extern char *n_spaces (int);
 234
 235 extern void fputstr_filtered (const char *str, int quotr,
 236                               struct ui_file * stream);
 237
 238 extern void fputstr_unfiltered (const char *str, int quotr,
 239                                 struct ui_file * stream);
 240
 241 extern void fputstrn_filtered (const char *str, int n, int quotr,
 242                                struct ui_file * stream);
 243
 244 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 245                                  struct ui_file * stream);
 246
 247 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 248 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 249
 250 /* Convert CORE_ADDR to string in platform-specific manner.
 251    This is usually formatted similar to 0x%lx.  */
 252 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 253
 254 /* Return a string representation in hexadecimal notation of ADDRESS,
 255    which is suitable for printing.  */
 256
 257 extern const char *print_core_address (struct gdbarch *gdbarch,
 258                                        CORE_ADDR address);
 259
 260 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 261 extern hashval_t core_addr_hash (const void *ap);
 262 extern int core_addr_eq (const void *ap, const void *bp);
 263
 264 extern CORE_ADDR string_to_core_addr (const char *my_string);
 265
 266 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 267                                      enum language, int);
 268
 269 extern void throw_perror_with_name (enum errors errcode, const char *string)
 270   ATTRIBUTE_NORETURN;
 271
 272 extern void perror_warning_with_name (const char *string);
 273
 274 extern void print_sys_errmsg (const char *, int);
 275 \f
 276 /* Warnings and error messages.  */
 277
 278 extern void (*deprecated_error_begin_hook) (void);
 279
 280 /* Message to be printed before the warning message, when a warning occurs.  */
 281
 282 extern char *warning_pre_print;
 283
 284 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 285
 286 extern void internal_vwarning (const char *file, int line,
 287                                const char *, va_list ap)
 288      ATTRIBUTE_PRINTF (3, 0);
 289
 290 extern void internal_warning (const char *file, int line,
 291                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 292
 293 extern void demangler_vwarning (const char *file, int line,
 294                                const char *, va_list ap)
 295      ATTRIBUTE_PRINTF (3, 0);
 296
 297 extern void demangler_warning (const char *file, int line,
 298                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 299
 300 \f
 301 /* Misc. utilities.  */
 302
 303 /* Allocation and deallocation functions for the libiberty hash table
 304    which use obstacks.  */
 305 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 306 void dummy_obstack_deallocate (void *object, void *data);
 307
 308 #ifdef HAVE_WAITPID
 309 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 310 #endif
 311
 312 extern int producer_is_gcc_ge_4 (const char *producer);
 313
 314 extern int myread (int, char *, int);
 315
 316 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
 317    power of 2).  Round up/down when necessary.  Examples of correct
 318    use include:
 319
 320    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
 321    write_memory (addr, value, len);
 322    addr += len;
 323
 324    and:
 325
 326    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
 327    write_memory (sp, value, len);
 328
 329    Note that uses such as:
 330
 331    write_memory (addr, value, len);
 332    addr += align_up (len, 8);
 333
 334    and:
 335
 336    sp -= align_up (len, 8);
 337    write_memory (sp, value, len);
 338
 339    are typically not correct as they don't ensure that the address (SP
 340    or ADDR) is correctly aligned (relying on previous alignment to
 341    keep things right).  This is also why the methods are called
 342    "align_..." instead of "round_..." as the latter reads better with
 343    this incorrect coding style.  */
 344
 345 extern ULONGEST align_up (ULONGEST v, int n);
 346 extern ULONGEST align_down (ULONGEST v, int n);
 347
 348 /* Sign extend VALUE.  BIT is the (1-based) index of the bit in VALUE
 349    to sign-extend.  */
 350
 351 extern LONGEST gdb_sign_extend (LONGEST value, int bit);
 352
 353 /* Resource limits used by getrlimit and setrlimit.  */
 354
 355 enum resource_limit_kind
 356   {
 357     LIMIT_CUR,
 358     LIMIT_MAX
 359   };
 360
 361 /* Check whether GDB will be able to dump core using the dump_core
 362    function.  Returns zero if GDB cannot or should not dump core.
 363    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 364    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 365
 366 extern int can_dump_core (enum resource_limit_kind limit_kind);
 367
 368 /* Print a warning that we cannot dump core.  */
 369
 370 extern void warn_cant_dump_core (const char *reason);
 371
 372 /* Dump core trying to increase the core soft limit to hard limit
 373    first.  */
 374
 375 extern void dump_core (void);
 376
 377 #endif /* UTILS_H */