1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
5 /* Universidad de Cantabria, SPAIN */
6 /* University of York, UK */
7 /* Scuola Superiore Sant'Anna, ITALY */
8 /* Kaiserslautern University, GERMANY */
9 /* Univ. Politécnica Valencia, SPAIN */
10 /* Czech Technical University in Prague, CZECH REPUBLIC */
12 /* Thales Communication S.A. FRANCE */
13 /* Visual Tools S.A. SPAIN */
14 /* Rapita Systems Ltd UK */
17 /* See http://www.frescor.org for a link to partners' websites */
19 /* FRESCOR project (FP6/2005/IST/5-034026) is funded */
20 /* in part by the European Union Sixth Framework Programme */
21 /* The European Union is not liable of any use that may be */
22 /* made of this code. */
25 /* This file is part of FWP (Frescor WLAN Protocol) */
27 /* FWP is free software; you can redistribute it and/or modify it */
28 /* under terms of the GNU General Public License as published by the */
29 /* Free Software Foundation; either version 2, or (at your option) any */
30 /* later version. FWP is distributed in the hope that it will be */
31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
33 /* General Public License for more details. You should have received a */
34 /* copy of the GNU General Public License along with FWP; see file */
35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
36 /* Cambridge, MA 02139, USA. */
38 /* As a special exception, including FWP header files in a file, */
39 /* instantiating FWP generics or templates, or linking other files */
40 /* with FWP objects to produce an executable application, does not */
41 /* by itself cause the resulting executable application to be covered */
42 /* by the GNU General Public License. This exception does not */
43 /* however invalidate any other reasons why the executable file might be */
44 /* covered by the GNU Public License. */
45 /**************************************************************************/
46 #include "fwp_utils.h"
50 #include "fwp_endpoint.h"
51 #include "fwp_debug.h"
57 static void* fwp_vres_tx_thread(void *_vres);
65 fwp_vres_params_t fwp_vres_params_default = {
69 .period = {.tv_sec = 2 , .tv_nsec = 111111}
73 * Structure of FWP vres.
74 * Internal representation of vres
78 struct fwp_vres_params params;
79 /* consideration: move tx_queue to endpoint */
80 /**< queue for messages to send */
81 struct fwp_msgq tx_queue;
82 fwp_vres_flag_t flags;
83 /**< endpoint bounded to this vres */
84 /*fwp_endpoint_t *epoint; */
85 pthread_t tx_thread; /**< tx_thread id*/
86 pthread_attr_t tx_thread_attr;
87 int ac_sockd; /**< ac socket descriptor */
91 struct fwp_vres_table {
92 unsigned int max_vres;
97 /* Global variable - vres table */
98 static fwp_vres_table_t fwp_vres_table = {
101 .lock = PTHREAD_MUTEX_INITIALIZER,
104 /**< mapping priority to ac*/
105 static const int prio_to_ac[8] = {2,3,3,2,1,1,0,0};
106 /**< IP tos for AC_VI, AC_VO, AC_BE, AC_BK */
107 static const unsigned int ac_to_tos[4] = {224,160,96,64};
110 * Set access category (AC) to socket
112 * \param[in] sockd Socket descriptor
113 * \param[in] ac_id AC identifier
115 * \return On success returns zero.
116 * On error, negative error code is returned.
119 static inline int fwp_vres_set_ac(int sockd, fwp_ac_t ac_id)
123 tos = ac_to_tos[ac_id];
124 if (setsockopt(sockd, SOL_IP, IP_TOS, &tos, sizeof(tos)) == -1) {
125 FWP_ERROR("setsockopt: %s", strerror(errno));
132 static inline void fwp_vres_set_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
134 vres->flags |= (1 << flag);
137 static inline void fwp_vres_clear_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
139 vres->flags &= ~(1 << flag);
142 static inline int fwp_vres_get_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
144 return !!(vres->flags & (1 << flag));
147 static inline void fwp_vres_clearall_flag(fwp_vres_t *vres)
154 static int fwp_vres_ac_open(fwp_ac_t ac_id)
159 if ((ac_id < 0)||(ac_id >= FWP_AC_NUM)) {
164 if ((sockd = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0) {
165 FWP_ERROR("Unable to open socket for AC: %s", strerror(errno));
169 tos = ac_to_tos[ac_id];
171 if (setsockopt(sockd, SOL_IP, IP_TOS, &tos, sizeof(tos)) == -1) {
173 FWP_ERROR("setsockopt(IP_TOS): %s", strerror(errno));
183 static inline int _fwp_vres_send(fwp_vres_t *vres, struct fwp_msgb* msgb)
186 struct msghdr msg = {0};
188 char cmsg_buf[CMSG_SPACE(sizeof(struct in_pktinfo))];
190 iov.iov_base = msgb->data;
191 iov.iov_len = msgb->len;
198 if (vres->params.src.s_addr != 0) {
199 struct cmsghdr *cmsg;
200 struct in_pktinfo *ipi;
202 msg.msg_control = cmsg_buf;
203 msg.msg_controllen = sizeof(cmsg_buf);
205 cmsg = CMSG_FIRSTHDR(&msg);
207 cmsg->cmsg_level = SOL_IP;
208 cmsg->cmsg_type = IP_PKTINFO;
209 cmsg->cmsg_len = CMSG_LEN(sizeof(struct in_pktinfo));
211 ipi = (struct in_pktinfo*)CMSG_DATA(cmsg);
212 ipi->ipi_spec_dst = vres->params.src;
214 ret = sendmsg(vres->ac_sockd, &msg, 0);
218 static inline void fwp_vres_free(fwp_vres_t *vres)
220 fwp_vres_clearall_flag(vres);
223 static inline int fwp_vres_is_valid(fwp_vres_t *vres)
225 int id = vres - fwp_vres_table.entry;
227 if ((id < 0) || (id > fwp_vres_table.max_vres - 1) ||
228 (!fwp_vres_get_flag(vres, FWP_VF_USED)))
234 /*inline int fwp_vres_get(fwp_vres_id_t vres_id, fwp_vres_t **vres )
236 if ((vres_id < 0) || (vres_id > fwp_vres_table.nr_vres - 1))
238 *vres = &fwp_vres_table.entry[vres_id];
243 int fwp_vres_table_init(unsigned int max_vres)
245 unsigned int table_size = max_vres * sizeof(fwp_vres_t);
247 fwp_vres_table.entry = (fwp_vres_t*) malloc(table_size);
248 if (!fwp_vres_table.entry)
249 return -1; /* Errno is set by malloc */
251 memset((void*) fwp_vres_table.entry, 0, table_size);
252 fwp_vres_table.max_vres = max_vres;
256 fwp_vres_id_t fwp_vres_get_id(fwp_vres_d_t vresd)
258 fwp_vres_t *vres = vresd;
260 return (vres - fwp_vres_table.entry);
266 * \return On success returns vres descriptor.
268 fwp_vres_d_t fwp_vres_alloc()
271 unsigned int max_vres;
273 /* find free vres id */
274 pthread_mutex_lock(&fwp_vres_table.lock);
276 max_vres = fwp_vres_table.max_vres;
277 while ((i < max_vres) &&
278 (fwp_vres_get_flag(&fwp_vres_table.entry[i], FWP_VF_USED))) {
283 pthread_mutex_unlock(&fwp_vres_table.lock);
288 FWP_DEBUG("Allocated vres id = %d\n",i);
289 fwp_vres_set_flag(&fwp_vres_table.entry[i], FWP_VF_USED);
290 pthread_mutex_unlock(&fwp_vres_table.lock);
291 return (&fwp_vres_table.entry[i]);
294 inline int _fwp_vres_set_params(fwp_vres_t *vres, fwp_vres_params_t *params)
298 /* copy vres paramters into vres structure */
299 rv = fwp_vres_set_ac(vres->ac_sockd, params->ac_id);
302 memcpy(&vres->params, params, sizeof(struct fwp_vres_params));
303 fwp_vres_set_flag(vres, FWP_VF_CHANGED);
311 * \param[in] vresdp Vres descriptor
312 * \param[in] params Vres parameters
314 * \return On success returns zero.
315 * On error, negative error code is returned.
318 int fwp_vres_set_params(fwp_vres_d_t vresd, fwp_vres_params_t *params)
320 fwp_vres_t *vres = vresd;
322 if (!fwp_vres_is_valid(vres)) {
327 return _fwp_vres_set_params(vres, params);
333 * \param[in] params Vres parameters
334 * \param[out] vresdp Pointer to the descriptor of newly created vres
336 * \return On success returns descriptor of vres.
337 * On error, negative error code is returned.
340 int fwp_vres_create(fwp_vres_params_t *params, fwp_vres_d_t *vresdp)
345 vres = fwp_vres_alloc();
350 /* initialize msg queue */
351 fwp_msgq_init(&vres->tx_queue);
353 memcpy(&vres->params, params, sizeof(struct fwp_vres_params));
354 fwp_vres_set_flag(vres, FWP_VF_CHANGED);
355 pthread_attr_init(&vres->tx_thread_attr);
356 if ((rv = pthread_create(&vres->tx_thread, &vres->tx_thread_attr,
357 fwp_vres_tx_thread, (void*) vres)) != 0){
371 * \param[in] vresd Vres descriptor
373 * \return On success returns 0.
374 * On error, negative error code is returned.
377 int fwp_vres_destroy(fwp_vres_d_t vresd)
379 fwp_vres_t *vres = vresd;
381 if (!fwp_vres_is_valid(vres)) {
386 pthread_cancel(vres->tx_thread);
388 FWP_DEBUG("Vres vparam_id=%d destroyed.\n", vres->params.id);
392 static void fwp_vres_cleanup(void *_vres)
394 fwp_vres_t *vres = (fwp_vres_t*)_vres;
396 fwp_msgq_dequeue_all(&vres->tx_queue);
401 fwp_vres_sched_update(fwp_vres_t *vres, struct timespec *period,
402 fwp_budget_t *budget)
404 if (fwp_vres_get_flag(vres, FWP_VF_CHANGED)) {
405 /*period->tv_nsec = vres->params.period % SEC_TO_USEC;
406 period->tv_sec = vres->params.period / SEC_TO_USEC;*/
407 *period = vres->params.period;
408 *budget = vres->params.budget;
409 FWP_DEBUG("Vres tx thread with budget=%ld period_sec=%ld "
410 "period_nsec=%ld.\n",vres->params.budget,
411 period->tv_sec, period->tv_nsec);
412 fwp_vres_clear_flag(vres, FWP_VF_CHANGED);
417 * Thread that does budgeting
420 static void* fwp_vres_tx_thread(void *_vres)
422 struct fwp_vres *vres = (struct fwp_vres*)_vres;
423 struct fwp_msgq *msgq = &vres->tx_queue;
424 struct fwp_msgb *msgb = NULL;
425 unsigned int ac_id = vres->params.ac_id;
426 fwp_budget_t budget = vres->params.budget;
427 fwp_budget_t curr_budget;
429 struct timespec start, period, interval, now;
431 fwp_set_rt_prio(90 - ac_id);
432 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
433 pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, NULL);
434 pthread_cleanup_push(fwp_vres_cleanup, (void*)vres);
437 fwp_vres_sched_update(vres, &period, &budget);
438 curr_budget = budget;
439 clock_gettime(CLOCK_MONOTONIC, &start);
442 msgb = fwp_msgq_dequeue(msgq);
443 if (msgb->len > budget) {
444 FWP_ERROR("Message too large: %zd -> skipping\n",
448 if (curr_budget < msgb->len) {
449 /* needs to replenish */
450 clock_gettime(CLOCK_MONOTONIC, &now);
451 fwp_timespec_sub(&interval, &now, &start);
452 ul_logtrash("start=%ld.%09ld, now=%ld.%09ld diff=%ld.%09ld\n", (long)start.tv_sec, (long)start.tv_nsec, (long)now.tv_sec, (long)now.tv_nsec, (long)interval.tv_sec, (long)interval.tv_nsec);
453 fwp_timespec_sub(&interval, &period, &interval);
454 if (interval.tv_sec > 0 ||
455 (interval.tv_sec == 0 && interval.tv_nsec > 0)) {
456 /* We have to wait to replenish */
457 ul_logtrash("sleeping=%ld.%09ld\n", (long)interval.tv_sec, (long)interval.tv_nsec);
458 nanosleep(&interval, NULL);
459 fwp_timespec_add(&start, &now, &interval);
463 fwp_vres_sched_update(vres, &period, &budget);
464 curr_budget = budget;
467 rc = _fwp_vres_send(vres, msgb);
469 FWP_DEBUG("Message sent through AC%d\n",ac_id);
470 curr_budget -= msgb->len;
472 FWP_ERROR("Message sent error %d\n",rc);
477 /*pthread_testcancel(); */
478 /*pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, NULL);
480 fwp_timespec_add(&end_period, &start_period, &period);
481 clock_gettime(CLOCK_MONOTONIC, ¤t_time);
482 fwp_timespec_sub(&interval, &end_period, ¤t_time);
483 nanosleep(&interval, NULL);
487 /* it should normaly never come here */
488 pthread_cleanup_pop(0);
494 int fwp_vres_send(fwp_vres_d_t vresd, struct fwp_msgb* msgb)
496 fwp_vres_t *vres = vresd;
498 if (fwp_vres_is_valid(vres)) {
499 return fwp_msgq_enqueue(&vres->tx_queue, msgb);
506 /*int fwp_vres_bind(fwp_vres_d_t vresd, fwp_endpoint_t *epoint)*/
507 int fwp_vres_bind(fwp_vres_d_t vresd, int sockd)
509 fwp_vres_t *vres = vresd;
512 pthread_mutex_lock(&fwp_vres_table.lock);
513 if (!fwp_vres_is_valid(vres)) {
519 if (fwp_vres_get_flag(vres, FWP_VF_BOUND)) { /*if already bounded */
525 vres->ac_sockd = sockd;
526 rv = fwp_vres_set_ac(vres->ac_sockd,vres->params.ac_id);
529 fwp_vres_set_flag(vres, FWP_VF_BOUND);
531 pthread_mutex_unlock(&fwp_vres_table.lock);
535 int fwp_vres_unbind(fwp_vres_d_t vresd)
537 fwp_vres_t *vres = vresd;
539 if (!fwp_vres_is_valid(vresd)) {
543 fwp_vres_clear_flag(vres, FWP_VF_BOUND);
544 /* TODO: consider what to do with pending messages */
545 /* fwp_vres_free_msgb(vres->tx_queue); */