nptl: Add comment to __pthread_get_minstack about external users

diff --git a/ChangeLog b/ChangeLog
index b46b581707b7ffa4ffe711bcd321f83e7007521b..53a3ae4ddbe3c63f14cb58776ee313c426fe60da 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2019-05-27  Florian Weimer  <fweimer@redhat.com>
+
+       * nptl/nptl-init.c: Add comment.
+
 2019-05-24  Florian Weimer  <fweimer@redhat.com>
 
        * resolv/nss_dns/dns-host.c (getanswer_r): Be more explicit about

diff --git a/nptl/nptl-init.c b/nptl/nptl-init.c
index 2926558b912f3c59feb4e740e88ea55803bc8442..73935f8be41f102034babb8e1a5cfb6852a95566 100644 (file)
--- a/nptl/nptl-init.c
+++ b/nptl/nptl-init.c
@@ -407,6 +407,14 @@ strong_alias (__pthread_initialize_minimal_internal,
              __pthread_initialize_minimal)
 
 
+/* This function is internal (it has a GLIBC_PRIVATE) version, but it
+   is widely used (either via weak symbol, or dlsym) to obtain the
+   __static_tls_size value.  This value is then used to adjust the
+   value of the stack size attribute, so that applications receive the
+   full requested stack size, not diminished by the TCB and static TLS
+   allocation on the stack.  Once the TCB is separately allocated,
+   this function should be removed or renamed (if it is still
+   necessary at that point).  */
 size_t
 __pthread_get_minstack (const pthread_attr_t *attr)
 {