remote: allow aborting long operations (e.g., file transfers)
[external/binutils.git] / gdb / defs.h
1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
2                       for now.  */
3 /* Basic, host-specific, and target-specific definitions for GDB.
4    Copyright (C) 1986-2015 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 DEFS_H
22 #define DEFS_H
23
24 #ifdef GDBSERVER
25 #  error gdbserver should not include gdb/defs.h
26 #endif
27
28 #include "common-defs.h"
29
30 #include <sys/types.h>
31 #include <limits.h>
32
33 /* The libdecnumber library, on which GDB depends, includes a header file
34    called gstdint.h instead of relying directly on stdint.h.  GDB, on the
35    other hand, includes stdint.h directly, relying on the fact that gnulib
36    generates a copy if the system doesn't provide one or if it is missing
37    some features.  Unfortunately, gstdint.h and stdint.h cannot be included
38    at the same time, which may happen when we include a file from
39    libdecnumber.
40
41    The following macro definition effectively prevents the inclusion of
42    gstdint.h, as all the definitions it provides are guarded against
43    the GCC_GENERATED_STDINT_H macro.  We already have gnulib/stdint.h
44    included, so it's ok to blank out gstdint.h.  */
45 #define GCC_GENERATED_STDINT_H 1
46
47 #include <unistd.h>
48
49 #include <fcntl.h>
50
51 #include "gdb_wchar.h"
52
53 #include "ui-file.h"
54
55 #include "host-defs.h"
56
57 /* Scope types enumerator.  List the types of scopes the compiler will
58    accept.  */
59
60 enum compile_i_scope_types
61   {
62     COMPILE_I_INVALID_SCOPE,
63
64     /* A simple scope.  Wrap an expression into a simple scope that
65        takes no arguments, returns no value, and uses the generic
66        function name "_gdb_expr". */
67
68     COMPILE_I_SIMPLE_SCOPE,
69
70     /* Do not wrap the expression,
71        it has to provide function "_gdb_expr" on its own.  */
72     COMPILE_I_RAW_SCOPE,
73
74     /* A printable expression scope.  Wrap an expression into a scope
75        suitable for the "compile print" command.  It uses the generic
76        function name "_gdb_expr".  COMPILE_I_PRINT_ADDRESS_SCOPE variant
77        is the usual one, taking address of the object.
78        COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
79        name already specifies its address.  See get_out_value_type.  */
80     COMPILE_I_PRINT_ADDRESS_SCOPE,
81     COMPILE_I_PRINT_VALUE_SCOPE,
82   };
83
84 /* Just in case they're not defined in stdio.h.  */
85
86 #ifndef SEEK_SET
87 #define SEEK_SET 0
88 #endif
89 #ifndef SEEK_CUR
90 #define SEEK_CUR 1
91 #endif
92
93 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
94    It is used as an access modifier in calls to open(), where it acts
95    similarly to the "b" character in fopen()'s MODE argument.  On Posix
96    platforms it should be a no-op, so it is defined as 0 here.  This 
97    ensures that the symbol may be used freely elsewhere in gdb.  */
98
99 #ifndef O_BINARY
100 #define O_BINARY 0
101 #endif
102
103 #include "hashtab.h"
104
105 #ifndef min
106 #define min(a, b) ((a) < (b) ? (a) : (b))
107 #endif
108 #ifndef max
109 #define max(a, b) ((a) > (b) ? (a) : (b))
110 #endif
111
112 /* * Enable dbx commands if set.  */
113 extern int dbx_commands;
114
115 /* * System root path, used to find libraries etc.  */
116 extern char *gdb_sysroot;
117
118 /* * GDB datadir, used to store data files.  */
119 extern char *gdb_datadir;
120
121 /* * If non-NULL, the possibly relocated path to python's "lib" directory
122    specified with --with-python.  */
123 extern char *python_libdir;
124
125 /* * Search path for separate debug files.  */
126 extern char *debug_file_directory;
127
128 /* GDB has two methods for handling SIGINT.  When immediate_quit is
129    nonzero, a SIGINT results in an immediate longjmp out of the signal
130    handler.  Otherwise, SIGINT simply sets a flag; code that might
131    take a long time, and which ought to be interruptible, checks this
132    flag using the QUIT macro.
133
134    These functions use the extension_language_ops API to allow extension
135    language(s) and GDB SIGINT handling to coexist seamlessly.  */
136
137 /* * Clear the quit flag.  */
138 extern void clear_quit_flag (void);
139 /* * Evaluate to non-zero if the quit flag is set, zero otherwise.  This
140    will clear the quit flag as a side effect.  */
141 extern int check_quit_flag (void);
142 /* * Set the quit flag.  */
143 extern void set_quit_flag (void);
144
145 /* Flag that function quit should call quit_force.  */
146 extern volatile int sync_quit_force_run;
147
148 extern int immediate_quit;
149
150 extern void quit (void);
151
152 /* Helper for the QUIT macro.  */
153
154 extern void maybe_quit (void);
155
156 /* Check whether a Ctrl-C was typed, and if so, call quit.  The target
157    is given a chance to process the Ctrl-C.  E.g., it may detect that
158    repeated Ctrl-C requests were issued, and choose to close the
159    connection.  */
160 #define QUIT maybe_quit ()
161
162 /* * Languages represented in the symbol table and elsewhere.
163    This should probably be in language.h, but since enum's can't
164    be forward declared to satisfy opaque references before their
165    actual definition, needs to be here.  */
166
167 enum language
168   {
169     language_unknown,           /* Language not known */
170     language_auto,              /* Placeholder for automatic setting */
171     language_c,                 /* C */
172     language_cplus,             /* C++ */
173     language_d,                 /* D */
174     language_go,                /* Go */
175     language_objc,              /* Objective-C */
176     language_java,              /* Java */
177     language_fortran,           /* Fortran */
178     language_m2,                /* Modula-2 */
179     language_asm,               /* Assembly language */
180     language_pascal,            /* Pascal */
181     language_ada,               /* Ada */
182     language_opencl,            /* OpenCL */
183     language_minimal,           /* All other languages, minimal support only */
184     nr_languages
185   };
186
187 /* The number of bits needed to represent all languages, with enough
188    padding to allow for reasonable growth.  */
189 #define LANGUAGE_BITS 5
190 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
191
192 enum precision_type
193   {
194     single_precision,
195     double_precision,
196     unspecified_precision
197   };
198
199 /* * A generic, not quite boolean, enumeration.  This is used for
200    set/show commands in which the options are on/off/automatic.  */
201 enum auto_boolean
202 {
203   AUTO_BOOLEAN_TRUE,
204   AUTO_BOOLEAN_FALSE,
205   AUTO_BOOLEAN_AUTO
206 };
207
208 /* * Potential ways that a function can return a value of a given
209    type.  */
210
211 enum return_value_convention
212 {
213   /* * Where the return value has been squeezed into one or more
214      registers.  */
215   RETURN_VALUE_REGISTER_CONVENTION,
216   /* * Commonly known as the "struct return convention".  The caller
217      passes an additional hidden first parameter to the caller.  That
218      parameter contains the address at which the value being returned
219      should be stored.  While typically, and historically, used for
220      large structs, this is convention is applied to values of many
221      different types.  */
222   RETURN_VALUE_STRUCT_CONVENTION,
223   /* * Like the "struct return convention" above, but where the ABI
224      guarantees that the called function stores the address at which
225      the value being returned is stored in a well-defined location,
226      such as a register or memory slot in the stack frame.  Don't use
227      this if the ABI doesn't explicitly guarantees this.  */
228   RETURN_VALUE_ABI_RETURNS_ADDRESS,
229   /* * Like the "struct return convention" above, but where the ABI
230      guarantees that the address at which the value being returned is
231      stored will be available in a well-defined location, such as a
232      register or memory slot in the stack frame.  Don't use this if
233      the ABI doesn't explicitly guarantees this.  */
234   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
235 };
236
237 /* Needed for various prototypes */
238
239 struct symtab;
240 struct breakpoint;
241 struct frame_info;
242 struct gdbarch;
243 struct value;
244
245 /* From main.c.  */
246
247 /* This really belong in utils.c (path-utils.c?), but it references some
248    globals that are currently only available to main.c.  */
249 extern char *relocate_gdb_directory (const char *initial, int flag);
250
251 \f
252 /* Annotation stuff.  */
253
254 extern int annotation_level;    /* in stack.c */
255 \f
256
257 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
258    "const char *" in unistd.h, so we can't declare the argument
259    as "char *".  */
260
261 EXTERN_C char *re_comp (const char *);
262
263 /* From symfile.c */
264
265 extern void symbol_file_command (char *, int);
266
267 /* * Remote targets may wish to use this as their load function.  */
268 extern void generic_load (const char *name, int from_tty);
269
270 /* * Report on STREAM the performance of memory transfer operation,
271    such as 'load'.
272    @param DATA_COUNT is the number of bytes transferred.
273    @param WRITE_COUNT is the number of separate write operations, or 0,
274    if that information is not available.
275    @param START_TIME is the time at which an operation was started.
276    @param END_TIME is the time at which an operation ended.  */
277 struct timeval;
278 extern void print_transfer_performance (struct ui_file *stream,
279                                         unsigned long data_count,
280                                         unsigned long write_count,
281                                         const struct timeval *start_time,
282                                         const struct timeval *end_time);
283
284 /* From top.c */
285
286 typedef void initialize_file_ftype (void);
287
288 extern char *gdb_readline (const char *);
289
290 extern char *gdb_readline_wrapper (const char *);
291
292 extern char *command_line_input (const char *, int, char *);
293
294 extern void print_prompt (void);
295
296 extern int input_from_terminal_p (void);
297
298 extern int info_verbose;
299
300 /* From printcmd.c */
301
302 extern void set_next_address (struct gdbarch *, CORE_ADDR);
303
304 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
305                                    struct ui_file *, int, char *);
306
307 extern int build_address_symbolic (struct gdbarch *,
308                                    CORE_ADDR addr,
309                                    int do_demangle, 
310                                    char **name, 
311                                    int *offset, 
312                                    char **filename, 
313                                    int *line,   
314                                    int *unmapped);
315
316 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
317 extern const char *pc_prefix (CORE_ADDR);
318
319 /* From source.c */
320
321 /* See openp function definition for their description.  */
322 #define OPF_TRY_CWD_FIRST     0x01
323 #define OPF_SEARCH_IN_PATH    0x02
324 #define OPF_RETURN_REALPATH   0x04
325
326 extern int openp (const char *, int, const char *, int, char **);
327
328 extern int source_full_path_of (const char *, char **);
329
330 extern void mod_path (char *, char **);
331
332 extern void add_path (char *, char **, int);
333
334 extern void directory_switch (char *, int);
335
336 extern char *source_path;
337
338 extern void init_source_path (void);
339
340 /* From exec.c */
341
342 /* * Process memory area starting at ADDR with length SIZE.  Area is
343    readable iff READ is non-zero, writable if WRITE is non-zero,
344    executable if EXEC is non-zero.  Area is possibly changed against
345    its original file based copy if MODIFIED is non-zero.  DATA is
346    passed without changes from a caller.  */
347
348 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
349                                          int read, int write, int exec,
350                                          int modified, void *data);
351
352 /* * Possible lvalue types.  Like enum language, this should be in
353    value.h, but needs to be here for the same reason.  */
354
355 enum lval_type
356   {
357     /* * Not an lval.  */
358     not_lval,
359     /* * In memory.  */
360     lval_memory,
361     /* * In a register.  Registers are relative to a frame.  */
362     lval_register,
363     /* * In a gdb internal variable.  */
364     lval_internalvar,
365     /* * Value encapsulates a callable defined in an extension language.  */
366     lval_xcallable,
367     /* * Part of a gdb internal variable (structure field).  */
368     lval_internalvar_component,
369     /* * Value's bits are fetched and stored using functions provided
370        by its creator.  */
371     lval_computed
372   };
373
374 /* * Control types for commands.  */
375
376 enum misc_command_type
377   {
378     ok_command,
379     end_command,
380     else_command,
381     nop_command
382   };
383
384 enum command_control_type
385   {
386     simple_control,
387     break_control,
388     continue_control,
389     while_control,
390     if_control,
391     commands_control,
392     python_control,
393     compile_control,
394     guile_control,
395     while_stepping_control,
396     invalid_control
397   };
398
399 /* * Structure for saved commands lines (for breakpoints, defined
400    commands, etc).  */
401
402 struct command_line
403   {
404     struct command_line *next;
405     char *line;
406     enum command_control_type control_type;
407     union
408       {
409         struct
410           {
411             enum compile_i_scope_types scope;
412             void *scope_data;
413           }
414         compile;
415       }
416     control_u;
417     /* * The number of elements in body_list.  */
418     int body_count;
419     /* * For composite commands, the nested lists of commands.  For
420        example, for "if" command this will contain the then branch and
421        the else branch, if that is available.  */
422     struct command_line **body_list;
423   };
424
425 extern struct command_line *read_command_lines (char *, int, int,
426                                                 void (*)(char *, void *),
427                                                 void *);
428 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
429                                                   void (*)(char *, void *),
430                                                   void *);
431
432 extern void free_command_lines (struct command_line **);
433
434 /* * Parameters of the "info proc" command.  */
435
436 enum info_proc_what
437   {
438     /* * Display the default cmdline, cwd and exe outputs.  */
439     IP_MINIMAL,
440
441     /* * Display `info proc mappings'.  */
442     IP_MAPPINGS,
443
444     /* * Display `info proc status'.  */
445     IP_STATUS,
446
447     /* * Display `info proc stat'.  */
448     IP_STAT,
449
450     /* * Display `info proc cmdline'.  */
451     IP_CMDLINE,
452
453     /* * Display `info proc exe'.  */
454     IP_EXE,
455
456     /* * Display `info proc cwd'.  */
457     IP_CWD,
458
459     /* * Display all of the above.  */
460     IP_ALL
461   };
462
463 /* * String containing the current directory (what getwd would return).  */
464
465 extern char *current_directory;
466
467 /* * Default radixes for input and output.  Only some values supported.  */
468 extern unsigned input_radix;
469 extern unsigned output_radix;
470
471 /* * Possibilities for prettyformat parameters to routines which print
472    things.  Like enum language, this should be in value.h, but needs
473    to be here for the same reason.  FIXME:  If we can eliminate this
474    as an arg to LA_VAL_PRINT, then we can probably move it back to
475    value.h.  */
476
477 enum val_prettyformat
478   {
479     Val_no_prettyformat = 0,
480     Val_prettyformat,
481     /* * Use the default setting which the user has specified.  */
482     Val_prettyformat_default
483   };
484
485 /* * Optional native machine support.  Non-native (and possibly pure
486    multi-arch) targets do not need a "nm.h" file.  This will be a
487    symlink to one of the nm-*.h files, built by the `configure'
488    script.  */
489
490 #ifdef GDB_NM_FILE
491 #include "nm.h"
492 #endif
493
494 /* Assume that fopen accepts the letter "b" in the mode string.
495    It is demanded by ISO C9X, and should be supported on all
496    platforms that claim to have a standard-conforming C library.  On
497    true POSIX systems it will be ignored and have no effect.  There
498    may still be systems without a standard-conforming C library where
499    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
500    4.x and 4.3BSD.  This assumption means these systems are no longer
501    supported.  */
502 #ifndef FOPEN_RB
503 # include "fopen-bin.h"
504 #endif
505
506 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
507    FIXME: Assumes 2's complement arithmetic.  */
508
509 #if !defined (UINT_MAX)
510 #define UINT_MAX ((unsigned int)(~0))       /* 0xFFFFFFFF for 32-bits */
511 #endif
512
513 #if !defined (INT_MAX)
514 #define INT_MAX ((int)(UINT_MAX >> 1))      /* 0x7FFFFFFF for 32-bits */
515 #endif
516
517 #if !defined (INT_MIN)
518 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
519 #endif
520
521 #if !defined (ULONG_MAX)
522 #define ULONG_MAX ((unsigned long)(~0L))    /* 0xFFFFFFFF for 32-bits */
523 #endif
524
525 #if !defined (LONG_MAX)
526 #define LONG_MAX ((long)(ULONG_MAX >> 1))   /* 0x7FFFFFFF for 32-bits */
527 #endif
528
529 #if !defined (ULONGEST_MAX)
530 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
531 #endif
532
533 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
534 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
535 #endif
536
537 /* * Convert a LONGEST to an int.  This is used in contexts (e.g. number of
538    arguments to a function, number in a value history, register number, etc.)
539    where the value must not be larger than can fit in an int.  */
540
541 extern int longest_to_int (LONGEST);
542
543 /* * List of known OS ABIs.  If you change this, make sure to update the
544    table in osabi.c.  */
545 enum gdb_osabi
546 {
547   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
548
549   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
550
551   GDB_OSABI_SVR4,
552   GDB_OSABI_HURD,
553   GDB_OSABI_SOLARIS,
554   GDB_OSABI_LINUX,
555   GDB_OSABI_FREEBSD_AOUT,
556   GDB_OSABI_FREEBSD_ELF,
557   GDB_OSABI_NETBSD_AOUT,
558   GDB_OSABI_NETBSD_ELF,
559   GDB_OSABI_OPENBSD_ELF,
560   GDB_OSABI_WINCE,
561   GDB_OSABI_GO32,
562   GDB_OSABI_IRIX,
563   GDB_OSABI_HPUX_ELF,
564   GDB_OSABI_HPUX_SOM,
565   GDB_OSABI_QNXNTO,
566   GDB_OSABI_CYGWIN,
567   GDB_OSABI_AIX,
568   GDB_OSABI_DICOS,
569   GDB_OSABI_DARWIN,
570   GDB_OSABI_SYMBIAN,
571   GDB_OSABI_OPENVMS,
572   GDB_OSABI_LYNXOS178,
573   GDB_OSABI_NEWLIB,
574   GDB_OSABI_SDE,
575
576   GDB_OSABI_INVALID             /* keep this last */
577 };
578
579 /* Global functions from other, non-gdb GNU thingies.
580    Libiberty thingies are no longer declared here.  We include libiberty.h
581    above, instead.  */
582
583 /* From other system libraries */
584
585 #ifndef atof
586 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
587 #endif
588
589 /* Dynamic target-system-dependent parameters for GDB.  */
590 #include "gdbarch.h"
591
592 /* * Maximum size of a register.  Something small, but large enough for
593    all known ISAs.  If it turns out to be too small, make it bigger.  */
594
595 enum { MAX_REGISTER_SIZE = 64 };
596
597 /* In findvar.c.  */
598
599 extern LONGEST extract_signed_integer (const gdb_byte *, int,
600                                        enum bfd_endian);
601
602 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
603                                           enum bfd_endian);
604
605 extern int extract_long_unsigned_integer (const gdb_byte *, int,
606                                           enum bfd_endian, LONGEST *);
607
608 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
609                                         struct type *type);
610
611 extern void store_signed_integer (gdb_byte *, int,
612                                   enum bfd_endian, LONGEST);
613
614 extern void store_unsigned_integer (gdb_byte *, int,
615                                     enum bfd_endian, ULONGEST);
616
617 extern void store_typed_address (gdb_byte *buf, struct type *type,
618                                  CORE_ADDR addr);
619
620 \f
621 /* From valops.c */
622
623 extern int watchdog;
624
625 /* Hooks for alternate command interfaces.  */
626
627 /* * The name of the interpreter if specified on the command line.  */
628 extern char *interpreter_p;
629
630 struct target_waitstatus;
631 struct cmd_list_element;
632
633 extern void (*deprecated_pre_add_symbol_hook) (const char *);
634 extern void (*deprecated_post_add_symbol_hook) (void);
635 extern void (*selected_frame_level_changed_hook) (int);
636 extern int (*deprecated_ui_loop_hook) (int signo);
637 extern void (*deprecated_show_load_progress) (const char *section,
638                                               unsigned long section_sent, 
639                                               unsigned long section_size, 
640                                               unsigned long total_sent, 
641                                               unsigned long total_size);
642 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
643                                                          int line,
644                                                          int stopline,
645                                                          int noerror);
646 extern int (*deprecated_query_hook) (const char *, va_list)
647      ATTRIBUTE_FPTR_PRINTF(1,0);
648 extern void (*deprecated_warning_hook) (const char *, va_list)
649      ATTRIBUTE_FPTR_PRINTF(1,0);
650 extern void (*deprecated_interactive_hook) (void);
651 extern void (*deprecated_readline_begin_hook) (char *, ...)
652      ATTRIBUTE_FPTR_PRINTF_1;
653 extern char *(*deprecated_readline_hook) (const char *);
654 extern void (*deprecated_readline_end_hook) (void);
655 extern void (*deprecated_context_hook) (int);
656 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
657                                               struct target_waitstatus *status,
658                                               int options);
659
660 extern void (*deprecated_attach_hook) (void);
661 extern void (*deprecated_detach_hook) (void);
662 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
663                                              char *cmd, int from_tty);
664
665 extern int (*deprecated_ui_load_progress_hook) (const char *section,
666                                                 unsigned long num);
667
668 /* If this definition isn't overridden by the header files, assume
669    that isatty and fileno exist on this system.  */
670 #ifndef ISATTY
671 #define ISATTY(FP)      (isatty (fileno (FP)))
672 #endif
673
674 /* * A width that can achieve a better legibility for GDB MI mode.  */
675 #define GDB_MI_MSG_WIDTH  80
676
677 /* From progspace.c */
678
679 extern void initialize_progspace (void);
680 extern void initialize_inferiors (void);
681
682 /* * Special block numbers */
683
684 enum block_enum
685 {
686   GLOBAL_BLOCK = 0,
687   STATIC_BLOCK = 1,
688   FIRST_LOCAL_BLOCK = 2
689 };
690
691 #include "utils.h"
692
693 #endif /* #ifndef DEFS_H */