Skip to contentSkip to conversation

webkitgtk: Reduce stack and heap sizes for jsc on musl

PATCH Superseded Khem Raj 3 participants 5 messages Mar 17, 2021

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Khem Raj

author
#0 lore raw

PATCH 1/1 webkitgtk: Reduce stack and heap sizes for jsc on musl

Fixes

[YOCTO #14281]

Cc Andrei Gherzan <[email protected]>
---
 .../webkitgtk/musl-lower-stack-usage.patch    | 51 +++++++++++++++++++
 meta/recipes-sato/webkit/webkitgtk_2.30.5.bb  |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644 meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch
meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +51 -0
new file mode 100644
index 0000000000..3d66766d9a
@@ -0,0 +1,51 @@
+reduce thread stack and heap usage for javascriptcore on musl
+
+default sizes for musl are smaller compared to glibc, this matches
+to musl defaults, avoid stack overflow crashes in jscore
+
+Upstream-Status: Pending
+Signed-off-by: Khem Raj <[email protected]>
+
+--- a/Source/JavaScriptCore/runtime/OptionsList.h
++++ b/Source/JavaScriptCore/runtime/OptionsList.h
+@@ -75,6 +75,18 @@ constexpr bool enableWebAssemblyStreamin
+ // On instantiation of the first VM instance, the Options will be write protected
+ // and cannot be modified thereafter.
+ 
++#if OS(LINUX) && !defined(__GLIBC__)
++// non-glibc options on linux ( musl )
++constexpr unsigned jscMaxPerThreadStack = 80 * KB;
++constexpr unsigned jscSoftReservedZoneSize = 32 * KB;
++constexpr unsigned jscReservedZoneSize = 16 * KB;
++#else
++//default
++constexpr unsigned jscMaxPerThreadStack = 4 * MB;
++constexpr unsigned jscSoftReservedZoneSize = 128 * KB;
++constexpr unsigned jscReservedZoneSize = 64 * KB;
++#endif
++
+ #define FOR_EACH_JSC_OPTION(v)                                          \
+     v(Bool, useKernTCSM, defaultTCSMValue(), Normal, "Note: this needs to go before other options since they depend on this value.") \
+     v(Bool, validateOptions, false, Normal, "crashes if mis-typed JSC options were passed to the VM") \
+@@ -90,9 +102,9 @@ constexpr bool enableWebAssemblyStreamin
+     \
+     v(Bool, reportMustSucceedExecutableAllocations, false, Normal, nullptr) \
+     \
+-    v(Unsigned, maxPerThreadStackUsage, 5 * MB, Normal, "Max allowed stack usage by the VM") \
+-    v(Unsigned, softReservedZoneSize, 128 * KB, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
+-    v(Unsigned, reservedZoneSize, 64 * KB, Normal, "The amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
++    v(Unsigned, maxPerThreadStackUsage, jscMaxPerThreadStack, Normal, "Max allowed stack usage by the VM") \
++    v(Unsigned, softReservedZoneSize, jscSoftReservedZoneSize, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
++    v(Unsigned, reservedZoneSize, jscReservedZoneSize, Normal, "The amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
+     \
+     v(Bool, crashOnDisallowedVMEntry, ASSERT_ENABLED, Normal, "Forces a crash if we attempt to enter the VM when disallowed") \
+     v(Bool, crashIfCantAllocateJITMemory, false, Normal, nullptr) \
+@@ -601,7 +613,7 @@ public:
+     bool init(const char*);
+     bool isInRange(unsigned);
+     const char* rangeString() const { return (m_state > InitError) ? m_rangeString : s_nullRangeStr; }
+-    
++
+     void dump(PrintStream& out) const;
+ 
+ private:
meta/recipes-sato/webkit/webkitgtk_2.30.5.bb +1 -0
index d0a41f48c7..36d33f550d 100644
@@ -20,6 +20,7 @@ SRC_URI = "https://www.webkitgtk.org/releases/${BPN}-${PV}.tar.xz \
            file://include_xutil.patch \
            file://reduce-memory-overheads.patch \
            file://0001-Extend-atomics-check-to-include-1-byte-CAS-test.patch \
+           file://musl-lower-stack-usage.patch \
            "
 
 SRC_URI[sha256sum] = "7d0dab08e3c5ae07bec80b2822ef42e952765d5724cac86eb23999bfed5a7f1f"
Signature · 1 line
2.31.0
#1 lore raw

Please Khem, send these patches upstream first.

Alex

Quoted 111 lines · Khem Raj

Fixes

[YOCTO #14281]

Cc Andrei Gherzan <[email protected]>
---
 .../webkitgtk/musl-lower-stack-usage.patch    | 51 +++++++++++++++++++
 meta/recipes-sato/webkit/webkitgtk_2.30.5.bb  |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch

diff --git a/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch b/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file mode 100644
index 0000000000..3d66766d9a

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +12 -0
@@ -0,0 +1,51 @@
+reduce thread stack and heap usage for javascriptcore on musl
+
+default sizes for musl are smaller compared to glibc, this matches
+to musl defaults, avoid stack overflow crashes in jscore
+
+Upstream-Status: Pending
+Signed-off-by: Khem Raj <[email protected]>
+
+--- a/Source/JavaScriptCore/runtime/OptionsList.h
++++ b/Source/JavaScriptCore/runtime/OptionsList.h
+@@ -75,6 +75,18 @@ constexpr bool enableWebAssemblyStreamin
+ // On instantiation of the first VM instance, the Options will be write

protected
+ // and cannot be modified thereafter.

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +15 -0
+
++#if OS(LINUX) && !defined(__GLIBC__)
++// non-glibc options on linux ( musl )
++constexpr unsigned jscMaxPerThreadStack = 80 * KB;
++constexpr unsigned jscSoftReservedZoneSize = 32 * KB;
++constexpr unsigned jscReservedZoneSize = 16 * KB;
++#else
++//default
++constexpr unsigned jscMaxPerThreadStack = 4 * MB;
++constexpr unsigned jscSoftReservedZoneSize = 128 * KB;
++constexpr unsigned jscReservedZoneSize = 64 * KB;
++#endif
++
+ #define FOR_EACH_JSC_OPTION(v)                                          \
+     v(Bool, useKernTCSM, defaultTCSMValue(), Normal, "Note: this needs

to go before other options since they depend on this value.") \
+ v(Bool, validateOptions, false, Normal, "crashes if mis-typed JSC
options were passed to the VM") \
+@@ -90,9 +102,9 @@ constexpr bool enableWebAssemblyStreamin

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +2 -0
+     \
+     v(Bool, reportMustSucceedExecutableAllocations, false, Normal,

nullptr) \
+ \
+- v(Unsigned, maxPerThreadStackUsage, 5 * MB, Normal, "Max allowed
stack usage by the VM") \
+- v(Unsigned, softReservedZoneSize, 128 * KB, Normal, "A buffer
greater than reservedZoneSize that reserves space for stringifying exceptions.") \
+- v(Unsigned, reservedZoneSize, 64 * KB, Normal, "The amount of stack
space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
++ v(Unsigned, maxPerThreadStackUsage, jscMaxPerThreadStack, Normal,
"Max allowed stack usage by the VM") \
++ v(Unsigned, softReservedZoneSize, jscSoftReservedZoneSize, Normal,
"A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
++ v(Unsigned, reservedZoneSize, jscReservedZoneSize, Normal, "The
amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +2 -0
+     \
+     v(Bool, crashOnDisallowedVMEntry, ASSERT_ENABLED, Normal, "Forces a

crash if we attempt to enter the VM when disallowed") \

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +5 -0
+     v(Bool, crashIfCantAllocateJITMemory, false, Normal, nullptr) \
+@@ -601,7 +613,7 @@ public:
+     bool init(const char*);
+     bool isInRange(unsigned);
+     const char* rangeString() const { return (m_state > InitError) ?

m_rangeString : s_nullRangeStr; }
+-
++

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +3 -0
+     void dump(PrintStream& out) const;
+
+ private:
meta/recipes-sato/webkit/webkitgtk_2.30.5.bb +1 -0
index d0a41f48c7..36d33f550d 100644
@@ -20,6 +20,7 @@ SRC_URI = "
 https://www.webkitgtk.org/releases/${BPN}-${PV}.tar.xz \
            file://include_xutil.patch \
            file://reduce-memory-overheads.patch \
 
 file://0001-Extend-atomics-check-to-include-1-byte-CAS-test.patch \
+           file://musl-lower-stack-usage.patch \
            "

SRC_URI[sha256sum] =
"7d0dab08e3c5ae07bec80b2822ef42e952765d5724cac86eb23999bfed5a7f1f" --
2.31.0

author
#2 lore raw
Quoted 3 lines · Alexander Kanavin

Please Khem, send these patches upstream first.

its widely discussed problem in webkit and musl circuits, the patch here is carried by almost all musl distros in some form. see https://bugs.webkit.org/show_bug.cgi?id=187485
unfortunately, there is no final solution yet which is acceptable upstream as such.

Quoted 91 lines

Alex

Quoted 88 lines · Khem Raj

Fixes

[YOCTO #14281]

Cc Andrei Gherzan <[email protected]>
---
 .../webkitgtk/musl-lower-stack-usage.patch    | 51 +++++++++++++++++++
 meta/recipes-sato/webkit/webkitgtk_2.30.5.bb  |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644 meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch
meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +51 -0
new file mode 100644
index 0000000000..3d66766d9a
@@ -0,0 +1,51 @@
+reduce thread stack and heap usage for javascriptcore on musl
+
+default sizes for musl are smaller compared to glibc, this matches
+to musl defaults, avoid stack overflow crashes in jscore
+
+Upstream-Status: Pending
+Signed-off-by: Khem Raj <[email protected]>
+
+--- a/Source/JavaScriptCore/runtime/OptionsList.h
++++ b/Source/JavaScriptCore/runtime/OptionsList.h
+@@ -75,6 +75,18 @@ constexpr bool enableWebAssemblyStreamin
+ // On instantiation of the first VM instance, the Options will be write protected
+ // and cannot be modified thereafter.
+
++#if OS(LINUX) && !defined(__GLIBC__)
++// non-glibc options on linux ( musl )
++constexpr unsigned jscMaxPerThreadStack = 80 * KB;
++constexpr unsigned jscSoftReservedZoneSize = 32 * KB;
++constexpr unsigned jscReservedZoneSize = 16 * KB;
++#else
++//default
++constexpr unsigned jscMaxPerThreadStack = 4 * MB;
++constexpr unsigned jscSoftReservedZoneSize = 128 * KB;
++constexpr unsigned jscReservedZoneSize = 64 * KB;
++#endif
++
+ #define FOR_EACH_JSC_OPTION(v)                                          \
+     v(Bool, useKernTCSM, defaultTCSMValue(), Normal, "Note: this needs to go before other options since they depend on this value.") \
+     v(Bool, validateOptions, false, Normal, "crashes if mis-typed JSC options were passed to the VM") \
+@@ -90,9 +102,9 @@ constexpr bool enableWebAssemblyStreamin
+     \
+     v(Bool, reportMustSucceedExecutableAllocations, false, Normal, nullptr) \
+     \
+-    v(Unsigned, maxPerThreadStackUsage, 5 * MB, Normal, "Max allowed stack usage by the VM") \
+-    v(Unsigned, softReservedZoneSize, 128 * KB, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
+-    v(Unsigned, reservedZoneSize, 64 * KB, Normal, "The amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
++    v(Unsigned, maxPerThreadStackUsage, jscMaxPerThreadStack, Normal, "Max allowed stack usage by the VM") \
++    v(Unsigned, softReservedZoneSize, jscSoftReservedZoneSize, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
++    v(Unsigned, reservedZoneSize, jscReservedZoneSize, Normal, "The amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
+     \
+     v(Bool, crashOnDisallowedVMEntry, ASSERT_ENABLED, Normal, "Forces a crash if we attempt to enter the VM when disallowed") \
+     v(Bool, crashIfCantAllocateJITMemory, false, Normal, nullptr) \
+@@ -601,7 +613,7 @@ public:
+     bool init(const char*);
+     bool isInRange(unsigned);
+     const char* rangeString() const { return (m_state > InitError) ? m_rangeString : s_nullRangeStr; }
+-
++
+     void dump(PrintStream& out) const;
+
+ private:
meta/recipes-sato/webkit/webkitgtk_2.30.5.bb +1 -1
index d0a41f48c7..36d33f550d 100644
@@ -20,6 +20,7 @@ SRC_URI = "https://www.webkitgtk.org/releases/${BPN}-${PV}.tar.xz \
            file://include_xutil.patch \
            file://reduce-memory-overheads.patch \
            file://0001-Extend-atomics-check-to-include-1-byte-CAS-test.patch \
+           file://musl-lower-stack-usage.patch \
            "
 
 SRC_URI[sha256sum] = "7d0dab08e3c5ae07bec80b2822ef42e952765d5724cac86eb23999bfed5a7f1f"
--

2.31.0

#3 lore raw
In reply to Khem Raj

Hi,

Quoted 21 lines · Khem Raj

Fixes

[YOCTO #14281]

Cc Andrei Gherzan <[email protected]>
---
 .../webkitgtk/musl-lower-stack-usage.patch    | 51 +++++++++++++++++++
 meta/recipes-sato/webkit/webkitgtk_2.30.5.bb  |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644 

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch

(quoted diff) +0 -0

a/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch b/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file mode 100644
index 0000000000..3d66766d9a

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch line 4

Quoted 4 lines
meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +4 -0
@@ -0,0 +1,51 @@
+reduce thread stack and heap usage for javascriptcore on musl
+
+default sizes for musl are smaller compared to glibc, this matches
+to musl defaults, avoid stack overflow crashes in jscore

Tested and it works as expected. I was fixing it a bit hacky doing something similar to https://github.com/yaegashi/muslstack but this is cleaner.

I've backported your patch for dunfell too (rebased the patch).

Andrei

author
#4 lore raw
Quoted 17 lines · Andrei Gherzan

Hi,

Quoted 13 lines · Khem Raj

Fixes

[YOCTO #14281]

Cc Andrei Gherzan <[email protected]>
---
 .../webkitgtk/musl-lower-stack-usage.patch    | 51 +++++++++++++++++++
 meta/recipes-sato/webkit/webkitgtk_2.30.5.bb  |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch

Quoted 15 lines

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch line 4

Quoted 12 lines

diff --git a/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch b/meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file mode 100644
index 0000000000..3d66766d9a

meta/recipes-sato/webkit/webkitgtk/musl-lower-stack-usage.patch new file +4 -0
@@ -0,0 +1,51 @@
+reduce thread stack and heap usage for javascriptcore on musl
+
+default sizes for musl are smaller compared to glibc, this matches
+to musl defaults, avoid stack overflow crashes in jscore

Tested and it works as expected. I was fixing it a bit hacky doing something similar to https://github.com/yaegashi/muslstack but this is cleaner.

Thanks for testing, I have sent a v2 which should be better. I would rather not use muslstack utility as it papers over real issues. I think real fix would
be in webkit to use pthread_attr_setstacksize() instead of hardcoding the values, but I will let some experts in webkit to take it on.

Quoted 3 lines

I've backported your patch for dunfell too (rebased the patch).

Andrei