CLANG(1)

📦
version 16.0.6 · 2 versions
, in debian bookworm

💅 CLANG — the Clang C, C++, and Objective-C compiler 💅

okay so bestie, welcome to CLANG(1), the manual for clang — yes THE clang, the C / C++ / Objective-C compiler. she's iconic, she's built different, and she does literally everything. let's get into it 🫶

✨ SYNOPSIS ✨

clang [options] filename …

like. that's it. that's the whole summoning ritual. options, then files. slay ✨

🌸 DESCRIPTION 🌸

so clang is a C, C++, and Objective-C compiler, and she's a full pipeline girlie — preprocessing, parsing, optimization, code generation, assembly, AND linking, all in one. depending on which high-level mode setting you pass, Clang will stop before doing a full link. no cap.

and yeah she's ~highly integrated~ but bestie you still gotta understand the stages of compilation to understand how to invoke her. so here they are, in order, no skipping:

🚗 Driver

the clang executable is actually just a small driver that controls the overall execution of the other tools — the compiler, the assembler, and the linker. typically you don't need to interact with the driver directly, but you transparently use it to run all those other tools. she's the group chat admin fr 💅

🔤 Preprocessing

this stage handles tokenization of the input source file, macro expansion, #include expansion, and handling of all the other preprocessor directives. the output of this stage is typically called a .i file (for C), a .ii file (for C++), a .mi file (for Objective-C), or a .mii file (for Objective-C++). lowkey underrated stage ngl.

🧠 Parsing and Semantic Analysis

this stage parses the input file, translating preprocessor tokens into a parse tree. once it's in the form of a parse tree, it applies semantic analysis to compute types for expressions AND determine whether the code is well formed. this stage is responsible for generating most of the compiler warnings as well as parse errors — so when she yells at you, it's probably from here. the output of this stage is an "Abstract Syntax Tree" (AST). main character energy, honestly.

⚡ Code Generation and Optimization

this stage translates an AST into low-level intermediate code (known as "LLVM IR") and ultimately into machine code. this phase is responsible for optimizing the generated code and handling target-specific code generation. the output of this stage is typically called a .s file, or an "assembly" file.

Clang also supports the use of an integrated assembler, in which the code generator produces object files directly. this avoids the overhead of generating the .s file and of calling the target assembler. efficient queen 💅

🔧 Assembler

this stage runs the target assembler to translate the output of the compiler into a target object file. the output of this stage is typically called a .o file, or an "object" file.

🔗 Linker

this stage runs the target linker to merge multiple object files into an executable or dynamic library. the output of this stage is typically called an a.out, .dylib, or .so file. the final boss 🌈

🔍 Clang Static Analyzer

the Clang Static Analyzer is a tool that scans source code to try to find bugs through code analysis. this tool uses many parts of Clang and is built into the same driver. please see https://clang-analyzer.llvm.org for more details on how to use the static analyzer. she's nosy and we love her for it 🙈

💖 OPTIONS 💖

🎯 Stage Selection Options

  • -E — run the preprocessor stage. just vibes, no compile.
  • -fsyntax-only — run the preprocessor, parser and semantic analysis stages. she checks your grammar and dips ✨
  • -S — run the previous stages as well as LLVM generation and optimization stages and target-specific code generation, producing an assembly file.
  • -c — run all of the above, plus the assembler, generating a target .o object file.
  • no stage selection option — if no stage selection option is specified, all stages above are run, and the linker is run to combine the results into an executable or shared library. the full send, periodt.

🗣️ Language Selection and Mode Options

  • -x <language> — treat subsequent input files as having type language.
  • -std= <standard> — specify the language standard to compile for. here's where it gets juicy, bestie:

supported values for the C language are:

  • c89, c90, iso9899:1990 — ISO C 1990
  • iso9899:199409 — ISO C 1990 with amendment 1
  • gnu89, gnu90 — ISO C 1990 with GNU extensions
  • c99, iso9899:1999 — ISO C 1999
  • gnu99 — ISO C 1999 with GNU extensions
  • c11, iso9899:2011 — ISO C 2011
  • gnu11 — ISO C 2011 with GNU extensions
  • c17, iso9899:2017 — ISO C 2017
  • gnu17 — ISO C 2017 with GNU extensions

the default C language standard is gnu17, except on PS4, where it is gnu99. (PS4 really said "no <em>new</em> standards for me" 😭)

supported values for the C++ language are:

  • c++98, c++03 — ISO C++ 1998 with amendments
  • gnu++98, gnu++03 — ISO C++ 1998 with amendments and GNU extensions
  • c++11 — ISO C++ 2011 with amendments
  • gnu++11 — ISO C++ 2011 with amendments and GNU extensions
  • c++14 — ISO C++ 2014 with amendments
  • gnu++14 — ISO C++ 2014 with amendments and GNU extensions
  • c++17 — ISO C++ 2017 with amendments
  • gnu++17 — ISO C++ 2017 with amendments and GNU extensions
  • c++20 — ISO C++ 2020 with amendments
  • gnu++20 — ISO C++ 2020 with amendments and GNU extensions
  • c++2b — working draft for ISO C++ 2023
  • gnu++2b — working draft for ISO C++ 2023 with GNU extensions

the default C++ language standard is gnu++17.

supported values for the OpenCL language are:

  • cl1.0 — OpenCL 1.0
  • cl1.1 — OpenCL 1.1
  • cl1.2 — OpenCL 1.2
  • cl2.0 — OpenCL 2.0

the default OpenCL language standard is cl1.0.

supported values for the CUDA language are:

  • cuda — NVIDIA CUDA(tm)
  • -stdlib= <library> — specify the C++ standard library to use; supported options are libstdc++ and libc++. if not specified, platform default will be used.
  • -rtlib= <library> — specify the compiler runtime library to use; supported options are libgcc and compiler-rt. if not specified, platform default will be used.
  • -ansi — same as -std=c89.
  • -ObjC, -ObjC++ — treat source input files as Objective-C and Object-C++ inputs respectively.
  • -trigraphs — enable trigraphs.
  • -ffreestanding — indicate that the file should be compiled for a freestanding, not a hosted, environment. note that it is assumed that a freestanding environment will additionally provide memcpy, memmove, memset and memcmp implementations, as these are needed for efficient codegen for many programs.
  • -fno-builtin — disable special handling and optimizations of well-known library functions, like strlen() and malloc().
  • -fno-builtin- <function> — disable special handling and optimizations for that specific library function. for example, -fno-builtin-strlen removes any special handling for the strlen() library function.
  • -fno-builtin-std- <function> — disable special handling and optimizations for the specific C++ standard library function in namespace std. for example, -fno-builtin-std-move_if_noexcept removes any special handling for the std::move_if_noexcept() library function.
for C standard library functions that the C++ standard library also provides in namespace std, use -fno-builtin-<function> instead. (iykyk 💅)
  • -fmath-errno — indicate that math functions should be treated as updating errno.
  • -fpascal-strings — enable support for Pascal-style strings with "\pfoo".
  • -fms-extensions — enable support for Microsoft extensions.
  • -fmsc-version= — set _MSC_VER. defaults to 1300 on Windows. not set otherwise.
  • -fborland-extensions — enable support for Borland extensions.
  • -fwritable-strings — make all string literals default to writable. this disables uniquing of strings and other optimizations.
  • -flax-vector-conversions, -flax-vector-conversions= <kind>, -fno-lax-vector-conversions — allow loose type checking rules for implicit vector conversions. possible values of <kind>:
    • none: allow no implicit conversions between vectors
    • integer: allow implicit bitcasts between integer vectors of the same overall bit-width
    • all: allow implicit bitcasts between any vectors of the same overall bit-width

<kind> defaults to integer if unspecified.

  • -fblocks — enable the "Blocks" language feature.
  • -fobjc-abi-version=version — select the Objective-C ABI version to use. available versions are 1 (legacy "fragile" ABI), 2 (non-fragile ABI 1), and 3 (non-fragile ABI 2).
  • -fobjc-nonfragile-abi-version= <version> — select the Objective-C non-fragile ABI version to use by default. this will only be used as the Objective-C ABI when the non-fragile ABI is enabled (either via -fobjc-nonfragile-abi, or because it is the platform default).
  • -fobjc-nonfragile-abi, -fno-objc-nonfragile-abi — enable use of the Objective-C non-fragile ABI. on platforms for which this is the default ABI, it can be disabled with -fno-objc-nonfragile-abi.

🎯 Target Selection Options

Clang fully supports cross compilation as an inherent part of her design — it's not a bolt-on, it's a personality trait. depending on how your version of Clang is configured, it may have support for a number of cross compilers, or may only support a native target.

  • -target <architecture> — specify the architecture to build for (all platforms).
  • --print-supported-cpus — print out a list of supported processors for the given target (specified through --target=<architecture> or -arch <architecture>). if no target is specified, the system default target will be used.
  • -mcpu=?, -mtune=? — acts as an alias for --print-supported-cpus.
  • -march= <cpu> — specify that Clang should generate code for a specific processor family member and later. for example, if you specify -march=i486, the compiler is allowed to generate instructions that are valid on i486 and later processors, but which may not exist on earlier ones. so like, she's allowed to be fancy, but only as fancy as the hardware can handle 🦋

🌈 Code Generation Options 🌈

Optimization levels, bestie ✨

  • -O0, -O1, -O2, -O3, -Ofast, -Os, -Oz, -Og, -O, -O4 — okay so this is the whole optimization ladder and you're picking your level, gorgeous:
    • -O0 — "no optimization" energy. This one compiles the fastest and gives you the most debuggable code. Your bestie for when everything is on fire and you need to see what's happening. 🐛
    • -O1 — literally just somewhere between -O0 and -O2. mid. 💅
    • -O2 — moderate level of optimization which enables most optimizations. The sensible default-ish icon.
    • -O3 — like -O2, except it also turns on optimizations that take longer to perform or that may generate larger code (in an attempt to make the program run faster). it's giving "go fast or go home" 🔥
    • -Ofast — enables all the optimizations from -O3 along with other aggressive optimizations that may violate strict compliance with language standards. yes queen, break the rules, but know that you're breaking them 👑
    • -Os — like -O2 with extra optimizations to reduce code size. petite. 🎀
    • -Oz — like -Os (and thus -O2), but reduces code size further. tiny tiny.
    • -Og — like -O1. In future versions, this option might disable different optimizations in order to improve debuggability. so it might grow up and change, noted. 🌸
    • -O — equivalent to -O1. the vibe is "I typed one letter".
    • -O4 and higher — currently equivalent to -O3. no cap, that's all it does right now.

Debug info, the -g girlies 🦋

  • -g, -gline-tables-only, -gmodules — these control debug information output. Heads up: Clang debug information works best at -O0. And when more than one option starting with -g is specified, the last one wins (last one to the party takes the crown):
    • -g — generate debug information. classic, iconic.
    • -gline-tables-only — generate only line table debug information. This allows for symbolicated backtraces with inlining information, but does not include any information about variables, their locations or types. so you get the map but not the luggage 🙈
    • -gmodules — generate debug information that contains external references to types defined in Clang modules or precompiled headers instead of emitting redundant debug type information into every object file. This option transparently switches the Clang module format to object file containers that hold the Clang module together with the debug information. When compiling a program that uses Clang modules or precompiled headers, this option produces complete debug information with faster compile times and much smaller object files. genuinely slay. ✨
🚨 bestie listen — this option should not be used when building static libraries for distribution to other machines, because the debug info will contain references to the module cache on the machine the object files in the library were built on. it will not travel well. 💀

More codegen flags 💜

  • -fstandalone-debug, -fno-standalone-debug — okay so Clang does a bunch of optimizations to shrink debug info in your binary. They work based on the assumption that the debug type information can be spread out over multiple compilation units. For instance, Clang will not emit type definitions for types that are not needed by a module and could be replaced with a forward declaration. Further, Clang will only emit type info for a dynamic C++ class in the module that contains the vtable for the class.

The -fstandalone-debug option turns off these optimizations. This is useful when working with 3rd-party libraries that don't come with debug information. This is the default on Darwin. Note that Clang will never emit type information for types that are not referenced at all by the program. periodt.

  • -feliminate-unused-debug-types — by default, Clang does not emit type information for types that are defined but not used in a program. To retain the debug info for these unused types, the negation -fno-eliminate-unused-debug-types can be used. keeping the unread books on the shelf, respect. 🍓
  • -fexceptions — enable generation of unwind information. This allows exceptions to be thrown through Clang compiled stack frames. This is on by default in x86-64. 🧚
  • -ftrapv — generate code to catch integer overflow errors. Signed integer overflow is undefined in C. With this flag, extra code is generated to detect this and abort when it happens. so it catches it and then, yeah, it aborts. dramatic but honest.
  • -fvisibility — this flag sets the default visibility level.
  • -fcommon, -fno-common — this flag specifies that variables without initializers get common linkage. It can be disabled with -fno-common.
  • -ftls-model=<model> — set the default thread-local storage (TLS) model to use for thread-local variables. Valid values are: "global-dynamic", "local-dynamic", "initial-exec" and "local-exec". The default is "global-dynamic". The default model can be overridden with the tls_model attribute. The compiler will try to choose a more efficient model if possible. it's doing its best for you fr fr 💖
  • -flto, -flto=full, -flto=thin, -emit-llvm — generate output files in LLVM formats, suitable for link time optimization. When used with -S this generates LLVM intermediate language assembly files, otherwise this generates LLVM bitcode format object files (which may be passed to the linker depending on the stage selection options).

The default for -flto is "full", in which the LLVM bitcode is suitable for monolithic Link Time Optimization (LTO), where the linker merges all such modules into a single combined module for optimization. With "thin", ThinLTO compilation is invoked instead. skinny legend 🌈

NOTE: on Darwin, when using -flto along with -g and compiling and linking in separate steps, you also need to pass -Wl,-object_path_lto,<lto-filename>.o at the linking step to instruct the ld64 linker not to delete the temporary object file generated during Link Time Optimization (this flag is automatically passed to the linker by Clang if compilation and linking are done in a single step). This allows debugging the executable as well as generating the .dSYM bundle using dsymutil(1). don't skip this step or you'll be sad. 😭

🚗 Driver Options 🚗

  • -### — print (but do not run) the commands to run for this compilation. just peeking, not touching. 👀
  • --help — display available options.
  • -Qunused-arguments — do not emit any warnings for unused driver arguments. let them live.
  • -Wa,<args> — pass the comma separated arguments in args to the assembler.
  • -Wl,<args> — pass the comma separated arguments in args to the linker.
  • -Wp,<args> — pass the comma separated arguments in args to the preprocessor.
  • -Xanalyzer <arg> — pass arg to the static analyzer.
  • -Xassembler <arg> — pass arg to the assembler.
  • -Xlinker <arg> — pass arg to the linker.
  • -Xpreprocessor <arg> — pass arg to the preprocessor.
  • -o <file> — write output to file. the classic.
  • -print-file-name=<file> — print the full library path of file.
  • -print-libgcc-file-name — print the library path for the currently used compiler runtime library ("libgcc.a" or "libclang_rt.builtins.*.a").
  • -print-prog-name=<name> — print the full program path of name.
  • -print-search-dirs — print the paths used for finding libraries and programs.
  • -save-temps — save intermediate compilation results. hoarding the receipts, valid. 🎀
  • -save-stats, -save-stats=cwd, -save-stats=obj — save internal code generation (LLVM) statistics to a file in the current directory (-save-stats/"-save-stats=cwd") or the directory of the output file ("-save-state=obj").
  • -integrated-as, -no-integrated-as — used to enable and disable, respectively, the use of the integrated assembler. Whether the integrated assembler is on by default is target dependent.
  • -time — time individual commands. ⏱️
  • -ftime-report — print timing summary of each stage of compilation.
  • -v — show commands to run and use verbose output. yap mode activated. 💅

🩺 Diagnostics Options 🩺

  • -fshow-column, -fshow-source-location, -fcaret-diagnostics, -fdiagnostics-fixit-info, -fdiagnostics-parseable-fixits, -fdiagnostics-print-source-range-info, -fprint-source-range-info, -fdiagnostics-show-option, -fmessage-length — these options control how Clang prints out information about diagnostics (errors and warnings). Please see the Clang User's Manual for more information. iykyk, the manual has the deets. 📖

🧪 Preprocessor Options 🧪

  • -D<macroname>=<value> — adds an implicit #define into the predefines buffer which is read before the source file is preprocessed.
  • -U<macroname> — adds an implicit #undef into the predefines buffer which is read before the source file is preprocessed.
  • -include <filename> — adds an implicit #include into the predefines buffer which is read before the source file is preprocessed.
  • -I<directory> — add the specified directory to the search path for include files.
  • -F<directory> — add the specified directory to the search path for framework include files.
  • -nostdinc — do not search the standard system directories or compiler builtin directories for include files.
  • -nostdlibinc — do not search the standard system directories for include files, but do search compiler builtin include directories.
  • -nobuiltininc — do not search clang's builtin directory for include files.

🌍 ENVIRONMENT 🌍

  • TMPDIR, TEMP, TMP — these environment variables are checked, in order, for the location to write temporary files used during the compilation process.
  • CPATH — if this environment variable is present, it is treated as a delimited list of paths to be added to the default system include path list. The delimiter is the platform dependent delimiter, as used in the PATH environment variable.

Empty components in the environment variable are ignored. (so a stray :: won't wreck you, cute.)

  • C_INCLUDE_PATH, OBJC_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJCPLUS_INCLUDE_PATH — these environment variables specify additional paths, as for CPATH, which are only used when processing the appropriate language. language-specific besties 🫶

🐛 BUGS 🐛

To report bugs, please visit <https://github.com/llvm/llvm-project/issues/>. Most bug reports should include preprocessed source files (use the -E option) and the full output of the compiler, along with information to reproduce. give them the receipts so they can actually fix it, bestie 💖

👀 SEE ALSO 👀

as(1), ld(1)

✍️ AUTHOR ✍️

Maintained by the Clang / LLVM Team (<http://clang.llvm.org>)

2007-2023, The Clang Team

and that's a wrap on CLANG(1) 💅✨ this page is version 15, dated Oct 16, 2023 — go forth and compile something iconic, bestie. no cap. 🫶🌸

📦 where this page comes from