CMakePresets.json

{
    "version": 4,
    "cmakeMinimumRequired": { "major": 3, "minor": 23, "patch": 0 },
    "configurePresets": [
        {
            "name": "default",
            "displayName": "Plain CMake build (no ost)",
            "description": "Build the whole repo without ost, including the ArResolver bundle. Point CMAKE_PREFIX_PATH at your OpenUSD install, or pass -DCMAKE_PREFIX_PATH=<path> on the command line. `ost configure` instead writes per-target presets into the tool-owned CMakeUserPresets.json.",
            "generator": "Ninja",
            "binaryDir": "${sourceDir}/build/default",
            "cacheVariables": {
                "CMAKE_BUILD_TYPE": "Release"
            }
        },
        {
            "name": "plugin-msvc",
            "inherits": "default",
            "displayName": "The whole repository, through the Visual Studio generator",
            "description": "What `default` is on Windows outside a developer command prompt, and the way the ArResolver bundle is built there: the Ninja presets need cl.exe already on PATH, which is true inside a VS developer prompt and false in a plain shell. Point CMAKE_PREFIX_PATH at the OpenUSD runtime and at libcurl, separated by a semicolon.",
            "generator": "Visual Studio 17 2022",
            "architecture": "x64",
            "binaryDir": "${sourceDir}/build/plugin",
            "cacheVariables": {
                "CMAKE_BUILD_TYPE": null
            }
        },
        {
            "name": "core",
            "displayName": "Core libraries only (no OpenUSD)",
            "description": "Build and test everything under libs/ with no OpenUSD installation present. This is the normal way to work on the read contract, the backends, the cache, and the shared boundary suite; if it stops working, a libs/ module has acquired an OpenUSD dependency.",
            "generator": "Ninja",
            "binaryDir": "${sourceDir}/build/core",
            "cacheVariables": {
                "CMAKE_BUILD_TYPE": "Debug",
                "USD_HTTP_RESOLVER_BUILD_PLUGIN": "OFF"
            }
        },
        {
            "name": "core-msvc",
            "inherits": "core",
            "displayName": "Core libraries only, through the Visual Studio generator",
            "description": "What `core` is on Windows outside a developer command prompt. The Ninja presets need cl.exe already on PATH, which is true inside a VS developer prompt and false in a plain shell and on a stock CI runner; the Visual Studio generator locates the toolchain itself. This is the generator the Windows CI cell uses, so the lane a contributor reproduces is the lane CI runs.",
            "generator": "Visual Studio 17 2022",
            "architecture": "x64",
            "binaryDir": "${sourceDir}/build/core-msvc",
            "cacheVariables": {
                "CMAKE_BUILD_TYPE": null
            }
        },
        {
            "name": "core-asan",
            "inherits": "core",
            "displayName": "Core libraries under AddressSanitizer and UndefinedBehaviorSanitizer",
            "description": "The boundary suite's buffer handling and its offset arithmetic, checked rather than asserted. UBSan is named explicitly because offset and size arithmetic is where this project's overflow lives. Requires clang or GCC; MSVC implements only address.",
            "binaryDir": "${sourceDir}/build/core-asan",
            "cacheVariables": {
                "USD_HTTP_RESOLVER_SANITIZER": "address,undefined"
            }
        },
        {
            "name": "core-tsan",
            "inherits": "core",
            "displayName": "Core libraries under ThreadSanitizer",
            "description": "The concurrency properties in §7 of the design policy are only actually verified here; asserting them in prose asserts nothing. Requires clang or GCC.",
            "binaryDir": "${sourceDir}/build/core-tsan",
            "cacheVariables": {
                "USD_HTTP_RESOLVER_SANITIZER": "thread"
            }
        }
    ],
    "buildPresets": [
        { "name": "default", "configurePreset": "default" },
        { "name": "plugin-msvc", "configurePreset": "plugin-msvc", "configuration": "Release" },
        { "name": "core", "configurePreset": "core" },
        { "name": "core-msvc", "configurePreset": "core-msvc", "configuration": "Debug" },
        { "name": "core-asan", "configurePreset": "core-asan" },
        { "name": "core-tsan", "configurePreset": "core-tsan" }
    ],
    "testPresets": [
        { "name": "default", "configurePreset": "default", "output": { "outputOnFailure": true } },
        { "name": "plugin-msvc", "configurePreset": "plugin-msvc", "configuration": "Release", "output": { "outputOnFailure": true } },
        { "name": "core", "configurePreset": "core", "output": { "outputOnFailure": true } },
        { "name": "core-msvc", "configurePreset": "core-msvc", "configuration": "Debug", "output": { "outputOnFailure": true } },
        {
            "name": "core-asan",
            "configurePreset": "core-asan",
            "output": { "outputOnFailure": true },
            "environment": {
                "UBSAN_OPTIONS": "print_stacktrace=1"
            }
        },
        {
            "name": "core-tsan",
            "configurePreset": "core-tsan",
            "output": { "outputOnFailure": true },
            "environment": {
                "TSAN_OPTIONS": "halt_on_error=1"
            }
        }
    ]
}