/usr/include/xbt/fifo.h is in libsimgrid-dev 3.11.1-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | /* Copyright (c) 2004-2007, 2009-2014. 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. */
#ifndef _XBT_FIFO_H
#define _XBT_FIFO_H
#include "xbt/misc.h" /* SG_BEGIN_DECL */
#include "xbt/function_types.h" /* int_f_pvoid_pvoid_t */
SG_BEGIN_DECL()
/** @addtogroup XBT_fifo
* @brief This section describes the API to generic workqueue.
*
* These functions provide the same kind of functionnality as dynamic arrays but in time O(1).
* However these functions use malloc/free way too much often.
*/
/** @defgroup XBT_fifo_cons Fifo constructor and destructor
* @ingroup XBT_fifo
*
* @{
*/
/** \brief Bucket structure
*/
typedef struct xbt_fifo_item *xbt_fifo_item_t;
/** \brief FIFO structure
*/
typedef struct xbt_fifo *xbt_fifo_t;
XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void);
XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t);
XBT_PUBLIC(void) xbt_fifo_reset(xbt_fifo_t);
/** @} */
/** @defgroup XBT_fifo_perl Fifo perl-like functions
* @ingroup XBT_fifo
*
* @{
*/
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *);
XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *);
XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t);
XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t);
XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_search_item(xbt_fifo_t f, int_f_pvoid_pvoid_t cmp_fun, void *closure);
/** @} */
/** @defgroup XBT_fifo_direct Direct access to fifo elements
* @ingroup XBT_fifo
*
* @{
*/
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t);
XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t);
XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t);
XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t);
XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *);
XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *);
XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_item(xbt_fifo_t l);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
/**
* \brief List iterator
* asserts and stuff
* \param f a list (#xbt_fifo_t)
* \param i a bucket (#xbt_fifo_item_t)
* \param type a type
* \param n an object of type \a type.
* @hideinitializer
*
* Iterates over the whole list.
*/
#define xbt_fifo_foreach(f,i,n,type) \
for(i=xbt_fifo_get_first_item(f); \
((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL)); \
i=xbt_fifo_get_next_item(i))
/** @} */
/** @defgroup XBT_fifo_misc Misc fifo functions
* @ingroup XBT_fifo
*
* @{
*/
XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t);
XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t);
/** @} */
/* Deprecated functions: don't use! */
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void);
XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i);
XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
SG_END_DECL()
#endif /* _XBT_FIFO_H */
|