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