common/src/nxe_ip_max_payload_size_find.c


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

/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Packet Pool Mangement (Packet)                                      */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */
#include "nx_api.h"
#include "nx_ip.h"

#ifdef NX_IPSEC_ENABLE
#include "nx_ipsec.h"
#endif /* NX_IPSEC_ENABLE */

/* Bring in externs for caller checking code.  */

NX_CALLER_CHECKING_EXTERNS


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxe_ip_max_payload_size_find                       PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks for errors in the max IP payload computation   */
/*    service.                                                            */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP instance        */
/*    src_address                           Packet Source Address         */
/*    dest_address                          Packet Destination Address    */
/*    protocol                              Protocol type                 */
/*    src_port                              Source port number, in host   */
/*                                            byte order.                 */
/*    dest_port                             Destination port number,      */
/*                                            in host byte order.         */
/*    start_offset_ptr                      Pointer to storage space that */
/*                                            contains amount of offset   */
/*                                            for payload.                */
/*    payload_length_ptr                    Pointer to storage space that */
/*                                            indicates the amount of     */
/*                                            payload data that would not */
/*                                            cause IP fragmentation.     */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion Code.              */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_max_payload_size_get              The acutal function that      */
/*                                            computes the max payload    */
/*                                            size.                       */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/

UINT _nxe_ip_max_payload_size_find(NX_IP *ip_ptr,
                                   NXD_ADDRESS *dest_address,
                                   UINT if_index,
                                   UINT src_port,
                                   UINT dest_port,
                                   ULONG protocol,
                                   ULONG *start_offset_ptr,
                                   ULONG *payload_length_ptr)
{

    /* Check for valid pointer to an IP instance.  */
    if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
    {
        return(NX_PTR_ERROR);
    }

    /* Destination address must be valid. */
    if (dest_address == NX_NULL)
    {
        return(NX_PTR_ERROR);
    }

    if ((dest_address -> nxd_ip_version != NX_IP_VERSION_V4) &&
        (dest_address -> nxd_ip_version != NX_IP_VERSION_V6))
    {
        return(NX_IP_ADDRESS_ERROR);
    }

    if ((protocol != NX_PROTOCOL_UDP) &&
        (protocol != NX_PROTOCOL_TCP))
    {
        return(NX_NOT_SUPPORTED);
    }

    /* Check for appropriate caller.  */
    NX_INIT_AND_THREADS_CALLER_CHECKING

    return(_nx_ip_max_payload_size_find(ip_ptr, dest_address, if_index, src_port, dest_port,
                                        protocol, start_offset_ptr, payload_length_ptr));
}