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
|
/*
* File : lf_ring_buffer.c
* Author : Jérémy Zurcher <jeremy@asynk.ch>
* Date : 05/01/010
* License :
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#include "lf_ring_buffer.h"
#include "lf_portable_cas.h"
#include <stdlib.h>
#include <string.h>
#include <time.h>
#if !defined LFRB_DATA_SIZE
#error "LFRB_DATA_SIZE is not defined"
#endif
#if !defined LFRB_BUFFER_TYPE
#error "LFRB_BUFFER_TAPE is not defined"
#endif
#if !defined LFRB_BUFFER_SIZE
#error "LFRB_BUFFER_SIZE is not defined"
#endif
#if !defined LFRB_IS_AVAILABLE
#error "LFRB_IS_AVAILABLE is not defined"
#endif
#if !defined LFRB_MARK_AS_FILLED
#error "LFRB_MARK_AS_FILLED is not defined"
#endif
#if !defined LFRB_MARK_AS_READ
#error "LFRB_MARK_AS_READ is not defined"
#endif
#if !defined LFRB_DATA_PTR
#error "LFRB_DATA_PTR is not defined"
#endif
//#define DEBUG_LFR_RING 1
#ifdef DEBUG_LFR_RING
#include <stdio.h>
#define _LOG_( ... ) fprintf(stdout,__VA_ARGS__)
#else
#define _LOG_( ... )
#endif
#define BACKOFF_NANO_SLEEP 100
/* initialize an empty lf_ring_buffer struct */
lf_ring_buffer_t* lf_ring_buffer_create( size_t n_buf ) {
/* alloc ring_buffer struct */
lf_ring_buffer_t *r = malloc(sizeof(lf_ring_buffer_t));
if(r==NULL) return NULL;
/* */
r->buffer = malloc(LFRB_BUFFER_SIZE*n_buf);
if(r->buffer==NULL) {
free(r);
return NULL;
}
memset(r->buffer,0,LFRB_BUFFER_SIZE*n_buf);
r->n_buf = n_buf;
r->read_from = -1;
r->write_to = 0;
return r;
}
/* destroy an lf_ring_buffer strcture */
void lf_ring_buffer_destroy( lf_ring_buffer_t *r ) {
free(r->buffer);
free(r);
}
/* write data into the ring buffer */
int lf_ring_buffer_write( lf_ring_buffer_t *r, void *data, int flags ) {
int idx, next;
struct timespec backoff;
/* reserve a buffer */
for(;;){
idx = r->write_to;
if(LFRB_IS_AVAILABLE( r->buffer[idx] ) ) {
/* read_from==idx means that the buffer is full and that a writer thread which at first reserved this buffer
* hasn't had enough CPU cycles to call MARK_AS_FILLED
*/
if( r->read_from!=idx ) {
next = idx+1;
if (next==r->n_buf) next=0;
/* what might have happend between IS_AVAILABLE and now :
* - a writter has reserved this buffer => write_to has moved => CAS fails
* - a reader has consumed a buffer => read_from has moved => we've got more space
*/
_LOG_( "write: CAS %d %d %d\n", r->write_to, idx, next );
if( CompareAndSwapInt( &r->write_to, idx, next ) ) {
/* !!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!
* - if the ring is empty before this write operation (r->read_from==-1 or latest idx)
* - and n_buf other threads call this same function before this point
* then, the last thread will :
* - see this buffer as available
* - and see the ring as empty instead of full !!!!!
* so it will ends with two threads writing on this buffer
*/
if(r->read_from==-1) CompareAndSwapInt( &r->read_from, -1, idx );
break;
}
} else {
_LOG_("write: ring full %d %d\n",r->read_from,idx);
if(IS_NOT_BLOCKING(flags)) return -1;
backoff.tv_sec = 0;
backoff.tv_nsec = BACKOFF_NANO_SLEEP;
nanosleep(&backoff,NULL);
}
} else {
_LOG_("write: buffer not available\n");
if(IS_NOT_BLOCKING(flags)) return -1;
backoff.tv_sec = 0;
backoff.tv_nsec = BACKOFF_NANO_SLEEP;
nanosleep(&backoff,NULL);
}
}
/* fill this buffer and mark it as filled */
memcpy( r->buffer[idx].data, data, LFRB_DATA_SIZE );
LFRB_MARK_AS_FILLED( r->buffer[idx] );
return 0;
}
/* read data from the ring buffer */
int lf_ring_buffer_read( lf_ring_buffer_t *r, void *data, int flags ) {
int idx, next;
struct timespec backoff;
for(;;) {
idx = r->read_from;
if( !(LFRB_IS_AVAILABLE( r->buffer[idx] )) && r->read_from!=-1 ) {
next = idx+1;
if (next==r->n_buf) next=0;
/* will do bad things if data dst buffer is too small !! */
memcpy( data, r->buffer[idx].data, LFRB_DATA_SIZE );
_LOG_( "read: CAS %d %d %d\n", r->read_from, idx, next );
if( CompareAndSwapInt( &r->read_from, idx, next ) ) {
if(r->read_from==r->write_to) {
/* the buffer is empty but writers will see it as full */
_LOG_( "read: empty CAS %d %d %d\n", r->read_from, next, -1 );
CompareAndSwapInt( &r->read_from, next, -1 );
}
break;
}
}
_LOG_("read: ring empty\n");
if(IS_NOT_BLOCKING(flags)) return -1;
backoff.tv_sec = 0;
backoff.tv_nsec = BACKOFF_NANO_SLEEP;
nanosleep(&backoff,NULL);
}
/* finish the read process */
LFRB_MARK_AS_READ( r->buffer[idx] );
return 0;
}
|
