summaryrefslogtreecommitdiff
path: root/common/src/nxd_nd_cache_ip_address_find.c
blob: 0b7e95932a7203c6a6acbb68ae8c27ba95b7ebd2 (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
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-present Eclipse ThreadX Contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Neighbor Discovery Cache                                            */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_nd_cache.h"
#ifdef FEATURE_NX_IPV6
#include "nx_ipv6.h"
#endif /* FEATURE_NX_IPV6 */

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxd_nd_cache_entry_ip_address_find                 PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function finds an IPv6 address in the neighbor discovery       */
/*    cache table based on user-speicified MAC address.                   */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP instance        */
/*    ip_address                            Pointer to the IP address     */
/*                                            to search for               */
/*    physical_msw                          Physical address, most        */
/*                                            significant word            */
/*    physical_lsw                          Physical address, least       */
/*                                            significant word            */
/*    interface_index                       Index to the network          */
/*                                            interface through which the */
/*                                            node is reachable.          */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_nd_cache_find_entry_by_mac_addr   Internal find IP address in   */
/*                                          ND cache table mapped to      */
/*                                            input by mac address.       */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT  _nxd_nd_cache_ip_address_find(NX_IP *ip_ptr,
                                    NXD_ADDRESS *ip_address,
                                    ULONG physical_msw,
                                    ULONG physical_lsw,
                                    UINT *interface_index)
{
#ifdef FEATURE_NX_IPV6

ND_CACHE_ENTRY *entry;

    /* Find ND entry according to the given MAC address. */
    /* Obtain the protection. */
    tx_mutex_get(&ip_ptr -> nx_ip_protection, TX_WAIT_FOREVER);

    if (_nx_nd_cache_find_entry_by_mac_addr(ip_ptr, physical_msw, physical_lsw, &entry) != NX_SUCCESS)
    {

        /* Release the protection. */
        tx_mutex_put(&ip_ptr -> nx_ip_protection);

        /* No such MAC address found in cache table. */
        return(NX_ENTRY_NOT_FOUND);
    }

    /* Copy the IP address and version from the cache entry into the address structure. */
    ip_address -> nxd_ip_version = NX_IP_VERSION_V6;

    /*lint -e{644} suppress variable might not be initialized, since "entry" was initialized as long as previous call is NX_SUCCESS. */
    COPY_IPV6_ADDRESS(entry -> nx_nd_cache_dest_ip, ip_address -> nxd_ip_address.v6);

    /* If trace is enabled, insert this event into the trace buffer. */
    NX_TRACE_IN_LINE_INSERT(NX_TRACE_ND_CACHE_IP_ADDRESS_FIND, ip_ptr, ip_address -> nxd_ip_address.v6[3], physical_msw, physical_lsw, NX_TRACE_ARP_EVENTS, 0, 0);

    /* Get the interface_index.  */
    *interface_index = entry -> nx_nd_cache_interface_ptr -> nx_interface_index;

    /* Release the protection. */
    tx_mutex_put(&ip_ptr -> nx_ip_protection);

    /* Successful completion*/
    return(NX_SUCCESS);

#else /* !FEATURE_NX_IPV6 */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(ip_address);
    NX_PARAMETER_NOT_USED(physical_msw);
    NX_PARAMETER_NOT_USED(physical_lsw);
    NX_PARAMETER_NOT_USED(interface_index);

    return(NX_NOT_SUPPORTED);

#endif /* FEATURE_NX_IPV6 */
}