redict/src/threads_mngr.h
Drew DeVault 50ee0f5be8 all: let's go LGPL over GPL
Based on feedback from interested parties
2024-03-21 20:11:44 +01:00

48 lines
1.6 KiB
C

// Copyright (c) 2021, Redis Ltd.
// SPDX-FileCopyrightText: 2024 Redict Contributors
// SPDX-FileCopyrightText: 2024 Salvatore Sanfilippo <antirez at gmail dot com>
//
// SPDX-License-Identifier: BSD-3-Clause
// SPDX-License-Identifier: LGPL-3.0-only
#pragma once
#include "fmacros.h"
#include <sys/types.h>
#include <unistd.h>
/** This is an API to invoke callback on a list of threads using a user defined signal handler.
* NOTE: This is API is only supported only in linux systems.
* Calling the functions below on any other system does nothing.
*/
#define THREADS_SIGNAL SIGUSR2
/* Callback signature */
typedef void(*run_on_thread_cb)(void);
/* Register the process to THREADS_SIGNAL */
void ThreadsManager_init(void);
/** @brief Invoke callback by each thread in tids.
*
* @param tids An array of threads that need to invoke callback.
* @param tids_len The number of threads in @param tids.
* @param callback A callback to be invoked by each thread in @param tids.
*
* NOTES:
* It is assumed that all the threads don't block or ignore THREADS_SIGNAL.
*
* It is safe to include the calling thread in @param tids. However, be aware that subsequent tids will
* not be signaled until the calling thread returns from the callback invocation.
* Hence, it is recommended to place the calling thread last in @param tids.
*
* The function returns only when @param tids_len threads have returned from @param callback, or when we reached timeout.
*
* @return 1 if successful, 0 If ThreadsManager_runOnThreads is already in the middle of execution.
*
**/
int ThreadsManager_runOnThreads(pid_t *tids, size_t tids_len, run_on_thread_cb callback);