aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/session/application_interface.h
blob: 8db318fa41352b77d32c9dbee1d5191f5fdd0784 (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
/*
 * Copyright (c) 2016 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.
 */
#ifndef __included_uri_h__
#define __included_uri_h__

#include <vlib/vlib.h>
#include <vnet/vnet.h>
#include <svm/svm_fifo_segment.h>
#include <vnet/session/session.h>
#include <vnet/session/application.h>
#include <vnet/session/transport.h>

typedef struct _vnet_app_attach_args_t
{
  /** Binary API client index */
  u32 api_client_index;

  /** Application and segment manager options */
  u64 *options;

  /* Namespace id */
  u8 *namespace_id;

  /** Session to application callback functions */
  session_cb_vft_t *session_cb_vft;

  /*
   * Results
   */
  ssvm_private_t *segment;
  u64 app_event_queue_address;
  u32 app_index;
} vnet_app_attach_args_t;

typedef struct _vnet_app_detach_args_t
{
  u32 app_index;
} vnet_app_detach_args_t;

typedef struct _vnet_bind_args_t
{
  union
  {
    char *uri;
    session_endpoint_t sep;
  };

  u32 app_index;

  /*
   * Results
   */
  char *segment_name;
  u32 segment_name_length;
  u64 server_event_queue_address;
  u64 handle;
} vnet_bind_args_t;

typedef struct _vnet_unbind_args_t
{
  union
  {
    char *uri;
    u64 handle;
  };
  u32 app_index;
} vnet_unbind_args_t;

typedef struct _vnet_connect_args
{
  char *uri;
  session_endpoint_t sep;
  u32 app_index;
  u32 api_context;

  /* Used for redirects */
  void *mp;
  u64 session_handle;
} vnet_connect_args_t;

typedef struct _vnet_disconnect_args_t
{
  u64 handle;
  u32 app_index;
} vnet_disconnect_args_t;

/* Application attach options */
typedef enum
{
  APP_OPTIONS_FLAGS,
  APP_OPTIONS_EVT_QUEUE_SIZE,
  APP_OPTIONS_SEGMENT_SIZE,
  APP_OPTIONS_ADD_SEGMENT_SIZE,
  APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
  APP_OPTIONS_RX_FIFO_SIZE,
  APP_OPTIONS_TX_FIFO_SIZE,
  APP_OPTIONS_PREALLOC_FIFO_PAIRS,
  APP_OPTIONS_NAMESPACE,
  APP_OPTIONS_NAMESPACE_SECRET,
  APP_OPTIONS_PROXY_TRANSPORT,
  APP_OPTIONS_ACCEPT_COOKIE,
  APP_OPTIONS_N_OPTIONS
} app_attach_options_index_t;

#define foreach_app_options_flags				\
  _(ACCEPT_REDIRECT, "Use FIFO with redirects")			\
  _(ADD_SEGMENT, "Add segment and signal app if needed")	\
  _(IS_BUILTIN, "Application is builtin")			\
  _(IS_PROXY, "Application is proxying")				\
  _(USE_GLOBAL_SCOPE, "App can use global session scope")	\
  _(USE_LOCAL_SCOPE, "App can use local session scope")

typedef enum _app_options
{
#define _(sym, str) APP_OPTIONS_##sym,
  foreach_app_options_flags
#undef _
} app_options_t;

typedef enum _app_options_flags
{
#define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
  foreach_app_options_flags
#undef _
} app_options_flags_t;

clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
int vnet_application_detach (vnet_app_detach_args_t * a);

int vnet_bind_uri (vnet_bind_args_t *);
int vnet_unbind_uri (vnet_unbind_args_t * a);
clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
int vnet_disconnect_session (vnet_disconnect_args_t * a);

clib_error_t *vnet_bind (vnet_bind_args_t * a);
clib_error_t *vnet_connect (vnet_connect_args_t * a);
clib_error_t *vnet_unbind (vnet_unbind_args_t * a);

int
api_parse_session_handle (u64 handle, u32 * session_index,
			  u32 * thread_index);

#endif /* __included_uri_h__ */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
2 sw_if_index; igmp_config_t *config; if (!unformat_user (input, unformat_line_input, line_input)) { error = clib_error_return (0, "'help clear igmp' or 'clear igmp ?' for help"); return error; } while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "int %U", unformat_vnet_sw_interface, vnm, &sw_if_index)); else { error = clib_error_return (0, "unknown input '%U'", format_unformat_error, line_input); goto done; } } config = igmp_config_lookup (sw_if_index); if (config) igmp_clear_config (config); done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_clear_interface_command, static) = { .path = "clear igmp", .short_help = "clear igmp int <interface>", .function = igmp_clear_interface_command_fn, }; /* *INDENT-ON* */ static clib_error_t * igmp_listen_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; clib_error_t *error = NULL; u8 enable = 1; ip46_address_t saddr, *saddrs = NULL, gaddr; vnet_main_t *vnm = vnet_get_main (); u32 sw_if_index; int rv; if (!unformat_user (input, unformat_line_input, line_input)) { error = clib_error_return (0, "'help igmp listen' or 'igmp listen ?' for help"); return error; } while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "enable")) enable = 1; else if (unformat (line_input, "disable")) enable = 0; else if (unformat (line_input, "int %U", unformat_vnet_sw_interface, vnm, &sw_if_index)); else if (unformat (line_input, "saddr %U", unformat_ip46_address, &saddr)) vec_add1 (saddrs, saddr); else if (unformat (line_input, "gaddr %U", unformat_ip46_address, &gaddr)); else { error = clib_error_return (0, "unknown input '%U'", format_unformat_error, line_input); goto done; } } if ((vnet_sw_interface_get_flags (vnm, sw_if_index) && VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0) { error = clib_error_return (0, "Interface is down"); goto done; } rv = igmp_listen (vm, enable, sw_if_index, saddrs, &gaddr); if (rv == -1) { if (enable) error = clib_error_return (0, "This igmp configuration already exists"); else error = clib_error_return (0, "This igmp configuration does not exist"); } else if (rv == -2) error = clib_error_return (0, "Failed to add configuration, interface is in router mode"); done: unformat_free (line_input); vec_free (saddrs); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_listen_command, static) = { .path = "igmp listen", .short_help = "igmp listen [<enable|disable>] " "int <interface> saddr <ip4-address> gaddr <ip4-address>", .function = igmp_listen_command_fn, }; /* *INDENT-ON* */ static clib_error_t * igmp_enable_cli (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; igmp_mode_t mode = IGMP_MODE_ROUTER; vnet_main_t *vnm = vnet_get_main (); clib_error_t *error = NULL; u32 sw_if_index = ~0; u8 enable = 1; int rv; if (!unformat_user (input, unformat_line_input, line_input)) return error; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "enable")) enable = 1; else if (unformat (line_input, "disable")) enable = 0; if (unformat (line_input, "host")) mode = IGMP_MODE_HOST; else if (unformat (line_input, "router")) mode = IGMP_MODE_ROUTER; else if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index)); else { error = clib_error_return (0, "unknown input '%U'", format_unformat_error, line_input); goto done; } } if (~0 == sw_if_index) { error = clib_error_return (0, "interface must be specified"); goto done; } rv = igmp_enable_disable (sw_if_index, enable, mode); if (0 != rv) error = clib_error_return (0, "result: %d", rv); done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_enable_command, static) = { .path = "igmp", .short_help = "igmp <enable|disable> <host|router> <interface>", .function = igmp_enable_cli, }; /* *INDENT-ON* */ static clib_error_t * igmp_proxy_device_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; vnet_main_t *vnm = vnet_get_main (); clib_error_t *error = NULL; u32 sw_if_index = ~0; u32 vrf_id = ~0; u8 add = 1; int rv; if (!unformat_user (input, unformat_line_input, line_input)) return error; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "add")) add = 1; else if (unformat (line_input, "del")) add = 0; else if (unformat (line_input, "vrf-id %u", &vrf_id)) ; else if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index)); else { error = clib_error_return (0, "unknown input '%U'", format_unformat_error, line_input); goto done; } } if (~0 == sw_if_index) { error = clib_error_return (0, "interface must be specified"); goto done; } if (~0 == vrf_id) { error = clib_error_return (0, "VRF must be specified"); goto done; } rv = igmp_proxy_device_add_del (vrf_id, sw_if_index, add); if (0 != rv) error = clib_error_return (0, "result: %d", rv); done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_proxy_device_add_del_command, static) = { .path = "igmp proxy-dev", .short_help = "igmp proxy-dev <add|del> vrf-id <table-id> <interface>", .function = igmp_proxy_device_add_del_command_fn, }; /* *INDENT-ON* */ static clib_error_t * igmp_proxy_device_add_del_interface_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; vnet_main_t *vnm = vnet_get_main (); clib_error_t *error = NULL; u32 sw_if_index = ~0; u32 vrf_id = ~0; u8 add = 1; int rv; if (!unformat_user (input, unformat_line_input, line_input)) return error; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "add")) add = 1; else if (unformat (line_input, "del")) add = 0; else if (unformat (line_input, "vrf-id %u", &vrf_id)) ; else if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index)); else { error = clib_error_return (0, "unknown input '%U'", format_unformat_error, line_input); goto done; } } if (~0 == sw_if_index) { error = clib_error_return (0, "interface must be specified"); goto done; } if (~0 == vrf_id) { error = clib_error_return (0, "VRF must be specified"); goto done; } rv = igmp_proxy_device_add_del_interface (vrf_id, sw_if_index, add); if (0 != rv) error = clib_error_return (0, "result: %d", rv); done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_proxy_device_add_del_interface_command, static) = { .path = "igmp proxy-dev itf", .short_help = "igmp proxy-dev itf <add|del> vrf-id <table-id> <interface>", .function = igmp_proxy_device_add_del_interface_command_fn, }; /* *INDENT-ON* */ static clib_error_t * igmp_show_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { clib_error_t *error = NULL; igmp_main_t *im = &igmp_main; igmp_config_t *config; /* *INDENT-OFF* */ pool_foreach (config, im->configs, ({ vlib_cli_output (vm, "%U", format_igmp_config, config); })); /* *INDENT-ON* */ return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_show_command, static) = { .path = "show igmp config", .short_help = "show igmp config", .function = igmp_show_command_fn, }; /* *INDENT-ON* */ static clib_error_t * igmp_show_timers_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { #define _(n,f) vlib_cli_output (vm, "%s: %d", #f, igmp_timer_type_get(n)); foreach_igmp_timer_type #undef _ return (NULL); } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (igmp_show_timers_command, static) = { .path = "show igmp timers", .short_help = "show igmp timers", .function = igmp_show_timers_command_fn, }; /* *INDENT-ON* */ static clib_error_t * test_igmp_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { clib_error_t *error = NULL; u32 value; while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) { if (unformat (input, "query %d", &value)) igmp_timer_type_set (IGMP_TIMER_QUERY, value); else if (unformat (input, "src %d", &value)) igmp_timer_type_set (IGMP_TIMER_SRC, value); else if (unformat (input, "leave %d", &value)) igmp_timer_type_set (IGMP_TIMER_LEAVE, value); else error = clib_error_return (0, "query or src timers only"); } return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (test_igmp_command, static) = { .path = "test igmp timers", .short_help = "Change the default values for IGMP timers - only sensible during unit tests", .function = test_igmp_command_fn, }; /* *INDENT-ON* */ clib_error_t * igmp_cli_init (vlib_main_t * vm) { return 0; } VLIB_INIT_FUNCTION (igmp_cli_init); /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */