src/examples/srv6-sample-localsid/srv6_localsid_sample.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  *------------------------------------------------------------------
  17  * srv6_localsid_sample.c - Simple SRv6 LocalSID
  18  *------------------------------------------------------------------
  19  */
  20
  21 #include <vnet/vnet.h>
  22 #include <vnet/plugin/plugin.h>
  23 #include <srv6-localsid/srv6_localsid_sample.h>
  24
  25 #include <vlibapi/api.h>
  26 #include <vlibmemory/api.h>
  27
  28 unsigned char srv6_localsid_name[32] = "Sample-SRv6-LocalSID-plugin";
  29 unsigned char keyword_str[32] = "new_srv6_localsid";
  30 unsigned char def_str[64] = "This is a definition of a sample new_srv6_localsid";
  31 unsigned char params_str[32] = "<fib_table>";
  32
  33 /*****************************************/
  34 /* SRv6 LocalSID instantiation and removal functions */
  35 static int
  36 srv6_localsid_creation_fn (ip6_sr_localsid_t *localsid)
  37 {
  38   /*
  39    * Do you want to do anything fancy upon localsid instantiation?
  40    * You can do it here
  41    * (If return != 0 the localsid creation will be cancelled.)
  42    */
  43   /* As an example Im going to do a +1 to the fib table inserted by the user */
  44   srv6_localsid_sample_per_sid_memory_t *ls_mem = localsid->plugin_mem;
  45   ls_mem->fib_table += 1;
  46   return 0;
  47 }
  48
  49 static int
  50 srv6_localsid_removal_fn (ip6_sr_localsid_t *localsid)
  51 {
  52   /* Do you want to do anything fancy upon localsid removal?
  53    * You can do it here
  54    * (If return != 0 the localsid removal will be cancelled.)
  55    */
  56   /*
  57    * BTW if you stored something in localsid->plugin_mem you should clean it now
  58    */
  59
  60   //In this example we are only cleaning the memory allocated per localsid
  61   clib_mem_free(localsid->plugin_mem);
  62   return 0;
  63 }
  64
  65 /**********************************/
  66 /* SRv6 LocalSID format functions */
  67 /*
  68  * Prints nicely the parameters of a localsid
  69  * Example: print "Table 5"
  70  */
  71 u8 *
  72 format_srv6_localsid_sample (u8 * s, va_list * args)
  73 {
  74   srv6_localsid_sample_per_sid_memory_t *ls_mem = va_arg (*args, void *);
  75   return (format (s, "Table: %u", ls_mem->fib_table));
  76 }
  77
  78 /*
  79  * Process the parameters of a localsid
  80  * Example: process from:
  81  * sr localsid address cafe::1 behavior new_srv6_localsid 5
  82  * everything from behavior on... so in this case 'new_srv6_localsid 5'
  83  * Notice that it MUST match the keyword_str and params_str defined above.
  84  */
  85 uword
  86 unformat_srv6_localsid_sample (unformat_input_t * input, va_list * args)
  87 {
  88   void **plugin_mem = va_arg (*args, void **);
  89   srv6_localsid_sample_per_sid_memory_t *ls_mem;
  90   u32 table_id;
  91   if (unformat (input, "new_srv6_localsid %u", &table_id))
  92     {
  93       /* Allocate a portion of memory */
  94       ls_mem = clib_mem_alloc_aligned_at_offset (
  95         sizeof(srv6_localsid_sample_per_sid_memory_t), 0, 0, 1);
  96
  97       /* Set to zero the memory */
  98       memset (ls_mem, 0, sizeof(srv6_localsid_sample_per_sid_memory_t));
  99
 100       /* Our brand-new car is ready */
 101       ls_mem->fib_table = table_id;
 102
 103       /* Dont forget to add it to the localsid */
 104       *plugin_mem = ls_mem;
 105       return 1;
 106     }
 107   return 0;
 108 }
 109
 110 /*************************/
 111 /* SRv6 LocalSID FIB DPO */
 112 static u8 *
 113 format_srv6_localsid_sample_dpo (u8 * s, va_list * args)
 114 {
 115   index_t index = va_arg (*args, index_t);
 116   CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
 117
 118   return (format (s, "SR: localsid_sample_index:[%u]", index));
 119 }
 120
 121 void
 122 srv6_localsid_sample_dpo_lock (dpo_id_t * dpo)
 123 {
 124 }
 125
 126 void
 127 srv6_localsid_sample_dpo_unlock (dpo_id_t * dpo)
 128 {
 129 }
 130
 131 const static dpo_vft_t srv6_localsid_sample_vft = {
 132   .dv_lock = srv6_localsid_sample_dpo_lock,
 133   .dv_unlock = srv6_localsid_sample_dpo_unlock,
 134   .dv_format = format_srv6_localsid_sample_dpo,
 135 };
 136
 137 const static char *const srv6_localsid_sample_ip6_nodes[] = {
 138   "srv6-localsid-sample",
 139   NULL,
 140 };
 141
 142 const static char *const *const srv6_localsid_sample_nodes[DPO_PROTO_NUM] = {
 143   [DPO_PROTO_IP6] = srv6_localsid_sample_ip6_nodes,
 144 };
 145
 146 /**********************/
 147 static clib_error_t * srv6_localsid_sample_init (vlib_main_t * vm)
 148 {
 149   srv6_localsid_sample_main_t * sm = &srv6_localsid_sample_main;
 150   int rv = 0;
 151   /* Create DPO */
 152   sm->srv6_localsid_sample_dpo_type = dpo_register_new_type (
 153     &srv6_localsid_sample_vft, srv6_localsid_sample_nodes);
 154
 155   /* Register SRv6 LocalSID */
 156   rv = sr_localsid_register_function (vm,
 157                                   srv6_localsid_name,
 158                                   keyword_str,
 159                                   def_str,
 160                                   params_str,
 161                                   &sm->srv6_localsid_sample_dpo_type,
 162                                   format_srv6_localsid_sample,
 163                                   unformat_srv6_localsid_sample,
 164                                   srv6_localsid_creation_fn,
 165                                   srv6_localsid_removal_fn);
 166   if (rv < 0)
 167     clib_error_return (0, "SRv6 LocalSID function could not be registered.");
 168   else
 169     sm->srv6_localsid_behavior_id = rv;
 170
 171   return 0;
 172 }
 173
 174 VLIB_INIT_FUNCTION (srv6_localsid_sample_init);
 175
 176 VLIB_PLUGIN_REGISTER () = {
 177   .version = "1.0",
 178 };