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-2023 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 "gdbsupport/array-view.h" 26 #include "gdbsupport/scoped_restore.h" 27 #include <chrono> 28 29 #ifdef HAVE_LIBXXHASH 30 #include <xxhash.h> 31 #endif 32 33 struct completion_match_for_lcd; 34 class compiled_regex; 35 36 /* String utilities. */ 37 38 extern bool sevenbit_strings; 39 40 /* Modes of operation for strncmp_iw_with_mode. */ 41 42 enum class strncmp_iw_mode 43 { 44 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any 45 differences in whitespace. Returns 0 if they match, non-zero if 46 they don't (slightly different than strcmp()'s range of return 47 values). */ 48 NORMAL, 49 50 /* Like NORMAL, but also apply the strcmp_iw hack. I.e., 51 string1=="FOO(PARAMS)" matches string2=="FOO". */ 52 MATCH_PARAMS, 53 }; 54 55 /* Helper for strcmp_iw and strncmp_iw. Exported so that languages 56 can implement both NORMAL and MATCH_PARAMS variants in a single 57 function and defer part of the work to strncmp_iw_with_mode. 58 59 LANGUAGE is used to implement some context-sensitive 60 language-specific comparisons. For example, for C++, 61 "string1=operator()" should not match "string2=operator" even in 62 MATCH_PARAMS mode. 63 64 MATCH_FOR_LCD is passed down so that the function can mark parts of 65 the symbol name as ignored for completion matching purposes (e.g., 66 to handle abi tags). If IGNORE_TEMPLATE_PARAMS is true, all template 67 parameter lists will be ignored when language is C++. */ 68 69 extern int strncmp_iw_with_mode 70 (const char *string1, const char *string2, size_t string2_len, 71 strncmp_iw_mode mode, enum language language, 72 completion_match_for_lcd *match_for_lcd = NULL, 73 bool ignore_template_params = false); 74 75 /* Do a strncmp() type operation on STRING1 and STRING2, ignoring any 76 differences in whitespace. STRING2_LEN is STRING2's length. 77 Returns 0 if STRING1 matches STRING2_LEN characters of STRING2, 78 non-zero otherwise (slightly different than strncmp()'s range of 79 return values). Note: passes language_minimal to 80 strncmp_iw_with_mode, and should therefore be avoided if a more 81 suitable language is available. */ 82 extern int strncmp_iw (const char *string1, const char *string2, 83 size_t string2_len); 84 85 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any 86 differences in whitespace. Returns 0 if they match, non-zero if 87 they don't (slightly different than strcmp()'s range of return 88 values). 89 90 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO". 91 This "feature" is useful when searching for matching C++ function 92 names (such as if the user types 'break FOO', where FOO is a 93 mangled C++ function). 94 95 Note: passes language_minimal to strncmp_iw_with_mode, and should 96 therefore be avoided if a more suitable language is available. */ 97 extern int strcmp_iw (const char *string1, const char *string2); 98 99 extern int strcmp_iw_ordered (const char *, const char *); 100 101 /* Reset the prompt_for_continue clock. */ 102 void reset_prompt_for_continue_wait_time (void); 103 /* Return the time spent in prompt_for_continue. */ 104 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time (); 105 106 /* Parsing utilities. */ 107 108 extern int parse_pid_to_attach (const char *args); 109 110 extern int parse_escape (struct gdbarch *, const char **); 111 112 113 /* Cleanup utilities. */ 114 115 extern void init_page_info (void); 116 117 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size. 118 Restore when destroyed. */ 119 120 struct set_batch_flag_and_restore_page_info 121 { 122 public: 123 124 set_batch_flag_and_restore_page_info (); 125 ~set_batch_flag_and_restore_page_info (); 126 127 DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info); 128 129 private: 130 131 /* Note that this doesn't use scoped_restore, because it's important 132 to control the ordering of operations in the destruction, and it 133 was simpler to avoid introducing a new ad hoc class. */ 134 unsigned m_save_lines_per_page; 135 unsigned m_save_chars_per_line; 136 int m_save_batch_flag; 137 }; 138 139 140 /* Path utilities. */ 141 142 extern int gdb_filename_fnmatch (const char *pattern, const char *string, 143 int flags); 144 145 extern void substitute_path_component (char **stringp, const char *from, 146 const char *to); 147 148 std::string ldirname (const char *filename); 149 150 extern int count_path_elements (const char *path); 151 152 extern const char *strip_leading_path_elements (const char *path, int n); 153 154 /* GDB output, ui_file utilities. */ 155 156 struct ui_file; 157 158 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2); 159 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2); 160 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2); 161 162 extern void begin_line (void); 163 164 extern void wrap_here (int); 165 166 extern void reinitialize_more_filter (void); 167 168 /* Return the number of characters in a line. */ 169 170 extern int get_chars_per_line (); 171 172 extern bool pagination_enabled; 173 174 /* A flag indicating whether to timestamp debugging messages. */ 175 extern bool debug_timestamp; 176 177 extern struct ui_file **current_ui_gdb_stdout_ptr (void); 178 extern struct ui_file **current_ui_gdb_stdin_ptr (void); 179 extern struct ui_file **current_ui_gdb_stderr_ptr (void); 180 extern struct ui_file **current_ui_gdb_stdlog_ptr (void); 181 182 /* Flush STREAM. */ 183 extern void gdb_flush (struct ui_file *stream); 184 185 /* The current top level's ui_file streams. */ 186 187 /* Normal results */ 188 #define gdb_stdout (*current_ui_gdb_stdout_ptr ()) 189 /* Input stream */ 190 #define gdb_stdin (*current_ui_gdb_stdin_ptr ()) 191 /* Serious error notifications. This bypasses the pager, if one is in 192 use. */ 193 #define gdb_stderr (*current_ui_gdb_stderr_ptr ()) 194 /* Log/debug/trace messages that bypasses the pager, if one is in 195 use. */ 196 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ()) 197 198 /* Truly global ui_file streams. These are all defined in main.c. */ 199 200 /* Target output that should bypass the pager, if one is in use. */ 201 extern struct ui_file *gdb_stdtarg; 202 extern struct ui_file *gdb_stdtargerr; 203 extern struct ui_file *gdb_stdtargin; 204 205 /* Set the screen dimensions to WIDTH and HEIGHT. */ 206 207 extern void set_screen_width_and_height (int width, int height); 208 209 /* Generic stdio-like operations. */ 210 211 extern void gdb_puts (const char *, struct ui_file *); 212 213 extern void gdb_putc (int c, struct ui_file *); 214 215 extern void gdb_putc (int c); 216 217 extern void gdb_puts (const char *); 218 219 extern void puts_tabular (char *string, int width, int right); 220 221 /* Generic printf-like operations. As an extension over plain 222 printf, these support some GDB-specific format specifiers. 223 Particularly useful here are the styling formatters: '%p[', '%p]' 224 and '%ps'. See ui_out::message for details. */ 225 226 extern void gdb_vprintf (const char *, va_list) ATTRIBUTE_PRINTF (1, 0); 227 228 extern void gdb_vprintf (struct ui_file *, const char *, va_list) 229 ATTRIBUTE_PRINTF (2, 0); 230 231 extern void gdb_printf (struct ui_file *, const char *, ...) 232 ATTRIBUTE_PRINTF (2, 3); 233 234 extern void gdb_printf (const char *, ...) ATTRIBUTE_PRINTF (1, 2); 235 236 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2); 237 238 extern void print_spaces (int, struct ui_file *); 239 240 extern const char *n_spaces (int); 241 242 /* Return nonzero if filtered printing is initialized. */ 243 extern int filtered_printing_initialized (void); 244 245 /* Like gdb_printf, but styles the output according to STYLE, 246 when appropriate. */ 247 248 extern void fprintf_styled (struct ui_file *stream, 249 const ui_file_style &style, 250 const char *fmt, 251 ...) 252 ATTRIBUTE_PRINTF (3, 4); 253 254 /* Like gdb_puts, but styles the output according to STYLE, when 255 appropriate. */ 256 257 extern void fputs_styled (const char *linebuffer, 258 const ui_file_style &style, 259 struct ui_file *stream); 260 261 /* Like fputs_styled, but uses highlight_style to highlight the 262 parts of STR that match HIGHLIGHT. */ 263 264 extern void fputs_highlighted (const char *str, const compiled_regex &highlight, 265 struct ui_file *stream); 266 267 /* Convert CORE_ADDR to string in platform-specific manner. 268 This is usually formatted similar to 0x%lx. */ 269 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr); 270 271 /* Return a string representation in hexadecimal notation of ADDRESS, 272 which is suitable for printing. */ 273 274 extern const char *print_core_address (struct gdbarch *gdbarch, 275 CORE_ADDR address); 276 277 extern CORE_ADDR string_to_core_addr (const char *my_string); 278 279 extern void fprintf_symbol (struct ui_file *, const char *, 280 enum language, int); 281 282 extern void perror_warning_with_name (const char *string); 283 284 extern void print_sys_errmsg (const char *, int); 285 286 /* Warnings and error messages. */ 287 288 extern void (*deprecated_error_begin_hook) (void); 289 290 /* Message to be printed before the warning message, when a warning occurs. */ 291 292 extern const char *warning_pre_print; 293 294 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN; 295 296 extern void demangler_vwarning (const char *file, int line, 297 const char *, va_list ap) 298 ATTRIBUTE_PRINTF (3, 0); 299 300 extern void demangler_warning (const char *file, int line, 301 const char *, ...) ATTRIBUTE_PRINTF (3, 4); 302 303 304 /* Misc. utilities. */ 305 306 #ifdef HAVE_WAITPID 307 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout); 308 #endif 309 310 extern int myread (int, char *, int); 311 312 /* Integer exponentiation: Return V1**V2, where both arguments 313 are integers. 314 315 Requires V1 != 0 if V2 < 0. 316 Returns 1 for 0 ** 0. */ 317 extern ULONGEST uinteger_pow (ULONGEST v1, LONGEST v2); 318 319 /* Resource limits used by getrlimit and setrlimit. */ 320 321 enum resource_limit_kind 322 { 323 LIMIT_CUR, 324 LIMIT_MAX 325 }; 326 327 /* Check whether GDB will be able to dump core using the dump_core 328 function. Returns zero if GDB cannot or should not dump core. 329 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected. 330 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */ 331 332 extern int can_dump_core (enum resource_limit_kind limit_kind); 333 334 /* Print a warning that we cannot dump core. */ 335 336 extern void warn_cant_dump_core (const char *reason); 337 338 /* Dump core trying to increase the core soft limit to hard limit 339 first. */ 340 341 extern void dump_core (void); 342 343 /* Copy NBITS bits from SOURCE to DEST starting at the given bit 344 offsets. Use the bit order as specified by BITS_BIG_ENDIAN. 345 Source and destination buffers must not overlap. */ 346 347 extern void copy_bitwise (gdb_byte *dest, ULONGEST dest_offset, 348 const gdb_byte *source, ULONGEST source_offset, 349 ULONGEST nbits, int bits_big_endian); 350 351 /* A fast hashing function. This can be used to hash data in a fast way 352 when the length is known. If no fast hashing library is available, falls 353 back to iterative_hash from libiberty. START_VALUE can be set to 354 continue hashing from a previous value. */ 355 356 static inline unsigned int 357 fast_hash (const void *ptr, size_t len, unsigned int start_value = 0) 358 { 359 #ifdef HAVE_LIBXXHASH 360 return XXH64 (ptr, len, start_value); 361 #else 362 return iterative_hash (ptr, len, start_value); 363 #endif 364 } 365 366 #endif /* UTILS_H */ 367