docs/aboutvpp/releasenotes/v19.08.1.rst

   1 Release notes for VPP 19.08.1
   2 =============================
   3
   4 Exceptionally, this release has an API-changing fix introduced via
   5 https://gerrit.fd.io/r/#/c/vpp/+/21762/ - documented in VPP-1767. Given
   6 the exceptional nature of the change, also including the text here:
   7
   8 Bug: https://gerrit.fd.io/r/c/vpp/+/21492
   9
  10 Variable length strings were committed to VPP in 413f4a5b. The VPP
  11 server side of the API does not use a wire encoder/decoder. It maps a C
  12 struct directly onto on-the-wire API messages. The client side C
  13 language binding is the same, while other language bindings have their
  14 own encoder/decoders.
  15
  16 Multiple strings alone or combined with other variable length types
  17 turned out to be error prone to manually implement on the VPP side, and
  18 not supported by VPP API (VAPI) very well at all.
  19
  20 To avoid having to rewrite VAPI significantly, and to mitigate the risk
  21 and error prone server side support of multiple variable length fields,
  22 this patch extends strings to have a fixed size (on the wire) and a
  23 variable flavour, as well as adding detection in the API compiler to
  24 detect multiple variable length fields in a message (or type).
  25
  26 Given that this change breaks the commitment to binary API
  27 compatibility, normally present in point builds, ALL 19.08 build
  28 artifacts are being deferred.
  29
  30 This means the artifacts for the VPP 19.08.1 will be installed in the
  31 release repository (packagecloud.io/fdio/release), then ALL 19.08 build
  32 artifacts will be moved into the deferred repository
  33 (packagecloud.io/fdio/deferred). The 19.08 artifacts will always be
  34 available for archive purposes in the deferred repository.
  35
  36 During the further testing by Networking-VPP team, they discovered
  37 another issue documented in VPP-1769 - which requires a CRC-affecting
  38 fix in https://gerrit.fd.io/r/#/c/vpp/+/22015/ - so the 19.08.1 will
  39 contain the fixes for both issues.
  40
  41 These two changes have resulted in the following 20 messages changing
  42 their signatures:
  43
  44 =============================== ==================
  45 Message Name                    Result
  46 =============================== ==================
  47 cli_inband                      definition changed
  48 cli_inband_reply                definition changed
  49 connect_sock                    definition changed
  50 http_static_enable              definition changed
  51 log_details                     definition changed
  52 map_add_domain                  definition changed
  53 map_domain_details              definition changed
  54 nat44_add_del_identity_mapping  definition changed
  55 nat44_add_del_lb_static_mapping definition changed
  56 nat44_add_del_static_mapping    definition changed
  57 nat44_identity_mapping_details  definition changed
  58 nat44_lb_static_mapping_details definition changed
  59 nat44_static_mapping_details    definition changed
  60 nat_worker_details              definition changed
  61 punt_reason_details             definition changed
  62 punt_reason_dump                definition changed
  63 show_version_reply              definition changed
  64 sw_interface_details            definition changed
  65 sw_interface_dump               definition changed
  66 sw_interface_tag_add_del        definition changed
  67 =============================== ==================
  68
  69 Please accept our apologies for the inconvenience this caused.
  70
  71 For the full list of fixed issues please refer to:
  72
  73 - fd.io `JIRA <https://jira.fd.io>`__
  74 - git `commit log <https://git.fd.io/vpp/log/?h=stable/1908>`__
  75