summaryrefslogtreecommitdiff
path: root/common/src/nx_arp_info_get.c
blob: 470861e7d3cd739f797b56051fa80e9d82599783 (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Address Resolution Protocol (ARP)                                   */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

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


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_arp_info_get                                    PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function obtains ARP information for the specified IP          */
/*    instance.                                                           */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP instance pointer           */
/*    arp_requests_sent                     Destination for number of ARP */
/*                                            requests sent               */
/*    arp_requests_received                 Destination for number of ARP */
/*                                            requests received           */
/*    arp_responses_sent                    Destination for number of ARP */
/*                                            responses sent              */
/*    arp_responses_received                Destination for number of ARP */
/*                                            responses received          */
/*    arp_dynamic_entries                   Destination for number of ARP */
/*                                            dynamic entries             */
/*    arp_static_entries                    Destination for number of ARP */
/*                                            static entries              */
/*    arp_aged_entries                      Destination for number of ARP */
/*                                            aged entries                */
/*    arp_invalid_messages                  Destination for number of ARP */
/*                                            invalid messages            */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    tx_mutex_put                          Release protection mutex      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT  _nx_arp_info_get(NX_IP *ip_ptr, ULONG *arp_requests_sent, ULONG *arp_requests_received,
                       ULONG *arp_responses_sent, ULONG *arp_responses_received,
                       ULONG *arp_dynamic_entries, ULONG *arp_static_entries,
                       ULONG *arp_aged_entries, ULONG *arp_invalid_messages)
{

#ifndef NX_DISABLE_IPV4
    /* If trace is enabled, insert this event into the trace buffer.  */
    NX_TRACE_IN_LINE_INSERT(NX_TRACE_ARP_INFO_GET, ip_ptr, ip_ptr -> nx_ip_arp_requests_sent, ip_ptr -> nx_ip_arp_responses_received, ip_ptr -> nx_ip_arp_requests_received, NX_TRACE_ARP_EVENTS, 0, 0);

    /* Obtain protection on this IP instance.  */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    /* Determine if ARP requests sent is wanted.  */
    if (arp_requests_sent)
    {

        /* Return the number of ARP requests sent by this IP instance.  */
        *arp_requests_sent =  ip_ptr -> nx_ip_arp_requests_sent;
    }

    /* Determine if ARP requests received is wanted.  */
    if (arp_requests_received)
    {

        /* Return the number of ARP requests received by this IP instance.  */
        *arp_requests_received =  ip_ptr -> nx_ip_arp_requests_received;
    }

    /* Determine if ARP responses sent is wanted.  */
    if (arp_responses_sent)
    {

        /* Return the number of ARP responses sent by this IP instance.  */
        *arp_responses_sent =  ip_ptr -> nx_ip_arp_responses_sent;
    }

    /* Determine if ARP responses received is wanted.  */
    if (arp_responses_received)
    {

        /* Return the number of ARP responses received by this IP instance.  */
        *arp_responses_received =  ip_ptr -> nx_ip_arp_responses_received;
    }

    /* Determine if ARP dynamic entries is wanted.  */
    if (arp_dynamic_entries)
    {

        /* Return the number of ARP dynamic entries in this IP instance.  */
        *arp_dynamic_entries =  ip_ptr -> nx_ip_arp_dynamic_active_count;
    }

    /* Determine if ARP static entries is wanted.  */
    if (arp_static_entries)
    {

        /* Return the number of ARP static entries in this IP instance.  */
        *arp_static_entries =  ip_ptr -> nx_ip_arp_static_entries;
    }

    /* Determine if ARP aged entries is wanted.  */
    if (arp_aged_entries)
    {

        /* Return the number of ARP aged entries by this IP instance.  */
        *arp_aged_entries =  ip_ptr -> nx_ip_arp_aged_entries;
    }

    /* Determine if ARP invalid messages is wanted.  */
    if (arp_invalid_messages)
    {

        /* Return the number of ARP invalid messages handled by this IP instance.  */
        *arp_invalid_messages =  ip_ptr -> nx_ip_arp_invalid_messages;
    }

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

    /* Return status to the caller.  */
    return(NX_SUCCESS);
#else /* NX_DISABLE_IPV4  */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(arp_requests_sent);
    NX_PARAMETER_NOT_USED(arp_requests_received);
    NX_PARAMETER_NOT_USED(arp_responses_sent);
    NX_PARAMETER_NOT_USED(arp_responses_received);
    NX_PARAMETER_NOT_USED(arp_dynamic_entries);
    NX_PARAMETER_NOT_USED(arp_static_entries);
    NX_PARAMETER_NOT_USED(arp_aged_entries);
    NX_PARAMETER_NOT_USED(arp_invalid_messages);

    return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4  */
}