urcu-call-rcu.h

   1 #ifndef _URCU_CALL_RCU_H
   2 #define _URCU_CALL_RCU_H
   3
   4 /*
   5  * urcu-call-rcu.h
   6  *
   7  * Userspace RCU header - deferred execution
   8  *
   9  * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
  11  *
  12  * LGPL-compatible code should include this header with :
  13  *
  14  * #define _LGPL_SOURCE
  15  * #include <urcu-defer.h>
  16  *
  17  * This library is free software; you can redistribute it and/or
  18  * modify it under the terms of the GNU Lesser General Public
  19  * License as published by the Free Software Foundation; either
  20  * version 2.1 of the License, or (at your option) any later version.
  21  *
  22  * This library is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  25  * Lesser General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU Lesser General Public
  28  * License along with this library; if not, write to the Free Software
  29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  30  */
  31
  32 #include <stdlib.h>
  33 #include <pthread.h>
  34
  35 #include <urcu/wfqueue.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /* Note that struct call_rcu_data is opaque to callers. */
  42
  43 struct call_rcu_data;
  44
  45 /* Flag values. */
  46
  47 #define URCU_CALL_RCU_RT        0x1
  48 #define URCU_CALL_RCU_RUNNING   0x2
  49 #define URCU_CALL_RCU_STOP      0x4
  50 #define URCU_CALL_RCU_STOPPED   0x8
  51
  52 /*
  53  * The rcu_head data structure is placed in the structure to be freed
  54  * via call_rcu().
  55  */
  56
  57 struct rcu_head {
  58         struct cds_wfq_node next;
  59         void (*func)(struct rcu_head *head);
  60 };
  61
  62 /*
  63  * Exported functions
  64  */
  65
  66 /*
  67  * get_cpu_call_rcu_data should be called with RCU read-side lock held.
  68  * Callers should be registered RCU read-side threads.
  69  */
  70 struct call_rcu_data *get_cpu_call_rcu_data(int cpu);
  71 pthread_t get_call_rcu_thread(struct call_rcu_data *crdp);
  72 struct call_rcu_data *create_call_rcu_data(unsigned long flags,
  73                                            int cpu_affinity);
  74 int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp);
  75 struct call_rcu_data *get_default_call_rcu_data(void);
  76 /*
  77  * get_call_rcu_data should be called from registered RCU read-side
  78  * threads. For the QSBR flavor, the caller should be online.
  79  */
  80 struct call_rcu_data *get_call_rcu_data(void);
  81 struct call_rcu_data *get_thread_call_rcu_data(void);
  82 void set_thread_call_rcu_data(struct call_rcu_data *crdp);
  83 int create_all_cpu_call_rcu_data(unsigned long flags);
  84 /*
  85  * call_rcu should be called from registered RCU read-side threads.
  86  * For the QSBR flavor, the caller should be online.
  87  */
  88 void call_rcu(struct rcu_head *head,
  89               void (*func)(struct rcu_head *head));
  90 void call_rcu_data_free(struct call_rcu_data *crdp);
  91 void free_all_cpu_call_rcu_data(void);
  92 void call_rcu_after_fork_child(void);
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif /* _URCU_CALL_RCU_H */