cbe: implement optional slice representation change

Author: jacobly0

.github/CONTRIBUTING.md

@@ -68,7 +68,7 @@ test and debug from a git working tree.
 - `make` is typically sufficient to build zig during development iterations.
 - `make install` performs a build __and__ install.
 - `msbuild -p:Configuration=Release INSTALL.vcxproj` on Windows performs a
-build and install. To avoid install, pass cmake option `-DZIG_SKIP_INSTALL_LIB_FILES=ON`.
+build and install. To avoid install, pass cmake option `-DZIG_NO_LIB=ON`.
 
 To test changes, do the following from the build directory:
 

.github/ISSUE_TEMPLATE/bug.yml

@@ -14,27 +14,20 @@ body:
     attributes:
       label: Zig Version
       description: "The output of `zig version`"
-      placeholder: "0.9.0-dev.1275+ac52e0056"
+      placeholder: "0.10.0-dev.4583+875e98a57"
     validations:
       required: true
   - type: textarea
     id: repro
     attributes:
-      label: Steps to Reproduce
-      description: What exactly can someone else do, in order to observe the problem that you observed?
+      label: Steps to Reproduce and Observed Behavior
+      description: What exactly can someone else do, in order to observe the problem that you observed? Include the output and all error messages.
     validations:
       required: true
   - type: textarea
     id: expected
     attributes:
       label: Expected Behavior
-      description: What did you expect to happen?
-    validations:
-      required: true
-  - type: textarea
-    id: actual
-    attributes:
-      label: Actual Behavior
-      description: What happened instead? Be sure to include all error messages if any.
+      description: What did you expect to happen instead?
     validations:
       required: true

CMakeLists.txt

@@ -81,13 +81,20 @@ if("${ZIG_VERSION}" STREQUAL "")
 endif()
 message(STATUS "Configuring zig version ${ZIG_VERSION}")
 
-set(ZIG_SKIP_INSTALL_LIB_FILES off CACHE BOOL
+set(ZIG_NO_LIB off CACHE BOOL
     "Disable copying lib/ files to install prefix during the build phase")
 
+set(ZIG_SKIP_INSTALL_LIB_FILES off CACHE BOOL "Deprecated. Use ZIG_NO_LIB")
+if(ZIG_SKIP_INSTALL_LIB_FILES)
+  message(WARNING "ZIG_SKIP_INSTALL_LIB_FILES is deprecated. Use ZIG_NO_LIB instead.")
+  set(ZIG_NO_LIB ON)
+endif()
+
 set(ZIG_STATIC off CACHE BOOL "Attempt to build a static zig executable (not compatible with glibc)")
 set(ZIG_SHARED_LLVM off CACHE BOOL "Prefer linking against shared LLVM libraries")
 set(ZIG_STATIC_LLVM off CACHE BOOL "Prefer linking against static LLVM libraries")
 set(ZIG_STATIC_ZLIB off CACHE BOOL "Prefer linking against static zlib")
+set(ZIG_STATIC_ZSTD off CACHE BOOL "Prefer linking against static zstd")
 set(ZIG_USE_CCACHE off CACHE BOOL "Use ccache if available")
 
 if(CCACHE_PROGRAM AND ZIG_USE_CCACHE)
@@ -97,6 +104,7 @@ endif()
 if(ZIG_STATIC)
     set(ZIG_STATIC_LLVM ON)
     set(ZIG_STATIC_ZLIB ON)
+    set(ZIG_STATIC_ZSTD ON)
 endif()
 
 if (ZIG_SHARED_LLVM AND ZIG_STATIC_LLVM)
@@ -137,6 +145,12 @@ if(ZIG_STATIC_ZLIB)
     list(APPEND LLVM_LIBRARIES "${ZLIB}")
 endif()
 
+if(ZIG_STATIC_ZSTD)
+    list(REMOVE_ITEM LLVM_LIBRARIES "-lzstd")
+    find_library(ZSTD NAMES libzstd.a libzstdstatic.a zstd NAMES_PER_DIR)
+    list(APPEND LLVM_LIBRARIES "${ZSTD}")
+endif()
+
 if(APPLE AND ZIG_STATIC)
     list(REMOVE_ITEM LLVM_LIBRARIES "-lcurses")
     find_library(CURSES NAMES libcurses.a libncurses.a NAMES_PER_DIR
@@ -996,10 +1010,10 @@ elseif("${CMAKE_BUILD_TYPE}" STREQUAL "RelWithDebInfo")
 else()
   set(ZIG_RELEASE_ARG -Drelease -Dstrip)
 endif()
-if(ZIG_SKIP_INSTALL_LIB_FILES)
-  set(ZIG_SKIP_INSTALL_LIB_FILES_ARG "-Dskip-install-lib-files")
+if(ZIG_NO_LIB)
+  set(ZIG_NO_LIB_ARG "-Dno-lib")
 else()
-  set(ZIG_SKIP_INSTALL_LIB_FILES_ARG "-Dskip-install-lib-files=false")
+  set(ZIG_NO_LIB_ARG "")
 endif()
 if(ZIG_SINGLE_THREADED)
   set(ZIG_SINGLE_THREADED_ARG "-fsingle-threaded")
@@ -1072,7 +1086,7 @@ set(ZIG_BUILD_ARGS
     "-Denable-stage1"
     ${ZIG_RELEASE_ARG}
     ${ZIG_STATIC_ARG}
-    ${ZIG_SKIP_INSTALL_LIB_FILES_ARG}
+    ${ZIG_NO_LIB_ARG}
     ${ZIG_SINGLE_THREADED_ARG}
     "-Dtarget=${ZIG_TARGET_TRIPLE}"
     "-Dcpu=${ZIG_TARGET_MCPU}"

build.zig

@@ -61,7 +61,11 @@ pub fn build(b: *Builder) !void {
     const skip_stage1 = b.option(bool, "skip-stage1", "Main test suite skips stage1 compile error tests") orelse false;
     const skip_run_translated_c = b.option(bool, "skip-run-translated-c", "Main test suite skips run-translated-c tests") orelse false;
     const skip_stage2_tests = b.option(bool, "skip-stage2-tests", "Main test suite skips self-hosted compiler tests") orelse false;
-    const skip_install_lib_files = b.option(bool, "skip-install-lib-files", "Do not copy lib/ files to installation prefix") orelse false;
+    const deprecated_skip_install_lib_files = b.option(bool, "skip-install-lib-files", "deprecated. see no-lib") orelse false;
+    if (deprecated_skip_install_lib_files) {
+        std.log.warn("-Dskip-install-lib-files is deprecated in favor of -Dno-lib", .{});
+    }
+    const skip_install_lib_files = b.option(bool, "no-lib", "skip copying of lib/ files to installation prefix. Useful for development") orelse deprecated_skip_install_lib_files;
 
     const only_install_lib_files = b.option(bool, "lib-files-only", "Only install library files") orelse false;
 
@@ -122,8 +126,8 @@ pub fn build(b: *Builder) !void {
         return;
 
     const tracy = b.option([]const u8, "tracy", "Enable Tracy integration. Supply path to Tracy source");
-    const tracy_callstack = b.option(bool, "tracy-callstack", "Include callstack information with Tracy data. Does nothing if -Dtracy is not provided") orelse false;
-    const tracy_allocation = b.option(bool, "tracy-allocation", "Include allocation information with Tracy data. Does nothing if -Dtracy is not provided") orelse false;
+    const tracy_callstack = b.option(bool, "tracy-callstack", "Include callstack information with Tracy data. Does nothing if -Dtracy is not provided") orelse (tracy != null);
+    const tracy_allocation = b.option(bool, "tracy-allocation", "Include allocation information with Tracy data. Does nothing if -Dtracy is not provided") orelse (tracy != null);
     const force_gpa = b.option(bool, "force-gpa", "Force the compiler to use GeneralPurposeAllocator") orelse false;
     const link_libc = b.option(bool, "force-link-libc", "Force self-hosted compiler to link libc") orelse (enable_llvm or only_c);
     const sanitize_thread = b.option(bool, "sanitize-thread", "Enable thread-sanitization") orelse false;
@@ -378,7 +382,7 @@ pub fn build(b: *Builder) !void {
     if (tracy) |tracy_path| {
         const client_cpp = fs.path.join(
             b.allocator,
-            &[_][]const u8{ tracy_path, "TracyClient.cpp" },
+            &[_][]const u8{ tracy_path, "public", "TracyClient.cpp" },
         ) catch unreachable;
 
         // On mingw, we need to opt into windows 7+ to get some features required by tracy.
@@ -635,6 +639,7 @@ fn addStaticLlvmOptionsToExe(exe: *std.build.LibExeObjStep) !void {
     }
 
     exe.linkSystemLibrary("z");
+    exe.linkSystemLibrary("zstd");
 
     // This means we rely on clang-or-zig-built LLVM, Clang, LLD libraries.
     exe.linkSystemLibrary("c++");
@@ -673,13 +678,12 @@ fn addCxxKnownPath(
     exe.addObjectFile(path_unpadded);
 
     // TODO a way to integrate with system c++ include files here
-    // cc -E -Wp,-v -xc++ /dev/null
+    // c++ -E -Wp,-v -xc++ /dev/null
     if (need_cpp_includes) {
         // I used these temporarily for testing something but we obviously need a
         // more general purpose solution here.
-        //exe.addIncludePath("/nix/store/fvf3qjqa5qpcjjkq37pb6ypnk1mzhf5h-gcc-9.3.0/lib/gcc/x86_64-unknown-linux-gnu/9.3.0/../../../../include/c++/9.3.0");
-        //exe.addIncludePath("/nix/store/fvf3qjqa5qpcjjkq37pb6ypnk1mzhf5h-gcc-9.3.0/lib/gcc/x86_64-unknown-linux-gnu/9.3.0/../../../../include/c++/9.3.0/x86_64-unknown-linux-gnu");
-        //exe.addIncludePath("/nix/store/fvf3qjqa5qpcjjkq37pb6ypnk1mzhf5h-gcc-9.3.0/lib/gcc/x86_64-unknown-linux-gnu/9.3.0/../../../../include/c++/9.3.0/backward");
+        //exe.addIncludePath("/nix/store/2lr0fc0ak8rwj0k8n3shcyz1hz63wzma-gcc-11.3.0/include/c++/11.3.0");
+        //exe.addIncludePath("/nix/store/2lr0fc0ak8rwj0k8n3shcyz1hz63wzma-gcc-11.3.0/include/c++/11.3.0/x86_64-unknown-linux-gnu");
     }
 }
 

ci/azure/macos_script

@@ -9,7 +9,7 @@ ZIGDIR="$(pwd)"
 ARCH="x86_64"
 TARGET="$ARCH-macos-none"
 MCPU="baseline"
-CACHE_BASENAME="zig+llvm+lld+clang-$TARGET-0.10.0-dev.4111+5206832a8"
+CACHE_BASENAME="zig+llvm+lld+clang-$TARGET-0.10.0-dev.4560+828735ac0"
 PREFIX="$HOME/$CACHE_BASENAME"
 JOBS="-j2"
 
@@ -55,12 +55,26 @@ stage3-release/bin/zig build test docs \
   -Dskip-non-native \
   --search-prefix "$PREFIX"
 
+# Produce the experimental std lib documentation.
+mkdir -p "stage3-release/doc/std"
+stage3-release/bin/zig test "$(pwd)/../lib/std/std.zig" \
+  --zig-lib-dir "$(pwd)/../lib" \
+  -femit-docs="$(pwd)/stage3-release/doc/std" \
+  -fno-emit-bin
+
 if [ "${BUILD_REASON}" != "PullRequest" ]; then
-  mv ../LICENSE stage3-release/
-  mv ../zig-cache/langref.html stage3-release/
+  # Remove the unnecessary bin dir in stage3-release/bin/zig
   mv stage3-release/bin/zig stage3-release/
   rmdir stage3-release/bin
 
+  # Remove the unnecessary zig dir in stage3-release/lib/zig/std/std.zig
+  mv stage3-release/lib/zig stage3-release/lib2
+  rmdir stage3-release/lib
+  mv stage3-release/lib2 stage3-release/lib
+
+  mv ../LICENSE stage3-release/
+  mv ../zig-cache/langref.html stage3-release/doc
+
   VERSION=$(stage3-release/zig version)
   DIRNAME="zig-macos-$ARCH-$VERSION"
   TARBALL="$DIRNAME.tar.xz"

ci/azure/pipelines.yml

@@ -16,7 +16,7 @@ jobs:
     vmImage: 'windows-2019'
   variables:
     TARGET: 'x86_64-windows-gnu'
-    ZIG_LLVM_CLANG_LLD_NAME: 'zig+llvm+lld+clang-${{ variables.TARGET }}-0.10.0-dev.4459+4f9345d20'
+    ZIG_LLVM_CLANG_LLD_NAME: 'zig+llvm+lld+clang-${{ variables.TARGET }}-0.10.0-dev.4560+828735ac0'
     ZIG_LLVM_CLANG_LLD_URL: 'https://ziglang.org/deps/${{ variables.ZIG_LLVM_CLANG_LLD_NAME }}.zip'
   steps:
   - pwsh: |
@@ -60,6 +60,7 @@ jobs:
     displayName: 'Build'
 
   - pwsh: |
+      Set-Variable -Name ZIGLIBDIR -Value "$(Get-Location)\lib"
       Set-Variable -Name ZIGINSTALLDIR -Value "$(Get-Location)\stage3-release"
       Set-Variable -Name ZIGPREFIXPATH -Value "$(Get-Location)\$(ZIG_LLVM_CLANG_LLD_NAME)"
 
@@ -75,6 +76,14 @@ jobs:
         -Dstatic-llvm `
         -Dskip-non-native
       CheckLastExitCode
+
+      # Produce the experimental std lib documentation.
+      mkdir "$ZIGINSTALLDIR\doc\std" -force
+      & "$ZIGINSTALLDIR\bin\zig.exe" test "$ZIGLIBDIR\std\std.zig" `
+        --zig-lib-dir "$ZIGLIBDIR" `
+        -femit-docs="$ZIGINSTALLDIR\doc\std" `
+        -fno-emit-bin
+
     name: test
     displayName: 'Test'
 

ci/drone/drone.yml

@@ -9,56 +9,56 @@ platform:
 
 steps:
 - name: build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/linux_script_build
 
 - name: behavior
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_behavior
 
 - name: std_Debug
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_std_Debug
 
 - name: std_ReleaseSafe
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_std_ReleaseSafe
 
 - name: std_ReleaseFast
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_std_ReleaseFast
 
 - name: std_ReleaseSmall
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_std_ReleaseSmall
 
 - name: misc
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_misc
 
 - name: cases
   depends_on:
   - build
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   commands:
   - ./ci/drone/test_linux_cases
 
@@ -72,7 +72,7 @@ steps:
   - std_ReleaseSmall
   - misc
   - cases
-  image: ziglang/static-base:llvm15-aarch64-2
+  image: ziglang/static-base:llvm15-aarch64-3
   environment:
     SRHT_OAUTH_TOKEN:
       from_secret: SRHT_OAUTH_TOKEN

ci/drone/linux_script_finalize

@@ -12,18 +12,21 @@ if [ -n "$DRONE_PULL_REQUEST" ]; then
   exit 0
 fi
 
-apk update
-apk add py3-pip perl-utils jq curl
-pip3 install s3cmd
-
 cd build
 
-mv ../LICENSE "$INSTALL_PREFIX/"
-# https://github.com/ziglang/zig/issues/12689
-# mv ../zig-cache/langref.html "$INSTALL_PREFIX/"
+# Remove the unnecessary bin dir in $INSTALL_PREFIX/bin/zig
 mv "$INSTALL_PREFIX/bin/zig" "$INSTALL_PREFIX/"
 rmdir "$INSTALL_PREFIX/bin"
 
+# Remove the unnecessary zig dir in $INSTALL_PREFIX/lib/zig/std/std.zig
+mv "$INSTALL_PREFIX/lib/zig" "$INSTALL_PREFIX/lib2"
+rmdir "$INSTALL_PREFIX/lib"
+mv "$INSTALL_PREFIX/lib2" "$INSTALL_PREFIX/lib"
+
+mv ../LICENSE "$INSTALL_PREFIX/"
+# https://github.com/ziglang/zig/issues/12689
+# mv ../zig-cache/langref.html "$INSTALL_PREFIX/doc/"
+
 GITBRANCH="$DRONE_BRANCH"
 VERSION="$("$INSTALL_PREFIX/zig" version)"
 DIRNAME="zig-linux-$ARCH-$VERSION"

ci/drone/test_linux_std_Debug

@@ -13,3 +13,10 @@ $ZIG build test-std \
   -Dskip-release-fast \
   -Dskip-release-small \
   -Dskip-non-native
+
+# Produce the experimental std lib documentation.
+mkdir -p "$INSTALL_PREFIX/doc/std"
+$ZIG test "$DRONE_WORKSPACE/lib/std/std.zig" \
+  --zig-lib-dir "$DRONE_WORKSPACE/lib" \
+  -femit-docs="$INSTALL_PREFIX/doc/std" \
+  -fno-emit-bin

ci/srht/freebsd_script

@@ -62,12 +62,26 @@ stage3/bin/zig build test docs \
   -Dskip-stage1 \
   -Dskip-non-native
 
+# Produce the experimental std lib documentation.
+mkdir -p "stage3/doc/std"
+stage3/bin/zig test "$(pwd)/../lib/std/std.zig" \
+  --zig-lib-dir "$(pwd)/../lib" \
+  -femit-docs="$(pwd)/stage3/doc/std/" \
+  -fno-emit-bin
+
 if [ -f ~/.s3cfg ]; then
-  mv ../LICENSE stage3/
-  mv ../zig-cache/langref.html stage3/
+  # Remove the unnecessary bin dir in stage3/bin/zig
   mv stage3/bin/zig stage3/
   rmdir stage3/bin
 
+  # Remove the unnecessary zig dir in stage3/lib/zig/std/std.zig
+  mv stage3/lib/zig stage3/lib2
+  rmdir stage3/lib
+  mv stage3/lib2 stage3/lib
+
+  mv ../LICENSE stage3/
+  mv ../zig-cache/langref.html stage3/doc/
+
   GITBRANCH=$(basename $GITHUB_REF)
   VERSION=$(stage3/zig version)
   DIRNAME="zig-freebsd-x86_64-$VERSION"