Adding upstream version 1.44.3.upstream/1.44.3upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 447 insertions, 0 deletions

diff --git a/libnetdata/threads/Makefile.am b/libnetdata/threads/Makefile.am
new file mode 100644
index 00000000..161784b8
--- /dev/null
+++ b/libnetdata/threads/Makefile.am
@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+AUTOMAKE_OPTIONS = subdir-objects
+MAINTAINERCLEANFILES = $(srcdir)/Makefile.in
+
+dist_noinst_DATA = \
+    README.md \
+    $(NULL)
diff --git a/libnetdata/threads/README.md b/libnetdata/threads/README.md
new file mode 100644
index 00000000..7e9e493f
--- /dev/null
+++ b/libnetdata/threads/README.md
@@ -0,0 +1,12 @@
+<!--
+title: Threads
+custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threads/README.md
+sidebar_label: "Threads"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata"
+-->
+
+# Threads
+
+Netdata uses a custom threads library
diff --git a/libnetdata/threads/threads.c b/libnetdata/threads/threads.c
new file mode 100644
index 00000000..c14f9a7e
--- /dev/null
+++ b/libnetdata/threads/threads.c
@@ -0,0 +1,340 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include "../libnetdata.h"
+
+static pthread_attr_t *netdata_threads_attr = NULL;
+
+// ----------------------------------------------------------------------------
+// per thread data
+
+typedef struct {
+    void *arg;
+    char tag[NETDATA_THREAD_NAME_MAX + 1];
+    void *(*start_routine) (void *);
+    NETDATA_THREAD_OPTIONS options;
+} NETDATA_THREAD;
+
+static __thread NETDATA_THREAD *netdata_thread = NULL;
+
+inline int netdata_thread_tag_exists(void) {
+    return (netdata_thread && *netdata_thread->tag);
+}
+
+static const char *thread_name_get(bool recheck) {
+    static __thread char threadname[NETDATA_THREAD_NAME_MAX + 1] = "";
+
+    if(netdata_thread_tag_exists())
+        strncpyz(threadname, netdata_thread->tag, NETDATA_THREAD_NAME_MAX);
+    else {
+        if(!recheck && threadname[0])
+            return threadname;
+
+#if defined(__FreeBSD__)
+        pthread_get_name_np(pthread_self(), threadname, NETDATA_THREAD_NAME_MAX + 1);
+        if(strcmp(threadname, "netdata") == 0)
+            strncpyz(threadname, "MAIN", NETDATA_THREAD_NAME_MAX);
+#elif defined(__APPLE__)
+        strncpyz(threadname, "MAIN", NETDATA_THREAD_NAME_MAX);
+#elif defined(HAVE_PTHREAD_GETNAME_NP)
+        pthread_getname_np(pthread_self(), threadname, NETDATA_THREAD_NAME_MAX + 1);
+        if(strcmp(threadname, "netdata") == 0)
+            strncpyz(threadname, "MAIN", NETDATA_THREAD_NAME_MAX);
+#else
+        strncpyz(threadname, "MAIN", NETDATA_THREAD_NAME_MAX);
+#endif
+    }
+
+    return threadname;
+}
+
+const char *netdata_thread_tag(void) {
+    return thread_name_get(false);
+}
+
+static size_t webrtc_id = 0;
+static __thread bool webrtc_name_set = false;
+void webrtc_set_thread_name(void) {
+    if(!netdata_thread && !webrtc_name_set) {
+        webrtc_name_set = true;
+        char threadname[NETDATA_THREAD_NAME_MAX + 1];
+
+#if defined(__FreeBSD__)
+        snprintfz(threadname, NETDATA_THREAD_NAME_MAX, "WEBRTC[%zu]", __atomic_fetch_add(&webrtc_id, 1, __ATOMIC_RELAXED));
+        pthread_set_name_np(pthread_self(), threadname);
+#elif defined(__APPLE__)
+        snprintfz(threadname, NETDATA_THREAD_NAME_MAX, "WEBRTC[%zu]", __atomic_fetch_add(&webrtc_id, 1, __ATOMIC_RELAXED));
+        pthread_setname_np(threadname);
+#elif defined(HAVE_PTHREAD_GETNAME_NP)
+        pthread_getname_np(pthread_self(), threadname, NETDATA_THREAD_NAME_MAX+1);
+        if(strcmp(threadname, "netdata") == 0) {
+            snprintfz(threadname, NETDATA_THREAD_NAME_MAX, "WEBRTC[%zu]", __atomic_fetch_add(&webrtc_id, 1, __ATOMIC_RELAXED));
+            pthread_setname_np(pthread_self(), threadname);
+        }
+#else
+        snprintfz(threadname, NETDATA_THREAD_NAME_MAX, "WEBRTC[%zu]", __atomic_fetch_add(&webrtc_id, 1, __ATOMIC_RELAXED));
+        pthread_setname_np(pthread_self(), threadname);
+#endif
+
+        thread_name_get(true);
+    }
+}
+
+// ----------------------------------------------------------------------------
+// compatibility library functions
+
+static __thread pid_t gettid_cached_tid = 0;
+pid_t gettid(void) {
+    pid_t tid = 0;
+
+    if(likely(gettid_cached_tid > 0))
+        return gettid_cached_tid;
+
+#ifdef __FreeBSD__
+
+    tid = (pid_t)pthread_getthreadid_np();
+
+#elif defined(__APPLE__)
+
+    #if (defined __MAC_OS_X_VERSION_MIN_REQUIRED && __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060)
+        uint64_t curthreadid;
+        pthread_threadid_np(NULL, &curthreadid);
+        tid = (pid_t)curthreadid;
+    #else /* __MAC_OS_X_VERSION_MIN_REQUIRED */
+        tid = (pid_t)pthread_self;
+    #endif /* __MAC_OS_X_VERSION_MIN_REQUIRED */
+
+#else /* __APPLE__*/
+
+    tid = (pid_t)syscall(SYS_gettid);
+
+#endif /* __FreeBSD__, __APPLE__*/
+
+    gettid_cached_tid = tid;
+    return tid;
+}
+
+// ----------------------------------------------------------------------------
+// early initialization
+
+size_t netdata_threads_init(void) {
+    int i;
+
+    // --------------------------------------------------------------------
+    // get the required stack size of the threads of netdata
+
+    if(!netdata_threads_attr) {
+        netdata_threads_attr = callocz(1, sizeof(pthread_attr_t));
+        i = pthread_attr_init(netdata_threads_attr);
+        if (i != 0)
+            fatal("pthread_attr_init() failed with code %d.", i);
+    }
+
+    size_t stacksize = 0;
+    i = pthread_attr_getstacksize(netdata_threads_attr, &stacksize);
+    if(i != 0)
+        fatal("pthread_attr_getstacksize() failed with code %d.", i);
+
+    return stacksize;
+}
+
+// ----------------------------------------------------------------------------
+// late initialization
+
+void netdata_threads_init_after_fork(size_t stacksize) {
+    int i;
+
+    // ------------------------------------------------------------------------
+    // set pthread stack size
+
+    if(netdata_threads_attr && stacksize > (size_t)PTHREAD_STACK_MIN) {
+        i = pthread_attr_setstacksize(netdata_threads_attr, stacksize);
+        if(i != 0)
+            nd_log(NDLS_DAEMON, NDLP_WARNING, "pthread_attr_setstacksize() to %zu bytes, failed with code %d.", stacksize, i);
+        else
+            nd_log(NDLS_DAEMON, NDLP_DEBUG, "Set threads stack size to %zu bytes", stacksize);
+    }
+    else
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "Invalid pthread stacksize %zu", stacksize);
+}
+
+// ----------------------------------------------------------------------------
+// threads init for external plugins
+
+void netdata_threads_init_for_external_plugins(size_t stacksize) {
+    size_t default_stacksize = netdata_threads_init();
+    if(default_stacksize < 1 * 1024 * 1024)
+        default_stacksize = 1 * 1024 * 1024;
+
+    netdata_threads_init_after_fork(stacksize ? stacksize : default_stacksize);
+}
+
+// ----------------------------------------------------------------------------
+// netdata_thread_create
+
+void rrdset_thread_rda_free(void);
+void sender_thread_buffer_free(void);
+void query_target_free(void);
+void service_exits(void);
+void rrd_collector_finished(void);
+
+static void thread_cleanup(void *ptr) {
+    if(netdata_thread != ptr) {
+        NETDATA_THREAD *info = (NETDATA_THREAD *)ptr;
+        nd_log(NDLS_DAEMON, NDLP_ERR, "THREADS: internal error - thread local variable does not match the one passed to this function. Expected thread '%s', passed thread '%s'", netdata_thread->tag, info->tag);
+    }
+
+    if(!(netdata_thread->options & NETDATA_THREAD_OPTION_DONT_LOG_CLEANUP))
+        nd_log(NDLS_DAEMON, NDLP_DEBUG, "thread with task id %d finished", gettid());
+
+    rrd_collector_finished();
+    sender_thread_buffer_free();
+    rrdset_thread_rda_free();
+    query_target_free();
+    thread_cache_destroy();
+    service_exits();
+    worker_unregister();
+
+    netdata_thread->tag[0] = '\0';
+
+    freez(netdata_thread);
+    netdata_thread = NULL;
+}
+
+void netdata_thread_set_tag(const char *tag) {
+    if(!tag || !*tag)
+        return;
+
+    int ret = 0;
+
+    char threadname[NETDATA_THREAD_NAME_MAX+1];
+    strncpyz(threadname, tag, NETDATA_THREAD_NAME_MAX);
+
+#if defined(__FreeBSD__)
+    pthread_set_name_np(pthread_self(), threadname);
+#elif defined(__APPLE__)
+    ret = pthread_setname_np(threadname);
+#else
+    ret = pthread_setname_np(pthread_self(), threadname);
+#endif
+
+    if (ret != 0)
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot set pthread name of %d to %s. ErrCode: %d", gettid(), threadname, ret);
+    else
+        nd_log(NDLS_DAEMON, NDLP_DEBUG, "set name of thread %d to %s", gettid(), threadname);
+
+    if(netdata_thread) {
+        strncpyz(netdata_thread->tag, threadname, sizeof(netdata_thread->tag) - 1);
+    }
+}
+
+void uv_thread_set_name_np(uv_thread_t ut, const char* name) {
+    int ret = 0;
+
+    char threadname[NETDATA_THREAD_NAME_MAX+1];
+    strncpyz(threadname, name, NETDATA_THREAD_NAME_MAX);
+
+#if defined(__FreeBSD__)
+    pthread_set_name_np(ut ? ut : pthread_self(), threadname);
+#elif defined(__APPLE__)
+    // Apple can only set its own name
+    UNUSED(ut);
+#else
+    ret = pthread_setname_np(ut ? ut : pthread_self(), threadname);
+#endif
+
+    thread_name_get(true);
+
+    if (ret)
+        nd_log(NDLS_DAEMON, NDLP_NOTICE, "cannot set libuv thread name to %s. Err: %d", threadname, ret);
+}
+
+void os_thread_get_current_name_np(char threadname[NETDATA_THREAD_NAME_MAX + 1])
+{
+    threadname[0] = '\0';
+#if defined(__FreeBSD__)
+    pthread_get_name_np(pthread_self(), threadname, NETDATA_THREAD_NAME_MAX + 1);
+#elif defined(HAVE_PTHREAD_GETNAME_NP) /* Linux & macOS */
+    (void)pthread_getname_np(pthread_self(), threadname, NETDATA_THREAD_NAME_MAX + 1);
+#endif
+}
+
+static void *netdata_thread_init(void *ptr) {
+    netdata_thread = (NETDATA_THREAD *)ptr;
+
+    if(!(netdata_thread->options & NETDATA_THREAD_OPTION_DONT_LOG_STARTUP))
+        nd_log(NDLS_DAEMON, NDLP_DEBUG, "thread created with task id %d", gettid());
+
+    if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot set pthread cancel type to DEFERRED.");
+
+    if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot set pthread cancel state to ENABLE.");
+
+    netdata_thread_set_tag(netdata_thread->tag);
+
+    if (!(netdata_thread->options & NETDATA_THREAD_OPTION_JOINABLE)) {
+        int rc = pthread_detach(pthread_self());
+        if (rc != 0)
+            nd_log(NDLS_DAEMON, NDLP_WARNING,
+                   "cannot request detach of newly created %s thread. pthread_detach() failed with code %d",
+                   netdata_thread->tag, rc);
+    }
+
+    void *ret = NULL;
+    pthread_cleanup_push(thread_cleanup, ptr);
+            ret = netdata_thread->start_routine(netdata_thread->arg);
+    pthread_cleanup_pop(1);
+
+    return ret;
+}
+
+int netdata_thread_create(netdata_thread_t *thread, const char *tag, NETDATA_THREAD_OPTIONS options, void *(*start_routine) (void *), void *arg) {
+    NETDATA_THREAD *info = callocz(1, sizeof(NETDATA_THREAD));
+    info->arg = arg;
+    info->start_routine = start_routine;
+    info->options = options;
+    strncpyz(info->tag, tag, NETDATA_THREAD_NAME_MAX);
+
+    int ret = pthread_create(thread, netdata_threads_attr, netdata_thread_init, info);
+    if(ret != 0)
+        nd_log(NDLS_DAEMON, NDLP_ERR, "failed to create new thread for %s. pthread_create() failed with code %d", tag, ret);
+
+    return ret;
+}
+
+// ----------------------------------------------------------------------------
+// netdata_thread_cancel
+#ifdef NETDATA_INTERNAL_CHECKS
+int netdata_thread_cancel_with_trace(netdata_thread_t thread, int line, const char *file, const char *function) {
+#else
+int netdata_thread_cancel(netdata_thread_t thread) {
+#endif
+    int ret = pthread_cancel(thread);
+    if(ret != 0)
+#ifdef NETDATA_INTERNAL_CHECKS
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot cancel thread. pthread_cancel() failed with code %d at %d@%s, function %s()", ret, line, file, function);
+#else
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot cancel thread. pthread_cancel() failed with code %d.", ret);
+#endif
+
+    return ret;
+}
+
+// ----------------------------------------------------------------------------
+// netdata_thread_join
+
+int netdata_thread_join(netdata_thread_t thread, void **retval) {
+    int ret = pthread_join(thread, retval);
+    if(ret != 0)
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot join thread. pthread_join() failed with code %d.", ret);
+
+    return ret;
+}
+
+int netdata_thread_detach(pthread_t thread) {
+    int ret = pthread_detach(thread);
+    if(ret != 0)
+        nd_log(NDLS_DAEMON, NDLP_WARNING, "cannot detach thread. pthread_detach() failed with code %d.", ret);
+
+    return ret;
+}
diff --git a/libnetdata/threads/threads.h b/libnetdata/threads/threads.h
new file mode 100644
index 00000000..97c3c803
--- /dev/null
+++ b/libnetdata/threads/threads.h
@@ -0,0 +1,87 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef NETDATA_THREADS_H
+#define NETDATA_THREADS_H 1
+
+#include "../libnetdata.h"
+
+pid_t gettid(void);
+
+typedef enum {
+    NETDATA_THREAD_OPTION_DEFAULT          = 0 << 0,
+    NETDATA_THREAD_OPTION_JOINABLE         = 1 << 0,
+    NETDATA_THREAD_OPTION_DONT_LOG_STARTUP = 1 << 1,
+    NETDATA_THREAD_OPTION_DONT_LOG_CLEANUP = 1 << 2,
+    NETDATA_THREAD_OPTION_DONT_LOG         = NETDATA_THREAD_OPTION_DONT_LOG_STARTUP|NETDATA_THREAD_OPTION_DONT_LOG_CLEANUP,
+} NETDATA_THREAD_OPTIONS;
+
+#define netdata_thread_cleanup_push(func, arg) pthread_cleanup_push(func, arg)
+#define netdata_thread_cleanup_pop(execute) pthread_cleanup_pop(execute)
+
+void netdata_thread_set_tag(const char *tag);
+
+typedef pthread_t netdata_thread_t;
+
+struct netdata_static_thread {
+    // the name of the thread as it should appear in the logs
+    char *name;
+
+    // the section of netdata.conf to check if this is enabled or not
+    char *config_section;
+
+    // the name of the config option to check if it is true or false
+    char *config_name;
+
+    // the current status of the thread
+    volatile sig_atomic_t enabled;
+
+    // internal use, to maintain a pointer to the created thread
+    netdata_thread_t *thread;
+
+    // an initialization function to run before spawning the thread
+    void (*init_routine) (void);
+
+    // the threaded worker
+    void *(*start_routine) (void *);
+
+    // the environment variable to create
+    char *env_name;
+
+    // global variable
+    bool *global_variable;
+};
+
+#define NETDATA_MAIN_THREAD_RUNNING     CONFIG_BOOLEAN_YES
+#define NETDATA_MAIN_THREAD_EXITING     (CONFIG_BOOLEAN_YES + 1)
+#define NETDATA_MAIN_THREAD_EXITED      CONFIG_BOOLEAN_NO
+
+#define NETDATA_THREAD_TAG_MAX 100
+const char *netdata_thread_tag(void);
+int netdata_thread_tag_exists(void);
+
+size_t netdata_threads_init(void);
+void netdata_threads_init_after_fork(size_t stacksize);
+void netdata_threads_init_for_external_plugins(size_t stacksize);
+
+int netdata_thread_create(netdata_thread_t *thread, const char *tag, NETDATA_THREAD_OPTIONS options, void *(*start_routine) (void *), void *arg);
+
+#ifdef NETDATA_INTERNAL_CHECKS
+#define netdata_thread_cancel(thread) netdata_thread_cancel_with_trace(thread, __LINE__, __FILE__, __FUNCTION__)
+int netdata_thread_cancel_with_trace(netdata_thread_t thread, int line, const char *file, const char *function);
+#else
+int netdata_thread_cancel(netdata_thread_t thread);
+#endif
+
+int netdata_thread_join(netdata_thread_t thread, void **retval);
+int netdata_thread_detach(pthread_t thread);
+
+#define NETDATA_THREAD_NAME_MAX 15
+void uv_thread_set_name_np(uv_thread_t ut, const char* name);
+void os_thread_get_current_name_np(char threadname[NETDATA_THREAD_NAME_MAX + 1]);
+
+void webrtc_set_thread_name(void);
+
+#define netdata_thread_self pthread_self
+#define netdata_thread_testcancel pthread_testcancel
+
+#endif //NETDATA_THREADS_H