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