Outline ![]()
Files ![]()
loading...
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Packet Pool Management (Packet) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_packet.h"
#include "nx_ipv6.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_packet_copy PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function copies the specified packet into one or more packets */
/* allocated from the specified packet pool. */
/* */
/* INPUT */
/* */
/* packet_ptr Pointer to source packet */
/* new_packet_ptr Pointer for return packet */
/* pool_ptr Pointer to packet pool to use */
/* for new packet(s) */
/* wait_option Timeout option on packet */
/* allocate and data append */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Successful completion status */
/* NX_INVALID_PACKET If zero packet payload or data*/
/* to copy */
/* CALLS */
/* */
/* _nx_packet_allocate Allocate data packet */
/* _nx_packet_data_append Packet data append service */
/* _nx_packet_release Release data packet */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_packet_copy(NX_PACKET *packet_ptr, NX_PACKET **new_packet_ptr,
NX_PACKET_POOL *pool_ptr, ULONG wait_option)
{
NX_PACKET *work_ptr; /* Working packet pointer */
NX_PACKET *source_ptr; /* Source packet pointer */
ULONG size; /* Packet data size */
UINT status; /* Return status */
UINT first_packet; /* First packet flag */
UINT data_prepend_offset; /* Data prepend offset */
UINT ip_header_offset; /* IP header offset */
#ifdef TX_ENABLE_EVENT_TRACE
TX_TRACE_BUFFER_ENTRY *trace_event;
ULONG trace_timestamp;
#endif
/* Default the return packet pointer to NULL. */
*new_packet_ptr = NX_NULL;
/* Default the first packet to TRUE. */
first_packet = NX_TRUE;
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_PACKET_COPY, packet_ptr, 0, pool_ptr, wait_option, NX_TRACE_PACKET_EVENTS, &trace_event, &trace_timestamp);
/* Determine if there is anything to copy. */
if (packet_ptr -> nx_packet_length == 0)
{
/* Empty source packet, return an error. */
return(NX_INVALID_PACKET);
}
/* Allocate a new packet from the default packet pool supplied. */
/*lint -e{946} -e{947} suppress pointer subtraction, since it is necessary. */
status = _nx_packet_allocate(pool_ptr, &work_ptr, 0, wait_option);
/* Determine if the packet was not allocated. */
if (status != NX_SUCCESS)
{
/* Return the error code from the packet allocate routine. */
return(status);
}
/* Copy the packet interface information. */
/*lint -e{644} suppress variable might not be initialized, since "work_ptr" was initialized by _nx_packet_allocate. */
work_ptr -> nx_packet_address.nx_packet_interface_ptr = packet_ptr -> nx_packet_address.nx_packet_interface_ptr;
#ifdef FEATURE_NX_IPV6
/* Copy the IP version information. */
work_ptr -> nx_packet_ip_version = packet_ptr -> nx_packet_ip_version;
#endif /* FEATURE_NX_IPV6 */
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
/* Copy the packet interface capability. */
work_ptr -> nx_packet_interface_capability_flag = packet_ptr -> nx_packet_interface_capability_flag;
#endif /* NX_ENABLE_INTERFACE_CAPABILITY */
#ifdef NX_IPSEC_ENABLE
work_ptr -> nx_packet_ipsec_sa_ptr = packet_ptr -> nx_packet_ipsec_sa_ptr;
#endif /* NX_IPSEC_ENABLE */
/* Save the source packet pointer. */
source_ptr = packet_ptr;
#ifndef NX_DISABLE_PACKET_CHAIN
/* Loop to copy the original packet's data. */
do
{
#endif /* NX_DISABLE_PACKET_CHAIN */
/* Check if it is the first packet. */
if (first_packet == NX_TRUE)
{
/* Yes, it is, copied the data beginning at data starting position. */
/* Calculate this packet's data size. */
/*lint -e{946} -e{947} suppress pointer subtraction, since it is necessary. */
size = (ULONG)(packet_ptr -> nx_packet_append_ptr - packet_ptr -> nx_packet_data_start);
/* Copy the data from the source packet into the new packet using
the data append feature. */
status = _nx_packet_data_append(work_ptr, packet_ptr -> nx_packet_data_start, size, pool_ptr, wait_option);
}
else
{
/* Calculate this packet's data size. */
/*lint -e{946} -e{947} suppress pointer subtraction, since it is necessary. */
size = (ULONG)(packet_ptr -> nx_packet_append_ptr - packet_ptr -> nx_packet_prepend_ptr);
/* Copy the data from the source packet into the new packet using
the data append feature. */
status = _nx_packet_data_append(work_ptr, packet_ptr -> nx_packet_prepend_ptr, size, pool_ptr, wait_option);
}
/* Determine if there was an error in the data append. */
if (status != NX_SUCCESS)
{
/* An error is present, release the new packet. */
_nx_packet_release(work_ptr);
/* Return the error code from the packet data append service. */
return(status);
}
#ifndef NX_DISABLE_PACKET_CHAIN
/* Move to the next packet in the packet chain. */
packet_ptr = packet_ptr -> nx_packet_next;
/* Set the first packet to FALSE. */
first_packet = NX_FALSE;
} while (packet_ptr);
#endif /* NX_DISABLE_PACKET_CHAIN */
/* Adjust the prepend pointer and data length. */
/*lint --e{946} --e{947} --e{732} suppress pointer subtraction, since it is necessary. */
data_prepend_offset = (UINT)(source_ptr -> nx_packet_prepend_ptr - source_ptr -> nx_packet_data_start);
work_ptr -> nx_packet_prepend_ptr = work_ptr -> nx_packet_data_start + data_prepend_offset;
work_ptr -> nx_packet_length = work_ptr -> nx_packet_length - data_prepend_offset;
/* Set the ip_header information. */
ip_header_offset = (UINT)(source_ptr -> nx_packet_ip_header - source_ptr -> nx_packet_data_start);
work_ptr -> nx_packet_ip_header = work_ptr -> nx_packet_data_start + ip_header_offset;
/* Determine if the packet copy was successful. */
if (source_ptr -> nx_packet_length != work_ptr -> nx_packet_length)
{
/* An error is present, release the new packet. */
_nx_packet_release(work_ptr);
/* Return an error code. */
return(NX_INVALID_PACKET);
}
else
{
/* Everything is okay, return the new packet pointer. */
*new_packet_ptr = work_ptr;
/* Add debug information. */
NX_PACKET_DEBUG(__FILE__, __LINE__, work_ptr);
/* Update the trace event with the status. */
NX_TRACE_EVENT_UPDATE(trace_event, trace_timestamp, NX_TRACE_PACKET_COPY, 0, work_ptr, 0, 0);
/* Return success status. */
return(NX_SUCCESS);
}
}