summaryrefslogtreecommitdiff
path: root/common/src/nxd_ipv6_find_default_router_from_address.c
blob: 8f85a53140258527a8b909b5671a62709b8db568 (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Internet Protocol version 6 Default Router Table (IPv6 router)      */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_ipv6.h"
#include "nx_nd_cache.h"


#ifdef FEATURE_NX_IPV6
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxd_ipv6_find_default_router_from_address          PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function finds the specific IPv6 default router.               */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP instance pointer           */
/*    router_address                        The specific gateway address  */
/*                                            to search for.              */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    default router entry                  Pointer to the default router */
/*                                            entry.                      */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain IP protection mutex    */
/*    tx_mutex_put                          Release IP protection mutex   */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _nxd_icmpv6_process_na                                              */
/*                                                                        */
/*  NOTE                                                                  */
/*                                                                        */
/*    This function acquires the nx_ipv6_protection mutex.                */
/*    Make sure the mutex is not locked before entering this function.    */
/*                                                                        */
/*    This function cannot be called from ISR.                            */
/*                                                                        */
/**************************************************************************/
NX_IPV6_DEFAULT_ROUTER_ENTRY *_nxd_ipv6_find_default_router_from_address(NX_IP *ip_ptr, ULONG *router_address)
{

INT                           i;
NX_IPV6_DEFAULT_ROUTER_ENTRY *rt_entry;


    /* Get exclusive access to the IP task lock. */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    /* Start the search at the top of the list...*/
    i = 0;

    /* And go through the entire table or until a match is found. */
    while (i < NX_IPV6_DEFAULT_ROUTER_TABLE_SIZE)
    {

        /* Local pointer to table entry. */
        rt_entry = &ip_ptr -> nx_ipv6_default_router_table[i];

        /* Does this slot contain a valid router? */
        if (rt_entry -> nx_ipv6_default_router_entry_flag)
        {

            /* Yes, check if it matches the specified router address. */
            if (CHECK_IPV6_ADDRESSES_SAME(router_address, rt_entry -> nx_ipv6_default_router_entry_router_address))
            {


                /* Yes it does, we can release the IP protection. */
                tx_mutex_put(&(ip_ptr -> nx_ip_protection));

                /* Return the pointer to this router entry. */
                return(rt_entry);
            }
        }

        i++;
    }

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

    /* Return a null pointer indicating no matching router found. */
    return(NX_NULL);
}

#endif /* FEATURE_NX_IPV6 */