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