aboutsummaryrefslogtreecommitdiff
path: root/libiot/pthread/cond.c
blob: 288e5489ae489c81d261a9952a64fbb041787543 (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
/*
 * Copyright (C) 2015 - 2018, IBEROXARXA SERVICIOS INTEGRALES, S.L.
 * Copyright (C) 2015 - 2018, Jaume Olivé Petrus (jolive@whitecatboard.org)
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *     * The WHITECAT logotype cannot be changed, you can remove it, but you
 *       cannot change it in any way. The WHITECAT logotype is:
 *
 *          /\       /\
 *         /  \_____/  \
 *        /_____________\
 *        W H I T E C A T
 *
 *     * Redistributions in binary form must retain all copyright notices printed
 *       to any local or remote output device. This include any reference to
 *       Lua RTOS, whitecatboard.org, Lua, and other copyright notices that may
 *       appear in the future.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Lua RTOS pthread implementation for FreeRTOS
 *
 */

#include "_pthread.h"

#include <sys/mutex.h>
#include <sys/time.h>

#if configUSE_16_BIT_TICKS
#define BITS_PER_EVENT_GROUP 8
#else
#define BITS_PER_EVENT_GROUP 24
#endif

int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr) {
	// Avoid to reinitialize the object referenced by cond, a previously
	// initialized, but not yet destroyed, condition variable
	if (*cond != PTHREAD_COND_INITIALIZER) {
		return EBUSY;
	}

	// Initialize the internal cond structure
	struct pthread_cond *scond = calloc(1, sizeof(struct pthread_cond));
	if (!scond) {
		return ENOMEM;
	}

	// Init the cond mutex
	mtx_init(&scond->mutex, NULL, NULL, 0);
	if (!scond->mutex.lock) {
		free(scond);
		return ENOMEM;
	}

	// Create the event group
	scond->ev = xEventGroupCreate();
	if (scond->ev == NULL) {
		mtx_destroy(&scond->mutex);
		free(scond);
		return ENOMEM;
	}

	// Return the cond reference
	*cond = (pthread_cond_t)scond;

	return 0;
}

int pthread_cond_destroy(pthread_cond_t *cond) {
	if (*cond == PTHREAD_COND_INITIALIZER) {
		return EINVAL;
	}

	struct pthread_cond *scond = (struct pthread_cond *) *cond;

	mtx_lock(&scond->mutex);

	if (scond->referenced > 0) {
		mtx_unlock(&scond->mutex);

		return EBUSY;
	}

	mtx_destroy(&scond->mutex);

	return 0;
}

int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex) {
	return pthread_cond_timedwait(cond, mutex, NULL);
}

int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
		const struct timespec *abstime) {

	if (*cond == PTHREAD_COND_INITIALIZER) {
		return EINVAL;
	}

	struct pthread_cond *scond = (struct pthread_cond *)*cond;

	// Find an unused bit in the event group to sync the condition
	mtx_lock(&scond->mutex);

	uint8_t bit;
	for(bit=0;bit < BITS_PER_EVENT_GROUP;bit++) {
		if (!((1 << bit) & scond->referenced)) {
			scond->referenced |= (1 << bit);

			break;
		}
	}

	mtx_unlock(&scond->mutex);

	if (bit >= BITS_PER_EVENT_GROUP) {
		// All bits are used in the event group. This is a rare condition, because
		// in Lua RTOS an event group has 24 bits, which means that 24 conditions
		// (or 24 threads) can be handled for each condition variable.
		//
		// Although is not part of the pthread specification we indicate this
		// condition returning the EINVAL error code.
		return EINVAL;
	}

	// Get the timeout in ticks
	TickType_t ticks;

	if (!abstime) {
		ticks = portMAX_DELAY;
	} else {
		struct timeval now, future, diff;

		gettimeofday(&now, NULL);

		future.tv_sec = abstime->tv_sec;
		future.tv_usec = abstime->tv_nsec / 1000;

		if (timercmp(&future, &now, <)) {
			return ETIMEDOUT;
		} else {
			timersub(&future, &now, &diff);
			ticks = ((diff.tv_sec * 1000) + (diff.tv_usec / 1000)) / portTICK_PERIOD_MS;
		}
	}

	pthread_mutex_unlock(mutex);
	EventBits_t uxBits = xEventGroupWaitBits(scond->ev, (1 << bit), pdTRUE, pdTRUE, ticks);
	if (!(uxBits & (1 << bit))) {
	    pthread_mutex_lock(mutex);
	    scond->referenced &= ~(1 << bit);
	    pthread_mutex_unlock(mutex);

		return ETIMEDOUT;
	}
	pthread_mutex_lock(mutex);

	return 0;
}

int pthread_cond_signal(pthread_cond_t *cond) {
	if (*cond == PTHREAD_COND_INITIALIZER) {
		return EINVAL;
	}

	struct pthread_cond *scond = (struct pthread_cond *)*cond;

	mtx_lock(&scond->mutex);

	uint8_t bit;
	for(bit=0;bit < BITS_PER_EVENT_GROUP;bit++) {
		if ((1 << bit) & scond->referenced) {
			xEventGroupSetBits(scond->ev, (1 << bit));

			scond->referenced &= ~(1 << bit);
		}
	}

	mtx_unlock(&scond->mutex);

	return 0;
}