Add accessor functions and check in header file.
authorJennifer Richards <jennifer@painless-security.com>
Thu, 23 Jun 2016 17:24:23 +0000 (13:24 -0400)
committerJennifer Richards <jennifer@painless-security.com>
Thu, 23 Jun 2016 17:24:23 +0000 (13:24 -0400)
common/tr_mq.c
include/tr_mq.h [new file with mode: 0644]

index c41a48c..b2e854c 100644 (file)
@@ -29,12 +29,47 @@ void tr_mq_msg_free(TR_MQ_MSG *msg)
     talloc_free(msg);
 }
 
+void *tr_mq_msg_get_payload(TR_MQ_MSG *msg)
+{
+  return msg->p;
+}
+
+/* call with a pointer to the payload and a function to free it later */
+void tr_mq_msg_set_payload(TR_MQ_MSG *msg, void *p, void (*p_free)(void *))
+{
+  msg->p=p;
+  msg->p_free=p_free;
+}
+
+
+static TR_MQ_MSG *tr_mq_msg_get_next(TR_MQ_MSG *msg)
+{
+  return msg->next;
+}
+
+static void tr_mq_msg_set_next(TR_MQ_MSG *msg, TR_MQ_MSG *next)
+{
+  msg->next=next;
+}
+
+static TR_MQ_MSG *tr_mq_msg_get_tail(TR_MQ_MSG *msg)
+{
+  while (msg!=NULL)
+    msg=tr_mq_msg_get_next(msg);
+  return msg;
+}
+
+static void tr_mq_msg_append(TR_MQ_MSG *msg, TR_MQ_MSG *new)
+{
+  tr_mq_msg_set_next(tr_mq_msg_get_tail(msg), new);
+}
+
 /* Message Queues */
 TR_MQ *tr_mq_new(TALLOC_CTX *mem_ctx)
 {
   TR_MQ *mq=talloc(mem_ctx, TR_MQ);
   if (mq!=NULL) {
-    pthread_mutex_init(&(mq->lock), 0);
+    pthread_mutex_init(&(mq->mutex), 0);
     mq->head=NULL;
     mq->tail=NULL;
   }
@@ -44,11 +79,41 @@ TR_MQ *tr_mq_new(TALLOC_CTX *mem_ctx)
 void tr_mq_free(TR_MQ *mq)
 {
   if (mq!=NULL) {
-    pthread_mutex_lock(&(mq->lock)); /* don't pull this out from under someone */
+    tr_mq_lock(mq); /* don't pull the rug out from under someone */
     talloc_free(mq);
   }
 }
 
+int tr_mq_lock(TR_MQ *mq)
+{
+  return pthread_mutex_lock(&(mq->mutex));
+}
+
+int tr_mq_unlock(TR_MQ *mq)
+{
+  return pthread_mutex_lock(&(mq->mutex));
+}
+
+static TR_MQ_MST *tr_mq_get_head(TR_MQ *mq)
+{
+  return mq->head;
+}
+
+static void tr_mq_set_head(TR_MQ *mq, TR_MQ_MSG *msg)
+{
+  mq->head=msg;
+}
+
+static TR_MQ_MST *tr_mq_get_tail(TR_MQ *mq)
+{
+  return mq->tail;
+}
+
+static void tr_mq_set_tail(TR_MQ *mq, TR_MQ_MSG *msg)
+{
+  mq->tail=msg;
+}
+
 /* puts msg in mq's talloc context */
 void tr_mq_append(TR_MQ *mq, TR_MQ_MSG *msg)
 {
@@ -56,19 +121,20 @@ void tr_mq_append(TR_MQ *mq, TR_MQ_MSG *msg)
   TR_MQ_NOTIFY_FN notify_cb=NULL;
   void *notify_cb_arg=NULL;
 
-  pthread_mutex_lock(&(mq->lock));
-  if (mq->head==NULL) {
+  tr_mq_lock(mq);
+  if (tr_mq_get_head(mq)==NULL) {
     was_empty=TRUE;
-    mq->head=mq->tail=msg;
+    tr_mq_set_head(mq, msg);
+    tr_mq_set_tail(mq, msg);
   } else {
-    mq->tail->next=msg; /* add to list */
-    mq->tail=msg; /* update tail of list */
+    tr_mq_msg_set_next(tr_mq_get_tail(), msg); /* add to list */
+    tr_mq_set_tail(mq, msg); /* update tail of list */
   }
   talloc_steal(mq, msg);
-  /* before releasing the lock, get notify_cb data out of mq */
+  /* before releasing the mutex, get notify_cb data out of mq */
   notify_cb=mq->notify_cb;
   notify_cb_arg=mq->notify_cb_arg;
-  pthread_mutex_unlock(&(mq->lock));
+  tr_mq_unlock(mq);
 
   /* see if we need to tell someone we became non-empty */
   if (was_empty && (notify_cb!=NULL))
@@ -80,15 +146,15 @@ TR_MQ_MSG *tr_mq_pop(TR_MQ *mq)
 {
   TR_MQ_MSG *popped=NULL;
 
-  pthread_mutex_lock(&(mq->lock));
-  if (mq->head!=NULL) {
-    popped=mq->head;
-    mq->head=mq->head->next;
-    if (mq->head==NULL)
-      mq->tail=NULL; /* just popped the last element */
+  tr_mq_lock(mq);
+  if (tr_mq_get_head(mq)!=NULL) {
+    popped=tr_mq_get_head(mq);
+    tr_mq_msg_set_next(popped, tr_mq_msg_get_next(popped)); /* popped is the old head */
+    if (tr_mq_get_head(mq)==NULL)
+      tr_mq_set_tail(mq, NULL); /* just popped the last element */
   }
-  pthread_mutex_unlock(&(mq->lock));
+  tr_mq_unlock(mq);
   if (popped!=NULL)
-    popped->next=NULL; /* disconnect */
+    tr_mq_msg_set_next(popped, NULL); /* disconnect from list */
   return popped;
 }
diff --git a/include/tr_mq.h b/include/tr_mq.h
new file mode 100644 (file)
index 0000000..cc5d21c
--- /dev/null
@@ -0,0 +1,45 @@
+#ifndef _TR_MQ_H_
+#define _TR_MQ_H_
+
+#include <talloc.h>
+#include <pthread.h>
+
+/* REMOVE */
+#define FALSE 0
+#define TRUE 1
+
+/* msg for inter-thread messaging */
+typedef struct tr_mq_msg TR_MQ_MSG;
+struct tr_mq_msg {
+  TR_MQ_MSG *next;
+  void *p; /* payload */
+  void (*p_free)(void *); /* function to free payload */
+};
+
+/* message queue for inter-thread messaging */
+
+typedef struct tr_mq TR_MQ;
+typedef void (*TR_MQ_NOTIFY_FN)(TR_MQ *, void *);
+struct tr_mq {
+  pthread_mutex_t mutex;
+  TR_MQ_MSG *head;
+  TR_MQ_MSG *tail;
+  TR_MQ_NOTIFY_FN notify_cb; /* callback when queue becomes non-empty */
+  void *notify_cb_arg;
+};
+
+TR_MQ_MSG *tr_mq_msg_new(TALLOC_CTX *mem_ctx);
+void tr_mq_msg_free(TR_MQ_MSG *msg);
+void *tr_mq_msg_get_payload(TR_MQ_MSG *msg);
+void tr_mq_msg_set_payload(TR_MQ_MSG *msg, void *p, void (*p_free)(void *));
+
+
+TR_MQ *tr_mq_new(TALLOC_CTX *mem_ctx);
+void tr_mq_free(TR_MQ *mq);
+int tr_mq_lock(TR_MQ *mq);
+int tr_mq_unlock(TR_MQ *mq);
+void tr_mq_set_notify_cb(TR_MQ *mq, TR_MQ_NOTIFY_FN cb);
+void tr_mq_append(TR_MQ *mq, TR_MQ_MSG *msg);
+TR_MQ_MSG *tr_mq_pop(TR_MQ *mq);
+#endif /*_TR_MQ_H_ */