X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fefd_lib.rst;h=cb1a1df8696d6d735bdf93a48db675b69f9e8488;hb=c06ddf9698e0c2a9653cfa971f9ddc205065662c;hp=5b8e4e390e078188a1dcf0fc41cee09a7c1a1f55;hpb=0dd62a01874a5ac7becbfe18c0a8d0dc2483ec77;p=dpdk.git diff --git a/doc/guides/prog_guide/efd_lib.rst b/doc/guides/prog_guide/efd_lib.rst index 5b8e4e390e..cb1a1df869 100644 --- a/doc/guides/prog_guide/efd_lib.rst +++ b/doc/guides/prog_guide/efd_lib.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2016-2017 Intel Corporation. All rights reserved. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2016-2017 Intel Corporation. .. _Efd_Library: @@ -270,6 +243,11 @@ failed to find a suitable perfect hash or the group was full). The function will return ``EFD_UPDATE_NO_CHANGE (3)`` if there is no change to the EFD table (i.e, same value already exists). +.. Note:: + + This function is not multi-thread safe and should only be called + from one thread. + EFD Lookup ~~~~~~~~~~ @@ -285,6 +263,11 @@ lookup function. ``rte_efd_lookup_bulk()`` is the bulk lookup function, that looks up num_keys simultaneously stored in the key_list and the corresponding return values will be returned in the value_list. +.. Note:: + + This function is multi-thread safe, but there should not be other threads + writing in the EFD table, unless locks are used. + EFD Delete ~~~~~~~~~~ @@ -295,6 +278,11 @@ use to lookup the existing value, which is ideally the caller's socket id. The previous value associated with this key will be returned in the prev_value argument. +.. Note:: + + This function is not multi-thread safe and should only be called + from one thread. + .. _Efd_internals: Library Internals