xref: /FreeRTOS-Plus-TCP-v4.0.0/test/cbmc/proofs/IP/HandleEthernetPacket/HandleEthernetPacket_harness.c (revision 2d3f4daa567ffe71aeda2e0f6d0bc02850db0627) 
1 /*
2  * FreeRTOS memory safety proofs with CBMC.
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without
8  * restriction, including without limitation the rights to use, copy,
9  * modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  * http://aws.amazon.com/freertos
26  * http://www.FreeRTOS.org
27  */
28 
29 #include <stdint.h>
30 
31 /* FreeRTOS includes. */
32 #include "FreeRTOS.h"
33 #include "task.h"
34 
35 /* FreeRTOS+TCP includes. */
36 #include "FreeRTOS_IP.h"
37 #include "FreeRTOS_IP_Private.h"
38 
39 #include "cbmc.h"
40 
41 /* Declaration */
42 void __CPROVER_file_local_FreeRTOS_IP_c_prvHandleEthernetPacket( NetworkBufferDescriptor_t * pxBuffer );
43 
44 /* Stubs */
45 
46 /* ProcessEthernetPacket() is proved else where */
__CPROVER_file_local_FreeRTOS_IP_c_prvProcessEthernetPacket(NetworkBufferDescriptor_t * const pxNetworkBuffer)47 void __CPROVER_file_local_FreeRTOS_IP_c_prvProcessEthernetPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer )
48 {
49     __CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer != NULL" );
50     __CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "pxNetworkBuffer->pucEthernetBuffer != NULL" );
51 }
52 
53 /*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
54 /*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
pxGetNetworkBufferWithDescriptor(size_t xRequestedSizeBytes,TickType_t xBlockTimeTicks)55 NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
56                                                               TickType_t xBlockTimeTicks )
57 {
58     NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
59 
60     __CPROVER_assume( pxNetworkBuffer != NULL );
61 
62     pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xRequestedSizeBytes );
63     __CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
64 
65     pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
66     return pxNetworkBuffer;
67 }
68 
69 
70 /* The harness test proceeds to call eConsiderFrameForProcessing with an unconstrained buffer */
harness()71 void harness()
72 {
73     NetworkBufferDescriptor_t * pxBuffer;
74     NetworkBufferDescriptor_t * pxBufferTemp;
75     TickType_t xBlockTimeTicks;
76     BaseType_t uBuffSize;
77     BaseType_t uIdx;
78 
79     /* Assume minimum and maximum buffer size expected */
80     __CPROVER_assume( uBuffSize > 0 && uBuffSize < ipconfigNETWORK_MTU );
81 
82     pxBuffer = pxGetNetworkBufferWithDescriptor( uBuffSize, xBlockTimeTicks );
83     pxBuffer->pxNextBuffer = pxGetNetworkBufferWithDescriptor( uBuffSize, xBlockTimeTicks );
84 
85     __CPROVER_assume( pxBuffer->pxNextBuffer->pxNextBuffer == NULL );
86 
87     __CPROVER_file_local_FreeRTOS_IP_c_prvHandleEthernetPacket( pxBuffer );
88 }
89