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 /* Return a null stream.  */
 193 extern struct ui_file *null_stream (void);
 194
 195 /* Set the screen dimensions to WIDTH and HEIGHT.  */
 196
 197 extern void set_screen_width_and_height (int width, int height);
 198
 199 /* More generic printf like operations.  Filtered versions may return
 200    non-locally on error.  */
 201
 202 extern void fputs_filtered (const char *, struct ui_file *);
 203
 204 extern void fputs_unfiltered (const char *, struct ui_file *);
 205
 206 extern int fputc_filtered (int c, struct ui_file *);
 207
 208 extern int fputc_unfiltered (int c, struct ui_file *);
 209
 210 extern int putchar_filtered (int c);
 211
 212 extern int putchar_unfiltered (int c);
 213
 214 extern void puts_filtered (const char *);
 215
 216 extern void puts_unfiltered (const char *);
 217
 218 extern void puts_filtered_tabular (char *string, int width, int right);
 219
 220 extern void puts_debug (char *prefix, char *string, char *suffix);
 221
 222 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 223
 224 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 225   ATTRIBUTE_PRINTF (2, 0);
 226
 227 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 228   ATTRIBUTE_PRINTF (2, 3);
 229
 230 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 231   ATTRIBUTE_PRINTF (3, 4);
 232
 233 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 234
 235 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 236
 237 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 238
 239 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 240   ATTRIBUTE_PRINTF (2, 0);
 241
 242 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 243   ATTRIBUTE_PRINTF (2, 3);
 244
 245 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 246
 247 extern void print_spaces (int, struct ui_file *);
 248
 249 extern void print_spaces_filtered (int, struct ui_file *);
 250
 251 extern char *n_spaces (int);
 252
 253 extern void fputstr_filtered (const char *str, int quotr,
 254                               struct ui_file * stream);
 255
 256 extern void fputstr_unfiltered (const char *str, int quotr,
 257                                 struct ui_file * stream);
 258
 259 extern void fputstrn_filtered (const char *str, int n, int quotr,
 260                                struct ui_file * stream);
 261
 262 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 263                                  struct ui_file * stream);
 264
 265 /* Return nonzero if filtered printing is initialized.  */
 266 extern int filtered_printing_initialized (void);
 267
 268 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 269 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 270
 271 /* Wrapper that avoids adding a pointless cast to all callers.  */
 272 #define gdb_print_host_address(ADDR, STREAM) \
 273   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 274
 275 /* Convert CORE_ADDR to string in platform-specific manner.
 276    This is usually formatted similar to 0x%lx.  */
 277 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 278
 279 /* Return a string representation in hexadecimal notation of ADDRESS,
 280    which is suitable for printing.  */
 281
 282 extern const char *print_core_address (struct gdbarch *gdbarch,
 283                                        CORE_ADDR address);
 284
 285 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 286 extern hashval_t core_addr_hash (const void *ap);
 287 extern int core_addr_eq (const void *ap, const void *bp);
 288
 289 extern CORE_ADDR string_to_core_addr (const char *my_string);
 290
 291 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 292                                      enum language, int);
 293
 294 extern void throw_perror_with_name (enum errors errcode, const char *string)
 295   ATTRIBUTE_NORETURN;
 296
 297 extern void perror_warning_with_name (const char *string);
 298
 299 extern void print_sys_errmsg (const char *, int);
 300 \f
 301 /* Warnings and error messages.  */
 302
 303 extern void (*deprecated_error_begin_hook) (void);
 304
 305 /* Message to be printed before the warning message, when a warning occurs.  */
 306
 307 extern char *warning_pre_print;
 308
 309 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 310
 311 extern void demangler_vwarning (const char *file, int line,
 312                                const char *, va_list ap)
 313      ATTRIBUTE_PRINTF (3, 0);
 314
 315 extern void demangler_warning (const char *file, int line,
 316                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 317
 318 \f
 319 /* Misc. utilities.  */
 320
 321 /* Allocation and deallocation functions for the libiberty hash table
 322    which use obstacks.  */
 323 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 324 void dummy_obstack_deallocate (void *object, void *data);
 325
 326 #ifdef HAVE_WAITPID
 327 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 328 #endif
 329
 330 extern int producer_is_gcc_ge_4 (const char *producer);
 331 extern int producer_is_gcc (const char *producer, int *major, int *minor);
 332
 333 extern int myread (int, char *, int);
 334
 335 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
 336    power of 2).  Round up/down when necessary.  Examples of correct
 337    use include:
 338
 339    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
 340    write_memory (addr, value, len);
 341    addr += len;
 342
 343    and:
 344
 345    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
 346    write_memory (sp, value, len);
 347
 348    Note that uses such as:
 349
 350    write_memory (addr, value, len);
 351    addr += align_up (len, 8);
 352
 353    and:
 354
 355    sp -= align_up (len, 8);
 356    write_memory (sp, value, len);
 357
 358    are typically not correct as they don't ensure that the address (SP
 359    or ADDR) is correctly aligned (relying on previous alignment to
 360    keep things right).  This is also why the methods are called
 361    "align_..." instead of "round_..." as the latter reads better with
 362    this incorrect coding style.  */
 363
 364 extern ULONGEST align_up (ULONGEST v, int n);
 365 extern ULONGEST align_down (ULONGEST v, int n);
 366
 367 /* Resource limits used by getrlimit and setrlimit.  */
 368
 369 enum resource_limit_kind
 370   {
 371     LIMIT_CUR,
 372     LIMIT_MAX
 373   };
 374
 375 /* Check whether GDB will be able to dump core using the dump_core
 376    function.  Returns zero if GDB cannot or should not dump core.
 377    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 378    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 379
 380 extern int can_dump_core (enum resource_limit_kind limit_kind);
 381
 382 /* Print a warning that we cannot dump core.  */
 383
 384 extern void warn_cant_dump_core (const char *reason);
 385
 386 /* Dump core trying to increase the core soft limit to hard limit
 387    first.  */
 388
 389 extern void dump_core (void);
 390
 391 /* Return the hex string form of LENGTH bytes of DATA.
 392    Space for the result is malloc'd, caller must free.  */
 393
 394 extern char *make_hex_string (const gdb_byte *data, size_t length);
 395
 396 #endif /* UTILS_H */