[Packaging] Add No-asserts toolchain to setup #425

mhegazy · 2025-05-20T18:02:21Z

This is a follow up to swiftlang/swift#81644 which adds build support for no-asserts toolchain variant along with the default asserts variant.

Note to reviewers: Reviewing this change one commit at a time should give you a better experience than looking at all changes at once.

Changes:

Split bld.msi, ide.msi, cli.msi and dbg.msi into two separate msi's each. the current authoring with no changes (Same upgrade codes, and component names) goes to a <product>.asserts.msi and <product>.asserts.cab, and a new msi is created using the same authoring but new upgrade codes to <product>.noasserts.msi and <product>.noasserts.cab
The new msi's are only built if the command line option is passed to build.cmd/build.ps1. this ensures that build time do not regress as a result of this change
To enable that without duplication, the authoring is parametrized.; the authoring for bld.msi, ide.msi, cli.msi and dbg.msi moves from <product>.wxs to <product>.wxi and is shared between the two msi variants.
- To see the differences few differences between the two msi's look at asserts/<product>.asserts.wxs vs noasserts/<product>.noasserts.wxs
Create a new folder structure for no-asserts toolchain, by duplicating all our folders under ToolchainsVersioned defined in shared.wxs
- Since the no-assert toolchain build output is not a complete layout, i.e. not all needed files are built twice, only ones that are different between the two toolchain variants are built. we need to pull filles from both output folders to make a complete layout.
Add a new UI option to select one or both of the two variants of the toolchain
UI makes it so at least one toolchain should be enabled at anytime. users can choose to add both
- Path env var is set to Asserts if it is selected. if users select only no-asserts variant, then the PATH will be set to this one.

Still Open

UI for the installer. This changes extends the UI by 40px to add new options; this should be fixed in a separate PR before this change lands

…n applicaple

…n available

… avialable

…ailable

…nstalled

platforms/Windows/SideBySideUpgradeStrategy.props

platforms/Windows/shared/swift.en-us.wxl

compnerd · 2025-05-20T21:18:50Z

platforms/Windows/shared/shared.wxs

@@ -103,6 +130,10 @@
    <Property Id="TOOLCHAINSVERSIONED">
      <RegistrySearch Root="HKCU" Key="SOFTWARE\!(loc.ManufacturerName)\Installer\$(ProductVersion)\!(bind.Property.UpgradeCode)" Name="ToolchainsVersioned" Type="directory" />


We should name this to include the variant.

that would break the upgrade scenario.

compnerd · 2025-05-20T21:27:11Z

platforms/Windows/shared/shared.wxs

@@ -86,6 +108,11 @@
        <RegistryValue Root="HKCU" Key="SOFTWARE\!(loc.ManufacturerName)\Installer\$(ProductVersion)\!(bind.Property.UpgradeCode)" Name="ToolchainsVersioned" Value="[ToolchainsVersioned]" />
        <util:RemoveFolderEx Property="TOOLCHAINSVERSIONED" Condition="TOOLCHAINSVERSIONED" />
      </Component>
+
+      <Component Id="VersionedDirectoryCleanupToolchains_noasserts">


Can this not be merged into the singular VersionedDirectoryCleanupToolchains? We should be cleaning up %ROOT%\Toolchains.

no. they are two different directories: <INSTALLROOT>\Toolchains\0.0.0+Asserts and <INSTALLROOT>\Toolchains\0.0.0+NoAsserts

My understanding was that it was meant to clean up any orphaned directories in <INSTALLROOT>\Toolchains. Is that not the case?

there are two folders. Toolchain, and ToolchainVersioned:

<DirectoryRef Id="INSTALLROOT"> <Directory Id="Toolchains" Name="Toolchains"> <Directory Id="ToolchainsVersioned" Name="$(ProductVersion)+Asserts">

So for every top level folder we create we need to remember to remove it. so this is why we have similar entries for VersionedDirectoryCleanupRedistVersion, VersionedDirectoryCleanupRuntimes and VersionedDirectoryCleanupRedistVersion

compnerd · 2025-05-20T21:29:15Z

platforms/Windows/shared/shared.wxs

+        </Directory>
+      </Directory>
+    </DirectoryRef>
+  </Fragment>


I'm not sure I understand why the _noasserts suffix is needed at all. The layout is going to be identical, its just that the content source is different. The only piece that changes is the ToolchainsVersioned directory, which can include the suffix. If we do this, we can actually share the definition across the variants no?

they are diffrent layouts. they are rooted at diffrent directores. one at 0.0.0+Asserts and one at 0.0.0+NoAsserts. a directory entry in an msi is just a name and parent. since the parents are diffrent, we need a new entry

I see; lets make that a prefix I think.

why? all the other names it is a suffix. e.g. dbg.noasserts. why would component names and folder names be different?

…ad of INCLUDE_NOASSERTS as a flag

platforms/Windows/bundle/installer.wixproj

platforms/Windows/bld/noasserts/bld.noasserts..wxs

compnerd · 2025-05-21T02:53:38Z

platforms/Windows/bld/noasserts/bld.noasserts.wixproj

+  <PropertyGroup>
+    <DefineConstants>
+      $(DefineConstants);
+      _USR_LIB_CLANG_NOASSERTS=$(ImageRoot)\Toolchains\$(ProductVersion)+Asserts\usr\lib\clang;


Can we make the variant a prefix instead of a suffix?

platforms/Windows/bundle/installer.wxs

compnerd · 2025-05-21T03:02:13Z

platforms/Windows/shared/shared.wxs

+        </Directory>
+      </Directory>
+    </DirectoryRef>
+  </Fragment>


I see; lets make that a prefix I think.

compnerd · 2025-05-21T03:02:46Z

platforms/Windows/shared/shared.wxs

@@ -86,6 +108,11 @@
        <RegistryValue Root="HKCU" Key="SOFTWARE\!(loc.ManufacturerName)\Installer\$(ProductVersion)\!(bind.Property.UpgradeCode)" Name="ToolchainsVersioned" Value="[ToolchainsVersioned]" />
        <util:RemoveFolderEx Property="TOOLCHAINSVERSIONED" Condition="TOOLCHAINSVERSIONED" />
      </Component>
+
+      <Component Id="VersionedDirectoryCleanupToolchains_noasserts">


My understanding was that it was meant to clean up any orphaned directories in <INSTALLROOT>\Toolchains. Is that not the case?

mhegazy added 17 commits May 19, 2025 11:26

Add option to install no-assert toolchain variant to installer ui

5ffba7e

Split cli.msi into two msi's by variant

61d6312

Install cli.noassert files to noassert directory layout

dab2c7a

Pull cli.noassert files from the noaassert build output directory whe…

6d43ed4

…n applicaple

Split dbg.msi into two separate msi's by variant

9d10e4a

Install dbg.noassert files to the noassert toolchain folder structure

e97f514

Pull dbg.noassert files from the noassert toolchain output folder whe…

ba99d51

…n available

Split ide.msi into two separate msi's by variant

f3be6a7

Install ide.noasserts files to the noassert toolchain folder

cf8f5f1

Pull ide.noasserts.msi files from the noasserts toolchain output when…

92426da

… avialable

Split bld.msi into two separate msi's based on variant

26bc1ef

Install bld.noassert.msi files to the noassert toolchain folders

4d78a33

Pull bld.noasserts.msi files from the noasserts output folder when av…

15d0085

…ailable

Make product names for noasserts msi uniform

4e76e5a

Only build the noasserts msi's if the INCLUDE_NOASSERTS property is set

c8994cb

Only allow choosing variants if we are building with IncludeNoAsserts

979dcc8

Set PATH env var for no-asserts toolchain if it is the only variant i…

0ad2570

…nstalled

compnerd reviewed May 20, 2025

View reviewed changes

mhegazy added 5 commits May 20, 2025 17:55

Change names of upgradeCodes and localization strings to reflect variant

2dd961b

Add variant in product names

7daeb98

Use variant-free names for UI for feature selection

5a02a68

Use Asserts/NoAsserts uniformly in all Product Names

2ab0301

Pass in an array of ToolchainVariants as input to the installer isnte…

c50c40e

…ad of INCLUDE_NOASSERTS as a flag

mhegazy requested a review from compnerd May 21, 2025 01:17

compnerd reviewed May 21, 2025

View reviewed changes

platforms/Windows/bundle/installer.wixproj Outdated Show resolved Hide resolved

compnerd reviewed May 21, 2025

View reviewed changes

mhegazy added 3 commits May 20, 2025 21:29

Switch variable name casing

eae9891

Fix file names with extra dot

4aba9d4

Use Install instead of Include

3846721

mhegazy requested a review from compnerd May 21, 2025 04:35

mhegazy added 2 commits May 20, 2025 22:53

Fix typo

c942d44

Use condition correctelly in proj file

2e5dfdb

		@@ -103,6 +130,10 @@
		<Property Id="TOOLCHAINSVERSIONED">
		<RegistrySearch Root="HKCU" Key="SOFTWARE\!(loc.ManufacturerName)\Installer\$(ProductVersion)\!(bind.Property.UpgradeCode)" Name="ToolchainsVersioned" Type="directory" />

[Packaging] Add No-asserts toolchain to setup #425

Are you sure you want to change the base?

[Packaging] Add No-asserts toolchain to setup #425

Conversation

mhegazy commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mhegazy commented May 20, 2025 •

edited

Loading