fwp/lib/fwp/fwp_vres.c

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   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                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  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.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FWP (Frescor WLAN Protocol)                      */
  26 /*                                                                        */
  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.                                              */
  37 /*                                                                        */
  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"
  47 #include "fwp_vres.h"
  48
  49 #include "fwp_msgq.h"
  50 #include "fwp_endpoint.h"
  51 #include "fwp_debug.h"
  52
  53 #include <string.h>
  54 #include <errno.h>
  55 #include <stdlib.h>
  56
  57 static void* fwp_vres_tx_thread(void *_vres);
  58
  59 typedef enum {
  60         FWP_VF_USED             = 0,
  61         FWP_VF_BOUND            = 1,
  62         FWP_VF_CHANGED          = 2,
  63 } fwp_vres_flag_t;
  64
  65 fwp_vres_params_t fwp_vres_params_default = {
  66         .id = 0,
  67         .ac_id = FWP_AC_VO,
  68         .budget = 100,
  69         .period = {.tv_sec = 2 , .tv_nsec = 111111}
  70 };
  71
  72 /**
  73  * Structure of FWP vres.
  74  * Internal representation of vres
  75  *
  76  */
  77 struct fwp_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 */
  88 };
  89
  90 typedef
  91 struct fwp_vres_table {
  92         unsigned int                    max_vres;
  93         fwp_vres_t                      *entry;
  94         pthread_mutex_t                 lock;
  95 } fwp_vres_table_t;
  96
  97 /* Global variable - vres table */
  98 static fwp_vres_table_t  fwp_vres_table = {
  99         .max_vres = 0,
 100         .entry = NULL,
 101         .lock = PTHREAD_MUTEX_INITIALIZER,
 102 };
 103
 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};
 108
 109 /**
 110  * Set access category (AC) to socket
 111  *
 112  * \param[in] sockd Socket descriptor
 113  * \param[in] ac_id AC identifier
 114  *
 115  * \return On success returns zero.
 116  * On error, negative error code is returned.
 117  *
 118  */
 119 static inline int fwp_vres_set_ac(int sockd, fwp_ac_t ac_id)
 120 {
 121         unsigned int tos;
 122
 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));
 126                 return (-1);
 127         }
 128
 129         return 0;
 130 }
 131
 132 static inline void fwp_vres_set_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
 133 {
 134         vres->flags |= (1 << flag);
 135 }
 136
 137 static inline void fwp_vres_clear_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
 138 {
 139         vres->flags &= ~(1 << flag);
 140 }
 141
 142 static inline int fwp_vres_get_flag(fwp_vres_t *vres, fwp_vres_flag_t flag)
 143 {
 144         return !!(vres->flags & (1 << flag));
 145 }
 146
 147 static inline void fwp_vres_clearall_flag(fwp_vres_t *vres)
 148 {
 149         vres->flags = 0;
 150 }
 151
 152 #if 0
 153 /* Deprecated */
 154 static int fwp_vres_ac_open(fwp_ac_t ac_id)
 155 {
 156         int sockd;
 157         unsigned int tos;
 158
 159         if ((ac_id < 0)||(ac_id >= FWP_AC_NUM)) {
 160                 errno = EINVAL;
 161                 return -1;
 162         }
 163
 164         if ((sockd = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0) {
 165                 FWP_ERROR("Unable to open socket for AC: %s", strerror(errno));
 166                 return (-1);
 167         }
 168
 169         tos = ac_to_tos[ac_id];
 170
 171         if (setsockopt(sockd, SOL_IP, IP_TOS, &tos, sizeof(tos)) == -1) {
 172                 int e = errno;
 173                 FWP_ERROR("setsockopt(IP_TOS): %s", strerror(errno));
 174                 close(sockfd);
 175                 errno = e;
 176                 return -1;
 177         }
 178
 179         return sockd;
 180 }
 181 #endif
 182
 183 static inline int _fwp_vres_send(fwp_vres_t *vres, struct fwp_msgb* msgb)
 184 {
 185         struct iovec  iov;
 186         struct msghdr msg = {0};
 187         ssize_t ret;
 188         char cmsg_buf[CMSG_SPACE(sizeof(struct in_pktinfo))];
 189
 190         iov.iov_base = msgb->data;
 191         iov.iov_len = msgb->len;
 192
 193         msg.msg_iov = &iov;
 194         msg.msg_iovlen = 1;
 195
 196
 197
 198         if (vres->params.src.s_addr != 0) {
 199                 struct cmsghdr *cmsg;
 200                 struct in_pktinfo *ipi;
 201
 202                 msg.msg_control = cmsg_buf;
 203                 msg.msg_controllen = sizeof(cmsg_buf);
 204
 205                 cmsg = CMSG_FIRSTHDR(&msg);
 206
 207                 cmsg->cmsg_level = SOL_IP;
 208                 cmsg->cmsg_type = IP_PKTINFO;
 209                 cmsg->cmsg_len = CMSG_LEN(sizeof(struct in_pktinfo));
 210
 211                 ipi = (struct in_pktinfo*)CMSG_DATA(cmsg);
 212                 ipi->ipi_spec_dst = vres->params.src;
 213         }
 214         ret = sendmsg(vres->ac_sockd, &msg, 0);
 215         return ret;
 216 }
 217
 218 static inline void fwp_vres_free(fwp_vres_t *vres)
 219 {
 220         fwp_vres_clearall_flag(vres);
 221 }
 222
 223 static inline int fwp_vres_is_valid(fwp_vres_t *vres)
 224 {
 225         int id  = vres - fwp_vres_table.entry;
 226
 227         if ((id < 0) || (id > fwp_vres_table.max_vres - 1) ||
 228                 (!fwp_vres_get_flag(vres, FWP_VF_USED)))
 229                 return 0;
 230
 231         return 1;
 232 }
 233
 234 /*inline int fwp_vres_get(fwp_vres_id_t vres_id, fwp_vres_t **vres )
 235 {
 236         if ((vres_id < 0) || (vres_id > fwp_vres_table.nr_vres - 1))
 237                 return -EINVAL;
 238         *vres = &fwp_vres_table.entry[vres_id];
 239         return 0;
 240 }
 241 */
 242
 243 int fwp_vres_table_init(unsigned int max_vres)
 244 {
 245         unsigned int table_size = max_vres * sizeof(fwp_vres_t);
 246
 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 */
 250
 251         memset((void*) fwp_vres_table.entry, 0, table_size);
 252         fwp_vres_table.max_vres = max_vres;
 253         return 0;
 254 }
 255
 256 fwp_vres_id_t fwp_vres_get_id(fwp_vres_d_t vresd)
 257 {
 258         fwp_vres_t *vres = vresd;
 259
 260         return (vres - fwp_vres_table.entry);
 261 }
 262
 263 /**
 264  * Allocate vres
 265  *
 266  * \return On success returns vres descriptor.
 267  */
 268 fwp_vres_d_t fwp_vres_alloc()
 269 {
 270         int i;
 271         unsigned int max_vres;
 272
 273         /* find free vres id */
 274         pthread_mutex_lock(&fwp_vres_table.lock);
 275         i = 0;
 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))) {
 279                 i++;
 280         }
 281
 282         if (i == max_vres) {
 283                 pthread_mutex_unlock(&fwp_vres_table.lock);
 284                 errno = ENOBUFS;
 285                 return NULL;
 286         }
 287
 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]);
 292 }
 293
 294 inline int _fwp_vres_set_params(fwp_vres_t *vres, fwp_vres_params_t *params)
 295 {
 296         int rv;
 297
 298         /* copy vres paramters into vres structure */
 299         rv = fwp_vres_set_ac(vres->ac_sockd, params->ac_id);
 300         if (!rv)
 301                 return rv;
 302         memcpy(&vres->params, params, sizeof(struct fwp_vres_params));
 303         fwp_vres_set_flag(vres, FWP_VF_CHANGED);
 304
 305         return 0;
 306 }
 307
 308 /**
 309  * Set vres params
 310  *
 311  * \param[in] vresdp Vres descriptor
 312  * \param[in] params Vres parameters
 313  *
 314  * \return On success returns zero.
 315  * On error, negative error code is returned.
 316  *
 317  */
 318 int fwp_vres_set_params(fwp_vres_d_t vresd, fwp_vres_params_t *params)
 319 {
 320         fwp_vres_t *vres = vresd;
 321
 322         if (!fwp_vres_is_valid(vres)) {
 323                 errno = EINVAL;
 324                 return -1;
 325         }
 326
 327         return _fwp_vres_set_params(vres, params);
 328 }
 329
 330 /**
 331  * Creates new vres
 332  *
 333  * \param[in] params Vres parameters
 334  * \param[out] vresdp Pointer to the descriptor of newly created vres
 335  *
 336  * \return On success returns descriptor of vres.
 337  * On error, negative error code is returned.
 338  *
 339  */
 340 int fwp_vres_create(fwp_vres_params_t *params, fwp_vres_d_t *vresdp)
 341 {
 342         int rv;
 343         fwp_vres_t *vres;
 344
 345         vres = fwp_vres_alloc();
 346         if (!vres) {
 347                 errno = ENOMEM;
 348                 return -1;
 349         }
 350         /* initialize msg queue */
 351         fwp_msgq_init(&vres->tx_queue);
 352
 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){
 358                 goto err;
 359         }
 360
 361         *vresdp = vres;
 362         return 0;
 363 err:
 364         fwp_vres_free(vres);
 365         return -1;
 366 }
 367
 368 /**
 369  * Destroys vres
 370  *
 371  * \param[in] vresd Vres descriptor
 372  *
 373  * \return On success returns 0.
 374  * On error, negative error code is returned.
 375  *
 376  */
 377 int fwp_vres_destroy(fwp_vres_d_t vresd)
 378 {
 379         fwp_vres_t *vres = vresd;
 380
 381         if (!fwp_vres_is_valid(vres)) {
 382                 errno = EINVAL;
 383                 return -1;
 384         }
 385
 386         pthread_cancel(vres->tx_thread);
 387
 388         FWP_DEBUG("Vres vparam_id=%d destroyed.\n", vres->params.id);
 389         return  0;
 390 }
 391
 392 static void fwp_vres_cleanup(void *_vres)
 393 {
 394         fwp_vres_t *vres = (fwp_vres_t*)_vres;
 395
 396         fwp_msgq_dequeue_all(&vres->tx_queue);
 397         fwp_vres_free(vres);
 398 }
 399
 400 static inline void
 401 fwp_vres_sched_update(fwp_vres_t *vres, struct timespec *period,
 402                         fwp_budget_t  *budget)
 403 {
 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);
 413         }
 414 }
 415
 416 /**
 417  * Thread that does budgeting
 418  *
 419  */
 420 static void* fwp_vres_tx_thread(void *_vres)
 421 {
 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;
 428         int             rc;
 429         struct timespec start, period, interval, now;
 430
 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);
 435
 436         /* just for sure */
 437         fwp_vres_sched_update(vres, &period, &budget);
 438         curr_budget = budget;
 439         clock_gettime(CLOCK_MONOTONIC, &start);
 440
 441         while (1) {
 442                 msgb = fwp_msgq_dequeue(msgq);
 443                 if (msgb->len > budget) {
 444                         FWP_ERROR("Message too large: %zd -> skipping\n",
 445                                   msgb->len);
 446                         goto skip_message;
 447                 }
 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);
 460                         } else {
 461                                 start = now;
 462                         }
 463                         fwp_vres_sched_update(vres, &period, &budget);
 464                         curr_budget = budget;
 465                 }
 466
 467                 rc = _fwp_vres_send(vres, msgb);
 468                 if (!(rc < 0)) {
 469                         FWP_DEBUG("Message sent through AC%d\n",ac_id);
 470                         curr_budget -= msgb->len;
 471                 } else {
 472                         FWP_ERROR("Message sent error %d\n",rc);
 473                 }
 474         skip_message:
 475                 fwp_msgb_free(msgb);
 476
 477                 /*pthread_testcancel(); */
 478                 /*pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, NULL);
 479
 480                 fwp_timespec_add(&end_period, &start_period, &period);
 481                 clock_gettime(CLOCK_MONOTONIC, &current_time);
 482                 fwp_timespec_sub(&interval, &end_period, &current_time);
 483                 nanosleep(&interval, NULL);
 484                 */
 485         }
 486
 487         /* it should normaly never come here */
 488         pthread_cleanup_pop(0);
 489         fwp_vres_free(vres);
 490
 491         return NULL;
 492 }
 493
 494 int fwp_vres_send(fwp_vres_d_t vresd, struct fwp_msgb* msgb)
 495 {
 496         fwp_vres_t *vres = vresd;
 497
 498         if (fwp_vres_is_valid(vres)) {
 499                 return fwp_msgq_enqueue(&vres->tx_queue, msgb);
 500         } else {
 501                 errno = EINVAL;
 502                 return -1;
 503         }
 504 }
 505
 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)
 508 {
 509         fwp_vres_t *vres = vresd;
 510         int rv = 0;
 511
 512         pthread_mutex_lock(&fwp_vres_table.lock);
 513         if (!fwp_vres_is_valid(vres)) {
 514                 errno = EINVAL;
 515                 rv = -1;
 516                 goto err;
 517         }
 518
 519         if (fwp_vres_get_flag(vres, FWP_VF_BOUND)) { /*if already bounded */
 520                 errno = EBUSY;
 521                 rv = -1;
 522                 goto err;
 523         }
 524
 525         vres->ac_sockd = sockd;
 526         rv = fwp_vres_set_ac(vres->ac_sockd,vres->params.ac_id);
 527         /*if (rv)
 528                 goto err;*/
 529         fwp_vres_set_flag(vres, FWP_VF_BOUND);
 530 err:
 531         pthread_mutex_unlock(&fwp_vres_table.lock);
 532         return rv;
 533 }
 534
 535 int fwp_vres_unbind(fwp_vres_d_t vresd)
 536 {
 537         fwp_vres_t *vres = vresd;
 538
 539         if (!fwp_vres_is_valid(vresd)) {
 540                 errno = EINVAL;
 541                 return -1;
 542         }
 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); */
 546         return 0;
 547 }