/usr/include/xbt/swag.h is in libsimgrid-dev 3.14.159-2.
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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | /* Copyright (c) 2004-2015. 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. */
/* Warning, this module is done to be efficient and performs tons of cast and dirty things. So avoid using it unless
* you really know what you are doing. */
#ifndef _XBT_SWAG_H
#define _XBT_SWAG_H
#include "xbt/misc.h"
#include "xbt/sysdep.h" /* size_t */
SG_BEGIN_DECL()
/**
* @addtogroup XBT_swag
* @brief a O(1) set based on linked lists
*
* Warning, this module is done to be efficient and performs tons of cast and dirty things. So make sure you know what
* you are doing while using it.
* It is basically a fifo but with restrictions so that it can be used as a set. Any operation (add, remove, belongs)
* is O(1) and no call to malloc/free is done.
*
* @deprecated If you are using C++, you might want to use
* `boost::intrusive::set` instead.
*/
/** @defgroup XBT_swag_type Swag types
@ingroup XBT_swag
Specific set.
These typedefs are public so that the compiler can do his job but believe me, you don't want to try to play with
those structs directly. Use them as an abstract datatype.
*/
/* @{ */
typedef struct xbt_swag_hookup {
void *next;
void *prev;
} s_xbt_swag_hookup_t;
/**< This type should be added to a type that is to be used in a swag.
*
* Whenever a new object with this struct is created, all fields have to be set to NULL
*
* Here is an example like that :
\code
typedef struct foo {
s_xbt_swag_hookup_t set1_hookup;
s_xbt_swag_hookup_t set2_hookup;
double value;
} s_foo_t, *foo_t;
...
{
s_foo_t elem;
xbt_swag_t set1=NULL;
xbt_swag_t set2=NULL;
set1 = xbt_swag_new(xbt_swag_offset(elem, set1_hookup));
set2 = xbt_swag_new(xbt_swag_offset(elem, set2_hookup));
}
\endcode
*/
typedef s_xbt_swag_hookup_t *xbt_swag_hookup_t;
struct xbt_swag {
void *head;
void *tail;
size_t offset;
int count;
};
typedef struct xbt_swag s_xbt_swag_t;
typedef struct xbt_swag* xbt_swag_t;
/**< A typical swag */
/* @} */
/** @defgroup XBT_swag_func SWAG functions
* @ingroup XBT_swag
* @{
*/
XBT_PUBLIC(xbt_swag_t) xbt_swag_new(size_t offset);
XBT_PUBLIC(void) xbt_swag_free(xbt_swag_t swag);
XBT_PUBLIC(void) xbt_swag_init(xbt_swag_t swag, size_t offset);
/**
* \brief Makes a swag empty.
* \param swag a swag
* @hideinitializer
*/
#define xbt_swag_reset(swag) do {} while(xbt_swag_extract(swag))
/**
* \param obj the objet to insert in the swag
* \param swag a swag
* @hideinitializer
*
* insert \a obj in \a swag
*/
#define xbt_swag_insert(obj, swag) xbt_swag_insert_at_tail(obj, swag)
XBT_PUBLIC(void) xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
XBT_PUBLIC(void) xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
XBT_PUBLIC(void *) xbt_swag_remove(void *obj, xbt_swag_t swag);
XBT_PUBLIC(void *) xbt_swag_extract(xbt_swag_t swag);
XBT_PUBLIC(int) xbt_swag_size(xbt_swag_t swag);
#define xbt_swag_getPrev(obj, offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
#define xbt_swag_getNext(obj, offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
#define xbt_swag_belongs(obj, swag) (xbt_swag_getNext((obj), (swag)->offset) || (swag)->tail == (obj))
static inline void *xbt_swag_getFirst(xbt_swag_t swag)
{
return (swag->head);
}
/**
* \brief Offset computation
* \arg var a variable of type <tt>struct</tt> something
* \arg field a field of <tt>struct</tt> something
* \return the offset of \a field in <tt>struct</tt> something.
* @hideinitializer
*
* It is very similar to offsetof except that is done at runtime and that you have to declare a variable. Why defining
* such a macro then ? Because it is portable...
*/
#define xbt_swag_offset(var,field) ((char *)&( (var).field ) - (char *)&(var))
/* @} */
/**
* \defgroup XBT_swag_curs Swag cursor
* @ingroup XBT_swag
* Iterates over the whole swag.
*
* @{ */
/** @brief A simple swag iterator
* @param obj the indice of the loop
* @param swag what to iterate over
* @warning you cannot modify the \a swag while using this loop
* @hideinitializer */
#ifndef __cplusplus
#define xbt_swag_foreach(obj,swag) \
for((obj)=xbt_swag_getFirst((swag)); \
(obj)!=NULL; \
(obj)=xbt_swag_getNext((obj),(swag)->offset))
#else
#define xbt_swag_foreach(obj,swag) \
for((obj)=(decltype(obj)) xbt_swag_getFirst((swag)); \
(obj)!=NULL; \
(obj)=(decltype(obj)) xbt_swag_getNext((obj),(swag)->offset))
#endif
/**
* @brief A safe swag iterator
* @param obj the indice of the loop
* @param obj_next the object that is right after (if any) \a obj in the swag
* @param swag what to iterate over
* @hideinitializer
You can safely modify the \a swag while using this loop.
Well, safely... Err. You can remove \a obj without having any trouble at least. */
#ifndef __cplusplus
#define xbt_swag_foreach_safe(obj,obj_next,swag) \
for((obj)=xbt_swag_getFirst((swag)), \
((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)): \
(obj_next=NULL)); \
(obj)!=NULL; \
(obj)=obj_next, \
((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)): \
(obj_next=NULL)) )
#else
#define xbt_swag_foreach_safe(obj,obj_next,swag) \
for((obj) = (decltype(obj)) xbt_swag_getFirst((swag)), \
((obj)?(obj_next = (decltype(obj)) xbt_swag_getNext((obj),(swag)->offset)): \
(obj_next=NULL)); \
(obj) != NULL; \
(obj) = obj_next, \
((obj)?(obj_next = (decltype(obj)) xbt_swag_getNext((obj),(swag)->offset)): \
(obj_next=NULL)) )
#endif
/* @} */
SG_END_DECL()
#endif /* _XBT_SWAG_H */
|