node-gyp: allow node.exe/iojs.exe to be renamed #1251

piscisaureus · 2015-03-25T00:14:17Z

win,node-gyp: allow node.exe/iojs.exe to be renamed
On Windows, when node or io.js attempts to dynamically load a compiled
addon, the compiled addon tries to load node.exe or iojs.exe again -
depending on which import library the module used when it was linked.
This makes it impossible to rename node.exe or iojs.exe, because when
that happens the module can't find its dependencies.

With this patch, a delay-load hook is added to all modules that are
compiled with node-gyp. The delay-load hook ensures that whenever a
module tries to load imports from node.exe/iojs.exe, it'll just refer
back to the process image, thus making it possible to rename the
iojs/node binary.

Bug: iojs#751
Bug: iojs#965
Upstream PR: nodejs/node-gyp#599

R=@bnoordhuis
R=@rvagg
R=@iojs/platform-windows

am11 · 2015-03-25T03:25:00Z

This is outstanding. Thank you! 👍 🌟

Is it possible that we could rename iojs.exe to anything other than node.exe?
(ex. jsl.exe (next to cl.exe) or jsrunner.exe)

piscisaureus · 2015-03-25T03:27:40Z

@am11 yes, you can rename it to anything you like now.

rvagg · 2015-03-25T03:39:41Z

it's a bit beyond me, so windozy, but lgtm none the less

can someone verify a few addons on windows with this? I don't have time to fiddle right now unfortunately

piscisaureus · 2015-03-25T03:43:39Z

Here's the ones I tested myself:

bson\build\Release\bson.node
node-sass\build\Release\binding.node
bufferutil\build\Release\bufferutil.node
utf-8-validate\build\Release\validation.node
kerberos\build\Release\kerberos.node
sqlite3\build\Release\node_sqlite3.nodeelease\kerberos.node

piscisaureus · 2015-03-25T04:06:26Z

@rvagg Made it a teensy bit less windozy, but unfortunately this is as good as it gets...

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This makes it impossible to rename node.exe or iojs.exe, because when that happens the module can't find its dependencies. With this patch, a delay-load hook is added to all modules that are compiled with node-gyp. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just refer back to the process image, thus making it possible to rename the iojs/node binary. Bug: nodejs#751 Bug: nodejs#965 Upstream PR: nodejs/node-gyp#599 PR-URL: nodejs#1251 Reviewed-By: Rod Vagg <rod@vagg.org>

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This makes it impossible to rename node.exe or iojs.exe, because when that happens the module can't find its dependencies. With this patch, a delay-load hook is added to all modules that are compiled with node-gyp. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just refer back to the process image, thus making it possible to rename the iojs/node binary. Bug: nodejs/node#751 Bug: nodejs/node#965 Downstream PR: nodejs/node#1251

am11 · 2015-03-25T04:23:59Z

I have also tested with node-sass binary and it is working perfectly fine.

@rvagg, we are using pangyp with node-sass and so do other folks. Once this ~~get merged~~ (already merged!) here, should we apply this patch to pangyp as well?

othiym23 · 2015-03-25T04:48:31Z

@piscisaureus I'm keeping an eye on @TooTallNate/node-gyp#599 now, but this is going to need to be added to the floating patch we apply to npm when it's merged to io.js until such time as a new version of node-gyp is released upstream, no? Can you do me a favor and ping me on issues that touch things under deps/npm so I know they need to be preserved on merges?

piscisaureus · 2015-03-25T04:57:19Z

@othiym23
I think we're currently floating two patches:

this one :)
58a612e

othiym23 · 2015-03-25T05:00:17Z

OK! You're going on the reviewers list for npm updates now, because I'm not sure I'll remember this (although I am making a note of it).

Fishrock123 · 2015-03-25T05:00:45Z

@othiym23 @piscisaureus though next update, with should just merge the commits again for floating, so as to just have one if possible.

othiym23 · 2015-03-25T05:01:33Z

@Fishrock123

should just merge the commits again for floating, if possible.

Can you expand? I'm not sure I get what you're saying.

The delay-load hook that was landed in 3d46fef to make compiled addons work on Windows regardless of the iojs.exe/node.exe filename causes issues with a small amount of compiled addons. Therefore this patch makes it an opt-in feature. An addon may set the 'win_delay_load_hook' option to 'true' in its binding.gyp to enable this feature. Example: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Refs: nodejs#1251 PR-URL: nodejs#1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

@piscisaureus

Fix inherited by @piscisaureus's work: * nodejs/node#1251 and * nodejs/node#1266 Issue URL: #4. PR URL: rvagg#5.

* nodejs/node#1251 and * nodejs/node#1266 Note: this is a disableable/optional feature and it is disabled by default (since there are chances that MSVCR chokes on linking, given if the module exports data) Issue URL: #4. PR URL: rvagg#5.

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: #751 Bug: #965 Upstream PR: nodejs/node-gyp#599 PR-URL: #1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: #1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

Notable changes: * fs: corruption can be caused by fs.writeFileSync() and append-mode fs.writeFile() and fs.writeFileSync() under certain circumstances, reported in #1058, fixed in #1063 (Olov Lassus). * iojs: an "internal modules" API has been introduced to allow core code to share JavaScript modules internally only without having to expose them as a public API, this feature is for core-only #848 (Vladimir Kurchatkin). * timers: two minor problems with timers have been fixed: - Timer#close() is now properly idempotent #1288 (Petka Antonov). - setTimeout() will only run the callback once now after an unref() during the callback #1231 (Roman Reiss). * Windows: a "delay-load hook" has been added for compiled add-ons on Windows that should alleviate some of the problems that Windows users may be experiencing with add-ons in io.js #1251 (Bert Belder). * V8: minor bug-fix upgrade for V8 to 4.1.0.27. * npm: upgrade npm to 2.7.4. See npm CHANGELOG.md for details.

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: nodejs#751 Bug: nodejs#965 Upstream PR: nodejs/node-gyp#599 PR-URL: nodejs#1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: nodejs#1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: #751 Bug: #965 Upstream PR: nodejs/node-gyp#599 PR-URL: #1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: #1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: nodejs#751 Bug: nodejs#965 Upstream PR: nodejs/node-gyp#599 PR-URL: nodejs#1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: nodejs#1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: #751 Bug: #965 Upstream PR: nodejs/node-gyp#599 PR-URL: #1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: #1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

On Windows, when node or io.js attempts to dynamically load a compiled addon, the compiled addon tries to load node.exe or iojs.exe again - depending on which import library the module used when it was linked. This causes many compiled addons to break when node.exe or iojs.exe are renamed, because when the binary has been renamed the addon DLL can't find the (right) .exe file to load its imports from. This patch gives compiled addon developers an option to overcome this restriction by compiling a delay-load hook into their binary. The delay-load hook ensures that whenever a module tries to load imports from node.exe/iojs.exe, it'll just look at the process image, thereby making the addon work regardless of what name the node/iojs binary has. To enable this feature, the addon developer must set the 'win_delay_load_hook' option to 'true' in their binding.gyp file, like this: ``` { 'targets': [ { 'target_name': 'ernie', 'win_delay_load_hook': 'true', ... ``` Bug: nodejs#751 Bug: nodejs#965 Upstream PR: nodejs/node-gyp#599 PR-URL: nodejs#1251 Reviewed-By: Rod Vagg <rod@vagg.org> PR-URL: nodejs#1266 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

piscisaureus mentioned this pull request Mar 25, 2015

Windows: Broken node alias #751

Closed

piscisaureus force-pushed the win-fix-renaming branch from 316a2ce to 6a00fdc Compare March 25, 2015 00:18

piscisaureus mentioned this pull request Mar 25, 2015

Unable to build and run C++ addon in Windows 8.1 x64 #965

Closed

mscdex added the c++ Issues and PRs that require attention from people who are familiar with C++. label Mar 25, 2015

piscisaureus added the windows Issues and PRs related to the Windows platform. label Mar 25, 2015

piscisaureus mentioned this pull request Mar 25, 2015

Release proposal: v1.6.3 #1252

Closed

piscisaureus force-pushed the win-fix-renaming branch from 6a00fdc to 8bf7eec Compare March 25, 2015 03:50

piscisaureus force-pushed the win-fix-renaming branch from 8bf7eec to d87745e Compare March 25, 2015 03:55

piscisaureus force-pushed the win-fix-renaming branch from d87745e to ba92954 Compare March 25, 2015 04:00

piscisaureus force-pushed the win-fix-renaming branch from ba92954 to 3d46fef Compare March 25, 2015 04:18

piscisaureus merged commit 3d46fef into nodejs:v1.x Mar 25, 2015

piscisaureus deleted the win-fix-renaming branch March 25, 2015 04:24

piscisaureus mentioned this pull request Mar 25, 2015

win: allow node.exe/iojs.exe to be renamed nodejs/node-gyp#599

Merged

am11 added a commit to am11/pangyp that referenced this pull request Mar 29, 2015

win: Adds delay load hook to allow renaming exe.

251a416

Fix inherited by @piscisaureus's work: * nodejs/node#1251 and * nodejs/node#1266 Issue URL: #4. PR URL: rvagg#5.

am11 mentioned this pull request Mar 29, 2015

win: Adds delay load hook to allow renaming exe rvagg/archived-pangyp#5

Merged

trevorlinton mentioned this pull request Apr 7, 2015

Unable to load native modules on Windows x64 trueinteractions/tint2#110

Open

Fishrock123 mentioned this pull request Apr 9, 2015

test: windows ci timeouts related to child_process #1383

Closed

yoannmoinet mentioned this pull request Apr 12, 2015

Traduction de iojs Week of April 3rd nodejs/nodejs-fr#52

Merged

am11 mentioned this pull request May 3, 2015

Create a troubleshooting guide sass/node-sass#921

Merged

saper mentioned this pull request Jan 11, 2016

Exit status 3221225477 returned from node scripts/build.js / Windows XP sass/node-sass#1283

Closed

tvald mentioned this pull request Mar 16, 2017

don't delay loading node.exe due to imported data Venemo/node-lmdb#92

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

node-gyp: allow node.exe/iojs.exe to be renamed #1251

node-gyp: allow node.exe/iojs.exe to be renamed #1251

piscisaureus commented Mar 25, 2015

am11 commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

rvagg commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

am11 commented Mar 25, 2015

othiym23 commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

othiym23 commented Mar 25, 2015

Fishrock123 commented Mar 25, 2015

othiym23 commented Mar 25, 2015

node-gyp: allow node.exe/iojs.exe to be renamed #1251

node-gyp: allow node.exe/iojs.exe to be renamed #1251

Conversation

piscisaureus commented Mar 25, 2015

am11 commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

rvagg commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

am11 commented Mar 25, 2015

othiym23 commented Mar 25, 2015

piscisaureus commented Mar 25, 2015

othiym23 commented Mar 25, 2015

Fishrock123 commented Mar 25, 2015

othiym23 commented Mar 25, 2015