summaryrefslogtreecommitdiff
path: root/mbglib/common/mbgklist.h
blob: 19f22a3315a01c2db6c1db54fa8e14ff9b1f2680 (plain)
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

/**************************************************************************
 *
 *  $Id: mbgklist.h 1.2.1.4 2017/01/12 15:09:45 philipp TEST $
 *
 *  Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
 *
 *  Description:
 *    Userspace implementation of Linux Kernel's list.h
 *
 * -----------------------------------------------------------------------
 *  $Log: mbgklist.h $
 *  Revision 1.2.1.4  2017/01/12 15:09:45  philipp
 *  Added more safe loop macros
 *  Revision 1.2.1.3  2017/01/12 12:21:22  philipp
 *  Added safe loop macros
 *  Revision 1.2.1.2  2016/08/11 14:13:22  martin
 *  Revision 1.2.1.1  2016/08/10 14:32:13Z  martin
 *  *** empty log message ***
 *  Revision 1.2  2015/10/06 07:08:45  philipp
 *  Added functions to loop containers of list entries
 *  Revision 1.1  2015/09/09 10:42:27  martin
 *  Initial revision.
 *
 **************************************************************************/

#ifndef _MBGKLIST_H
#define _MBGKLIST_H

/* Other headers to be included */

#include <mbg_cof.h>


#ifdef _MBGKLIST
 #define _ext
 #define _DO_INIT
#else
 #define _ext extern
#endif


/* Start of header body */

#ifdef __cplusplus
extern "C" {
#endif


#define MBG_KLIST_INIT(name) { &(name), &(name) }

#define MBG_KLIST_DECLARE(name) \
  struct mbg_klist_head name = MBG_KLIST_INIT(name)

#define mbg_klist_for_each(head, pos) \
  for (pos = (head)->next; pos != (head); pos = pos->next)

#define mbg_klist_for_each_safe(head, pos, n) \
  for (pos = (head)->next, n = (pos)->next; \
       pos != (head); \
       pos = n, n = pos->next)

#define mbg_klist_for_each_rev(head, pos) \
  for (pos = (head)->prev; pos != (head); pos = pos->prev)

#define mbg_klist_for_each_rev_safe(head, pos, n) \
  for (pos = (head)->prev, n = (pos)->prev; \
       pos != (head); \
       pos = n, n = pos->prev)

#define mbg_klist_entry(ptr, type, member) \
    mbg_container_of(ptr, type, member)

#define mbg_klist_first_entry(ptr, type, member) \
    mbg_klist_entry((ptr)->next, type, member)

#define mbg_klist_last_entry(ptr, type, member) \
    mbg_klist_entry((ptr)->prev, type, member)



#if defined( __GNUC__ ) || defined( __clang__ )  // "typeof" supported

#define mbg_klist_next_entry(pos, member) \
    mbg_klist_entry((pos)->member.next, typeof(*pos), member)

#define mbg_klist_prev_entry(pos, member) \
    mbg_klist_entry((pos)->member.prev, typeof(*pos), member)

#define mbg_klist_for_each_entry(head, pos, member) \
    for (pos = mbg_klist_first_entry(head, typeof(*pos), member); \
         &pos->member != (head); \
         pos = mbg_klist_next_entry(pos, member))

#define mbg_klist_for_each_entry_rev(head, pos, member) \
    for (pos = mbg_klist_last_entry(head, typeof(*pos), member); \
         &pos->member != (head); \
         pos = mbg_klist_prev_entry(pos, member))

#define mbg_klist_for_each_entry_safe(head, pos, n, member) \
    for (pos = mbg_klist_first_entry(head, typeof(*pos), member), \
         n = mbg_klist_next_entry(pos, member); \
         &pos->member != (head); \
         pos = n, n = mbg_klist_next_entry(pos, member))

#define mbg_klist_for_each_entry_rev_safe(head, pos, n, member) \
    for (pos = mbg_klist_last_entry(head, typeof(*pos), member), \
         n = mbg_klist_prev_entry(pos, member); \
         &pos->member != (head); \
         pos = n, n = mbg_klist_prev_entry(pos, member))

#endif



struct mbg_klist_head
{
  struct mbg_klist_head *prev;
  struct mbg_klist_head *next;
};



/* function prototypes: */

static __mbg_inline
void mbg_klist_init( struct mbg_klist_head *head )
{
  head->next = head;
  head->prev = head;
}


static __mbg_inline
void __mbg_klist_add_item( struct mbg_klist_head *item, struct mbg_klist_head *prev, struct mbg_klist_head *next )
{
  next->prev = item;
  item->next = next;
  item->prev = prev;
  prev->next = item;
}


static __mbg_inline
void mbg_klist_prepend_item( struct mbg_klist_head *head, struct mbg_klist_head *item )
{
  __mbg_klist_add_item( item, head, head->next );
}


static __mbg_inline
void mbg_klist_append_item( struct mbg_klist_head *head, struct mbg_klist_head *item )
{
  __mbg_klist_add_item( item, head->prev, head );
}


static __mbg_inline
void __mbg_klist_delete_item( struct mbg_klist_head *prev, struct mbg_klist_head *next )
{
  next->prev = prev;
  prev->next = next;
}


static __mbg_inline
void mbg_klist_delete_item( struct mbg_klist_head *item )
{
  __mbg_klist_delete_item( item->prev, item->next );
}


static __mbg_inline
void mbg_klist_delete_item_init( struct mbg_klist_head *item )
{
  __mbg_klist_delete_item( item->prev, item->next );
  mbg_klist_init( item );
}


static __mbg_inline
void mbg_klist_replace_item( struct mbg_klist_head *old, struct mbg_klist_head *item )
{
  item->next = old->next;
  item->next->prev = item;
  item->prev = old->prev;
  item->prev->next = item;
}


static __mbg_inline
void mbg_klist_replace_item_init( struct mbg_klist_head *old, struct mbg_klist_head *item )
{
  mbg_klist_replace_item( old, item );
  mbg_klist_init( item );
}


static __mbg_inline
void mbg_klist_move_prepend_item( struct mbg_klist_head *head, struct mbg_klist_head *item )
{
  mbg_klist_delete_item( item );
  mbg_klist_prepend_item( head, item );
}


static __mbg_inline
void mbg_klist_move_append_item( struct mbg_klist_head *head, struct mbg_klist_head *item )
{
  mbg_klist_delete_item( item );
  mbg_klist_append_item( head, item );
}


static __mbg_inline
int mbg_klist_is_first( const struct mbg_klist_head *head, const struct mbg_klist_head *item )
{
  return ( ( item->prev == head ) ? 1 : 0 );
}


static __mbg_inline
int mbg_klist_is_last( const struct mbg_klist_head *head, const struct mbg_klist_head *item )
{
  return ( ( item->next == head ) ? 1 : 0 );
}


static __mbg_inline
int mbg_klist_is_empty( const struct mbg_klist_head *head )
{
  return ( ( head->next == head ) ? 1 : 0 );
}


static __mbg_inline
void __mbg_klist_add_list( const struct mbg_klist_head *list, struct mbg_klist_head *prev, struct mbg_klist_head *next )
{
  struct mbg_klist_head *first = list->next;
  struct mbg_klist_head *last = list->prev;

  first->prev = prev;
  prev->next = first;

  last->next = next;
  next->prev = last;
}


static __mbg_inline
void mbg_klist_prepend_list( struct mbg_klist_head *head, const struct mbg_klist_head *list )
{
  if ( !mbg_klist_is_empty( list ) )
    __mbg_klist_add_list( list, head, head->next );
}


static __mbg_inline
void mbg_klist_append_list( struct mbg_klist_head *head, const struct mbg_klist_head *list )
{
  if ( !mbg_klist_is_empty( list ) )
    __mbg_klist_add_list( list, head->prev, head );
}


static __mbg_inline
void mbg_klist_prepend_list_init( struct mbg_klist_head *head, struct mbg_klist_head *list )
{
  if ( !mbg_klist_is_empty( list ) )
  {
    __mbg_klist_add_list( list, head, head->next );
    mbg_klist_init( list );
  }
}


static __mbg_inline
void mbg_klist_append_list_init( struct mbg_klist_head *head, struct mbg_klist_head *list )
{
  if ( !mbg_klist_is_empty( list ) )
  {
    __mbg_klist_add_list( list, head->prev, head );
    mbg_klist_init( list );
  }
}


/* ----- function prototypes begin ----- */

/* This section was generated automatically */
/* by MAKEHDR, do not remove the comments. */

/* ----- function prototypes end ----- */

#ifdef __cplusplus
}
#endif

/* End of header body */

#undef _ext
#undef _DO_INIT

#endif  /* _MBGKLIST_H */