X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3e8755b31f40edd05eb6679b4c5571083020545a..0a03cd809dd45e3645a54feffe364d8f2b33d71e:/src/xbt/fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index 2f191af958..ba7c0b2dfd 100644
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -1,104 +1,144 @@
-/* Authors: Arnaud Legrand                                                  */
+/* 	$Id$	 */
+
+/* Copyright (c) 2004 Arnaud Legrand. 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/sysdep.h"
-#include "xbt/error.h"
+#include "xbt/log.h"
+#include "xbt/mallocator.h"
 #include "fifo_private.h"
+#include "xbt_modinter.h"
+
+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);
 
-/*
- * xbt_fifo_new()
+static xbt_mallocator_t item_mallocator = NULL;
+
+/** Constructor
+ * \return a new fifo
  */
 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;
 }
 
-/*
- * xbt_fifo_free()
+/** 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_item_t b, tmp;
 
-  for (b = xbt_fifo_getFirstitem(l); b;
-       tmp = b, b = b->next, xbt_fifo_freeitem(tmp));
-  free(l);
+  for (b = xbt_fifo_get_first_item(l); b;
+       tmp = b, b = b->next, xbt_fifo_free_item(tmp));
+  xbt_free(l);
   return;
 }
 
-/*
- * xbt_fifo_push()
- * at the tail
+/** Push
+ * \param l list
+ * \param t element
+ * \return the bucket that was just added
+ *
+ * Add an object at the tail of the list
  */
 xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t l, void *t)
 {
   xbt_fifo_item_t new;
 
-  new = xbt_fifo_newitem();
+  new = xbt_fifo_new_item();
   new->content = t;
 
-  xbt_fifo_push_item(l,new);
+  xbt_fifo_push_item(l, new);
   return new;
 }
 
-/*
- * xbt_fifo_pop()
- * from the tail
+/** Pop
+ * \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.
+ * Returns NULL if the list is empty.
  */
 void *xbt_fifo_pop(xbt_fifo_t l)
 {
   xbt_fifo_item_t item;
   void *content;
 
-  item = xbt_fifo_pop_item(l);
-  if(item==NULL) return NULL;
+  if (l == NULL)
+    return NULL;
+  if (!(item = xbt_fifo_pop_item(l)))
+    return NULL;
 
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
-/*
- * xbt_fifo_unshift()
- * at the head
+/**
+ * \param l list
+ * \param t element
+ * \return the bucket that was just added
+ *
+ * Add an object at the head of the list
  */
 xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t l, void *t)
 {
   xbt_fifo_item_t new;
 
-  new = xbt_fifo_newitem();
+  new = xbt_fifo_new_item();
   new->content = t;
-  xbt_fifo_unshift_item(l,new);
+  xbt_fifo_unshift_item(l, new);
   return new;
 }
 
-/*
- * xbt_fifo_shift()
- * from the head
+/** Shift
+ * \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.
+ * Returns NULL if the list is empty.
  */
 void *xbt_fifo_shift(xbt_fifo_t l)
 {
   xbt_fifo_item_t item;
   void *content;
 
-  item = xbt_fifo_shift_item(l);
-  if(l==NULL) return NULL;
+  if (l == NULL)
+    return NULL;
+  if (!(item = xbt_fifo_shift_item(l)))
+    return NULL;
 
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
-/*
- * xbt_fifo_push_item()
- * at the tail
+/** Push a bucket
+ * \param l list
+ * \param new bucket
+ *
+ * Hook up this bucket at the tail of the list
  */
 void xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
+  xbt_assert0((new->next == NULL) && (new->prev == NULL), "Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -110,9 +150,11 @@ void xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t new)
   l->tail = new;
 }
 
-/*
- * xbt_fifo_pop_item()
- * from the tail
+/** Pop bucket
+ * \param l
+ * \returns the bucket that was at the tail of the list.
+ *
+ * Returns NULL if the list was empty.
  */
 xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
 {
@@ -130,15 +172,21 @@ xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
     l->tail->next = NULL;
 
   (l->count)--;
+
+  item->prev = NULL;
+
   return item;
 }
 
-/*
- * xbt_fifo_unshift_item()
- * at the head
+/** Push a bucket
+ * \param l list
+ * \param new bucket
+ *
+ * Hook up this bucket at the head of the list
  */
 void xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
+  xbt_assert0((new->next == NULL) && (new->prev == NULL), "Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -151,9 +199,11 @@ void xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t new)
   return;
 }
 
-/*
- * xbt_fifo_shift_item()
- * from the head
+/** Shift bucket
+ * \param l
+ * \returns the bucket that was at the head of the list.
+ *
+ * Returns NULL if the list was empty.
  */
 xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
 {
@@ -171,14 +221,21 @@ xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
     l->head->prev = NULL;
 
   (l->count)--;
+
+  item->next = NULL;
+
   return item;
 }
 
-/*
- * xbt_fifo_remove()
- *   removes an xbt_fifo_item_t using its content from the xbt_fifo 
+/**
+ * \param l
+ * \param t an objet
+ *
+ * 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;
 
@@ -189,45 +246,78 @@ void xbt_fifo_remove(xbt_fifo_t l, void *t)
       continue;
     /* remove the item */
     xbt_fifo_remove_item(l, current);
-    xbt_fifo_freeitem(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;
 }
 
-/*
- * xbt_fifo_remove_item()
- *   removes a given xbt_fifo_item_t from the xbt_fifo
+/**
+ * \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...
  */
 void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
 {
-  if (l->head == l->tail) {	/* special case */
-      l->head = NULL;
-      l->tail = NULL;
-      (l->count)--;
-      return;
-    }
-
-    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 */
-      l->tail = current->prev;
-      l->tail->next = NULL;
-    } else {			/* It's in the middle */
-      current->prev->next = current->next;
-      current->next->prev = current->prev;
-    }
+  if (l->head == l->tail) {     /* special case */
+    xbt_assert0((current == l->head), "This item is not in the list!");
+    l->head = NULL;
+    l->tail = NULL;
     (l->count)--;
+    current->prev = current->next = NULL;
+    return;
+  }
+
+  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 */
+    l->tail = current->prev;
+    l->tail->next = NULL;
+  } else {                      /* It's in the middle */
+    current->prev->next = current->next;
+    current->next->prev = current->prev;
+  }
+  (l->count)--;
+  current->prev = current->next = NULL;
 }
 
-/*
- * xbt_fifo_is_in()
+/**
+ * \param f a list
+ * \param content an object
+ * \return 1 if \a content is in \a f.
  */
 int xbt_fifo_is_in(xbt_fifo_t f, void *content)
 {
-  xbt_fifo_item_t item = xbt_fifo_getFirstitem(f);
+  xbt_fifo_item_t item = xbt_fifo_get_first_item(f);
   while (item) {
     if (item->content == content)
       return 1;
@@ -236,8 +326,9 @@ int xbt_fifo_is_in(xbt_fifo_t f, void *content)
   return 0;
 }
 
-/*
- * xbt_fifo_to_array()
+/**
+ * \param f a list
+ * \return a table with the objects stored in \a f.
  */
 void **xbt_fifo_to_array(xbt_fifo_t f)
 {
@@ -250,14 +341,15 @@ void **xbt_fifo_to_array(xbt_fifo_t f)
   else
     array = xbt_new0(void *, f->count);
 
-  for (i = 0, b = xbt_fifo_getFirstitem(f); b; i++, b = b->next) {
+  for (i = 0, b = xbt_fifo_get_first_item(f); b; i++, b = b->next) {
     array[i] = b->content;
   }
   return array;
 }
 
-/*
- * xbt_fifo_Copy()
+/**
+ * \param f a list
+ * \return a copy of \a f.
  */
 xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 {
@@ -266,42 +358,160 @@ xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 
   copy = xbt_fifo_new();
 
-  for (b = xbt_fifo_getFirstitem(f); b; b = b->next) {
+  for (b = xbt_fifo_get_first_item(f); b; b = b->next) {
     xbt_fifo_push(copy, b->content);
   }
   return copy;
 }
 
-/*
- * xbt_fifo_newitem()
+/* Functions passed to the mallocator constructor */
+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)
+{
+  /* memset to zero like calloc */
+  memset(item, 0, sizeof(s_xbt_fifo_item_t));
+}
+
+/** Constructor
+ * \return a new bucket
  */
-xbt_fifo_item_t xbt_fifo_newitem(void)
+XBT_INLINE xbt_fifo_item_t xbt_fifo_new_item(void)
 {
-  return xbt_new0(struct xbt_fifo_item,1);
+  return xbt_mallocator_get(item_mallocator);
 }
 
-void xbt_fifo_set_item_content(xbt_fifo_item_t i , void *v)
+/** \deprecated Use #xbt_fifo_new_item instead.
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_newitem(void)
 {
-  xbt_fifo_setItemcontent(i,v);
+  WARN0("This function is deprecated. Use xbt_fifo_new_item.");
+  return xbt_fifo_new_item();
 }
 
-void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
+/**
+ * \param i a bucket
+ * \param v an object
+ *
+ * stores \a v in \a i.
+ */
+XBT_INLINE void xbt_fifo_set_item_content(xbt_fifo_item_t i, void *v)
+{
+  xbt_fifo_setItemcontent(i, v);
+}
+
+/**
+ * \param i a bucket
+ * \return the object stored \a i.
+ */
+XBT_INLINE void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
 {
   return xbt_fifo_getItemcontent(i);
 }
 
-/*
- * xbt_fifo_freeitem()
+/** Destructor
+ * \param b poor victim
+ *
+ * Free the bucket but does not modifies the object (if any) that was stored in it.
+ */
+XBT_INLINE void xbt_fifo_free_item(xbt_fifo_item_t b)
+{
+  xbt_mallocator_release(item_mallocator, b);
+  return;
+}
+
+/** 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)
 {
-  free(b);
+  WARN0("This function is deprecated. Use xbt_fifo_free_item.");
+  xbt_fifo_free_item(b);
   return;
 }
 
-int xbt_fifo_size(xbt_fifo_t f)
+/**
+ * \param f a list
+ * \return the number of buckets in \a f.
+ */
+XBT_INLINE int xbt_fifo_size(xbt_fifo_t f)
 {
   return f->count;
 }
 
+/**
+ * \param l a list
+ * \return the head of \a l.
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l)
+{
+  return l->head;
+}
+
+/** \deprecated Use #xbt_fifo_get_first_item instead.
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
+{
+  WARN0("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
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
+{
+  if (i)
+    return i->next;
+  return NULL;
+}
+
+/** \deprecated Use #xbt_fifo_get_next_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i)
+{
+  WARN0("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.
+ */
+XBT_INLINE xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
+{
+  if (i)
+    return i->prev;
+  return NULL;
+}
+
+/** \deprecated Use #xbt_fifo_get_prev_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i)
+{
+  WARN0("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().
+ */
+void xbt_fifo_exit(void)
+{
+  if (item_mallocator != NULL) {
+    xbt_mallocator_free(item_mallocator);
+    item_mallocator = NULL;
+  }
+}
 
+/* @} */