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