summaryrefslogtreecommitdiff
path: root/common/src/nx_arp_interface_entries_delete.c
blob: b7e4f4a053cafc0d89f1e9c24dba2c7cddda2fe3 (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
/***************************************************************************
 * 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 (IP)                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE

/* Include necessary system files. */

#include "nx_api.h"
#include "nx_arp.h"

#ifndef NX_DISABLE_IPV4
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_arp_interface_entries_delete                    PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function removes ARP entries associated with the interface     */
/*    specified by index from the IP's arp table.                         */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP control block   */
/*    index                                 IP interface index            */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    _nx_arp_dynamic_entry_delete          Delete dynamic ARP entry      */
/*    _nx_arp_static_entry_delete_internal  Internal static ARP entry     */
/*                                            delete function             */
/*    tx_mutex_put                          release protection mutex      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT _nx_arp_interface_entries_delete(NX_IP *ip_ptr, UINT index)
{

NX_ARP       *arp_entry;
NX_ARP       *next_arp_entry;
NX_ARP       *last_arp_entry;
NX_INTERFACE *interface_ptr;

    interface_ptr = &(ip_ptr -> nx_ip_interface[index]);

    /* Obtain protection on this IP instance for access into the ARP dynamic list. */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    /* Begain remove ARP entries from the dynamic list. */

    /* Setup pointers to the starting and ending ARP entries in the dynamic list. */
    arp_entry = ip_ptr -> nx_ip_arp_dynamic_list;

    /* Walk through the dynamic ARP list until there are no more active entries. */
    while ((arp_entry) && (ip_ptr -> nx_ip_arp_dynamic_active_count))
    {

        /* Yes, there is one or more dynamic entries. */
        /* Determine if this ARP entry is for the specified interface. */
        if (arp_entry -> nx_arp_ip_interface == interface_ptr)
        {

            _nx_arp_dynamic_entry_delete(ip_ptr, arp_entry);

            /* Cleanup the nx_arp_ip_interface filed. */
            arp_entry -> nx_arp_ip_interface = NX_NULL;
        }

        /* Determine if we are at the end of the dynamic list. */
        if (arp_entry -> nx_arp_pool_next != ip_ptr -> nx_ip_arp_dynamic_list)
        {
            /* No, simply move to the next dynamic entry. */
            arp_entry = arp_entry -> nx_arp_pool_next;
        }
        else
        {
            /* Yes, we are at the end of the dynamic list, break out of the loop. */
            break;
        }
    }

    /* End remove ARP entries from the dynamic list. */

    /* Begain remove ARP entries from the static list. */

    /* Setup pointers to the starting/ending ARP entry in the static list. */
    next_arp_entry = ip_ptr -> nx_ip_arp_static_list;
    if (next_arp_entry)
    {

        /* Pick up the last ARP entry. */
        last_arp_entry = next_arp_entry -> nx_arp_pool_previous;

        /* Walk through the static ARP list until there are no more active entries. */
        while (next_arp_entry)
        {

            /* Yes, there is one or more static ARP entries. */
            arp_entry = next_arp_entry;

            /* Move to the next pakcet in the queue. */
            next_arp_entry = next_arp_entry -> nx_arp_pool_next;

            if (arp_entry -> nx_arp_ip_interface == interface_ptr)
            {

                /* The static entry was found.  It needs to be unlinked from the active
                   list and the static list and re-linked to the end of the dynamic list.  */
                _nx_arp_static_entry_delete_internal(ip_ptr, arp_entry);
            }

            if (arp_entry == last_arp_entry)
            {
                break;
            }
        }
    }

    /* End remove ARP entries from the static list. */

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

    /* Return successful status to the caller. */
    return(NX_SUCCESS);
}
#endif /* !NX_DISABLE_IPV4  */