summaryrefslogtreecommitdiffstats
path: root/ctrl/libhicnctrl/src/hicn_plugin_api.c
blob: 0b387404b621e9dce2b09c8868dbe083e68f3faf (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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * \file api.c
 * \brief Implementation of hICN control library API
 */

#include <assert.h>  // assert
#include <fcntl.h>   // fcntl
#include <math.h>    // log2
#include <stdbool.h>
#include <stdio.h>       // snprintf
#include <string.h>      // memmove, strcasecmp
#include <sys/socket.h>  // socket
#include <unistd.h>      // close, fcntl
#include <vapi/vapi_safe.h>

#include <hicn/ctrl/api.h>
#include <hicn/ctrl/commands.h>
#include <hicn/util/token.h>
#include <strings.h>
#include <vapi/hicn.api.vapi.h>
#include <vapi/ip.api.vapi.h>
#include <vapi/interface.api.vapi.h>
#include <hicn/util/log.h>
#include <hicn/util/map.h>
#include <hicn/error.h>
#include <vnet/ip/ip6_packet.h>
#include <vnet/ip/ip46_address.h>

#define APP_NAME "hicn_plugin"
#define MAX_OUTSTANDING_REQUESTS 4
#define RESPONSE_QUEUE_SIZE 2

DEFINE_VAPI_MSG_IDS_HICN_API_JSON
DEFINE_VAPI_MSG_IDS_INTERFACE_API_JSON
DEFINE_VAPI_MSG_IDS_IP_API_JSON

typedef struct {
  vapi_ctx_t g_vapi_ctx_instance;
  bool async;
} vapi_skc_ctx_t;

vapi_skc_ctx_t vapi_skc = {
  .g_vapi_ctx_instance = NULL,
  .async = false,
};

/**
 * Messages to the forwarder might be multiplexed thanks to the seqNum fields in
 * the header_control_message structure. The forwarder simply answers back the
 * original sequence number. We maintain a map of such sequence number to
 * outgoing queries so that replied can be demultiplexed and treated
 * appropriately.
 */
/* TYPEDEF_MAP_H(hc_sock_map, int, hc_sock_request_t *); */
/* TYPEDEF_MAP(hc_sock_map, int, hc_sock_request_t *, int_cmp, int_snprintf, */
/*             generic_snprintf); */

struct hc_sock_s {
  vapi_ctx_t g_vapi_ctx_instance;
  char *url;
  int fd;

  size_t roff; /**< Read offset */
  size_t woff; /**< Write offset */
  u32 buffer[RECV_BUFLEN];
  /* Next sequence number to be used for requests */
  int seq;

  bool async;
};


/******************************************************************************
 * Message helper types and aliases
 ******************************************************************************/

#define foreach_hc_command             \
  _(hicn_api_node_params_set)          \
  _(hicn_api_node_params_set_reply)    \
  _(hicn_api_node_params_get_reply)    \
  _(hicn_api_node_stats_get_reply)     \
  _(hicn_api_face_add)                 \
  _(hicn_api_face_add_reply)           \
  _(hicn_api_face_del)                 \
  _(hicn_api_face_del_reply)           \
  _(hicn_api_face_get)                 \
  _(hicn_api_faces_details)            \
  _(hicn_api_face_stats_details)       \
  _(hicn_api_face_get_reply)           \
  _(hicn_api_route_nhops_add)          \
  _(hicn_api_route_nhops_add_reply)    \
  _(hicn_api_route_del)                \
  _(hicn_api_route_del_reply)          \
  _(hicn_api_route_nhop_del)           \
  _(hicn_api_route_nhop_del_reply)     \
  _(hicn_api_route_get)                \
  _(hicn_api_route_get_reply)          \
  _(hicn_api_routes_details)           \
  _(hicn_api_strategies_get_reply)     \
  _(hicn_api_strategy_get)             \
  _(hicn_api_strategy_get_reply)       \
  _(hicn_api_punting_add)              \
  _(hicn_api_punting_add_reply)        \
  _(hicn_api_punting_del)              \
  _(hicn_api_punting_del_reply)

typedef vapi_type_msg_header2_t hc_msg_header_t;

typedef union {
#define _(a) vapi_payload_ ## a a;
  foreach_hc_command
#undef _
} hc_msg_payload_t;

typedef struct __attribute__ ((__packed__)) {
  hc_msg_header_t hdr;
  hc_msg_payload_t payload;
} hc_hicnp_t;

typedef void (* NTOH)(void *msg);

typedef struct __attribute__((__packed__)) {
  hc_data_t *data;
  uint32_t curr_msg;
} callback_ctx_t;

typedef struct __attribute__((__packed__)) {
  hc_hicnp_t * hicnp_msg;
  vapi_cb_t callback;
  callback_ctx_t *callback_ctx;
  NTOH ntoh;
} hc_msg_s;

/******************************************************************************
 * Control Data
 ******************************************************************************/

hc_data_t *hc_data_create(size_t in_element_size, size_t out_element_size, data_callback_t complete_cb) {
  hc_data_t *data = malloc(sizeof(hc_data_t));
  if (!data) goto ERR_MALLOC;

  /* FIXME Could be NULL thanks to realloc provided size is 0 */
  data->in_element_size = in_element_size;
  data->out_element_size = out_element_size;
  data->size = 0;
  data->current = 0;
  data->complete = false;
  data->command_id = 0;  // TODO this could also be a busy mark in the socket
  /* No callback needed in blocking code for instance */
  data->complete_cb = complete_cb;

  return data;

ERR_MALLOC:
  return NULL;
}

void hc_data_free(hc_data_t *data) {
  if (data != NULL) {
    if (data->buffer) free(data->buffer);
    free(data);
  }
}

/******************************************************************************
 * Control socket
 ******************************************************************************/

/**
 * \brief Parse a connection URL into a sockaddr
 * \param [in] url - URL
 * \param [out] sa - Resulting struct sockaddr, expected zero'ed.
 * \return 0 if parsing succeeded, a negative error value otherwise.
 */
int hc_sock_parse_url(const char *url, struct sockaddr *sa) {
  // NOT IMPLEMENTED
  return -1;
}

hc_sock_t *hc_sock_create_url(const char *url) {
  // NOT IMPLEMENTED
  return NULL;
}

hc_sock_t *hc_sock_create(void) {
  hc_sock_t *s = malloc(sizeof(hc_sock_t));

  if (!s) goto ERR_SOCK;

  memset(s, 0, sizeof(hc_sock_t));

  //By default the socket is blocking -- not async
  s->async = 0;

  return s;

ERR_SOCK:
  return NULL;
}

void hc_sock_free(hc_sock_t *s) {
  if (s->url) free(s->url);
  close(s->fd);
  free(s);

  vapi_disconnect_safe();
  vapi_skc.g_vapi_ctx_instance = NULL;
}

int hc_sock_get_next_seq(hc_sock_t *s) {
  return vapi_gen_req_context(s->g_vapi_ctx_instance);
}

int hc_sock_set_nonblocking(hc_sock_t *s) {
  s->async = 1;
  return 0;
}

int hc_sock_get_fd(hc_sock_t *s) { return 1; }

int hc_sock_connect(hc_sock_t *s) {

  vapi_error_e rv = vapi_connect_safe(&s->g_vapi_ctx_instance, s->async);
  if (rv != VAPI_OK)
    goto ERR_CONNECT;

  return 0;

ERR_CONNECT:
  ERROR("[hc_sock_connect] connection failed");
  return -1;
}

int hc_sock_send(hc_sock_t *s, hc_msg_t *msg, size_t msglen, int seq) {
  return -1;
}

int hc_sock_get_available(hc_sock_t *s, u8 **buffer, size_t *size) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_sock_recv(hc_sock_t *s) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_sock_process(hc_sock_t *s, hc_data_t **pdata) {
  //NOT IMPLEMENTED
  return -1;
}

/******************************************************************************
 * Command-specific structures and functions
 ******************************************************************************/


/*----------------------------------------------------------------------------*
 * Listeners
 *----------------------------------------------------------------------------*/

/* LISTENER CREATE */

int _hc_listener_create(hc_sock_t *s, hc_listener_t *listener, bool async) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_listener_create(hc_sock_t *s, hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_listener_create_async(hc_sock_t *s, hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

/* LISTENER GET */
int hc_listener_get(hc_sock_t *s, hc_listener_t *listener,
                    hc_listener_t **listener_found) {
  // NOT IMPLEMENTED
  return -1;
}

/* LISTENER DELETE */

int hc_listener_delete(hc_sock_t *s, hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_listener_delete_async(hc_sock_t *s, hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

vapi_error_e process_ip_info(struct vapi_ctx_s *ctx,
                            void *callback_ctx,
                            vapi_error_e rv,
                            bool is_last,
                            vapi_payload_ip_address_details *reply) {

  if (is_last)
    return 0;
  hc_data_t *data = (hc_data_t *)callback_ctx;

  if (data->size == data->current) {
    data->buffer = realloc(data->buffer, sizeof(hc_listener_t) * data->size * 2);

    if (!data->buffer)
      return VAPI_ENOMEM;

    data->size *=2;
  }

  hc_listener_t * listener = (hc_listener_t *)(data->buffer + data->current * sizeof(hc_listener_t));

  if(reply->prefix.address.af == ADDRESS_IP4) {
    memcpy(listener->local_addr.v4.as_u8, reply->prefix.address.un.ip4, IPV4_ADDR_LEN);
    listener->family = AF_INET;
  }
  else {
    memcpy(listener->local_addr.v6.as_u8, reply->prefix.address.un.ip6, IPV6_ADDR_LEN);
    listener->family = AF_INET6;
  }

  listener->id = reply->sw_if_index;
  data->current++;
  return rv;
}

typedef struct {
  u32 swif;
  char interface_name[INTERFACE_LEN];
} hc_vapi_interface_t;

vapi_error_e listener_list_complete_cb (struct vapi_ctx_s *ctx,
					void *callback_ctx,
					vapi_error_e rv,
					bool is_last,
				        vapi_payload_sw_interface_details *reply) {

  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (is_last)
    return 0;

  hc_data_t *data = (hc_data_t *)callback_ctx;

  if (data->size == data->current) {
    data->buffer = realloc(data->buffer, sizeof(hc_vapi_interface_t) * data->size * 2);

    if (!data->buffer)
      return VAPI_ENOMEM;

    data->size *=2;
  }

  hc_vapi_interface_t *swif = &((hc_vapi_interface_t*)data->buffer)[data->current];

  swif[0].swif = reply->sw_if_index;
  memcpy(swif[0].interface_name, reply->interface_name, INTERFACE_LEN);

  data->current++;

  return rv;
}


/* LISTENER LIST */
int hc_listener_list(hc_sock_t *s, hc_data_t **pdata) {
  int retval = VAPI_OK;
  vapi_lock();
  vapi_msg_sw_interface_dump *hicnp_msg;
  hicnp_msg = vapi_alloc_sw_interface_dump(s->g_vapi_ctx_instance);

  if (!hicnp_msg) {
    retval = VAPI_ENOMEM;
    goto END;
  }

  hicnp_msg->payload.sw_if_index = ~0;
  hicnp_msg->payload.name_filter_valid = 0;

  hc_data_t *data = hc_data_create(0, sizeof(hc_vapi_interface_t),NULL);

  if (!data) {
    retval = -1;
    goto END;
  }

  hc_data_t *data2 = hc_data_create(0, 1,NULL);

  if (!data2) {
    retval = -1;
    goto END;
  }

  data->buffer = malloc(sizeof(hc_vapi_interface_t));
  data->size = 1;

  if (!data->buffer) {
    free (data);
    retval = -1;
    goto FREE_DATA;
  }

  int ret = vapi_sw_interface_dump(s->g_vapi_ctx_instance, hicnp_msg, listener_list_complete_cb, data);

  if (ret != VAPI_OK) {
    free(data->buffer);
    free(data);
    retval = -1;
    goto FREE_DATA_BUFFER;
  }

  data2->buffer = malloc(sizeof(hc_listener_t));
  data2->size = 1;
  data2->out_element_size = 1;

  if (!data2->buffer) {
    free (data2->buffer);
    retval =1 -1;
    goto CLEAN;
  }

  /* Query the forwarder for each interface */
  for(int i = 0; i < data->current; i++) {
    int index = data2->current;
    vapi_msg_ip_address_dump* msg = vapi_alloc_ip_address_dump(s->g_vapi_ctx_instance);
    msg->payload.sw_if_index = ((hc_vapi_interface_t *)data->buffer)[i].swif;
    msg->payload.is_ipv6 = 0;
    retval = vapi_ip_address_dump(s->g_vapi_ctx_instance, msg, process_ip_info, data2);
    vapi_msg_ip_address_dump* msg2 = vapi_alloc_ip_address_dump(s->g_vapi_ctx_instance);

    if (retval) goto CLEAN;

    msg2->payload.sw_if_index = ((hc_vapi_interface_t *)data->buffer)[i].swif;
    msg2->payload.is_ipv6 = 1;
    retval = vapi_ip_address_dump(s->g_vapi_ctx_instance, msg2, process_ip_info, data2);
    for (size_t j = index; j < data2->current; j++) {
      memcpy(((hc_listener_t *)(data2->buffer))[j].interface_name, ((hc_vapi_interface_t*)(data->buffer))[i].interface_name, INTERFACE_LEN);
    }

    if (retval) goto CLEAN;
  }

CLEAN:
FREE_DATA_BUFFER:
  free(data->buffer);
FREE_DATA:
  free(data);

  data2->size = data2->current;
  data2->out_element_size = sizeof(hc_listener_t);
  *pdata = data2;
 END:
  vapi_unlock();
  return retval;
}

int hc_listener_list_async(hc_sock_t *s, hc_data_t **pdata) {
  // NOT IMPLEMENTED
  return -1;
}

/* LISTENER VALIDATE */

int hc_listener_validate(const hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

/* LISTENER CMP */

int hc_listener_cmp(const hc_listener_t *l1, const hc_listener_t *l2) {
  // NOT IMPLEMENTED
  return -1;
}

/* LISTENER PARSE */

int hc_listener_parse(void *in, hc_listener_t *listener) {
  // NOT IMPLEMENTED
  return -1;
}

GENERATE_FIND(listener)

/* LISTENER SNPRINTF */

/* /!\ Please update constants in header file upon changes */
int
hc_listener_snprintf(char * s, size_t size, hc_listener_t * listener)
{
    char local[MAXSZ_URL];
    int rc;
    rc = url_snprintf(local, MAXSZ_URL,
         listener->family, &listener->local_addr, listener->local_port);
    if (rc >= MAXSZ_URL)
        WARN("[hc_listener_snprintf] Unexpected truncation of URL string");
    if (rc < 0)
        return rc;

    return snprintf(s, size, "%s %s", listener->interface_name, local);
}

/*----------------------------------------------------------------------------*
 * CONNECTION
 *----------------------------------------------------------------------------*/

/* CONNECTION CREATE */

int hc_connection_create(hc_sock_t *s, hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_connection_create_async(hc_sock_t *s, hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION GET */

int hc_connection_get(hc_sock_t *s, hc_connection_t *connection,
                      hc_connection_t **connection_found) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION DELETE */

int hc_connection_delete(hc_sock_t *s, hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_connection_delete_async(hc_sock_t *s, hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION LIST */

int hc_connection_list(hc_sock_t *s, hc_data_t **pdata) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_connection_list_async(hc_sock_t *s, hc_data_t **pdata) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION VALIDATE */

int hc_connection_validate(const hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION CMP */

/*
 * hICN light uses ports even for hICN connections, but their value is ignored.
 * As connections are specific to hicn-light, we can safely use IP and ports for
 * comparison independently of the face type.
 */
int hc_connection_cmp(const hc_connection_t *c1, const hc_connection_t *c2) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION PARSE */

int hc_connection_parse(void *in, hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

GENERATE_FIND(connection)

/* CONNECTION SNPRINTF */

/* /!\ Please update constants in header file upon changes */
int hc_connection_snprintf(char *s, size_t size,
                           const hc_connection_t *connection) {
  // NOT IMPLEMENTED
  return -1;
}

/* CONNECTION SET ADMIN STATE */

int hc_connection_set_admin_state(hc_sock_t *s, const char *conn_id_or_name,
                                  face_state_t state) {
  // NOT IMPLEMENTED
  return -1;
}

int hc_connection_set_admin_state_async(hc_sock_t *s,
                                        const char *conn_id_or_name,
                                        face_state_t state) {
  // NOT IMPLEMENTED
  return -1;
}

/*----------------------------------------------------------------------------*
 * Routes
 *----------------------------------------------------------------------------*/

/* ROUTE CREATE */
vapi_error_e parse_route_create( vapi_ctx_t ctx,
				void *callback_ctx,
				vapi_error_e rv,
				bool is_last,
				vapi_payload_hicn_api_route_nhops_add_reply *reply) {
  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (reply->retval != VAPI_OK)
    return reply->retval;

  return reply->retval;
}

int _hc_route_create(hc_sock_t *s, hc_route_t *route, bool async) {
  if (!IS_VALID_FAMILY(route->family)) return -1;

  vapi_lock();
  vapi_msg_hicn_api_route_nhops_add *hicnp_msg;
  hicnp_msg = vapi_alloc_hicn_api_route_nhops_add(s->g_vapi_ctx_instance);

  if (!hicnp_msg) return VAPI_ENOMEM;

  if (route->family == AF_INET) {
    memcpy(&hicnp_msg->payload.prefix.address.un.ip4[0], &route->remote_addr.v4, 4);
  }
  else {
    memcpy(&hicnp_msg->payload.prefix.address.un.ip6[0], &route->remote_addr.v6, 16);
  }
  hicnp_msg->payload.prefix.address.af =
      route->family == AF_INET ? ADDRESS_IP4 : ADDRESS_IP6;
  hicnp_msg->payload.prefix.len = route->len;
  hicnp_msg->payload.face_ids[0] = route->face_id;
  hicnp_msg->payload.n_faces = 1;

  vapi_error_e ret = vapi_hicn_api_route_nhops_add(s->g_vapi_ctx_instance, hicnp_msg, parse_route_create, NULL);
  vapi_unlock();
  return ret;

}

int hc_route_create(hc_sock_t *s, hc_route_t *route) {
  return _hc_route_create(s, route, false);
}

int hc_route_create_async(hc_sock_t *s, hc_route_t *route) {
  return _hc_route_create(s, route, true);
}

/* ROUTE DELETE */
vapi_error_e parse_route_delete( vapi_ctx_t ctx,
				void *callback_ctx,
				vapi_error_e rv,
				bool is_last,
				vapi_payload_hicn_api_route_nhop_del_reply *reply) {
  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (reply->retval != VAPI_OK)
    return reply->retval;

  return reply->retval;
}

int _hc_route_delete(hc_sock_t *s, hc_route_t *route, bool async) {
  if (!IS_VALID_FAMILY(route->family)) return -1;

  vapi_lock();
  vapi_msg_hicn_api_route_nhop_del *hicnp_msg;
  hicnp_msg = vapi_alloc_hicn_api_route_nhop_del(s->g_vapi_ctx_instance);

  if (!hicnp_msg) return VAPI_ENOMEM;

  memcpy(&hicnp_msg->payload.prefix.address.un.ip6[0], &route->remote_addr, 16);
  hicnp_msg->payload.prefix.address.af =
      route->family == AF_INET ? ADDRESS_IP4 : ADDRESS_IP6;
  hicnp_msg->payload.prefix.len = route->len;
  hicnp_msg->payload.faceid = route->face_id;

  int retval = vapi_hicn_api_route_nhop_del(s->g_vapi_ctx_instance, hicnp_msg, parse_route_delete, NULL);
  vapi_unlock();
  return retval;
}

int hc_route_delete(hc_sock_t *s, hc_route_t *route) {
  return _hc_route_delete(s, route, false);
}

int hc_route_delete_async(hc_sock_t *s, hc_route_t *route) {
  return _hc_route_delete(s, route, true);
}

/* ROUTE LIST */
vapi_error_e parse_route_list( vapi_ctx_t ctx,
			      void *callback_ctx,
			      vapi_error_e rv,
			      bool is_last,
			      vapi_payload_hicn_api_routes_details *reply) {

  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (reply->retval != VAPI_OK)
    return reply->retval;

  hc_data_t *data = (hc_data_t *)callback_ctx;

  int empty_spots = data->size - data->current;
  if (empty_spots < reply->nfaces) {
    int new_size = data->size + (reply->nfaces - empty_spots);
    data->buffer = realloc(data->buffer, sizeof(hc_route_t) * (new_size));
    if (!data->buffer)
      return VAPI_ENOMEM;

    data->size =new_size;
  }

  for (int i = 0; i < reply->nfaces; i++) {
    hc_route_t * route = &((hc_route_t*)(data->buffer))[data->current];
    route->face_id = reply->faceids[i];
    route->cost = 1;
    route->len = reply->prefix.len;
    if (reply->prefix.address.af == ADDRESS_IP6)
      {
        memcpy(route->remote_addr.v6.as_u8, reply->prefix.address.un.ip6, 16);
      }
      else
      {
        memcpy(route->remote_addr.v4.as_u8, reply->prefix.address.un.ip4, 4);
      }
    route->family = reply->prefix.address.af == ADDRESS_IP6? AF_INET6 : AF_INET;
    data->current++;
  }

  return reply->retval;
}

int _hc_route_list(hc_sock_t *s, hc_data_t **pdata, bool async) {
  vapi_lock();
  vapi_msg_hicn_api_routes_dump *hicnp_msg;
  hicnp_msg = vapi_alloc_hicn_api_routes_dump(s->g_vapi_ctx_instance);

  hc_data_t *data = hc_data_create(0, sizeof(hc_route_t),NULL);
  int ret = VAPI_OK;

  if (!data){
    ret = -1;
    goto err;
  }

  data->buffer = malloc(sizeof(hc_route_t));
  data->size = 1;

  if (!data->buffer) {
    ret = -1;
    goto err_free;
  }

  ret = vapi_hicn_api_routes_dump(s->g_vapi_ctx_instance, hicnp_msg, parse_route_list, data);

  if (ret != VAPI_OK)
    goto err_free;

  *pdata = data;

  vapi_unlock();
  return ret;

 err_free:
  free(data);
 err:
  vapi_unlock();
  return ret;
}

int hc_route_list(hc_sock_t *s, hc_data_t **pdata) {
  return _hc_route_list(s, pdata, false);
}

int hc_route_list_async(hc_sock_t *s) {
  return _hc_route_list(s, NULL, true);
}

/* ROUTE SNPRINTF */

/* /!\ Please update constants in header file upon changes */
int hc_route_snprintf(char *s, size_t size, hc_route_t *route) {
  /* interface cost prefix length */

  char prefix[MAXSZ_IP_ADDRESS];
  int rc;

  rc = ip_address_snprintf(prefix, MAXSZ_IP_ADDRESS, &route->remote_addr,
                           route->family);
  if (rc < 0) return rc;

  return snprintf(s, size, "%*d %*d %s %*d", MAXSZ_FACE_ID, route->face_id,
                  MAXSZ_COST, route->cost, prefix, MAXSZ_LEN, route->len);
}

/*----------------------------------------------------------------------------*
 * Face
 *
 * Face support is not directly available in hicn-light, but we can offer such
 * an interface through a combination of listeners and connections. The code
 * starts with some conversion functions between faces/listeners/connections.
 *
 * We also need to make sure that there always exist a (single) listener when a
 * connection is created, and in the hICN face case, that there is a single
 * connection attached to this listener.
 *
 *----------------------------------------------------------------------------*/

/* FACE -> LISTENER */

int hc_face_to_listener(const hc_face_t *face, hc_listener_t *listener) {
  const face_t *f = &face->face;

  switch (f->type) {
    case FACE_TYPE_HICN_LISTENER:
      break;
    case FACE_TYPE_TCP_LISTENER:
      break;
    case FACE_TYPE_UDP_LISTENER:
      break;
    default:
      return -1;
  }
  return -1; /* XXX Not implemented */
}

/* LISTENER -> FACE */

int hc_listener_to_face(const hc_listener_t *listener, hc_face_t *face) {
  return -1; /* XXX Not implemented */
}

/* FACE -> CONNECTION */

int hc_face_to_connection(const hc_face_t *face, hc_connection_t *connection,
                          bool generate_name) {
  return 0;
}

/* CONNECTION -> FACE */

int hc_connection_to_face(const hc_connection_t *connection, hc_face_t *face) {
  return 0;
}

/* CONNECTION -> LISTENER */

int hc_connection_to_local_listener(const hc_connection_t *connection,
                                    hc_listener_t *listener) {
  return 0;
}

/* FACE CREATE */
vapi_error_e parse_face_create( vapi_ctx_t ctx,
			       void *callback_ctx,
			       vapi_error_e rv,
			       bool is_last,
			       vapi_payload_hicn_api_face_add_reply *reply) {

  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (reply->retval != VAPI_OK)
    return reply->retval;

  hc_data_t *data = (hc_data_t *)callback_ctx;

  hc_face_t *output = (hc_face_t *)data->buffer;

  output->id = reply->faceid;
  return reply->retval;
}

int hc_face_create(hc_sock_t *s, hc_face_t *face) {

  vapi_lock();
  vapi_msg_hicn_api_face_add *hicnp_msg;
  hicnp_msg = vapi_alloc_hicn_api_face_add(s->g_vapi_ctx_instance);

  int retval = VAPI_OK;
  if (!hicnp_msg) {
    retval = VAPI_ENOMEM;
    goto END;
  }

  switch(face->face.type) {
    case FACE_TYPE_HICN:
    {
      u8 check = ip46_address_is_ip4((ip46_address_t *)&(face->face.local_addr)) == ip46_address_is_ip4((ip46_address_t *)&(face->face.remote_addr));
      if (!check) {
	  retval = -1;
	  goto END;
	}

      hicnp_msg->payload.type = IP_FACE;
      if (ip46_address_is_ip4((ip46_address_t *)&(face->face.local_addr)))
      {
        memcpy(hicnp_msg->payload.face.ip.local_addr.un.ip4, face->face.local_addr.v4.as_u8, 4);
        memcpy(hicnp_msg->payload.face.ip.remote_addr.un.ip4, face->face.remote_addr.v4.as_u8, 4);
        hicnp_msg->payload.face.ip.local_addr.af = ADDRESS_IP4;
        hicnp_msg->payload.face.ip.remote_addr.af = ADDRESS_IP4;
      }
      else
      {
        memcpy(hicnp_msg->payload.face.ip.local_addr.un.ip6, face->face.local_addr.v6.as_u8, 16);
        memcpy(hicnp_msg->payload.face.ip.remote_addr.un.ip6, face->face.remote_addr.v6.as_u8, 16);
        hicnp_msg->payload.face.ip.local_addr.af = ADDRESS_IP6;
        hicnp_msg->payload.face.ip.remote_addr.af = ADDRESS_IP6;
      }
      hicnp_msg->payload.face.ip.swif = face->face.netdevice.index;
      memcpy(hicnp_msg->payload.face.ip.if_name, face->face.netdevice.name, IFNAMSIZ);
      break;
    }
  case FACE_TYPE_UDP:
    {
      u8 check = ip46_address_is_ip4((ip46_address_t *)&(face->face.local_addr)) == ip46_address_is_ip4((ip46_address_t *)&(face->face.remote_addr));
      if (!check) {
	  retval = -1;
	  goto END;
	}

      hicnp_msg->payload.type = UDP_FACE;
      if (ip46_address_is_ip4((ip46_address_t *)&(face->face.local_addr)))
      {
        memcpy(hicnp_msg->payload.face.udp.local_addr.un.ip4, face->face.local_addr.v4.as_u8, 4);
        memcpy(hicnp_msg->payload.face.udp.remote_addr.un.ip4, face->face.remote_addr.v4.as_u8, 4);
        hicnp_msg->payload.face.udp.local_addr.af = ADDRESS_IP4;
        hicnp_msg->payload.face.udp.remote_addr.af = ADDRESS_IP4;
      }
      else
      {
        memcpy(hicnp_msg->payload.face.udp.local_addr.un.ip6, face->face.local_addr.v6.as_u8, 16);
        memcpy(hicnp_msg->payload.face.udp.remote_addr.un.ip6, face->face.remote_addr.v6.as_u8, 16);
        hicnp_msg->payload.face.udp.local_addr.af = ADDRESS_IP6;
        hicnp_msg->payload.face.udp.remote_addr.af = ADDRESS_IP6;
      }
      hicnp_msg->payload.face.udp.lport = face->face.local_port;
      hicnp_msg->payload.face.udp.rport = face->face.remote_port;
      hicnp_msg->payload.face.udp.swif = face->face.netdevice.index;
      memcpy(hicnp_msg->payload.face.udp.if_name, face->face.netdevice.name, IFNAMSIZ);
      break;
    }
    default:
      {
	retval = -1;
	goto END;
      }
  }

  hc_data_t *data = hc_data_create(0, sizeof(hc_face_t),NULL);

  if (!data) {
    retval = -1;
    goto END;
  }

  data->buffer = malloc(sizeof(hc_face_t));
  data->out_element_size = sizeof(hc_face_t);

  if (!data->buffer) {
    free (data);
    retval = -1;
    goto END;
  }

  retval = vapi_hicn_api_face_add(s->g_vapi_ctx_instance, hicnp_msg, parse_face_create, data);

  if (retval != VAPI_OK)
    goto END;

  face->id = ((hc_face_t *)data->buffer)->id;

 END:
  vapi_unlock();
  return retval;
}

vapi_error_e parse_face_delete( vapi_ctx_t ctx,
			       void *callback_ctx,
			       vapi_error_e rv,
			       bool is_last,
			       vapi_payload_hicn_api_face_del_reply *reply) {

  if (reply == NULL || rv != VAPI_OK)
    return rv;

  return reply->retval;
}

int hc_face_delete(hc_sock_t *s, hc_face_t *face) {

  vapi_msg_hicn_api_face_del *hicnp_msg;
  vapi_lock();
  hicnp_msg = vapi_alloc_hicn_api_face_del(s->g_vapi_ctx_instance);

  if (!hicnp_msg) return VAPI_ENOMEM;

  hicnp_msg->payload.faceid = face->id;

  int retval = vapi_hicn_api_face_del(s->g_vapi_ctx_instance, hicnp_msg, parse_face_delete, NULL);
  vapi_unlock();
  return retval;
}

/* FACE LIST */

vapi_error_e parse_face_list( vapi_ctx_t ctx,
			       void *callback_ctx,
			       vapi_error_e rv,
			       bool is_last,
			       vapi_payload_hicn_api_faces_details *reply) {

  if (reply == NULL || rv != VAPI_OK)
    return rv;

  if (reply->retval != VAPI_OK)
    return reply->retval;

  hc_data_t *data = (hc_data_t *)callback_ctx;

  if (data->size == data->current) {
    int new_size = data->size *2;
    data->buffer = realloc(data->buffer, sizeof(hc_face_t) * (new_size));
    if (!data->buffer)
      return VAPI_ENOMEM;

    data->size =new_size;
  }

  int retval = VAPI_OK;

  hc_face_t * face = &((hc_face_t *)(data->buffer))[data->current];
  switch(reply->type)
    {
    case IP_FACE:
      {
        if (reply->face.ip.local_addr.af == ADDRESS_IP4)
        {
          memcpy(face->face.local_addr.v4.as_u8, reply->face.ip.local_addr.un.ip4, IPV4_ADDR_LEN);
          memcpy(face->face.remote_addr.v4.as_u8, reply->face.ip.remote_addr.un.ip4, IPV4_ADDR_LEN);
        }
        else
        {
          memcpy(face->face.local_addr.v6.as_u8, reply->face.ip.local_addr.un.ip6, IPV6_ADDR_LEN);
          memcpy(face->face.remote_addr.v6.as_u8, reply->face.ip.remote_addr.un.ip6, IPV6_ADDR_LEN);
        }
        face->face.type = FACE_TYPE_HICN;
        face->id = reply->faceid;
        face->face.netdevice.index = reply->face.ip.swif;
        memcpy(face->face.netdevice.name, reply->face.ip.if_name, IFNAMSIZ);
        break;
      }
      case UDP_FACE:
      {
        if (reply->face.ip.local_addr.af == ADDRESS_IP4)
        {
          memcpy(face->face.local_addr.v4.as_u8, reply->face.udp.local_addr.un.ip4, IPV4_ADDR_LEN);
          memcpy(face->face.remote_addr.v4.as_u8, reply->face.udp.remote_addr.un.ip4, IPV4_ADDR_LEN);
        }
        else
        {
          memcpy(face->face.local_addr.v6.as_u8, reply->face.udp.local_addr.un.ip6, IPV6_ADDR_LEN);
          memcpy(face->face.remote_addr.v6.as_u8, reply->face.udp.remote_addr.un.ip6, IPV6_ADDR_LEN);
        }
        face->face.local_port = reply->face.udp.lport;
        face->face.remote_port = reply->face.udp.rport;
        face->face.type = FACE_TYPE_UDP;
        face->id = reply->faceid;
        face->face.netdevice.index = reply->face.udp.swif;
        memcpy(face->face.netdevice.name, reply->face.udp.if_name, IFNAMSIZ);
        break;
      }
      default:
        retval = -1;
    }
    if (!retval)
      data->current++;

    return reply->retval;
}

int hc_face_list(hc_sock_t *s, hc_data_t **pdata) {
  vapi_lock();
  vapi_msg_hicn_api_faces_dump *hicnp_msg;
  hicnp_msg = vapi_alloc_hicn_api_faces_dump(s->g_vapi_ctx_instance);

  int retval = 0;
  if (!hicnp_msg) {
    retval = VAPI_ENOMEM;
    goto END;
  }

  hc_data_t *data = hc_data_create(0, sizeof(hc_face_t),NULL);

  if (!data) {
    retval = -1;
    goto END;
  }

  data->buffer = malloc(sizeof(hc_face_t));
  data->size = 1;

  if (!data->buffer) {
    free (data);
    retval = -1;
    goto err;
  }


  retval = vapi_hicn_api_faces_dump(s->g_vapi_ctx_instance, hicnp_msg, parse_face_list, data);
  *pdata = data;

  if (retval != VAPI_OK)
    goto err;

  data->size = data->current;
  vapi_unlock();
  return retval;

 err:
  free(data);
 END:
  vapi_unlock();
  return retval;
}

int hc_connection_parse_to_face(void *in, hc_face_t *face) { return 0; }

int hc_face_list_async(hc_sock_t *s)
{
  return 0;
}

/* /!\ Please update constants in header file upon changes */
int hc_face_snprintf(char *s, size_t size, hc_face_t *face) { return 0; }

int hc_face_set_admin_state(
    hc_sock_t *s, const char *conn_id_or_name,  // XXX wrong identifier
    face_state_t admin_state) {
  return 0;
}

/*----------------------------------------------------------------------------*
 * Punting
 *----------------------------------------------------------------------------*/

int _hc_punting_create(hc_sock_t *s, hc_punting_t *punting, bool async) {
  return 0;
}

int hc_punting_create(hc_sock_t *s, hc_punting_t *punting) {
  return _hc_punting_create(s, punting, false);
}

int hc_punting_create_async(hc_sock_t *s, hc_punting_t *punting) {
  return _hc_punting_create(s, punting, true);
}

int hc_punting_get(hc_sock_t *s, hc_punting_t *punting,
                   hc_punting_t **punting_found) {
  ERROR("hc_punting_get not (yet) implemented.");
  return -1;
}

int hc_punting_delete(hc_sock_t *s, hc_punting_t *punting) {
  ERROR("hc_punting_delete not (yet) implemented.");
  return -1;
}

int hc_punting_list(hc_sock_t *s, hc_data_t **pdata) {
  ERROR("hc_punting_list not (yet) implemented.");
  return -1;
}

int hc_punting_validate(const hc_punting_t *punting) {
  if (!IS_VALID_FAMILY(punting->family)) return -1;

  /*
   * We might use the zero value to add punting on all faces but this is not
   * (yet) implemented
   */
  if (punting->face_id == 0) {
    ERROR("Punting on all faces is not (yet) implemented.");
    return -1;
  }

  return 0;
}

int hc_punting_cmp(const hc_punting_t *p1, const hc_punting_t *p2) {
  return ((p1->face_id == p2->face_id) && (p1->family == p2->family) &&
          (ip_address_cmp(&p1->prefix, &p2->prefix, p1->family) == 0) &&
          (p1->prefix_len == p2->prefix_len))
             ? 0
             : -1;
}

int hc_punting_parse(void *in, hc_punting_t *punting) {
  ERROR("hc_punting_parse not (yet) implemented.");
  return -1;
}

int hc_punting_snprintf(char *s, size_t size, hc_punting_t *punting) {
  ERROR("hc_punting_snprintf not (yet) implemented.");
  return -1;
}

/*----------------------------------------------------------------------------*
 * Cache
 *----------------------------------------------------------------------------*/

int _hc_cache_set_store(hc_sock_t *s, int enabled, bool async) {
  return 0;
}

int hc_cache_set_store(hc_sock_t *s, int enabled) {
  return _hc_cache_set_store(s, enabled, false);
}

int hc_cache_set_store_async(hc_sock_t *s, int enabled) {
  return _hc_cache_set_store(s, enabled, true);
}

int _hc_cache_set_serve(hc_sock_t *s, int enabled, bool async) {
  return 0;
}

int hc_cache_set_serve(hc_sock_t *s, int enabled) {
  return _hc_cache_set_serve(s, enabled, false);
}

int hc_cache_set_serve_async(hc_sock_t *s, int enabled) {
  return _hc_cache_set_serve(s, enabled, true);
}

/*----------------------------------------------------------------------------*
 * Strategy
 *----------------------------------------------------------------------------*/

// per prefix
int hc_strategy_set(hc_sock_t *s /* XXX */) { return 0; }

#define ARRAY_SIZE(array) (sizeof(array) / sizeof(*array))

int hc_strategy_list(hc_sock_t *s, hc_data_t **data) {
  return 0;
}

/* /!\ Please update constants in header file upon changes */
int hc_strategy_snprintf(char *s, size_t size, hc_strategy_t *strategy) {
  return snprintf(s, size, "%s", strategy->name);
}

/*----------------------------------------------------------------------------*
 * WLDR
 *----------------------------------------------------------------------------*/

// per connection
int hc_wldr_set(hc_sock_t *s /* XXX */) { return 0; }

/*----------------------------------------------------------------------------*
 * MAP-Me
 *----------------------------------------------------------------------------*/

int hc_mapme_set(hc_sock_t *s, int enabled) { return 0; }

int hc_mapme_set_discovery(hc_sock_t *s, int enabled) { return 0; }

int hc_mapme_set_timescale(hc_sock_t *s, double timescale) { return 0; }

int hc_mapme_set_retx(hc_sock_t *s, double timescale) { return 0; }

/* Useless function defined to prevent undefined reference */
hc_connection_type_t
connection_type_from_str(const char * str)
{
    if (strcasecmp(str, "TCP") == 0)
        return CONNECTION_TYPE_TCP;
    else if (strcasecmp(str, "UDP") == 0)
        return CONNECTION_TYPE_UDP;
    else if (strcasecmp(str, "HICN") == 0)
        return CONNECTION_TYPE_HICN;
    else
	return CONNECTION_TYPE_UNDEFINED;
}

/*********************** Missing Symbol in vpp libraries *************************/
u8 *
format_vl_api_address_union (u8 * s, va_list * args)
{
  return NULL;
}