rculfhash: comment file inclusion order

[urcu.git] / urcu / rculfhash.h

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index 385a43b56a08c09df194c3c556362ade78a1c6fe..95fff09b61869d7575f048c37546355f94f87d77 100644 (file)
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -21,6 +21,8 @@
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Include this file _after_ including your URCU flavor.
  */
 
 #include <stdint.h>
@@ -79,20 +81,42 @@ enum {
        CDS_LFHT_AUTO_RESIZE = (1U << 0),
 };
 
+/*
+ * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly.
+ */
+struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
+                       cds_lfht_compare_fct compare_fct,
+                       unsigned long hash_seed,
+                       unsigned long init_size,
+                       int flags,
+                       void (*cds_lfht_call_rcu)(struct rcu_head *head,
+                               void (*func)(struct rcu_head *head)),
+                       void (*cds_lfht_synchronize_rcu)(void),
+                       void (*cds_lfht_rcu_read_lock)(void),
+                       void (*cds_lfht_rcu_read_unlock)(void),
+                       void (*cds_lfht_rcu_thread_offline)(void),
+                       void (*cds_lfht_rcu_thread_online)(void));
+
 /*
  * cds_lfht_new - allocate a hash table.
  *
  * init_size must be power of two.
  * Return NULL on error.
+ * Note: the RCU flavor must be already included before the hash table header.
  */
+static inline
 struct cds_lfht *cds_lfht_new(cds_lfht_hash_fct hash_fct,
                        cds_lfht_compare_fct compare_fct,
                        unsigned long hash_seed,
                        unsigned long init_size,
-                       int flags,
-                       void (*cds_lfht_call_rcu)(struct rcu_head *head,
-                               void (*func)(struct rcu_head *head)),
-                       void (*cds_lfht_synchronize_rcu)(void));
+                       int flags)
+{
+       return _cds_lfht_new(hash_fct, compare_fct, hash_seed,
+                       init_size, flags,
+                       call_rcu, synchronize_rcu, rcu_read_lock,
+                       rcu_read_unlock, rcu_thread_offline,
+                       rcu_thread_online);
+}
 
 /*
  * cds_lfht_destroy - destroy a hash table.