Rev 996 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 996 | Rev 1392 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (C) 2006 Jakub Jermar |
2 | * Copyright (C) 2006 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /* |
29 | /* |
30 | * This implementation of FIFO stores values in an array |
30 | * This implementation of FIFO stores values in an array |
31 | * (static or dynamic). As such, these FIFOs have upper bound |
31 | * (static or dynamic). As such, these FIFOs have upper bound |
32 | * on number of values they can store. Push and pop operations |
32 | * on number of values they can store. Push and pop operations |
33 | * are done via accessing the array through head and tail indices. |
33 | * are done via accessing the array through head and tail indices. |
34 | * Because of better operation ordering in fifo_pop(), the access |
34 | * Because of better operation ordering in fifo_pop(), the access |
35 | * policy for these two indices is to 'increment (mod size of FIFO) |
35 | * policy for these two indices is to 'increment (mod size of FIFO) |
36 | * and use'. |
36 | * and use'. |
37 | */ |
37 | */ |
38 | 38 | ||
39 | #ifndef __FIFO_H__ |
39 | #ifndef __FIFO_H__ |
40 | #define __FIFO_H__ |
40 | #define __FIFO_H__ |
41 | 41 | ||
42 | #include <malloc.h> |
42 | #include <malloc.h> |
43 | 43 | ||
44 | typedef unsigned long fifo_count_t; |
44 | typedef unsigned long fifo_count_t; |
45 | typedef unsigned long fifo_index_t; |
45 | typedef unsigned long fifo_index_t; |
46 | 46 | ||
47 | /** Create and initialize static FIFO. |
47 | /** Create and initialize static FIFO. |
48 | * |
48 | * |
49 | * FIFO is allocated statically. |
49 | * FIFO is allocated statically. |
50 | * This macro is suitable for creating smaller FIFOs. |
50 | * This macro is suitable for creating smaller FIFOs. |
51 | * |
51 | * |
52 | * @param name Name of FIFO. |
52 | * @param name Name of FIFO. |
53 | * @param t Type of values stored in FIFO. |
53 | * @param t Type of values stored in FIFO. |
54 | * @param itms Number of items that can be stored in FIFO. |
54 | * @param itms Number of items that can be stored in FIFO. |
55 | */ |
55 | */ |
56 | #define FIFO_INITIALIZE_STATIC(name, t, itms) \ |
56 | #define FIFO_INITIALIZE_STATIC(name, t, itms) \ |
57 | struct { \ |
57 | struct { \ |
58 | t fifo[(itms)]; \ |
58 | t fifo[(itms)]; \ |
59 | fifo_count_t items; \ |
59 | fifo_count_t items; \ |
60 | fifo_index_t head; \ |
60 | fifo_index_t head; \ |
61 | fifo_index_t tail; \ |
61 | fifo_index_t tail; \ |
62 | } name = { \ |
62 | } name = { \ |
63 | .items = (itms), \ |
63 | .items = (itms), \ |
64 | .head = 0, \ |
64 | .head = 0, \ |
65 | .tail = 0 \ |
65 | .tail = 0 \ |
66 | } |
66 | } |
67 | 67 | ||
68 | /** Create and prepare dynamic FIFO. |
68 | /** Create and prepare dynamic FIFO. |
69 | * |
69 | * |
70 | * FIFO is allocated dynamically. |
70 | * FIFO is allocated dynamically. |
71 | * This macro is suitable for creating larger FIFOs. |
71 | * This macro is suitable for creating larger FIFOs. |
72 | * |
72 | * |
73 | * @param name Name of FIFO. |
73 | * @param name Name of FIFO. |
74 | * @param t Type of values stored in FIFO. |
74 | * @param t Type of values stored in FIFO. |
75 | * @param itms Number of items that can be stored in FIFO. |
75 | * @param itms Number of items that can be stored in FIFO. |
76 | */ |
76 | */ |
77 | #define FIFO_INITIALIZE_DYNAMIC(name, t, itms) \ |
77 | #define FIFO_INITIALIZE_DYNAMIC(name, t, itms) \ |
78 | struct { \ |
78 | struct { \ |
79 | t *fifo; \ |
79 | t *fifo; \ |
80 | fifo_count_t items; \ |
80 | fifo_count_t items; \ |
81 | fifo_index_t head; \ |
81 | fifo_index_t head; \ |
82 | fifo_index_t tail; \ |
82 | fifo_index_t tail; \ |
83 | } name = { \ |
83 | } name = { \ |
84 | .fifo = NULL, \ |
84 | .fifo = NULL, \ |
85 | .items = (itms), \ |
85 | .items = (itms), \ |
86 | .head = 0, \ |
86 | .head = 0, \ |
87 | .tail = 0 \ |
87 | .tail = 0 \ |
88 | } |
88 | } |
89 | 89 | ||
90 | /** Pop value from head of FIFO. |
90 | /** Pop value from head of FIFO. |
91 | * |
91 | * |
92 | * @param name FIFO name. |
92 | * @param name FIFO name. |
93 | * |
93 | * |
94 | * @return Leading value in FIFO. |
94 | * @return Leading value in FIFO. |
95 | */ |
95 | */ |
96 | #define fifo_pop(name) \ |
96 | #define fifo_pop(name) \ |
97 | name.fifo[name.head = (name.head + 1) < name.items ? (name.head + 1) : 0] |
97 | name.fifo[name.head = (name.head + 1) < name.items ? (name.head + 1) : 0] |
98 | 98 | ||
99 | /** Push value to tail of FIFO. |
99 | /** Push value to tail of FIFO. |
100 | * |
100 | * |
101 | * @param name FIFO name. |
101 | * @param name FIFO name. |
102 | * @param value Value to be appended to FIFO. |
102 | * @param value Value to be appended to FIFO. |
103 | * |
103 | * |
104 | */ |
104 | */ |
105 | #define fifo_push(name, value) \ |
105 | #define fifo_push(name, value) \ |
106 | name.fifo[name.tail = (name.tail + 1) < name.items ? (name.tail + 1) : 0] = (value) |
106 | name.fifo[name.tail = (name.tail + 1) < name.items ? (name.tail + 1) : 0] = (value) |
107 | 107 | ||
108 | /** Allocate memory for dynamic FIFO. |
108 | /** Allocate memory for dynamic FIFO. |
109 | * |
109 | * |
110 | * @param name FIFO name. |
110 | * @param name FIFO name. |
111 | */ |
111 | */ |
112 | #define fifo_create(name) \ |
112 | #define fifo_create(name) \ |
113 | name.fifo = malloc(sizeof(*name.fifo) * name.items) |
113 | name.fifo = malloc(sizeof(*name.fifo) * name.items) |
114 | 114 | ||
115 | #endif |
115 | #endif |
116 | 116 |