lib/lq_etx_fpm/src/lq_etx_fpm.h

   1 /*
   2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
   3  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * * Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  * * Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  * * Neither the name of olsr.org, olsrd nor the names of its
  17  *   contributors may be used to endorse or promote products derived
  18  *   from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Visit http://www.olsr.org for more information.
  34  *
  35  * If you find this software useful feel free to make a donation
  36  * to the project. For more information see the website or contact
  37  * the copyright holders.
  38  *
  39  */
  40
  41 #ifndef LQ_ETX_FPM_
  42 #define LQ_ETX_FPM_
  43
  44 #include "olsr_types.h"
  45 #include "fpm.h"
  46 #include "lq_plugin.h"
  47
  48 #define LQ_PLUGIN_LC_MULTIPLIER 1024
  49 #define LQ_PLUGIN_RELEVANT_COSTCHANGE 16
  50
  51 #define LQ_ETX_FPM_HANDLER_NAME "ETX metric with FPM"
  52 struct lq_etx_fpm {
  53         fpm lq, nlq;
  54 };
  55
  56 void set_lq_etx_fpm_alpha(fpm alpha);
  57 int init_lq_etx_fpm(void);
  58
  59 olsr_linkcost lq_etx_fpm_calc_cost(const void *lq);
  60
  61 olsr_bool lq_etx_fpm_olsr_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
  62
  63 olsr_linkcost lq_etx_fpm_packet_loss_worker(void *lq, olsr_bool lost);
  64 void lq_etx_fpm_olsr_memorize_foreign_hello_lq(void *local, void *foreign);
  65
  66 int lq_etx_fpm_olsr_serialize_hello_lq_pair(unsigned char *buff, void *lq);
  67 void lq_etx_fpm_olsr_deserialize_hello_lq_pair(const olsr_u8_t **curr, void *lq);
  68 int lq_etx_fpm_olsr_serialize_tc_lq_pair(unsigned char *buff, void *lq);
  69 void lq_etx_fpm_olsr_deserialize_tc_lq_pair(const olsr_u8_t **curr, void *lq);
  70
  71 void lq_etx_fpm_olsr_copy_link_lq_into_tc(void *target, void *source);
  72 void lq_etx_fpm_olsr_clear_lq(void *target);
  73
  74 const char *lq_etx_fpm_olsr_print_lq(void *ptr, struct lqtextbuffer *buffer);
  75 const char *lq_etx_fpm_olsr_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer);
  76
  77 #endif /*LQ_ETX_FPM_*/