X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b591838fb09269e35740c6c8991a7ca478d64303..1f50f809c4d885ff2b2c1a626d69ebb4cea0502f:/src/xbt/fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index 09fed3254e..7a425f687c 100644
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -1,6 +1,5 @@
-/* 	$Id$	 */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -11,11 +10,11 @@
 #include "fifo_private.h"
 #include "xbt_modinter.h"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_fifo,xbt,"FIFO");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_fifo, xbt, "FIFO");
 
-static void* fifo_item_mallocator_new_f(void);
-static void fifo_item_mallocator_free_f(void* item);
-static void fifo_item_mallocator_reset_f(void* item);
+static void *fifo_item_mallocator_new_f(void);
+#define fifo_item_mallocator_free_f xbt_free_f
+static void fifo_item_mallocator_reset_f(void *item);
 
 static xbt_mallocator_t item_mallocator = NULL;
 
@@ -25,30 +24,36 @@ static xbt_mallocator_t item_mallocator = NULL;
 xbt_fifo_t xbt_fifo_new(void)
 {
   xbt_fifo_t fifo;
-  fifo = xbt_new0(struct xbt_fifo,1);
+  fifo = xbt_new0(struct xbt_fifo, 1);
 
-  if (item_mallocator == NULL) {
-    item_mallocator = xbt_mallocator_new(256,
-					 fifo_item_mallocator_new_f,
-					 fifo_item_mallocator_free_f,
-					 fifo_item_mallocator_reset_f);
-  }
   return fifo;
 }
 
+
 /** Destructor
  * \param l poor victim
  *
  * Free the fifo structure. None of the objects that was in the fifo is however modified.
  */
 void xbt_fifo_free(xbt_fifo_t l)
+{
+  xbt_fifo_reset(l);
+  xbt_free(l);
+}
+
+/**
+ * \brief Makes a fifo empty.
+ * \param l a fifo
+ *
+ * None of the objects that was in the fifo is however modified.
+ */
+void xbt_fifo_reset(xbt_fifo_t l)
 {
   xbt_fifo_item_t b, tmp;
 
   for (b = xbt_fifo_get_first_item(l); b;
        tmp = b, b = b->next, xbt_fifo_free_item(tmp));
-  xbt_free(l);
-  return;
+  l->head = l->tail = NULL;
 }
 
 /** Push
@@ -65,7 +70,7 @@ xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t l, void *t)
   new = xbt_fifo_new_item();
   new->content = t;
 
-  xbt_fifo_push_item(l,new);
+  xbt_fifo_push_item(l, new);
   return new;
 }
 
@@ -73,7 +78,7 @@ xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t l, void *t)
  * \param l list
  * \returns the object stored at the tail of the list.
  *
- * Removes and returns the object stored at the tail of the list. 
+ * Removes and returns the object stored at the tail of the list.
  * Returns NULL if the list is empty.
  */
 void *xbt_fifo_pop(xbt_fifo_t l)
@@ -81,8 +86,10 @@ void *xbt_fifo_pop(xbt_fifo_t l)
   xbt_fifo_item_t item;
   void *content;
 
-  if(l==NULL) return NULL;
-  if(!(item = xbt_fifo_pop_item(l))) return NULL;
+  if (l == NULL)
+    return NULL;
+  if (!(item = xbt_fifo_pop_item(l)))
+    return NULL;
 
   content = item->content;
   xbt_fifo_free_item(item);
@@ -102,7 +109,7 @@ xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t l, void *t)
 
   new = xbt_fifo_new_item();
   new->content = t;
-  xbt_fifo_unshift_item(l,new);
+  xbt_fifo_unshift_item(l, new);
   return new;
 }
 
@@ -110,7 +117,7 @@ xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t l, void *t)
  * \param l list
  * \returns the object stored at the head of the list.
  *
- * Removes and returns the object stored at the head of the list. 
+ * Removes and returns the object stored at the head of the list.
  * Returns NULL if the list is empty.
  */
 void *xbt_fifo_shift(xbt_fifo_t l)
@@ -118,9 +125,11 @@ void *xbt_fifo_shift(xbt_fifo_t l)
   xbt_fifo_item_t item;
   void *content;
 
-  if(l==NULL) return NULL;
-  if(!(item = xbt_fifo_shift_item(l))) return NULL;
-  
+  if (l == NULL)
+    return NULL;
+  if (!(item = xbt_fifo_shift_item(l)))
+    return NULL;
+
   content = item->content;
   xbt_fifo_free_item(item);
   return content;
@@ -134,7 +143,7 @@ void *xbt_fifo_shift(xbt_fifo_t l)
  */
 void xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
-  xbt_assert0((new->next == NULL)&&(new->prev == NULL),"Invalid item!");
+  xbt_assert((new->next == NULL) && (new->prev == NULL), "Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -160,7 +169,7 @@ xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
     return NULL;
 
   item = l->tail;
-  
+
   l->tail = item->prev;
   if (l->tail == NULL)
     l->head = NULL;
@@ -182,7 +191,7 @@ xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
  */
 void xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
-  xbt_assert0((new->next == NULL)&&(new->prev == NULL),"Invalid item!");
+  xbt_assert((new->next == NULL) && (new->prev == NULL), "Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -224,13 +233,14 @@ xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
 }
 
 /**
- * \param l 
+ * \param l
  * \param t an objet
  *
- * removes the first occurence of \a t from \a l. 
+ * removes the first occurence of \a t from \a l.
  * \warning it will not remove duplicates
+ * \return 1 if an item was removed and 0 otherwise.
  */
-void xbt_fifo_remove(xbt_fifo_t l, void *t)
+int xbt_fifo_remove(xbt_fifo_t l, void *t)
 {
   xbt_fifo_item_t current, current_next;
 
@@ -243,22 +253,47 @@ void xbt_fifo_remove(xbt_fifo_t l, void *t)
     xbt_fifo_remove_item(l, current);
     xbt_fifo_free_item(current);
     /* WILL NOT REMOVE DUPLICATES */
-    break;
+    return 1;
   }
-  return;
+  return 0;
+}
+
+
+/**
+ * \param l
+ * \param t an objet
+ *
+ * removes all occurences of \a t from \a l.
+ * \return 1 if an item was removed and 0 otherwise.
+ */
+int xbt_fifo_remove_all(xbt_fifo_t l, void *t)
+{
+  xbt_fifo_item_t current, current_next;
+  int res = 0;
+
+  for (current = l->head; current; current = current_next) {
+    current_next = current->next;
+    if (current->content != t)
+      continue;
+    /* remove the item */
+    xbt_fifo_remove_item(l, current);
+    xbt_fifo_free_item(current);
+    res = 1;
+  }
+  return res;
 }
 
 /**
  * \param l a list
  * \param current a bucket
  *
- * removes a bucket \a current from the list \a l. This function implicitely 
- * assumes (and doesn't check!) that this item belongs to this list... 
+ * removes a bucket \a current from the list \a l. This function implicitely
+ * assumes (and doesn't check!) that this item belongs to this list...
  */
 void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
 {
-  if (l->head == l->tail) {	/* special case */
-    xbt_assert0((current==l->head),"This item is not in the list!");
+  if (l->head == l->tail) {     /* special case */
+    xbt_assert((current == l->head), "This item is not in the list!");
     l->head = NULL;
     l->tail = NULL;
     (l->count)--;
@@ -266,13 +301,13 @@ void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
     return;
   }
 
-  if (current == l->head) {	/* It's the head */
+  if (current == l->head) {     /* It's the head */
     l->head = current->next;
     l->head->prev = NULL;
-  } else if (current == l->tail) {	/* It's the tail */
+  } else if (current == l->tail) {      /* It's the tail */
     l->tail = current->prev;
     l->tail->next = NULL;
-  } else {			/* It's in the middle */
+  } else {                      /* It's in the middle */
     current->prev->next = current->next;
     current->next->prev = current->prev;
   }
@@ -335,15 +370,13 @@ xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 }
 
 /* Functions passed to the mallocator constructor */
-static void* fifo_item_mallocator_new_f(void) {
+static void *fifo_item_mallocator_new_f(void)
+{
   return xbt_new(s_xbt_fifo_item_t, 1);
 }
 
-static void fifo_item_mallocator_free_f(void* item) {
-  xbt_free(item);
-}
-
-static void fifo_item_mallocator_reset_f(void* item) {
+static void fifo_item_mallocator_reset_f(void *item)
+{
   /* memset to zero like calloc */
   memset(item, 0, sizeof(s_xbt_fifo_item_t));
 }
@@ -351,16 +384,16 @@ static void fifo_item_mallocator_reset_f(void* item) {
 /** Constructor
  * \return a new bucket
  */
-xbt_fifo_item_t xbt_fifo_new_item(void)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_new_item(void)
 {
   return xbt_mallocator_get(item_mallocator);
 }
 
 /** \deprecated Use #xbt_fifo_new_item instead.
  */
-xbt_fifo_item_t xbt_fifo_newitem(void)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_newitem(void)
 {
-  WARN0("This function is deprecated. Use xbt_fifo_new_item.");
+  XBT_WARN("This function is deprecated. Use xbt_fifo_new_item.");
   return xbt_fifo_new_item();
 }
 
@@ -370,16 +403,16 @@ xbt_fifo_item_t xbt_fifo_newitem(void)
  *
  * stores \a v in \a i.
  */
-void xbt_fifo_set_item_content(xbt_fifo_item_t i , void *v)
+XBT_INLINE void xbt_fifo_set_item_content(xbt_fifo_item_t i, void *v)
 {
-  xbt_fifo_setItemcontent(i,v);
+  xbt_fifo_setItemcontent(i, v);
 }
 
 /**
  * \param i a bucket
  * \return the object stored \a i.
  */
-void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
+XBT_INLINE void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
 {
   return xbt_fifo_getItemcontent(i);
 }
@@ -389,7 +422,7 @@ void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
  *
  * Free the bucket but does not modifies the object (if any) that was stored in it.
  */
-void xbt_fifo_free_item(xbt_fifo_item_t b)
+XBT_INLINE void xbt_fifo_free_item(xbt_fifo_item_t b)
 {
   xbt_mallocator_release(item_mallocator, b);
   return;
@@ -398,9 +431,9 @@ void xbt_fifo_free_item(xbt_fifo_item_t b)
 /** Destructor
  * \deprecated Use #xbt_fifo_free_item instead.
  */
-void xbt_fifo_freeitem(xbt_fifo_item_t b)
+XBT_INLINE void xbt_fifo_freeitem(xbt_fifo_item_t b)
 {
-  WARN0("This function is deprecated. Use xbt_fifo_free_item.");
+  XBT_WARN("This function is deprecated. Use xbt_fifo_free_item.");
   xbt_fifo_free_item(b);
   return;
 }
@@ -409,7 +442,7 @@ void xbt_fifo_freeitem(xbt_fifo_item_t b)
  * \param f a list
  * \return the number of buckets in \a f.
  */
-int xbt_fifo_size(xbt_fifo_t f)
+XBT_INLINE int xbt_fifo_size(xbt_fifo_t f)
 {
   return f->count;
 }
@@ -417,27 +450,43 @@ int xbt_fifo_size(xbt_fifo_t f)
 /**
  * \param l a list
  * \return the head of \a l.
+ *
+ * Returns NULL if the list is empty.
  */
-xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l)
 {
   return l->head;
 }
 
+/**
+ * \param l a list
+ * \return the tail of \a l.
+ *
+ * Returns NULL if the list is empty.
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_last_item(xbt_fifo_t l)
+{
+  return l->tail;
+}
+
 /** \deprecated Use #xbt_fifo_get_first_item instead.
  */
-xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
 {
-  WARN0("This function is deprecated. Use xbt_fifo_get_first_item.");
+  XBT_WARN("This function is deprecated. Use xbt_fifo_get_first_item.");
   return xbt_fifo_get_first_item(l);
 }
 
 /**
  * \param i a bucket
  * \return the bucket that comes next
+ *
+ * Returns NULL if \a i is the tail of the list.
  */
-xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
 {
-  if(i) return i->next;
+  if (i)
+    return i->next;
   return NULL;
 }
 
@@ -445,17 +494,20 @@ xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
  */
 xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i)
 {
-  WARN0("This function is deprecated. Use xbt_fifo_get_next_item.");
+  XBT_WARN("This function is deprecated. Use xbt_fifo_get_next_item.");
   return xbt_fifo_get_next_item(i);
 }
 
 /**
  * \param i a bucket
  * \return the bucket that is just before \a i.
+ *
+ * Returns NULL if \a i is the head of the list.
  */
-xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
 {
-  if(i) return i->prev;
+  if (i)
+    return i->prev;
   return NULL;
 }
 
@@ -463,20 +515,28 @@ xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
  */
 xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i)
 {
-  WARN0("This function is deprecated. Use xbt_fifo_get_prev_item.");
+  XBT_WARN("This function is deprecated. Use xbt_fifo_get_prev_item.");
   return xbt_fifo_get_prev_item(i);
 }
 
-/**
- * Destroy the fifo item mallocator.
- * This is an internal XBT function called by xbt_exit().
+/* Module init/exit handling the fifo item mallocator
+ * These are internal XBT functions called by xbt_preinit/postexit().
+ * It can be used several times to recreate the mallocator, for example when you switch to MC mode
  */
-void xbt_fifo_exit(void) {
+void xbt_fifo_preinit(void)
+{
+  item_mallocator = xbt_mallocator_new(65536,
+                                       fifo_item_mallocator_new_f,
+                                       fifo_item_mallocator_free_f,
+                                       fifo_item_mallocator_reset_f);
+}
+
+void xbt_fifo_postexit(void)
+{
   if (item_mallocator != NULL) {
     xbt_mallocator_free(item_mallocator);
+    item_mallocator = NULL;
   }
 }
 
 /* @} */
-
-