[dpdk-dev] [PATCH] doc: add deprecation notice on external memory support

[Jerin Jacob]

-----Original Message-----
> Date: Wed, 1 Aug 2018 13:07:16 +0100
> From: Anatoly Burakov <anatoly.burakov at intel.com>
> To: dev at dpdk.org
> CC: Neil Horman <nhorman at tuxdriver.com>, John McNamara
>  <john.mcnamara at intel.com>, Marko Kovacevic <marko.kovacevic at intel.com>,
>  thomas at monjalon.net, keith.wiles at intel.com
> Subject: [dpdk-dev] [PATCH] doc: add deprecation notice on external memory
>  support
> X-Mailer: git-send-email 1.7.0.7
> 
> External Email
> 
> Due to the upcoming external memory support [1], some API and ABI
> changes will be required. In addition, although the changes called
> out in the deprecation notice are not yet present in form of code
> in the published RFC itself, they are based on consensus on the
> mailing list [2] on how to best implement this feature.
> 
> [1] http://patches.dpdk.org/project/dpdk/list/?series=453&state=*
> [2] https://mails.dpdk.org/archives/dev/2018-July/108002.html
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov at intel.com>


Acked-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 14714fe94..629154711 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -8,6 +8,21 @@ API and ABI deprecation notices are to be posted here.
>  Deprecation Notices
>  -------------------
> 
> +* eal: certain structures will change in EAL on account of upcoming external
> +  memory support. Aside from internal changes leading to an ABI break, the
> +  following externally visible changes will also be implemented:
> +
> +  - ``rte_memseg_list`` will change to include a boolean flag indicating
> +    whether a particular memseg list is externally allocated. This will have
> +    implications for any users of memseg-walk-related functions, as they will
> +    now have to skip externally allocated segments in most cases if the intent
> +    is to only iterate over internal DPDK memory.
> +  - ``socket_id`` parameter across the entire DPDK will gain additional meaning,
> +    as some socket ID's will now be representing externally allocated memory. No
> +    changes will be required for existing code as backwards compatibility will
> +    be kept, and those who do not use this feature will not see these extra
> +    socket ID's.
> +
>  * eal: both declaring and identifying devices will be streamlined in v18.08.
>    New functions will appear to query a specific port from buses, classes of
>    device and device drivers. Device declaration will be made coherent with the
> --
> 2.17.1