[urcu.git] / include / urcu / call-rcu.h

// SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
// SPDX-FileCopyrightText: 2009 Paul E. McKenney, IBM Corporation.
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef _URCU_CALL_RCU_H
#define _URCU_CALL_RCU_H

/*
 * Userspace RCU header - batch memory reclamation with kernel API
 *
 * This header is meant to be included indirectly through a liburcu
 * flavor header.
 */

#include <stdlib.h>
#include <pthread.h>

#include <urcu/wfcqueue.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Note that struct call_rcu_data is opaque to callers. */

struct call_rcu_data;

/* Flag values. */

#define URCU_CALL_RCU_RT	(1U << 0)
#define URCU_CALL_RCU_RUNNING	(1U << 1)
#define URCU_CALL_RCU_STOP	(1U << 2)
#define URCU_CALL_RCU_STOPPED	(1U << 3)
#define URCU_CALL_RCU_PAUSE	(1U << 4)
#define URCU_CALL_RCU_PAUSED	(1U << 5)

/*
 * The rcu_head data structure is placed in the structure to be freed
 * via call_rcu().
 */

struct rcu_head {
	struct cds_wfcq_node next;
	void (*func)(struct rcu_head *head);
};

/*
 * Exported functions
 *
 * Important: see rcu-api.md in userspace-rcu documentation for
 * call_rcu family of functions usage detail, including the surrounding
 * RCU usage required when using these primitives.
 */

void call_rcu(struct rcu_head *head,
	      void (*func)(struct rcu_head *head));

struct call_rcu_data *create_call_rcu_data(unsigned long flags,
					   int cpu_affinity);
void call_rcu_data_free(struct call_rcu_data *crdp);

struct call_rcu_data *get_default_call_rcu_data(void);
struct call_rcu_data *get_cpu_call_rcu_data(int cpu);
struct call_rcu_data *get_thread_call_rcu_data(void);
struct call_rcu_data *get_call_rcu_data(void);
pthread_t get_call_rcu_thread(struct call_rcu_data *crdp);

void set_thread_call_rcu_data(struct call_rcu_data *crdp);
int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp);

int create_all_cpu_call_rcu_data(unsigned long flags);
void free_all_cpu_call_rcu_data(void);

void call_rcu_before_fork(void);
void call_rcu_after_fork_parent(void);
void call_rcu_after_fork_child(void);

void rcu_barrier(void);

#ifdef __cplusplus
}
#endif

#endif /* _URCU_CALL_RCU_H */
Commit	Line	Data
	1	// SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	2	// SPDX-FileCopyrightText: 2009 Paul E. McKenney, IBM Corporation.
	3	//
	4	// SPDX-License-Identifier: LGPL-2.1-or-later
	5
	6	#ifndef _URCU_CALL_RCU_H
	7	#define _URCU_CALL_RCU_H
	8
	9	/*
	10	* Userspace RCU header - batch memory reclamation with kernel API
	11	*
	12	* This header is meant to be included indirectly through a liburcu
	13	* flavor header.
	14	*/
	15
	16	#include <stdlib.h>
	17	#include <pthread.h>
	18
	19	#include <urcu/wfcqueue.h>
	20
	21	#ifdef __cplusplus
	22	extern "C" {
	23	#endif
	24
	25	/* Note that struct call_rcu_data is opaque to callers. */
	26
	27	struct call_rcu_data;
	28
	29	/* Flag values. */
	30
	31	#define URCU_CALL_RCU_RT (1U << 0)
	32	#define URCU_CALL_RCU_RUNNING (1U << 1)
	33	#define URCU_CALL_RCU_STOP (1U << 2)
	34	#define URCU_CALL_RCU_STOPPED (1U << 3)
	35	#define URCU_CALL_RCU_PAUSE (1U << 4)
	36	#define URCU_CALL_RCU_PAUSED (1U << 5)
	37
	38	/*
	39	* The rcu_head data structure is placed in the structure to be freed
	40	* via call_rcu().
	41	*/
	42
	43	struct rcu_head {
	44	struct cds_wfcq_node next;
	45	void (func)(struct rcu_head head);
	46	};
	47
	48	/*
	49	* Exported functions
	50	*
	51	* Important: see rcu-api.md in userspace-rcu documentation for
	52	* call_rcu family of functions usage detail, including the surrounding
	53	* RCU usage required when using these primitives.
	54	*/
	55
	56	void call_rcu(struct rcu_head *head,
	57	void (func)(struct rcu_head head));
	58
	59	struct call_rcu_data *create_call_rcu_data(unsigned long flags,
	60	int cpu_affinity);
	61	void call_rcu_data_free(struct call_rcu_data *crdp);
	62
	63	struct call_rcu_data *get_default_call_rcu_data(void);
	64	struct call_rcu_data *get_cpu_call_rcu_data(int cpu);
	65	struct call_rcu_data *get_thread_call_rcu_data(void);
	66	struct call_rcu_data *get_call_rcu_data(void);
	67	pthread_t get_call_rcu_thread(struct call_rcu_data *crdp);
	68
	69	void set_thread_call_rcu_data(struct call_rcu_data *crdp);
	70	int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp);
	71
	72	int create_all_cpu_call_rcu_data(unsigned long flags);
	73	void free_all_cpu_call_rcu_data(void);
	74
	75	void call_rcu_before_fork(void);
	76	void call_rcu_after_fork_parent(void);
	77	void call_rcu_after_fork_child(void);
	78
	79	void rcu_barrier(void);
	80
	81	#ifdef __cplusplus
	82	}
	83	#endif
	84
	85	#endif /* _URCU_CALL_RCU_H */