summaryrefslogtreecommitdiff
path: root/common/src/nx_ipv6_prefix_list_delete_entry.c
blob: 0b266a978ddbbfa284b09a81637db1776563ce8d (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/***************************************************************************
 * 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
 **************************************************************************/

#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
/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Internet Protocol version 6 Prefix Table (IPv6 prefix table)        */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/



/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_ipv6_prefix_list_delete_entry                   PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function deletes an entry from the prefix list.                */
/*                                                                        */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP control block   */
/*    entry                                 Entry to be deleted           */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    CHECK_IPV6_ADDRESS_SAME               Compare two IPv6 addresses    */
/*    SET_SOLICITED_NODE_MULTICAST_ADDRESS  Get the solicited-node        */
/*                                            multicast address           */
/*    _nx_ipv6_multicast_leave              Leave an IPv6 mulcast group   */
/*    [ipv6_address_change_notify]          User callback function        */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _nx_ipv6_prefix_list_delete           Delete a prefix entry.        */
/*    _nx_ipv6_prefix_router_timer_tick     Router list timeout           */
/*                                                                        */
/*  NOTE                                                                  */
/*                                                                        */
/*    This function cannot be called from ISR.                            */
/*                                                                        */
/**************************************************************************/
VOID _nx_ipv6_prefix_list_delete_entry(NX_IP *ip_ptr, NX_IPV6_PREFIX_ENTRY *entry)
{

UINT              i;
ULONG             address_prefix[4];
NXD_IPV6_ADDRESS *interface_ipv6_address_prev, *interface_ipv6_address;
ULONG             multicast_address[4];
#ifdef NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY
UINT              ipv6_addr_index;
#endif /* NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY */

    /* Invalidate the interface IP address if we obtained the
       interface IP address based on the prefix information. */

    /* Search through each physical interface for a match. */
    for (i = 0; i < NX_MAX_PHYSICAL_INTERFACES; i++)
    {

        /* Get a pointer to the first address in the interface list. */
        interface_ipv6_address = ip_ptr -> nx_ip_interface[i].nxd_interface_ipv6_address_list_head;
        interface_ipv6_address_prev = NX_NULL;

        /* Search the address list for a match. */
        while (interface_ipv6_address)
        {

            /* Is this interface address valid? */
            if (interface_ipv6_address -> nxd_ipv6_address_state != NX_IPV6_ADDR_STATE_UNKNOWN &&
                interface_ipv6_address -> nxd_ipv6_address_ConfigurationMethod == NX_IPV6_ADDRESS_BASED_ON_INTERFACE)
            {

                /* Yes.  Extract the prefix to match on. The prefix length is 64 bits. */
                address_prefix[0] = interface_ipv6_address -> nxd_ipv6_address[0];
                address_prefix[1] = interface_ipv6_address -> nxd_ipv6_address[1];
                address_prefix[2] = 0;
                address_prefix[3] = 0;

                /* Do we have a match?  */
                if (CHECK_IPV6_ADDRESSES_SAME(address_prefix, entry -> nx_ipv6_prefix_entry_network_address))
                {

                    /* Yes, invalidate this address.  */
                    interface_ipv6_address -> nxd_ipv6_address_valid = NX_FALSE;
                    interface_ipv6_address -> nxd_ipv6_address_state = NX_IPV6_ADDR_STATE_UNKNOWN;

                    interface_ipv6_address -> nxd_ipv6_address_ConfigurationMethod = NX_IPV6_ADDRESS_NOT_CONFIGURED;

#ifndef NX_DISABLE_IPV6_DAD
                    interface_ipv6_address -> nxd_ipv6_address_DupAddrDetectTransmit = 0;
#endif /* NX_DISABLE_IPV6_DAD */

                    /* Update the list. */
                    if (interface_ipv6_address_prev == NX_NULL)
                    {
                        ip_ptr -> nx_ip_interface[i].nxd_interface_ipv6_address_list_head = interface_ipv6_address -> nxd_ipv6_address_next;
                    }
                    else
                    {
                        interface_ipv6_address_prev -> nxd_ipv6_address_next = interface_ipv6_address -> nxd_ipv6_address_next;
                    }

                    /* Delete the associated multicast address. */
                    SET_SOLICITED_NODE_MULTICAST_ADDRESS(multicast_address, interface_ipv6_address -> nxd_ipv6_address);

                    _nx_ipv6_multicast_leave(ip_ptr, &multicast_address[0], interface_ipv6_address -> nxd_ipv6_address_attached);

#ifdef NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY
                    /* If the address change notify callback is set, invoke the callback function. */
                    if (ip_ptr -> nx_ipv6_address_change_notify)
                    {
                        ipv6_addr_index = (ULONG)interface_ipv6_address -> nxd_ipv6_address_index;
                        ip_ptr -> nx_ipv6_address_change_notify(ip_ptr, NX_IPV6_ADDRESS_LIFETIME_EXPIRED, i, ipv6_addr_index,
                                                                &interface_ipv6_address -> nxd_ipv6_address[0]);
                    }
#endif /* NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY */

                    /* Clear the address at last. */
                    SET_UNSPECIFIED_ADDRESS(interface_ipv6_address -> nxd_ipv6_address);

                    /* Address for this interface is found. Just break. */
                    break;
                }
            }

            /* Set the previous address. */
            interface_ipv6_address_prev = interface_ipv6_address;

            /* Get the next address. */
            interface_ipv6_address = interface_ipv6_address -> nxd_ipv6_address_next;
        } /* while (interface_ipv6_address) */
    } /* for(i = 0; i < NX_MAX_PHYSICAL_INTERFACES; i++) */

    /* Unlink the previous node, if it exists. */
    if (entry -> nx_ipv6_prefix_entry_prev == NX_NULL)
    {
        ip_ptr -> nx_ipv6_prefix_list_ptr = entry -> nx_ipv6_prefix_entry_next;
    }
    else
    {
        entry -> nx_ipv6_prefix_entry_prev -> nx_ipv6_prefix_entry_next = entry -> nx_ipv6_prefix_entry_next;
    }

    /* Unlink the next node if it exists. */
    if (entry -> nx_ipv6_prefix_entry_next)
    {
        entry -> nx_ipv6_prefix_entry_next -> nx_ipv6_prefix_entry_prev = entry -> nx_ipv6_prefix_entry_prev;
    }

    /* Clean up this entry. */
    entry -> nx_ipv6_prefix_entry_next = NX_NULL;
    entry -> nx_ipv6_prefix_entry_prev = NX_NULL;

    /* Put entry onto the free list.*/
    if (ip_ptr -> nx_ipv6_prefix_entry_free_list == NX_NULL)
    {
        /* Free list is empty.  Set entry to be the first on the list. */
        ip_ptr -> nx_ipv6_prefix_entry_free_list = entry;
    }
    else
    {

        /* Free list is not empty.  Insert the entry to the head of the list. */
        ip_ptr -> nx_ipv6_prefix_entry_free_list -> nx_ipv6_prefix_entry_prev = entry;
        entry -> nx_ipv6_prefix_entry_next = ip_ptr -> nx_ipv6_prefix_entry_free_list;
        ip_ptr -> nx_ipv6_prefix_entry_free_list = entry;
    }

    /* All done. Return. */
    return;
}


#endif /* FEATURE_NX_IPV6 */