[all-commits] [llvm/llvm-project] ecbe2e: [llvm] annotate interfaces in llvm/ObjCopy and llv...

[Andrew Rogers via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: ecbe2e8c3f8f4be87d5d30ad5d1fcc1986fa5c47
      https://github.com/llvm/llvm-project/commit/ecbe2e8c3f8f4be87d5d30ad5d1fcc1986fa5c47
  Author: Andrew Rogers <andrurogerz at gmail.com>
  Date:   2025-06-04 (Wed, 04 Jun 2025)

  Changed paths:
    M llvm/include/llvm/ObjCopy/COFF/COFFObjcopy.h
    M llvm/include/llvm/ObjCopy/CommonConfig.h
    M llvm/include/llvm/ObjCopy/ConfigManager.h
    M llvm/include/llvm/ObjCopy/ELF/ELFObjcopy.h
    M llvm/include/llvm/ObjCopy/MachO/MachOObjcopy.h
    M llvm/include/llvm/ObjCopy/ObjCopy.h
    M llvm/include/llvm/ObjCopy/wasm/WasmObjcopy.h
    M llvm/include/llvm/Object/Archive.h
    M llvm/include/llvm/Object/ArchiveWriter.h
    M llvm/include/llvm/Object/Binary.h
    M llvm/include/llvm/Object/BuildID.h
    M llvm/include/llvm/Object/COFF.h
    M llvm/include/llvm/Object/COFFImportFile.h
    M llvm/include/llvm/Object/COFFModuleDefinition.h
    M llvm/include/llvm/Object/DXContainer.h
    M llvm/include/llvm/Object/Decompressor.h
    M llvm/include/llvm/Object/ELF.h
    M llvm/include/llvm/Object/ELFObjectFile.h
    M llvm/include/llvm/Object/Error.h
    M llvm/include/llvm/Object/FaultMapParser.h
    M llvm/include/llvm/Object/GOFFObjectFile.h
    M llvm/include/llvm/Object/IRObjectFile.h
    M llvm/include/llvm/Object/IRSymtab.h
    M llvm/include/llvm/Object/MachO.h
    M llvm/include/llvm/Object/MachOUniversal.h
    M llvm/include/llvm/Object/MachOUniversalWriter.h
    M llvm/include/llvm/Object/Minidump.h
    M llvm/include/llvm/Object/ModuleSymbolTable.h
    M llvm/include/llvm/Object/ObjectFile.h
    M llvm/include/llvm/Object/OffloadBinary.h
    M llvm/include/llvm/Object/OffloadBundle.h
    M llvm/include/llvm/Object/RelocationResolver.h
    M llvm/include/llvm/Object/SymbolSize.h
    M llvm/include/llvm/Object/SymbolicFile.h
    M llvm/include/llvm/Object/TapiFile.h
    M llvm/include/llvm/Object/TapiUniversal.h
    M llvm/include/llvm/Object/Wasm.h
    M llvm/include/llvm/Object/WindowsMachineFlag.h
    M llvm/include/llvm/Object/WindowsResource.h
    M llvm/include/llvm/Object/XCOFFObjectFile.h
    M llvm/lib/Object/XCOFFObjectFile.cpp

  Log Message:
  -----------
  [llvm] annotate interfaces in llvm/ObjCopy and llvm/Object for DLL export (#142668)

## Purpose

This patch is one in a series of code-mods that annotate LLVM’s public
interface for export. This patch annotates the `llvm/ObjCopy` and
`llvm/Object` libraries. These annotations currently have no meaningful
impact on the LLVM build; however, they are a prerequisite to support an
LLVM Windows DLL (shared library) build.

## Background

This effort is tracked in #109483. Additional context is provided in
[this
discourse](https://discourse.llvm.org/t/psa-annotating-llvm-public-interface/85307),
and documentation for `LLVM_ABI` and related annotations is found in the
LLVM repo
[here](https://github.com/llvm/llvm-project/blob/main/llvm/docs/InterfaceExportAnnotations.rst).

The bulk of these changes were generated automatically using the
[Interface Definition Scanner (IDS)](https://github.com/compnerd/ids)
tool, followed formatting with `git clang-format`.

The following manual adjustments were also applied after running IDS on
Linux:
- Add `#include "llvm/Support/Compiler.h"` to files where it was not
auto-added by IDS due to no pre-existing block of include statements.
- Manually annotate template class `CommonArchiveMemberHeader` with
`LLVM_ABI` since IDS ignores templates and this is the simplest solution
for DLL-exporting its child classes because it has methods defined
out-of-line. Seems to be an uncommon situation.
- Explicitly make `Archive` class non-copyable due to the class-level
`LLVM_ABI` annotation.
- Add default constructor to `ELFFile` so it can be instantiated for
DLL-export as a base class.
- Add `LLVM_TEMPLATE_ABI` and `LLVM_EXPORT_TEMPLATE` to exported
instantiated templates.

## Validation

Local builds and tests to validate cross-platform compatibility. This
included llvm, clang, and lldb on the following configurations:

- Windows with MSVC
- Windows with Clang
- Linux with GCC
- Linux with Clang
- Darwin with Clang



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications