build: windows sharedlib support #7487

stefanmb · 2016-06-29T20:16:19Z

Checklist

make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

build

Description of change

Following #6994 the next step is to provide support for generating a DLL on Windows for people using Node.js as a shared library. This commit makes the necessary changes, but unfortunately it requires a floating patch to V8's gyp files. I do not believe there is any way around this issue, so I am opening the PR now to get some feedback on my approach.

Overview:

Added "dll" option to vcbuild.bat
Insure that Unix SO name is not used on Windows (i.e. produce a .dll file)
Insure that Node and its V8 dependency link against the Visual C++ Runtime dynamically.

The last point is very important. In Windows If different libraries you link use different versions of the C++ Runtime you will get a variety of issues that are well documented here: http://siomsystems.com/mixing-visual-studio-versions/. Note that this situation can occur in multiple ways:

If different libraries in your program mix static and dynamic runtime libraries.
If different libraries in your program mix versions of Visual Studio.
If both situations above occur.

This also means that people using node.dll must also use the exact same Visual Studio version that Node was compiled with to build the program that links against the DLL. Further information is available here: https://www.softwariness.com/articles/visual-cpp-runtime-libraries/

The basic problem with V8 is that its gyp files are setup to always link statically against the C++ runtime unless V8 itself is being compiled as a shared library. The floating patch I provided is minimal and is inspired by qt/qtwebengine-chromium@743a641.

stefanmb · 2016-06-29T20:17:43Z

@bnoordhuis I would greatly appreciate your thoughts/review.
@joshgav This is the Windows patch I promised in #6994.

mhdawson · 2016-06-29T20:54:33Z

Once we have some feedback, if positive we'll start the process of landing the change to deps/v8/build/toolchain.gypi to v8 master.

joshgav · 2016-06-29T21:57:31Z

/cc @nodejs/platform-windows @orangemocha @AndrewPardoe

joshgav · 2016-06-29T22:02:57Z

TL;DR - modifications to Node and V8 build files to enable building Node as a DLL for Windows. Particularly useful for Electron. A change in V8 is also needed because by default it statically includes the VC runtime.

It's +34 lines mostly modifying compiler switches.

Josh Gavant
Sr. Program Manager
Microsoft | One Microsoft Way | Redmond, WA | 98052

From: Stefan Budeanu notifications@github.com
Sent: Wednesday, June 29, 2016 1:16:45 PM
To: nodejs/node
Subject: [nodejs/node] build: windows sharedlib support (DO NOT LAND YET) (#7487)

Checklist

make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

build

Description of change

Following #6994 #6994 the next step is to provide support for generating a DLL on Windows for people using Node.js as a shared library. This commit makes the necessary changes, but unfortunately it requires a floating patch to V8's gyp files. I do not believe there is any way around this issue, so I am opening the PR now to get some feedback on my approach.

Overview:

Added "dll" option to vcbuild.bat
Insure that Unix SO name is not used on Windows (i.e. produce a .dll file)
Insure that Node and its V8 dependency link against the Visual C++ Runtime dynamically.

The last point is very important. In Windows If different libraries you link use different versions of the C++ Runtime you will get a variety of issues that are well documented here: http://siomsystems.com/mixing-visual-studio-versions/https://na01.safelinks.protection.outlook.com/?url=http%3a%2f%2fsiomsystems.com%2fmixing-visual-studio-versions%2f&data=01%7c01%7cjosh.gavant%40microsoft.com%7cb9ab4f56485a4420361408d3a05a5075%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=LKLU0ztyY2C2Tozbvqcb1tOZs77OXz8ez3GymjQxQcA%3d. Note that this situation can occur in multiple ways:

If different libraries in your program mix static and dynamic runtime libraries.
If different libraries in your program mix versions of Visual Studio.
If both situations above occur.

This also means that people using node.dll must also use the exact same Visual Studio version that Node was compiled with to build the program that links against the DLL. Further information is available here: https://www.softwariness.com/articles/visual-cpp-runtime-libraries/https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fwww.softwariness.com%2farticles%2fvisual-cpp-runtime-libraries%2f&data=01%7c01%7cjosh.gavant%40microsoft.com%7cb9ab4f56485a4420361408d3a05a5075%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=n317zpyIVeP8HwteGbJ09fb5%2baTc6zLvAa6RYpDmtLs%3d

The basic problem with V8 is that its gyp files are setup to always link statically against the C++ runtime unless V8 itself is being compiled as a shared library. The floating patch I provided is minimal and is inspired by qt/qtwebengine-chromium@743a641qt/qtwebengine-chromium@743a641.

You can view, comment on, or merge this pull request online at:

#7487

Commit Summary

WIP: Windows Shared Lib

File Changes

M common.gypihttps://github.com/build: windows sharedlib support #7487/files#diff-0 (30)
M deps/v8/build/toolchain.gypihttps://github.com/build: windows sharedlib support #7487/files#diff-1 (6)
M node.gyphttps://github.com/build: windows sharedlib support #7487/files#diff-2 (2)
M vcbuild.bathttps://github.com/build: windows sharedlib support #7487/files#diff-3 (2)

Patch Links:

You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHubhttps://github.com//pull/7487, or mute the threadhttps://github.com/notifications/unsubscribe/AEN4WM3nClbv4h4tcCXB4iKC_PJj7aEtks5qQtKtgaJpZM4JBhb5.

mhdawson · 2016-07-05T19:33:33Z

@bnoordhuis , @orangemocha could you two take a look and comment. If this looks good we'll start the process of submitting change in deps/v8/build/toolchain.gypi to google master.

orangemocha · 2016-07-06T15:40:33Z

vcbuild.bat

@@ -79,6 +79,7 @@ if /i "%1"=="without-intl"     set i18n_arg=%1&goto arg-ok
 if /i "%1"=="download-all"  set download_arg="--download=all"&goto arg-ok
 if /i "%1"=="ignore-flaky"  set test_args=%test_args% --flaky-tests=dontcare&goto arg-ok
 if /i "%1"=="enable-vtune"  set enable_vtune_arg=1&goto arg-ok
+if /i "%1"=="dll"           set dll=1&goto arg-ok



Need to unset dll at https://github.com/nodejs/node/pull/7487/files#diff-f1d059c92a388e475daa1fbc2a88aa3aR41

stefanmb · 2016-07-06T19:53:13Z

@orangemocha I'm not sure I follow. Could you give me a few more details on what needs to be unset? Thanks.

orangemocha · 2016-07-06T21:08:44Z

@stefanmb , add

set dll=

after

node/vcbuild.bat

Line 40 in 6ee9e29

set build_addons=

I am still reviewing the rest.

stefanmb · 2016-07-06T21:42:08Z

@orangemocha Oops, thanks for catching that. Updated PR.

orangemocha · 2016-07-07T11:41:47Z

deps/v8/build/toolchain.gypi

@@ -1104,7 +1104,7 @@
          'VCCLCompilerTool': {
            'Optimization': '0',
            'conditions': [
-              ['component=="shared_library"', {
+              ['component=="shared_library" or node_shared=="true"', {


Perhaps make this a bit more generic: something like force_dynamic_crt rather than node_shared and set that in node.gyp based on node_shared.

Agreed, as it is I don't know if this change to the V8 gyp files can be accepted at all (as a floating patch) since the policy is to not patch upstream dependencies. If we have to submit the changes upstream to V8 first then force_dynamic_crt makes much more sense. Thanks.

We will submit to V8, do we just need to change node_shared to force_dynamic_crt as part of doing that ?

@mhdawson I would say yes, it's a 2 line change for V8 to toolchain.gypi. Let me know when that's ready and I will remove the warning from the title of this PR and push it once enough LGTMs are gathered.

orangemocha · 2016-07-07T11:42:32Z

One small suggestion, otherwise I don't see any problems with this change.

mhdawson · 2016-07-11T16:10:52Z

@sxa555 is working on the patch for submission to v8 master

stefanmb · 2016-07-11T23:44:48Z

@mhdawson Let me know when that's done and I will edit this patch. I can land it once sufficient LGTMs are reached.

sxa · 2016-07-15T14:30:14Z

@stefanmb https://codereview.chromium.org/2149963002 is the submission and it's not looking like there are any conceptual objections but they wanted force_dynamic_crt to be a 0/1 value rather than a true/false string to be consistent with the other V8 options so I've made that change that. I've verified that that works with node with this added to configure:

if b(options.shared) == 1:
o['variables']['force_dynamic_crt'] = 1
else:
o['variables']['force_dynamic_crt]' = 0

…MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. Reference: nodejs/node#7487 BUG= R=machenbach@chromium.org, michael_dawson@ca.ibm.com Review-Url: https://codereview.chromium.org/2149963002 Cr-Commit-Position: refs/heads/master@{#37814}

…MD on windows (patchset v8#3 id:40001 of https://codereview.chromium.org/2149963002/ ) Reason for revert: Fails gyp build with chromium: https://build.chromium.org/p/tryserver.chromium.mac/builders/ios-simulator/builds/37051 Blocks roll: https://codereview.chromium.org/2157903002/ Please add the trybot ios-simulator on reland. Original issue's description: > [build] Add force_dynamic_crt option to build a static library with /MD on windows > > Adds option to build a V8 library statically, but with the options on > windows that allows it to be subsequently included in another DLL. On > Windows this is required for it to correclty link against the correct > C++ runtime. Require for our Node.js shared library build. > > Reference: nodejs/node#7487 > > BUG= > R=machenbach@chromium.org, michael_dawson@ca.ibm.com > > Committed: https://crrev.com/9cf88c1c364cf76c1e745aa63196768435e8ef5d > Cr-Commit-Position: refs/heads/master@{#37814} TBR=michael_dawson@ca.ibm.com,franzih@chromium.org,sxa@uk.ibm.com # Skipping CQ checks because original CL landed less than 1 days ago. NOPRESUBMIT=true NOTREECHECKS=true NOTRY=true BUG= Review-Url: https://codereview.chromium.org/2155073002 Cr-Commit-Position: refs/heads/master@{#37822}

…MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. Reference: nodejs/node#7487 BUG= R=machenbach@chromium.org, michael_dawson@ca.ibm.com Committed: https://crrev.com/9cf88c1c364cf76c1e745aa63196768435e8ef5d Review-Url: https://codereview.chromium.org/2149963002 Cr-Original-Commit-Position: refs/heads/master@{#37814} Cr-Commit-Position: refs/heads/master@{#37856}

sxa · 2016-07-19T10:16:33Z

Now landed in V8 master :-)

Added "dll" option to vcbuild.bat Insure that Unix SO name is not used on Windows (i.e. produce a .dll file) Insure that Node and its V8 dependency link against the Visual C++ Runtime dynamically. Requires backported V8 patch, see PR 7802. Ref: nodejs#7802 PR-URL: nodejs#7487 Reviewed-By: Alexis Campailla <alexis@janeasystems.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Original Commit Message: Added "dll" option to vcbuild.bat Insure that Unix SO name is not used on Windows (i.e. produce a .dll file) Insure that Node and its V8 dependency link against the Visual C++ Runtime dynamically. Requires backported V8 patch, see PR 7802. Ref: #7802 PR-URL: #7487 Reviewed-By: Alexis Campailla <alexis@janeasystems.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> PR-URL: #8084 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>

Original commit message: [build] Add force_dynamic_crt option to build a static library with /… …MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. Reference: nodejs#7487 BUG= R=machenbach@chromium.org, michael_dawson@ca.ibm.com Committed: https://crrev.com/9cf88c1c364cf76c1e745aa63196768435e8ef5d Review-Url: https://codereview.chromium.org/2149963002 Cr-Original-Commit-Position: refs/heads/master@{nodejs#37814} Cr-Commit-Position: refs/heads/master@{nodejs#37856} PR-URL: nodejs#7802 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Add configure flag for building a shared library that can be embedded in other applications (like Electron). Add flags --without-bundled-v8 and --without-v8-platform to control V8 dependencies used. PR-URL: nodejs#6994 Ref: nodejs#9385 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reference: nodejs#7487

Add force_dynamic_crt option to build a static library with /MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. PR-URL: nodejs#8084 Reference: nodejs#7487 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>

Add configure flag for building a shared library that can be embedded in other applications (like Electron). Add flags --without-bundled-v8 and --without-v8-platform to control V8 dependencies used. PR-URL: nodejs#6994 Ref: nodejs#9385 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reference: nodejs#7487

Added "dll" option to vcbuild.bat Ensure that Unix SO name is not used on Windows (i.e. produce a .dll file) Ensure that Node and its V8 dependency link against the Visual C++ Runtime dynamically. Requires backported V8 patch Ref: nodejs#7802 PR-URL: nodejs#7487 Reviewed-By: Alexis Campailla <alexis@janeasystems.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Original commit message: [build] Add force_dynamic_crt option to build a static library with /… …MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. Reference: nodejs#7487 BUG= R=machenbach@chromium.org, michael_dawson@ca.ibm.com Committed: https://crrev.com/9cf88c1c364cf76c1e745aa63196768435e8ef5d Review-Url: https://codereview.chromium.org/2149963002 Cr-Original-Commit-Position: refs/heads/master@{nodejs#37814} Cr-Commit-Position: refs/heads/master@{nodejs#37856} Ref: nodejs#7802 Ref: nodejs#8084 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Original commit message: [build] Add force_dynamic_crt option to build a static library with /… …MD on windows Adds option to build a V8 library statically, but with the options on windows that allows it to be subsequently included in another DLL. On Windows this is required for it to correclty link against the correct C++ runtime. Require for our Node.js shared library build. Reference: #7487 BUG= R=machenbach@chromium.org, michael_dawson@ca.ibm.com Committed: https://crrev.com/9cf88c1c364cf76c1e745aa63196768435e8ef5d Review-Url: https://codereview.chromium.org/2149963002 Cr-Original-Commit-Position: refs/heads/master@{#37814} Cr-Commit-Position: refs/heads/master@{#37856} Ref: #7802 Ref: #8084 PR-URL: #9610 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>

Add configure flag for building a shared library that can be embedded in other applications (like Electron). Add flags --without-bundled-v8 and --without-v8-platform to control V8 dependencies used. PR-URL: nodejs#6994 Ref: nodejs#9385 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reference: nodejs#7487

Add configure flag for building a shared library that can be embedded in other applications (like Electron). Add flags --without-bundled-v8 and --without-v8-platform to control V8 dependencies used. PR-URL: #6994 Ref: #7487 Ref: #9385 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Original Commit Message: Added "dll" option to vcbuild.bat Insure that Unix SO name is not used on Windows (i.e. produce a .dll file) Insure that Node and its V8 dependency link against the Visual C++ Runtime dynamically. Requires backported V8 patch, see PR 7802. Ref: #7802 PR-URL: #7487 Reviewed-By: Alexis Campailla <alexis@janeasystems.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> PR-URL: #9385 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

nodejs-github-bot added the v8 engine Issues and PRs related to the V8 dependency. label Jun 29, 2016

stefanmb added windows Issues and PRs related to the Windows platform. build Issues and PRs related to build files or the CI. labels Jun 29, 2016

stefanmb self-assigned this Jun 29, 2016

mscdex added v8 engine Issues and PRs related to the V8 dependency. and removed v8 engine Issues and PRs related to the V8 dependency. labels Jun 29, 2016

jasnell added the wip Issues and PRs that are still a work in progress. label Jun 29, 2016

orangemocha reviewed Jul 6, 2016
View reviewed changes

orangemocha reviewed Jul 7, 2016
View reviewed changes

stefanmb changed the title ~~build: windows sharedlib support (DO NOT LAND YET)~~ build: windows sharedlib support Jul 19, 2016

stefanmb added 3 commits July 19, 2016 07:48

WIP: Windows Shared Lib

1877277

WIP: Review Fix

db00e24

WIP: Use force_dynamic_crt v8 flag

406d774

stefanmb force-pushed the winsharedlib branch from 94e4186 to 406d774 Compare July 19, 2016 11:53

mhdawson mentioned this pull request Nov 8, 2016

Backport --shared to V4.x codebase to allow building as a shared library / DLL #9385

Closed

2 tasks

sxa mentioned this pull request Nov 18, 2016

Make --shared on AIX work (shared library support) #9675

Closed

2 tasks

springmeyer mentioned this pull request May 20, 2017

Build failing for node v6.5.0 on windows mapnik/node-mapnik#691

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: windows sharedlib support #7487

build: windows sharedlib support #7487

stefanmb commented Jun 29, 2016 •

edited

stefanmb commented Jun 29, 2016

mhdawson commented Jun 29, 2016

joshgav commented Jun 29, 2016

joshgav commented Jun 29, 2016

mhdawson commented Jul 5, 2016

orangemocha Jul 6, 2016

stefanmb commented Jul 6, 2016

orangemocha commented Jul 6, 2016

stefanmb commented Jul 6, 2016

orangemocha Jul 7, 2016

stefanmb Jul 7, 2016

mhdawson Jul 7, 2016

stefanmb Jul 7, 2016 •

edited

orangemocha commented Jul 7, 2016

mhdawson commented Jul 11, 2016

stefanmb commented Jul 11, 2016

sxa commented Jul 15, 2016

sxa commented Jul 19, 2016

build: windows sharedlib support #7487

build: windows sharedlib support #7487

Conversation

stefanmb commented Jun 29, 2016 • edited

Checklist

Affected core subsystem(s)

Description of change

stefanmb commented Jun 29, 2016

mhdawson commented Jun 29, 2016

joshgav commented Jun 29, 2016

joshgav commented Jun 29, 2016

mhdawson commented Jul 5, 2016

orangemocha Jul 6, 2016

Choose a reason for hiding this comment

stefanmb commented Jul 6, 2016

orangemocha commented Jul 6, 2016

stefanmb commented Jul 6, 2016

orangemocha Jul 7, 2016

Choose a reason for hiding this comment

stefanmb Jul 7, 2016

Choose a reason for hiding this comment

mhdawson Jul 7, 2016

Choose a reason for hiding this comment

stefanmb Jul 7, 2016 • edited

Choose a reason for hiding this comment

orangemocha commented Jul 7, 2016

mhdawson commented Jul 11, 2016

stefanmb commented Jul 11, 2016

sxa commented Jul 15, 2016

sxa commented Jul 19, 2016

stefanmb commented Jun 29, 2016 •

edited

stefanmb Jul 7, 2016 •

edited