Frama-C:
Plug-ins:
Libraries:

Frama-C API - Machdep

Managing machine-dependent information.

Machdep

type mach = {
  1. sizeof_short : int;
    (*

    sizeof(short)

    *)
  2. sizeof_int : int;
    (*

    sizeof(int)

    *)
  3. sizeof_long : int;
    (*

    sizeof(long)

    *)
  4. sizeof_longlong : int;
    (*

    sizeof(long long)

    *)
  5. sizeof_ptr : int;
    (*

    sizeof(<pointer type>)

    *)
  6. sizeof_float : int;
    (*

    sizeof(float)

    *)
  7. sizeof_double : int;
    (*

    sizeof(double)

    *)
  8. sizeof_longdouble : int;
    (*

    sizeof(long double)

    *)
  9. sizeof_void : int;
    (*

    sizeof(void)

    *)
  10. sizeof_fun : int;
    (*

    sizeof(<function type>). Negative if unsupported.

    *)
  11. size_t : string;
    (*

    Type of sizeof(<type>)

    *)
  12. ssize_t : string;
    (*

    representation of ssize_t

    *)
  13. wchar_t : string;
    (*

    Type of "wchar_t"

    *)
  14. ptrdiff_t : string;
    (*

    Type of "ptrdiff_t"

    *)
  15. intptr_t : string;
    (*

    Type of "intptr_t"

    *)
  16. uintptr_t : string;
    (*

    Type of "uintptr_t"

    *)
  17. int_fast8_t : string;
    (*

    Type of "int_fast8_t"

    *)
  18. int_fast16_t : string;
    (*

    Type of "int_fast16_t"

    *)
  19. int_fast32_t : string;
    (*

    Type of "int_fast32_t"

    *)
  20. int_fast64_t : string;
    (*

    Type of "int_fast64_t"

    *)
  21. uint_fast8_t : string;
    (*

    Type of "uint_fast8_t"

    *)
  22. uint_fast16_t : string;
    (*

    Type of "uint_fast16_t"

    *)
  23. uint_fast32_t : string;
    (*

    Type of "uint_fast32_t"

    *)
  24. uint_fast64_t : string;
    (*

    Type of "uint_fast64_t"

    *)
  25. wint_t : string;
    (*

    Type of "wint_t"

    *)
  26. sig_atomic_t : string;
    (*

    Type of "sig_atomic_t"

    *)
  27. time_t : string;
    (*

    Type of "time_t"

    *)
  28. max_align_t : string;
    (*

    Type of "max_align_t"

    *)
  29. alignof_short : int;
    (*

    _Alignof(short)

    *)
  30. alignof_int : int;
    (*

    _Alignof(int)

    *)
  31. alignof_long : int;
    (*

    _Alignof(long)

    *)
  32. alignof_longlong : int;
    (*

    _Alignof(long long)

    *)
  33. alignof_ptr : int;
    (*

    _Alignof(<pointer type>)

    *)
  34. alignof_float : int;
    (*

    _Alignof(float)

    *)
  35. alignof_double : int;
    (*

    _Alignof(double)

    *)
  36. alignof_longdouble : int;
    (*

    _Alignof(long double)

    *)
  37. alignof_void : int;
    (*

    _Alignof(void). Negative if unsupported.

    *)
  38. alignof_fun : int;
    (*

    _Alignof(<function type>). Negative if unsupported.

    *)
  39. alignof_aligned : int;
    (*

    Alignment of a type with aligned attribute

    *)
  40. alignof_max_align_t : int;
    (*

    _Alignof(max_align_t). Negative if unsupported.

    *)
  41. max_extended_alignment : int;
    (*

    non -1 if extended alignment is supported.

    *)
  42. gcc_alignof_short : int;
    (*

    GCC __alignof__(short). Negative if unsupported.

    *)
  43. gcc_alignof_int : int;
    (*

    GCC __alignof__(int). Negative if unsupported.

    *)
  44. gcc_alignof_long : int;
    (*

    GCC __alignof__(long). Negative if unsupported.

    *)
  45. gcc_alignof_longlong : int;
    (*

    GCC __alignof__(long long). Negative if unsupported.

    *)
  46. gcc_alignof_ptr : int;
    (*

    GCC __alignof__(<pointer type>). Negative if unsupported.

    *)
  47. gcc_alignof_float : int;
    (*

    GCC __alignof__(float). Negative if unsupported.

    *)
  48. gcc_alignof_double : int;
    (*

    GCC __alignof__(double). Negative if unsupported.

    *)
  49. gcc_alignof_longdouble : int;
    (*

    GCC __alignof__(long double). Negative if unsupported.

    *)
  50. gcc_alignof_void : int;
    (*

    GCC __alignof__(void). Negative if unsupported.

    *)
  51. gcc_alignof_fun : int;
    (*

    GCC __alignof__(<function type>). Negative if unsupported.

    *)
  52. gcc_alignof_aligned : int;
    (*

    GCC Alignment of a type with aligned attribute

    *)
  53. gcc_alignof_max_align_t : int;
    (*

    GCC __alignof__(max_align_t). Negative if unsupported.

    *)
  54. char_is_unsigned : bool;
    (*

    Whether "char" is unsigned

    *)
  55. little_endian : bool;
    (*

    whether the machine is little endian

    *)
  56. has__builtin_va_list : bool;
    (*

    Whether __builtin_va_list is a known type

    *)
  57. compiler : string;
    (*

    Architecture-specific flags to be given to the preprocessor (if supported)

    *)
  58. cpp_arch_flags : string list;
  59. version : string;
    (*

    Information on this machdep

    *)
  60. weof : string;
    (*

    expansion of WEOF macro, empty if undefined

    *)
  61. wordsize : string;
    (*

    expansion of __WORDSIZE macro, empty if undefined

    *)
  62. posix_c_source : string;
    (*

    expansion of _POSIX_C_SOURCE macro, empty if undefined

    *)
  63. bufsiz : string;
    (*

    expansion of BUFSIZ macro

    *)
  64. eof : string;
    (*

    expansion of EOF macro

    *)
  65. fopen_max : string;
    (*

    expansion of FOPEN_MAX macro

    *)
  66. filename_max : string;
    (*

    expansion of FILENAME_MAX macro

    *)
  67. host_name_max : string;
    (*

    expansion of HOST_NAME_MAX macro

    *)
  68. tty_name_max : string;
    (*

    expansion of TTY_NAME_MAX macro

    *)
  69. l_ctermid : string;
    (*

    expansion of L_ctermid macro

    *)
  70. l_tmpnam : string;
    (*

    expansion of L_tmpnam macro

    *)
  71. path_max : string;
    (*

    expansion of PATH_MAX macro

    *)
  72. tmp_max : string;
    (*

    expansion of TMP_MAX macro

    *)
  73. rand_max : string;
    (*

    expansion of RAND_MAX macro

    *)
  74. mb_cur_max : string;
    (*

    expansion of MB_CUR_MAX macro

    *)
  75. nsig : string;
    (*

    expansion of non-standard NSIG macro, empty if undefined

    *)
  76. errno : (string * string) list;
    (*

    list of macros defining errors in errno.h

    *)
  77. machdep_name : string;
    (*

    name of the machdep

    *)
  78. custom_defs : (string * string) list;
    (*

    sequence of key/value for C macros

    *)
}

Definition of a machine model (architecture + compiler).

  • since 30.0-Zinc
val mach_to_yaml : mach -> Yaml.value
val mach_of_yaml : Yaml.value -> (mach, [> `Msg of string ]) Stdlib.result

Compiler

val msvcMode : mach -> bool

Short for machdep.compiler = "msvc"

  • since 30.0-Zinc
val gccMode : mach -> bool

Short for machdep.compiler = "gcc"

  • since 30.0-Zinc
val allowed_machdep : string -> string

allowed_machdep "machdep family" provides a standard message for features only allowed for a particular machdep.

  • since 30.0-Zinc

Generation

val gen_define_custom_macros : Stdlib.Format.formatter -> Datatype.String.Set.t -> mach -> unit

gen_define_custom_macros fmt censored_macros machdep Prints on the given formatter #define directives corresponding to the built-in macros of the current machdep.

  • parameter censored_macros

    prevents the generation of directives for the builtin macros in mach.custom_defs whose names match. empty by default.

  • since 31.0-Gallium (existed, but was not exported before)
val gen_all_defines : Stdlib.Format.formatter -> mach -> unit

Prints on the given formatter all #define directives required by share/libc/features.h and other system-dependent headers.

  • before 29.0-Copper

    censored_macros did not exist

  • before 31.0-Gallium

    censored_macros was necessary to filter builtin macros, that are now handled independently by gen_define_custom_macros

val generate_machdep_header : ?censored_macros:Datatype.String.Set.t -> mach -> Filepath.t

generates a __fc_machdep.h file in a temp directory and returns the directory name, to be added to the search path for preprocessing stdlib.

  • before 29.0-Copper

    censored_macros did not exist.