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