summaryrefslogtreecommitdiff
path: root/common/src/nx_icmp_info_get.c
blob: 92f1877d25a955e105fc5c790f7768ee68eb9a5e (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
/***************************************************************************
 * 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 Control Message Protocol (ICMP)                            */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_icmp.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_icmp_info_get                                   PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function retrieves the selected ICMP information for the       */
/*    caller.                                                             */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP instance        */
/*    pings_sent                            Destination for number of     */
/*                                            pings sent                  */
/*    ping_timeouts                         Destination for number of     */
/*                                            ping timeouts               */
/*    ping_threads_suspended                Destination for number of     */
/*                                            threads suspended on pings  */
/*    ping_responses_received               Destination for number of     */
/*                                            ping responses received     */
/*    icmp_checksum_errors                  Destination for number of     */
/*                                            ICMP checksum errors        */
/*    icmp_unhandled_messages               Destination for number of     */
/*                                            unhandled ICMP messages     */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    tx_mutex_put                          Release protection mutex      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT  _nx_icmp_info_get(NX_IP *ip_ptr, ULONG *pings_sent, ULONG *ping_timeouts,
                        ULONG *ping_threads_suspended, ULONG *ping_responses_received,
                        ULONG *icmp_checksum_errors, ULONG *icmp_unhandled_messages)
{

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

    /* Determine if pings sent is wanted.  */
    if (pings_sent)
    {

        /* Return the number of pings sent by this IP instance.  */
        *pings_sent =  ip_ptr -> nx_ip_pings_sent;
    }

    /* Determine if ping timeouts is wanted.  */
    if (ping_timeouts)
    {

        /* Return the number of ping timeouts by this IP instance.  */
        *ping_timeouts =  ip_ptr -> nx_ip_ping_timeouts;
    }

    /* Determine if ping threads suspended is wanted.  */
    if (ping_threads_suspended)
    {

        /* Return the number of ping threads suspended by this IP instance.  */
        *ping_threads_suspended =  ip_ptr -> nx_ip_ping_threads_suspended;
    }

    /* Determine if ping responses received is wanted.  */
    if (ping_responses_received)
    {

        /* Return the number of ping responses received by this IP instance.  */
        *ping_responses_received =  ip_ptr -> nx_ip_ping_responses_received;
    }

    /* Determine if ICMP checksum errors is wanted.  */
    if (icmp_checksum_errors)
    {

        /* Return the number of ICMP checksum errors detected by this IP instance.  */
        *icmp_checksum_errors =  ip_ptr -> nx_ip_icmp_checksum_errors;
    }

    /* Determine if ICMP unhandled messages is wanted.  */
    if (icmp_unhandled_messages)
    {

        /* Return the number of ICMP unhandled messages by this IP instance.  */
        *icmp_unhandled_messages =  ip_ptr -> nx_ip_icmp_unhandled_messages;
    }

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

    /* Return a successful status.  */
    return(NX_SUCCESS);
}