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