aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/java/Readme.txt
blob: 689b9b37a46029c8019f8df386de0150e714a773 (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

= JVpp

JVpp is JNI based Java API for VPP.

== Features
It is:

* Asynchronous
* Fully generated
* Lightweight

== Architecture

=== Plugin support

  /-------------\        /--------------\          /---------------\
  | JvppPlugin1 +<-------+ JVppRegistry +--------->+ VppConnection |
  \-------------/  inits \--+-----------/   uses   \---------------/
                            |
  /-------------\           |
  | JvppPlugin2 +<----------+ inits
  \-------------/           |
                            |
  ...                       |
                            |
  /----------\              |
  | JVppCore +<-------------+
  \----------/


VppRegistry opens connection to vpp (VppConnection) and manages jvpp plugins.
Each plugin needs to be registered in the VppRegistry. Registration involves
plugin initialization (providing JNI implementation with JVppCallback reference,
vpp client identifier and vpp shared memory queue address).

API user sends message by calling a method of appropriate plugin interface.
The call is delegated to JNI implementation provided by the particular plugin.
When JNI code receives reply, it invokes callback method of JVppCallback
that corresponds to the received message reply.

=== JVppCore as an example of JVpp plugin architecture

 JVpp Java

  /--------------\             /----------\          /------------\    /------\
  | JVppRegistry |             | JVppCore |          |  Callbacks |    | DTOs |
  \----+---------/             \----+-----/          \------+-----/    \------/
       ^                            ^                       ^
       | implements                 | implements            | implements
  /----+--------------\         /---+----------\      /-----+---------\
  | JVppRegistryImpl* +-------->+ JVppCoreImpl |      |  JVppCallback |
  \-------+-----------/  inits  \---+----------/      \-------+-------/
          |                          |                       ^
          |                          | uses                  | calls back
          |                          |                       |
----------|--------------------------|-----------------------|---------------------
          |                          |                       |
 C JNI    |                          +-------------------+   |       /-----------------\
          v                                              |   |   +-->+ jvpp_core_gen.h |
  /--------+--------\                                    |   |   |   \-----------------/
  | jpp_registry.c* +---+   /--------+----+----\         |   |   |
  \-----------------/   |   | << shared lib >> |        /-+--+---+------\
                        + ->+   jvpp_common*   <--------+  jvpp_core.c* |
                      uses  \------------------/  uses  \---------------/


* Components marked with an asterisk contain manually crafted code, which in addition
to generated classes form jvpp. Exception applies to Callbacks and DTOs, since there are
manually crafted marker interfaces in callback and dto package (dto/JVppRequest, dto/JVppReply,
dto/JVppDump, dto/JVppReplyDump, callback/JVppCallback)

Note: jvpp_core.c calls back the JVppCallback instance with every response. An instance of the
JVppCallback is provided to jvpp_core.c by JVppRegistryImpl on JVppCoreImpl initialization.

Part of the JVpp is also Future facade. It is asynchronous API returning Future objects
on top of low level JVpp. It wraps dump reply messages in one DTO using control_ping message
(provided by JVppRegistry).


Future facade

        /----------------\          /---------------\
        | FutureJVppCore |      +-->+ JVppRegistry* |
        \-----+----------/      |   \---------------/
              ^                 |
              | implements      | uses
              |                 |
     /--------+-------------\   |    /------------------------------\
     | FutureJVppCoreFacade +---+--->+ FutureJVppCoreFacadeCallback |
     \---------+------------/  uses  \-------+----------------------/
               |                             |
---------------|-----------------------------|-------------------------------
               | uses                        | implements
JVpp Java      |                             |
               |                             |
 /----------\  |                             |
 | JVppCore +<-+                             |
 \----+-----/                                |
      ^                                      |
      | implements                           v
 /----+---------\                   /--------+---------------\
 | JVppCoreImpl |                   | JVppCoreGlobalCallback |
 \--------------/                   \------------------------/



Another useful utility of the JVpp is Callback facade. It is asynchronous API
capable of calling specific callback instance (provided when performing a call)
per call.


Callback facade

        /------------------\          /---------------\
        | CallbackJVppCore |      +-->+ JVppRegistry* |
        \-----+------------/      |   \---------------/
              ^                   |
              | implements        | uses
              |                   |
     /--------+---------------\   |    /--------------------------\
     | CallbackJVppCoreFacade +---+--->+ CallbackJVppCoreCallback |
     \---------+--------------/  uses  \-----+--------------------/
               |                             |
---------------|-----------------------------|-------------------------------
               | uses                        | implements
JVpp Java      |                             |
               |                             |
 /----------\  |                             |
 | JVppCore +<-+                             |
 \----+-----/                                |
      ^                                      |
      | implements                           v
 /----+---------\                   /----------+-------------\
 | JVppCoreImpl |                   | JVppCoreGlobalCallback |
 \--------------/                   \------------------------/


== Package structure

* *io.fd.vpp.jvpp* - top level package for generated JVpp interface+ implementation and hand-crafted
VppConnection interface + implementation - packaged as jvpp-registry-version.jar

* *io.fd.vpp.jvpp.[plugin]* - top level package for generated JVpp interface + implementation
+ plugin's API tests - packaged as jvpp-[plugin]-version.jar

** *dto* - package for DTOs generated from VPP API structures + base/marker hand-crafted interfaces
(in case of jvpp-registry)
** *callback* - package for low-level JVpp callbacks and a global callback interface implementing each of
the low-level JVppcallbacks
** *future* - package for future based facade on top of JVpp and callbacks
** *callfacade* - package for callback based facade on top of JVpp and callbacks. Allowing
users to provide callback per request
** *test* - package for JVpp standalone tests. Can also serve as samples for JVpp.

C code is structured into modules:

* *jvpp_common* - shared library that provides jvpp_main_t reference used by jvpp_registry and plugins.

* *jvpp_registry* - native library used by JVppRegistryImpl, responsible for:

** VPP connection open/close
** Rx thread to java thread attach
** control ping message handling

* *jvpp_core* - native library used by jvpp core plugin:
** *jvpp_core.c* - contains hand crafted code for core plugin initialization
** *jvpp_core_gen.h* - contains generated JNI compatible handlers for all requests and replies defined in vpe.api

== Code generators
All of the required code except the base/marker interfaces is generated using
simple python2 code generators. The generators use __defs_vpp_papi.py__ input
file produced by __vppapigen__ from vpe.api file.

=== JNI compatible C code
Produces __jvpp_[plugin]_gen.h__ file containing JNI compatible handlers for each VPP
request and reply.

[NOTE]
====
Source: jvpp_c_gen.py
====

=== Request/Reply DTOs
For all the structures in __defs_vpp_papi.py__ a POJO DTO is produced. Logically,
there are 4 types of DTOs:

* Request - requests that can be sent to VPP and only a single response is expected
* DumpRequest - requests that can be sent to VPP and a stream of responses is expected
* Reply - reply to a simple request or a single response from dump triggered response stream
* ReplyDump - collection of replies from a single dump request
* Notifications/Events - Not implemented yet

[NOTE]
====
Source: dto_gen.py
====

=== JVpp
Produces __JVpp.java__ and __JVppImpl.java__. This is the layer right above JNI compatible C
code.

[NOTE]
====
Source: jvpp_impl_gen.py
====

=== Callbacks
Produces callback interface for each VPP reply + a global callback interface called
__JVpp[plugin]GlobalCallback.java__ aggregating all of the callback interfaces. The JNI
compatible C code expects only a single instance of this global callback and calls
it with every reply.

[NOTE]
====
Source: callback_gen.py
====

=== Future facade
Produces an asynchronous facade on top of JVpp and callbacks, which returns a Future that provides
matching reply once VPP invocation finishes. Sources produced:
__FutureJVpp[plugin].java, FutureJVpp[plugin]Facade.java and FutureJVpp[plugin]Callback.java__

[NOTE]
====
Source: jvpp_future_facade_gen.py
====

=== Callback facade
Similar to future facade, only this facade takes callback objects as part of the invocation
and the callback is called with result once VPP invocation finishes. Sources produced:
__CallbackJVpp[plugin].java, CallbackJVpp[plugin]Facade.java and CallbackJVpp[plugin]Callback.java__

[NOTE]
====
Source: jvpp_callback_facade_gen.py
====
ass="p">].mac @property def local_mac(self): """MAC-address of the VPP interface.""" return str(self._local_mac) @property def local_addr(self): return self._local_addr @property def remote_addr(self): return self._remote_addr @property def local_ip4(self): """Local IPv4 address on VPP interface (string).""" return self._local_ip4 @local_ip4.setter def local_ip4(self, value): self._local_ip4 = value @property def local_ip4_prefix_len(self): """Local IPv4 prefix length """ return self._local_ip4_len @local_ip4_prefix_len.setter def local_ip4_prefix_len(self, value): self._local_ip4_len = value @property def local_ip4_prefix(self): """Local IPv4 prefix """ return ("%s/%d" % (self._local_ip4, self._local_ip4_len)) @property def remote_ip4(self): """IPv4 address of remote peer "connected" to this interface.""" return self._remote_hosts[0].ip4 @property def local_ip6(self): """Local IPv6 address on VPP interface (string).""" return self._local_ip6 @local_ip6.setter def local_ip6(self, value): self._local_ip6 = value @property def local_ip6_prefix_len(self): """Local IPv6 prefix length """ return self._local_ip6_len @local_ip6_prefix_len.setter def local_ip6_prefix_len(self, value): self._local_ip6_len = value @property def local_ip6_prefix(self): """Local IPv4 prefix """ return ("%s/%d" % (self._local_ip6, self._local_ip6_len)) @property def remote_ip6(self): """IPv6 address of remote peer "connected" to this interface.""" return self._remote_hosts[0].ip6 @property def local_ip6_ll(self): """Local IPv6 link-local address on VPP interface (string).""" return self._local_ip6_ll @property def remote_ip6_ll(self): """Link-local IPv6 address of remote peer "connected" to this interface.""" return self._remote_ip6_ll @property def name(self): """Name of the interface.""" return self._name @property def dump(self): """RAW result of sw_interface_dump for this interface.""" return self._dump @property def test(self): """Test case creating this interface.""" return self._test @property def remote_hosts(self): """Remote hosts list""" return self._remote_hosts @remote_hosts.setter def remote_hosts(self, value): """ :param list value: List of remote hosts. """ self._remote_hosts = value self._hosts_by_mac = {} self._hosts_by_ip4 = {} self._hosts_by_ip6 = {} for host in self._remote_hosts: self._hosts_by_mac[host.mac] = host self._hosts_by_ip4[host.ip4] = host self._hosts_by_ip6[host.ip6] = host def host_by_mac(self, mac): """ :param mac: MAC address to find host by. :return: Host object assigned to interface. """ return self._hosts_by_mac[mac] def host_by_ip4(self, ip): """ :param ip: IPv4 address to find host by. :return: Host object assigned to interface. """ return self._hosts_by_ip4[ip] def host_by_ip6(self, ip): """ :param ip: IPv6 address to find host by. :return: Host object assigned to interface. """ return self._hosts_by_ip6[ip] def generate_remote_hosts(self, count=1): """Generate and add remote hosts for the interface. :param int count: Number of generated remote hosts. """ self._remote_hosts = [] self._hosts_by_mac = {} self._hosts_by_ip4 = {} self._hosts_by_ip6 = {} for i in range( 2, count + 2): # 0: network address, 1: local vpp address mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i) ip4 = "172.16.%u.%u" % (self.sw_if_index, i) ip6 = "fd01:%x::%x" % (self.sw_if_index, i) ip6_ll = mk_ll_addr(mac) host = Host(mac, ip4, ip6, ip6_ll) self._remote_hosts.append(host) self._hosts_by_mac[mac] = host self._hosts_by_ip4[ip4] = host self._hosts_by_ip6[ip6] = host @abc.abstractmethod def __init__(self, test): self._test = test self._remote_hosts = [] self._hosts_by_mac = {} self._hosts_by_ip4 = {} self._hosts_by_ip6 = {} def set_mac(self, mac): self._local_mac = str(mac) self._local_ip6_ll = mk_ll_addr(self._local_mac) self.test.vapi.sw_interface_set_mac_address( self.sw_if_index, mac.packed) return self def set_sw_if_index(self, sw_if_index): if sw_if_index > 255: raise RuntimeError("Don't support sw_if_index values " "greater than 255.") self._sw_if_index = sw_if_index self.generate_remote_hosts() self._local_ip4 = "172.16.%u.1" % self.sw_if_index self._local_ip4_len = 24 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index self.has_ip4_config = False self.ip4_table_id = 0 self._local_ip6 = "fd01:%x::1" % self.sw_if_index self._local_ip6_len = 64 self.has_ip6_config = False self.ip6_table_id = 0 self._local_addr = {socket.AF_INET: self.local_ip4, socket.AF_INET6: self.local_ip6} self._remote_addr = {socket.AF_INET: self.remote_ip4, socket.AF_INET6: self.remote_ip6} r = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index) for intf in r: if intf.sw_if_index == self.sw_if_index: self._name = intf.interface_name self._local_mac = intf.l2_address self._dump = intf break else: raise Exception( "Could not find interface with sw_if_index %d " "in interface dump %s" % (self.sw_if_index, moves.reprlib.repr(r))) self._local_ip6_ll = mk_ll_addr(self.local_mac) self._remote_ip6_ll = mk_ll_addr(self.remote_mac) def config_ip4(self): """Configure IPv4 address on the VPP interface.""" self.test.vapi.sw_interface_add_del_address( sw_if_index=self.sw_if_index, prefix=self.local_ip4_prefix) self.has_ip4_config = True return self def unconfig_ip4(self): """Remove IPv4 address on the VPP interface.""" try: if self.has_ip4_config: self.test.vapi.sw_interface_add_del_address( sw_if_index=self.sw_if_index, prefix=self.local_ip4_prefix, is_add=0) except AttributeError: self.has_ip4_config = False self.has_ip4_config = False return self def configure_ipv4_neighbors(self): """For every remote host assign neighbor's MAC to IPv4 addresses. :param vrf_id: The FIB table / VRF ID. (Default value = 0) """ for host in self._remote_hosts: self.test.vapi.ip_neighbor_add_del(self.sw_if_index, host.mac, host.ip4) return self def config_ip6(self): """Configure IPv6 address on the VPP interface.""" self.test.vapi.sw_interface_add_del_address( sw_if_index=self.sw_if_index, prefix=self.local_ip6_prefix) self.has_ip6_config = True return self def unconfig_ip6(self): """Remove IPv6 address on the VPP interface.""" try: if self.has_ip6_config: self.test.vapi.sw_interface_add_del_address( sw_if_index=self.sw_if_index, prefix=self.local_ip6_prefix, is_add=0) except AttributeError: self.has_ip6_config = False self.has_ip6_config = False return self def configure_ipv6_neighbors(self): """For every remote host assign neighbor's MAC to IPv6 addresses. :param vrf_id: The FIB table / VRF ID. (Default value = 0) """ for host in self._remote_hosts: self.test.vapi.ip_neighbor_add_del(self.sw_if_index, host.mac, host.ip6) def unconfig(self): """Unconfigure IPv6 and IPv4 address on the VPP interface.""" self.unconfig_ip4() self.unconfig_ip6() return self def set_table_ip4(self, table_id): """Set the interface in a IPv4 Table. .. note:: Must be called before configuring IP4 addresses. """ self.ip4_table_id = table_id self.test.vapi.sw_interface_set_table( self.sw_if_index, 0, self.ip4_table_id) return self def set_table_ip6(self, table_id): """Set the interface in a IPv6 Table. .. note:: Must be called before configuring IP6 addresses. """ self.ip6_table_id = table_id self.test.vapi.sw_interface_set_table( self.sw_if_index, 1, self.ip6_table_id) return self def disable_ipv6_ra(self): """Configure IPv6 RA suppress on the VPP interface.""" self.test.vapi.sw_interface_ip6nd_ra_config( sw_if_index=self.sw_if_index, suppress=1) return self def ip6_ra_config(self, no=0, suppress=0, send_unicast=0): """Configure IPv6 RA suppress on the VPP interface.""" self.test.vapi.sw_interface_ip6nd_ra_config( sw_if_index=self.sw_if_index, is_no=no, suppress=suppress, send_unicast=send_unicast) return self def ip6_ra_prefix(self, prefix, is_no=0, off_link=0, no_autoconfig=0, use_default=0): """Configure IPv6 RA suppress on the VPP interface. prefix can be a string in the format of '<address>/<length_in_bits>' or ipaddress.ipnetwork object (if strict.)""" self.test.vapi.sw_interface_ip6nd_ra_prefix( sw_if_index=self.sw_if_index, prefix=prefix, use_default=use_default, off_link=off_link, no_autoconfig=no_autoconfig, is_no=is_no) return self def admin_up(self): """Put interface ADMIN-UP.""" self.test.vapi.sw_interface_set_flags( self.sw_if_index, flags=VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_ADMIN_UP) return self def admin_down(self): """Put interface ADMIN-down.""" self.test.vapi.sw_interface_set_flags(self.sw_if_index, flags=0) return self def link_up(self): """Put interface link-state-UP.""" self.test.vapi.cli("test interface link-state %s up" % self.name) def link_down(self): """Put interface link-state-down.""" self.test.vapi.cli("test interface link-state %s down" % self.name) def ip6_enable(self): """IPv6 Enable interface""" self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index, enable=1) return self def ip6_disable(self): """Put interface ADMIN-DOWN.""" self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index, enable=0) return self def add_sub_if(self, sub_if): """Register a sub-interface with this interface. :param sub_if: sub-interface """ if not hasattr(self, 'sub_if'): self.sub_if = sub_if else: if isinstance(self.sub_if, list): self.sub_if.append(sub_if) else: self.sub_if = sub_if return self def enable_mpls(self): """Enable MPLS on the VPP interface.""" self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index) return self def disable_mpls(self): """Enable MPLS on the VPP interface.""" self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index, 0) return self def is_ip4_entry_in_fib_dump(self, dump): for i in dump: n = IPv4Network(text_type("%s/%d" % (self.local_ip4, self.local_ip4_prefix_len))) if i.route.prefix == n and \ i.route.table_id == self.ip4_table_id: return True return False def set_unnumbered(self, ip_sw_if_index): """ Set the interface to unnumbered via ip_sw_if_index """ self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index, self.sw_if_index) return self def unset_unnumbered(self, ip_sw_if_index): """ Unset the interface to unnumbered via ip_sw_if_index """ self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index, self.sw_if_index, is_add=0) return self def set_proxy_arp(self, enable=1): """ Set the interface to enable/disable Proxy ARP """ self.test.vapi.proxy_arp_intfc_enable_disable( self.sw_if_index, enable) return self def query_vpp_config(self): dump = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index) return self.is_interface_config_in_dump(dump) def get_interface_config_from_dump(self, dump): for i in dump: if i.interface_name.rstrip(' \t\r\n\0') == self.name and \ i.sw_if_index == self.sw_if_index: return i else: return None def is_interface_config_in_dump(self, dump): return self.get_interface_config_from_dump(dump) is not None def assert_interface_state(self, admin_up_down, link_up_down, expect_event=False): if expect_event: event = self.test.vapi.wait_for_event(timeout=1, name='sw_interface_event') self.test.assert_equal(event.sw_if_index, self.sw_if_index, "sw_if_index") self.test.assert_equal((event.flags & 1), admin_up_down, "admin state") self.test.assert_equal((event.flags & 2), link_up_down, "link state") dump = self.test.vapi.sw_interface_dump() if_state = self.get_interface_config_from_dump(dump) self.test.assert_equal((if_state.flags & 1), admin_up_down, "admin state") self.test.assert_equal((if_state.flags & 2), link_up_down, "link state") def __str__(self): return self.name def get_rx_stats(self): c = self.test.statistics.get_counter("^/if/rx$") return c[0][self.sw_if_index] def get_tx_stats(self): c = self.test.statistics.get_counter("^/if/tx$") return c[0][self.sw_if_index] def set_l3_mtu(self, mtu): self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [mtu, 0, 0, 0]) return self def set_ip4_mtu(self, mtu): self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, mtu, 0, 0]) return self def set_ip6_mtu(self, mtu): self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, mtu, 0]) return self def set_mpls_mtu(self, mtu): self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, 0, mtu]) return self