Revert "Hide all symbols (except stable/headeronly/shim) if TORCH_STABLE_ONLY is defined (pytorch#167496)"

This reverts commit 8f4dc30. Reverted pytorch#167496 on behalf of https://github.com/atalman due to Failing validations - https://github.com/pytorch/test-infra/actions/runs/19513141127/job/55857898996 ([comment](pytorch#167496 (comment)))

Author: pytorchmergebot

.ci/pytorch/smoke_test/check_binary_symbols.py

@@ -100,337 +100,6 @@ def check_lib_statically_linked_libstdc_cxx_abi_symbols(lib: str) -> None:
  )
 
 
-def _compile_and_extract_symbols(
- cpp_content: str, compile_flags: list[str], exclude_list: list[str] | None = None
-) -> list[str]:
- """
- Helper to compile a C++ file and extract all symbols.
-
- Args:
- cpp_content: C++ source code to compile
- compile_flags: Compilation flags
- exclude_list: List of symbol names to exclude. Defaults to ["main"].
-
- Returns:
- List of all symbols found in the object file (excluding those in exclude_list).
- """
- import subprocess
- import tempfile
-
- if exclude_list is None:
- exclude_list = ["main"]
-
- with tempfile.TemporaryDirectory() as tmpdir:
- tmppath = Path(tmpdir)
- cpp_file = tmppath / "test.cpp"
- obj_file = tmppath / "test.o"
-
- cpp_file.write_text(cpp_content)
-
- result = subprocess.run(
- compile_flags + [str(cpp_file), "-o", str(obj_file)],
- capture_output=True,
- text=True,
- timeout=60,
- )
-
- if result.returncode != 0:
- raise RuntimeError(f"Compilation failed: {result.stderr}")
-
- symbols = get_symbols(str(obj_file))
-
- # Return all symbol names, excluding those in the exclude list
- return [name for _addr, _stype, name in symbols if name not in exclude_list]
-
-
-def check_stable_only_symbols(install_root: Path) -> None:
- """
- Test TORCH_STABLE_ONLY and TORCH_TARGET_VERSION by compiling test code and comparing symbol counts.
-
- This approach tests:
- 1. WITHOUT macros -> many torch symbols exposed
- 2. WITH TORCH_STABLE_ONLY -> zero torch symbols (all hidden)
- 3. WITH TORCH_TARGET_VERSION -> zero torch symbols (all hidden)
- 4. WITH both macros -> zero torch symbols (all hidden)
- """
- include_dir = install_root / "include"
- assert include_dir.exists(), f"Expected {include_dir} to be present"
-
- test_cpp_content = """
-// Main torch C++ API headers
-#include <torch/torch.h>
-#include <torch/all.h>
-
-// ATen tensor library
-#include <ATen/ATen.h>
-
-// Core c10 headers (commonly used)
-#include <c10/core/Device.h>
-#include <c10/core/DeviceType.h>
-#include <c10/core/ScalarType.h>
-#include <c10/core/TensorOptions.h>
-#include <c10/util/Optional.h>
-
-int main() { return 0; }
-"""
-
- base_compile_flags = [
- "g++",
- "-std=c++17",
- f"-I{include_dir}",
- f"-I{include_dir}/torch/csrc/api/include",
- "-c", # Compile only, don't link
- ]
-
- # Compile WITHOUT any macros
- symbols_without = _compile_and_extract_symbols(
- cpp_content=test_cpp_content,
- compile_flags=base_compile_flags,
- )
-
- # We expect constexpr symbols, inline functions used by other headers etc.
- # to produce symbols
- num_symbols_without = len(symbols_without)
- print(f"Found {num_symbols_without} symbols without any macros defined")
- assert num_symbols_without != 0, (
- "Expected a non-zero number of symbols without any macros"
- )
-
- # Compile WITH TORCH_STABLE_ONLY (expect 0 symbols)
- compile_flags_with_stable_only = base_compile_flags + ["-DTORCH_STABLE_ONLY"]
-
- symbols_with_stable_only = _compile_and_extract_symbols(
- cpp_content=test_cpp_content,
- compile_flags=compile_flags_with_stable_only,
- )
-
- num_symbols_with_stable_only = len(symbols_with_stable_only)
- assert num_symbols_with_stable_only == 0, (
- f"Expected no symbols with TORCH_STABLE_ONLY macro, but found {num_symbols_with_stable_only}"
- )
-
- # Compile WITH TORCH_TARGET_VERSION (expect 0 symbols)
- compile_flags_with_target_version = base_compile_flags + [
- "-DTORCH_TARGET_VERSION=1"
- ]
-
- symbols_with_target_version = _compile_and_extract_symbols(
- cpp_content=test_cpp_content,
- compile_flags=compile_flags_with_target_version,
- )
-
- num_symbols_with_target_version = len(symbols_with_target_version)
- assert num_symbols_with_target_version == 0, (
- f"Expected no symbols with TORCH_TARGET_VERSION macro, but found {num_symbols_with_target_version}"
- )
-
- # Compile WITH both macros (expect 0 symbols)
- compile_flags_with_both = base_compile_flags + [
- "-DTORCH_STABLE_ONLY",
- "-DTORCH_TARGET_VERSION=1",
- ]
-
- symbols_with_both = _compile_and_extract_symbols(
- cpp_content=test_cpp_content,
- compile_flags=compile_flags_with_both,
- )
-
- num_symbols_with_both = len(symbols_with_both)
- assert num_symbols_with_both == 0, (
- f"Expected no symbols with both macros, but found {num_symbols_with_both}"
- )
-
-
-def check_stable_api_symbols(install_root: Path) -> None:
- """
- Test that stable API headers still expose symbols with TORCH_STABLE_ONLY.
- The torch/csrc/stable/c/shim.h header is tested in check_stable_c_shim_symbols
- """
- include_dir = install_root / "include"
- assert include_dir.exists(), f"Expected {include_dir} to be present"
-
- stable_dir = include_dir / "torch" / "csrc" / "stable"
- assert stable_dir.exists(), f"Expected {stable_dir} to be present"
-
- stable_headers = list(stable_dir.rglob("*.h"))
- if not stable_headers:
- raise RuntimeError("Could not find any stable headers")
-
- includes = []
- for header in stable_headers:
- rel_path = header.relative_to(include_dir)
- includes.append(f"#include <{rel_path.as_posix()}>")
-
- includes_str = "\n".join(includes)
- test_stable_content = f"""
-{includes_str}
-int main() {{ return 0; }}
-"""
-
- compile_flags = [
- "g++",
- "-std=c++17",
- f"-I{include_dir}",
- f"-I{include_dir}/torch/csrc/api/include",
- "-c",
- "-DTORCH_STABLE_ONLY",
- ]
-
- symbols_stable = _compile_and_extract_symbols(
- cpp_content=test_stable_content,
- compile_flags=compile_flags,
- )
- num_symbols_stable = len(symbols_stable)
- print(f"Found {num_symbols_stable} symbols in torch/csrc/stable")
- assert num_symbols_stable > 0, (
- f"Expected stable headers to expose symbols with TORCH_STABLE_ONLY, "
- f"but found {num_symbols_stable} symbols"
- )
-
-
-def check_headeronly_symbols(install_root: Path) -> None:
- """
- Test that header-only utility headers still expose symbols with TORCH_STABLE_ONLY.
- """
- include_dir = install_root / "include"
- assert include_dir.exists(), f"Expected {include_dir} to be present"
-
- # Find all headers in torch/headeronly
- headeronly_dir = include_dir / "torch" / "headeronly"
- assert headeronly_dir.exists(), f"Expected {headeronly_dir} to be present"
- headeronly_headers = list(headeronly_dir.rglob("*.h"))
- if not headeronly_headers:
- raise RuntimeError("Could not find any headeronly headers")
-
- # Filter out platform-specific headers that may not compile everywhere
- platform_specific_keywords = [
- "cpu/vec",
- ]
-
- filtered_headers = []
- for header in headeronly_headers:
- rel_path = header.relative_to(include_dir).as_posix()
- if not any(
- keyword in rel_path.lower() for keyword in platform_specific_keywords
- ):
- filtered_headers.append(header)
-
- includes = []
- for header in filtered_headers:
- rel_path = header.relative_to(include_dir)
- includes.append(f"#include <{rel_path.as_posix()}>")
-
- includes_str = "\n".join(includes)
- test_headeronly_content = f"""
-{includes_str}
-int main() {{ return 0; }}
-"""
-
- compile_flags = [
- "g++",
- "-std=c++17",
- f"-I{include_dir}",
- f"-I{include_dir}/torch/csrc/api/include",
- "-c",
- "-DTORCH_STABLE_ONLY",
- ]
-
- symbols_headeronly = _compile_and_extract_symbols(
- cpp_content=test_headeronly_content,
- compile_flags=compile_flags,
- )
- num_symbols_headeronly = len(symbols_headeronly)
- print(f"Found {num_symbols_headeronly} symbols in torch/headeronly")
- assert num_symbols_headeronly > 0, (
- f"Expected headeronly headers to expose symbols with TORCH_STABLE_ONLY, "
- f"but found {num_symbols_headeronly} symbols"
- )
-
-
-def check_aoti_shim_symbols(install_root: Path) -> None:
- """
- Test that AOTI shim headers still expose symbols with TORCH_STABLE_ONLY.
- """
- include_dir = install_root / "include"
- assert include_dir.exists(), f"Expected {include_dir} to be present"
-
- # There are no constexpr symbols etc., so we need to actually use functions
- # so that some symbols are found.
- test_shim_content = """
-#include <torch/csrc/inductor/aoti_torch/c/shim.h>
-int main() {
- int32_t (*fp1)() = &aoti_torch_device_type_cpu;
- int32_t (*fp2)() = &aoti_torch_dtype_float32;
- (void)fp1; (void)fp2;
- return 0;
-}
-"""
-
- compile_flags = [
- "g++",
- "-std=c++17",
- f"-I{include_dir}",
- f"-I{include_dir}/torch/csrc/api/include",
- "-c",
- "-DTORCH_STABLE_ONLY",
- ]
-
- symbols_shim = _compile_and_extract_symbols(
- cpp_content=test_shim_content,
- compile_flags=compile_flags,
- )
- num_symbols_shim = len(symbols_shim)
- assert num_symbols_shim > 0, (
- f"Expected shim headers to expose symbols with TORCH_STABLE_ONLY, "
- f"but found {num_symbols_shim} symbols"
- )
-
-
-def check_stable_c_shim_symbols(install_root: Path) -> None:
- """
- Test that stable C shim headers still expose symbols with TORCH_STABLE_ONLY.
- """
- include_dir = install_root / "include"
- assert include_dir.exists(), f"Expected {include_dir} to be present"
-
- # Check if the stable C shim exists
- stable_shim = include_dir / "torch" / "csrc" / "stable" / "c" / "shim.h"
- if not stable_shim.exists():
- raise RuntimeError("Could not find stable c shim")
-
- # There are no constexpr symbols etc., so we need to actually use functions
- # so that some symbols are found.
- test_stable_shim_content = """
-#include <torch/csrc/stable/c/shim.h>
-int main() {
- // Reference stable C API functions to create undefined symbols
- AOTITorchError (*fp1)(const char*, uint32_t*, int32_t*) = &torch_parse_device_string;
- AOTITorchError (*fp2)(uint32_t*) = &torch_get_num_threads;
- (void)fp1; (void)fp2;
- return 0;
-}
-"""
-
- compile_flags = [
- "g++",
- "-std=c++17",
- f"-I{include_dir}",
- f"-I{include_dir}/torch/csrc/api/include",
- "-c",
- "-DTORCH_STABLE_ONLY",
- ]
-
- symbols_stable_shim = _compile_and_extract_symbols(
- cpp_content=test_stable_shim_content,
- compile_flags=compile_flags,
- )
- num_symbols_stable_shim = len(symbols_stable_shim)
- assert num_symbols_stable_shim > 0, (
- f"Expected stable C shim headers to expose symbols with TORCH_STABLE_ONLY, "
- f"but found {num_symbols_stable_shim} symbols"
- )
-
-
 def check_lib_symbols_for_abi_correctness(lib: str) -> None:
  print(f"lib: {lib}")
  cxx11_symbols = grep_symbols(lib, LIBTORCH_CXX11_PATTERNS)
@@ -460,13 +129,6 @@ def main() -> None:
  check_lib_symbols_for_abi_correctness(libtorch_cpu_path)
  check_lib_statically_linked_libstdc_cxx_abi_symbols(libtorch_cpu_path)
 
- # Check symbols when TORCH_STABLE_ONLY is defined
- check_stable_only_symbols(install_root)
- check_stable_api_symbols(install_root)
- check_headeronly_symbols(install_root)
- check_aoti_shim_symbols(install_root)
- check_stable_c_shim_symbols(install_root)
-
 
 if __name__ == "__main__":
  main()