Start switching pkg_install usage to know the full path of where to install things. (#43487)

[ABLD-302] Start switching pkg_install usage to know the full path of where to install things.

- Restore the ability to have an addition prefix on so_symlink.
- Change --dest_dir={install_dir}/embedded to --dest_dir={install_dir}
- Add prefix='embedded' to things we push

This did some of the libraries. I can do the rest in a followup or in this PR.

# Rationale

As we start installing more, we will have some pieces that go to embedded, and others that do not. It will be easier to understand if all the install instances use the single destdir. Eventually, we can create targets like //pkg/install_dir:install, which is a big pkg_install of all the dependencies and config scripts. Then the whole thing gets built  with a single `bazel run -- //opt/datadog/lib:install --destdir='#{install_dir}'.   When we get multiple remote executors, it can all dispatch in parallel.

The next release of rules_pkg will allow destdir to come from a build flag. The need for that is to automate build time genrules where we must brand the dest_dir into a binary. At that point we can also use the command line dest_dir in the pkg_install command, eliminating the need to use --dest_dir on the command lines in .rb files.



[ABLD-302]: https://datadoghq.atlassian.net/browse/ABLD-302?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Co-authored-by: tony.aiuto <[email protected]>

Author: aiuto

bazel/rules/so_symlink.bzl

@@ -6,16 +6,17 @@ _SPECS = [
     struct(os = "windows", prefix = "bin/", format = "{}.dll"),
 ]
 
-def _gen_targets(base_name, src, libname, version, spec):
+def _gen_targets(base_name, src, libname, version, prefix, spec):
     name = "{}_{}".format(base_name, spec.os)
     platform = "@platforms//os:{}".format(spec.os)
+    dest_prefix = (prefix + "/" + spec.prefix) if prefix else spec.prefix
 
     # Windows: no symlinks, no renaming - just copy the DLL as-is
     if spec.os == "windows":
         pkg_files(
             name = name,
             srcs = [src],
-            prefix = spec.prefix,
+            prefix = dest_prefix,
             target_compatible_with = [platform],
         )
         return platform, ":{}".format(name)
@@ -26,7 +27,7 @@ def _gen_targets(base_name, src, libname, version, spec):
     pkg_files(
         name = targets[-1],
         srcs = [src],
-        prefix = spec.prefix,
+        prefix = dest_prefix,
         renames = {src: target},
         target_compatible_with = [platform],
     )
@@ -39,7 +40,7 @@ def _gen_targets(base_name, src, libname, version, spec):
         targets.append("{}_{}".format(name, link_name))
         pkg_mklink(
             name = targets[-1],
-            link_name = "{}{}".format(spec.prefix, link),
+            link_name = "{}{}".format(dest_prefix, link),
             target = target,
             target_compatible_with = [platform],
         )
@@ -48,8 +49,8 @@ def _gen_targets(base_name, src, libname, version, spec):
     pkg_filegroup(name = name, srcs = targets, target_compatible_with = [platform])
     return platform, ":{}".format(name)
 
-def so_symlink(name, src, libname, version):
-    """Creates shared library packaging appropriate for each platform.
+def so_symlink(name, src, libname = None, version = None, prefix = ""):
+    """Creates shared library symlink chain following Unix conventions.
 
     Unix (Linux/macOS): Generates the common multilevel symlink hierarchy for shared libraries:
     - `real name`: actual file with full version (e.g., libreadline.so.3.0 / libreadline.3.0.dylib)
@@ -64,9 +65,10 @@ def so_symlink(name, src, libname, version):
         name: Name of the generated pkg_filegroup
         src: Label of the cc_shared_library to package
         libname: Library name without extension (e.g., "libreadline")
+        prefix: Installation directory prefix (default: "")
         version: Full version string (e.g., "3.0", ignored on Windows)
     """
     native.alias(
         name = name,
-        actual = select(dict([_gen_targets(name, src, libname, version, spec) for spec in _SPECS])),
+        actual = select(dict([_gen_targets(name, src, libname, version, prefix, spec) for spec in _SPECS])),
     )

deps/attr/attr.BUILD.bazel

@@ -97,12 +97,13 @@ so_symlink(
     src = ":attr",
     libname = "libattr",
     version = "1.1.2501",
+    prefix = "embedded",
 )
 
 pkg_files(
     name = "hdr_files",
     srcs = _PUBLIC_HEADERS,
-    prefix = "include/attr/",
+    prefix = "embedded/include/attr/",
 )
 
 expand_template(
@@ -122,7 +123,7 @@ expand_template(
 pkg_files(
     name = "pc_file",
     srcs = [":gen_pkgconfig"],
-    prefix = "lib/pkgconfig",
+    prefix = "embedded/lib/pkgconfig",
 )
 
 pkg_install(

deps/bzip2.BUILD.bazel

@@ -138,19 +138,19 @@ cc_shared_library(
 
 pkg_mklink(
     name = "so_major_minor",
-    link_name = "lib/libbz2.so.1.0",
+    link_name = "embedded/lib/libbz2.so.1.0",
     target = SONAME,
 )
 
 pkg_mklink(
     name = "so_major",
-    link_name = "lib/libbz2.so.1",
+    link_name = "embedded/lib/libbz2.so.1",
     target = SONAME,
 )
 
 pkg_mklink(
     name = "so",
-    link_name = "lib/libbz2.so",
+    link_name = "embedded/lib/libbz2.so",
     target = SONAME,
 )
 
@@ -161,13 +161,13 @@ pkg_files(
         # Note: you would think you can put :so and other links here, but pkg_files
         # seems to drop links in srcs.
     ],
-    prefix = "lib",
+    prefix = "embedded/lib",
 )
 
 pkg_files(
     name = "hdr_files",
     srcs = _PUBLIC_HEADERS,
-    prefix = "include",
+    prefix = "embedded/include",
 )
 
 pkg_install(

deps/zlib.BUILD.bazel

@@ -132,20 +132,13 @@ so_symlink(
     src = ":z",
     libname = "libz",
     version = "1.3.1",
+    prefix = "embedded",
 )
 
 pkg_files(
     name = "hdr_files",
     srcs = _ZLIB_PUBLIC_HEADERS,
-    prefix = "include",
-)
-
-pkg_install(
-    name = "install",
-    srcs = [
-        ":hdr_files",
-        ":lib_files",
-    ],
+    prefix = "embedded/include",
 )
 
 copy_file(
@@ -159,11 +152,14 @@ pkg_files(
     srcs = [
         ":renamed_license",
     ],
+    prefix = "LICENSES",
 )
 
 pkg_install(
-    name = "install_license",
+    name = "install",
     srcs = [
+        ":hdr_files",
+        ":lib_files",
         ":license_files",
     ],
 )

deps/zstd.BUILD.bazel

@@ -1,10 +1,10 @@
 load("@@//bazel/rules:so_symlink.bzl", "so_symlink")
-load("@bazel_skylib//rules:expand_template.bzl", "expand_template")
 load("@bazel_skylib//rules:copy_file.bzl", "copy_file")
+load("@bazel_skylib//rules:expand_template.bzl", "expand_template")
+load("@rules_cc//cc:defs.bzl", "cc_library", "cc_shared_library")
 load("@rules_license//rules:license.bzl", "license")
-load("@rules_pkg//pkg:mappings.bzl", "pkg_files")
 load("@rules_pkg//pkg:install.bzl", "pkg_install")
-load("@rules_cc//cc:defs.bzl", "cc_library", "cc_shared_library")
+load("@rules_pkg//pkg:mappings.bzl", "pkg_files")
 
 package(default_visibility = ["//visibility:private"])
 
@@ -90,12 +90,13 @@ so_symlink(
     libname = "libzstd",
     src = ":zstd",
     version = _VERSION,
+    prefix = "embedded",
 )
 
 pkg_files(
     name = "hdr_files",
     srcs = _PUBLIC_HEADERS,
-    prefix = "include/",
+    prefix = "embedded/include",
 )
 
 expand_template(
@@ -110,13 +111,13 @@ expand_template(
         "@VERSION@": _VERSION,
         "@LIBS_MT@": "",
         "@LIBS_PRIVATE@": "",
-    }
+    },
 )
 
 pkg_files(
     name = "pc_file",
     srcs = [":gen_pkgconfig"],
-    prefix = "lib/pkgconfig",
+    prefix = "embedded/lib/pkgconfig",
 )
 
 pkg_install(

omnibus/config/software/attr.rb

@@ -29,7 +29,7 @@
 relative_path "#{name}-#{version}"
 
 build do
-  command_on_repo_root "bazelisk run -- @attr//:install --destdir='#{install_dir}/embedded'"
+  command_on_repo_root "bazelisk run -- @attr//:install --destdir='#{install_dir}'"
   command_on_repo_root "bazelisk run -- //bazel/rules:replace_prefix --prefix '#{install_dir}/embedded'" \
     " #{install_dir}/embedded/lib/pkgconfig/libattr.pc" \
     " #{install_dir}/embedded/lib/libattr.so"

omnibus/config/software/bzip2.rb

@@ -32,7 +32,7 @@
 source url: "https://fossies.org/linux/misc/#{name}-#{version}.tar.gz"
 
 build do
-  command_on_repo_root "bazelisk run -- @bzip2//:install --destdir='#{install_dir}/embedded'"
+  command_on_repo_root "bazelisk run -- @bzip2//:install --destdir='#{install_dir}'"
 
   # The version of bzip2 we use doesn't create a pkgconfig file,
   # we add it here manually (needed at least by the Python build)

omnibus/config/software/zlib.rb

@@ -17,6 +17,5 @@
 name "zlib"
 
 build do
-  command_on_repo_root "bazelisk run -- @zlib//:install --destdir='#{install_dir}/embedded'"
-  command_on_repo_root "bazelisk run -- @zlib//:install_license --destdir='#{install_dir}/LICENSES'"
+  command_on_repo_root "bazelisk run -- @zlib//:install --destdir='#{install_dir}'"
 end

omnibus/config/software/zstd.rb

@@ -28,7 +28,7 @@
 relative_path "zstd-#{version}"
 
 build do
-  command_on_repo_root "bazelisk run -- @zstd//:install --destdir='#{install_dir}/embedded'"
+  command_on_repo_root "bazelisk run -- @zstd//:install --destdir='#{install_dir}'"
   command_on_repo_root "bazelisk run -- //bazel/rules:replace_prefix --prefix '#{install_dir}/embedded'" \
     " #{install_dir}/embedded/lib/pkgconfig/libzstd.pc" \
     " #{install_dir}/embedded/lib/libzstd.so"