iPXE
memcpy_test.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 /** @file
27  *
28  * memcpy() self-tests
29  *
30  */
31 
32 /* Forcibly enable assertions */
33 #undef NDEBUG
34 
35 #include <stdint.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <ipxe/test.h>
39 #include <ipxe/profile.h>
40 
41 /** Number of sample iterations for profiling */
42 #define PROFILE_COUNT 16
43 
44 /* Provide global functions to allow inspection of generated code */
45 
46 void memcpy_0 ( void *dest, void *src ) { memcpy ( dest, src, 0 ); }
47 void memcpy_1 ( void *dest, void *src ) { memcpy ( dest, src, 1 ); }
48 void memcpy_2 ( void *dest, void *src ) { memcpy ( dest, src, 2 ); }
49 void memcpy_3 ( void *dest, void *src ) { memcpy ( dest, src, 3 ); }
50 void memcpy_4 ( void *dest, void *src ) { memcpy ( dest, src, 4 ); }
51 void memcpy_5 ( void *dest, void *src ) { memcpy ( dest, src, 5 ); }
52 void memcpy_6 ( void *dest, void *src ) { memcpy ( dest, src, 6 ); }
53 void memcpy_7 ( void *dest, void *src ) { memcpy ( dest, src, 7 ); }
54 void memcpy_8 ( void *dest, void *src ) { memcpy ( dest, src, 8 ); }
55 void memcpy_9 ( void *dest, void *src ) { memcpy ( dest, src, 9 ); }
56 void memcpy_10 ( void *dest, void *src ) { memcpy ( dest, src, 10 ); }
57 void memcpy_11 ( void *dest, void *src ) { memcpy ( dest, src, 11 ); }
58 void memcpy_12 ( void *dest, void *src ) { memcpy ( dest, src, 12 ); }
59 void memcpy_13 ( void *dest, void *src ) { memcpy ( dest, src, 13 ); }
60 void memcpy_14 ( void *dest, void *src ) { memcpy ( dest, src, 14 ); }
61 void memcpy_15 ( void *dest, void *src ) { memcpy ( dest, src, 15 ); }
62 void memcpy_16 ( void *dest, void *src ) { memcpy ( dest, src, 16 ); }
63 void memcpy_17 ( void *dest, void *src ) { memcpy ( dest, src, 17 ); }
64 void memcpy_18 ( void *dest, void *src ) { memcpy ( dest, src, 18 ); }
65 void memcpy_19 ( void *dest, void *src ) { memcpy ( dest, src, 19 ); }
66 void memcpy_20 ( void *dest, void *src ) { memcpy ( dest, src, 20 ); }
67 void memcpy_21 ( void *dest, void *src ) { memcpy ( dest, src, 21 ); }
68 void memcpy_22 ( void *dest, void *src ) { memcpy ( dest, src, 22 ); }
69 void memcpy_23 ( void *dest, void *src ) { memcpy ( dest, src, 23 ); }
70 void memcpy_24 ( void *dest, void *src ) { memcpy ( dest, src, 24 ); }
71 void memcpy_25 ( void *dest, void *src ) { memcpy ( dest, src, 25 ); }
72 void memcpy_26 ( void *dest, void *src ) { memcpy ( dest, src, 26 ); }
73 void memcpy_27 ( void *dest, void *src ) { memcpy ( dest, src, 27 ); }
74 void memcpy_28 ( void *dest, void *src ) { memcpy ( dest, src, 28 ); }
75 void memcpy_29 ( void *dest, void *src ) { memcpy ( dest, src, 29 ); }
76 void memcpy_30 ( void *dest, void *src ) { memcpy ( dest, src, 30 ); }
77 void memcpy_31 ( void *dest, void *src ) { memcpy ( dest, src, 31 ); }
78 
79 /**
80  * Force a call to the variable-length implementation of memcpy()
81  *
82  * @v dest Destination address
83  * @v src Source address
84  * @v len Length of data
85  * @ret dest Destination address
86  */
87 __attribute__ (( noinline )) void * memcpy_var ( void *dest, const void *src,
88  size_t len ) {
89  return memcpy ( dest, src, len );
90 }
91 
92 /**
93  * Perform a constant-length memcpy() test
94  *
95  * ... Data to copy
96  */
97 #define MEMCPY_TEST_CONSTANT( ... ) do { \
98  static const uint8_t src[] = { __VA_ARGS__ }; \
99  uint8_t dest_const[ 1 + sizeof ( src ) + 1 ]; \
100  uint8_t dest_var[ 1 + sizeof ( src ) + 1 ]; \
101  \
102  dest_const[0] = 0x33; \
103  dest_const[ sizeof ( dest_const ) - 1 ] = 0x44; \
104  memcpy ( ( dest_const + 1 ), src, \
105  ( sizeof ( dest_const ) - 2 ) ); \
106  ok ( dest_const[0] == 0x33 ); \
107  ok ( dest_const[ sizeof ( dest_const ) - 1 ] == 0x44 ); \
108  ok ( memcmp ( ( dest_const + 1 ), src, \
109  ( sizeof ( dest_const ) - 2 ) ) == 0 ); \
110  \
111  dest_var[0] = 0x55; \
112  dest_var[ sizeof ( dest_var ) - 1 ] = 0x66; \
113  memcpy_var ( ( dest_var + 1 ), src, \
114  ( sizeof ( dest_var ) - 2 ) ); \
115  ok ( dest_var[0] == 0x55 ); \
116  ok ( dest_var[ sizeof ( dest_var ) - 1 ] == 0x66 ); \
117  ok ( memcmp ( ( dest_var + 1 ), src, \
118  ( sizeof ( dest_var ) - 2 ) ) == 0 ); \
119  } while ( 0 )
120 
121 /**
122  * Test memcpy() speed
123  *
124  * @v dest_offset Destination alignment offset
125  * @v src_offset Source alignment offset
126  * @v len Length of data to copy
127  */
128 static void memcpy_test_speed ( unsigned int dest_offset,
129  unsigned int src_offset, size_t len ) {
130  struct profiler profiler;
131  uint8_t *dest;
132  uint8_t *src;
133  unsigned int i;
134 
135  /* Allocate blocks */
136  dest = malloc ( len + dest_offset );
137  assert ( dest != NULL );
138  src = malloc ( len + src_offset );
139  assert ( src != NULL );
140 
141  /* Generate random source data */
142  for ( i = 0 ; i < len ; i++ )
143  src[ src_offset + i ] = random();
144 
145  /* Check correctness of copied data */
146  memcpy ( ( dest + dest_offset ), ( src + src_offset ), len );
147  ok ( memcmp ( ( dest + dest_offset ), ( src + src_offset ),
148  len ) == 0 );
149 
150  /* Profile memcpy() */
151  memset ( &profiler, 0, sizeof ( profiler ) );
152  for ( i = 0 ; i < PROFILE_COUNT ; i++ ) {
153  profile_start ( &profiler );
154  memcpy ( ( dest + dest_offset ), ( src + src_offset ), len );
155  profile_stop ( &profiler );
156  }
157 
158  /* Free blocks */
159  free ( dest );
160  free ( src );
161 
162  DBG ( "MEMCPY copied %zd bytes (+%d => +%d) in %ld +/- %ld ticks\n",
163  len, src_offset, dest_offset, profile_mean ( &profiler ),
164  profile_stddev ( &profiler ) );
165 }
166 
167 /**
168  * Perform memcpy() self-tests
169  *
170  */
171 static void memcpy_test_exec ( void ) {
172  unsigned int dest_offset;
173  unsigned int src_offset;
174 
175  /* Constant-length tests */
177  MEMCPY_TEST_CONSTANT ( 0x86 );
178  MEMCPY_TEST_CONSTANT ( 0x8c, 0xd3 );
179  MEMCPY_TEST_CONSTANT ( 0x4e, 0x08, 0xed );
180  MEMCPY_TEST_CONSTANT ( 0xcc, 0x61, 0x8f, 0x70 );
181  MEMCPY_TEST_CONSTANT ( 0x6d, 0x28, 0xe0, 0x9e, 0x6d );
182  MEMCPY_TEST_CONSTANT ( 0x7d, 0x13, 0x4f, 0xef, 0x17, 0xb3 );
183  MEMCPY_TEST_CONSTANT ( 0x38, 0xa7, 0xd4, 0x8d, 0x44, 0x01, 0xfd );
184  MEMCPY_TEST_CONSTANT ( 0x45, 0x9f, 0xf4, 0xf9, 0xf3, 0x0f, 0x99, 0x43 );
185  MEMCPY_TEST_CONSTANT ( 0x69, 0x8c, 0xf6, 0x12, 0x79, 0x70, 0xd8, 0x1e,
186  0x9d );
187  MEMCPY_TEST_CONSTANT ( 0xbe, 0x53, 0xb4, 0xb7, 0xdd, 0xe6, 0x35, 0x10,
188  0x3c, 0xe7 );
189  MEMCPY_TEST_CONSTANT ( 0xaf, 0x41, 0x8a, 0x88, 0xb1, 0x4e, 0x52, 0xd4,
190  0xe6, 0xc3, 0x76 );
191  MEMCPY_TEST_CONSTANT ( 0xdf, 0x43, 0xe4, 0x5d, 0xad, 0x17, 0x35, 0x38,
192  0x1a, 0x1d, 0x57, 0x58 );
193  MEMCPY_TEST_CONSTANT ( 0x20, 0x52, 0x83, 0x92, 0xb9, 0x85, 0xa4, 0x06,
194  0x94, 0xe0, 0x3d, 0x57, 0xd4 );
195  MEMCPY_TEST_CONSTANT ( 0xf1, 0x67, 0x31, 0x9e, 0x32, 0x98, 0x27, 0xe9,
196  0x8e, 0x62, 0xb4, 0x82, 0x7e, 0x02 );
197  MEMCPY_TEST_CONSTANT ( 0x93, 0xc1, 0x55, 0xe3, 0x60, 0xce, 0xac, 0x1e,
198  0xae, 0x9d, 0xca, 0xec, 0x92, 0xb3, 0x38 );
199  MEMCPY_TEST_CONSTANT ( 0xb3, 0xc1, 0xfa, 0xe7, 0x8a, 0x1c, 0xe4, 0xce,
200  0x85, 0xe6, 0x3c, 0xab, 0x1c, 0xa2, 0xaf, 0x7a );
201  MEMCPY_TEST_CONSTANT ( 0x9b, 0x6e, 0x1c, 0x48, 0x82, 0xd3, 0x6e, 0x58,
202  0xa7, 0xb0, 0xe6, 0xea, 0x6d, 0xee, 0xc8, 0xf8,
203  0xaf );
204  MEMCPY_TEST_CONSTANT ( 0x86, 0x6d, 0xb0, 0xf5, 0xf2, 0xc9, 0xcd, 0xfe,
205  0xfb, 0x38, 0x67, 0xbc, 0x51, 0x9d, 0x25, 0xbc,
206  0x09, 0x88 );
207  MEMCPY_TEST_CONSTANT ( 0x58, 0xa4, 0x96, 0x9e, 0x98, 0x36, 0xdb, 0xae,
208  0x8a, 0x08, 0x7c, 0x64, 0xf9, 0xfb, 0x25, 0xb4,
209  0x8e, 0xf3, 0xed );
210  MEMCPY_TEST_CONSTANT ( 0xc6, 0x3b, 0x84, 0x3c, 0x76, 0x24, 0x8e, 0x42,
211  0x11, 0x1f, 0x09, 0x2e, 0x24, 0xbb, 0x67, 0x71,
212  0x3a, 0xca, 0x60, 0xdd );
213  MEMCPY_TEST_CONSTANT ( 0x8e, 0x2d, 0xa9, 0x58, 0x87, 0xe2, 0xac, 0x4b,
214  0xc8, 0xbf, 0xa2, 0x4e, 0xee, 0x3a, 0xa6, 0x71,
215  0x76, 0xee, 0x42, 0x05, 0x6e );
216  MEMCPY_TEST_CONSTANT ( 0x8a, 0xda, 0xdf, 0x7b, 0x55, 0x41, 0x8c, 0xcd,
217  0x42, 0x40, 0x18, 0xe2, 0x60, 0xc4, 0x7d, 0x64,
218  0x00, 0xd5, 0xef, 0xa1, 0x7b, 0x31 );
219  MEMCPY_TEST_CONSTANT ( 0xd9, 0x25, 0xcb, 0xbb, 0x9c, 0x1d, 0xdd, 0xcd,
220  0xde, 0x96, 0xd9, 0x74, 0x13, 0x95, 0xfe, 0x68,
221  0x0b, 0x3d, 0x30, 0x8d, 0x0c, 0x1e, 0x6d );
222  MEMCPY_TEST_CONSTANT ( 0x2d, 0x0d, 0x02, 0x33, 0xd6, 0xbe, 0x6c, 0xa6,
223  0x0a, 0xab, 0xe5, 0xda, 0xe2, 0xab, 0x78, 0x3c,
224  0xd3, 0xdd, 0xea, 0xfa, 0x1a, 0xe4, 0xf4, 0xb3 );
225  MEMCPY_TEST_CONSTANT ( 0x6a, 0x34, 0x39, 0xea, 0x29, 0x5f, 0xa6, 0x18,
226  0xc1, 0x53, 0x39, 0x78, 0xdb, 0x40, 0xf2, 0x98,
227  0x78, 0xcf, 0xee, 0xfd, 0xcd, 0xf8, 0x56, 0xf8,
228  0x30 );
229  MEMCPY_TEST_CONSTANT ( 0xe4, 0xe5, 0x5a, 0x8d, 0xcf, 0x04, 0x29, 0x7c,
230  0xa7, 0xd8, 0x43, 0xbf, 0x0b, 0xbf, 0xe7, 0x68,
231  0xf7, 0x8c, 0x81, 0xf9, 0x3f, 0xad, 0xa4, 0x40,
232  0x38, 0x82 );
233  MEMCPY_TEST_CONSTANT ( 0x71, 0xcd, 0x3d, 0x26, 0xde, 0x11, 0x23, 0xd5,
234  0x42, 0x6e, 0x63, 0x72, 0x53, 0xfc, 0x28, 0x06,
235  0x4b, 0xe0, 0x2c, 0x07, 0x6b, 0xe8, 0xd9, 0x5f,
236  0xf8, 0x74, 0xed );
237  MEMCPY_TEST_CONSTANT ( 0x05, 0xb2, 0xae, 0x81, 0x91, 0xc9, 0xa2, 0x5f,
238  0xa9, 0x1b, 0x25, 0x7f, 0x32, 0x0c, 0x04, 0x00,
239  0xf1, 0x46, 0xab, 0x77, 0x1e, 0x12, 0x27, 0xe7,
240  0xf6, 0x1e, 0x0c, 0x29 );
241  MEMCPY_TEST_CONSTANT ( 0x0e, 0xca, 0xa5, 0x56, 0x3d, 0x99, 0x99, 0xf9,
242  0x6e, 0xdd, 0x93, 0x98, 0xec, 0x8b, 0x5c, 0x71,
243  0x0c, 0xb0, 0xe6, 0x12, 0xf2, 0x10, 0x1a, 0xbe,
244  0x4a, 0xe0, 0xe3, 0x00, 0xf8 );
245  MEMCPY_TEST_CONSTANT ( 0x40, 0xa8, 0x28, 0x5b, 0x12, 0x0d, 0x80, 0x8e,
246  0x8a, 0xd9, 0x92, 0x7a, 0x6e, 0x48, 0x8d, 0x14,
247  0x4b, 0xc6, 0xce, 0x21, 0x2f, 0x0e, 0x47, 0xbd,
248  0xf1, 0xca, 0x0e, 0x1f, 0x65, 0xc4 );
249  MEMCPY_TEST_CONSTANT ( 0x84, 0x83, 0x44, 0xe8, 0x1c, 0xbf, 0x23, 0x05,
250  0xdf, 0xed, 0x3b, 0xb7, 0x0b, 0x4a, 0x05, 0xec,
251  0xb7, 0x6f, 0x1c, 0xfe, 0x05, 0x05, 0x4e, 0xd1,
252  0x50, 0x88, 0x81, 0x87, 0x68, 0xf6, 0x66 );
253  MEMCPY_TEST_CONSTANT ( 0x0d, 0x1d, 0xcf, 0x3e, 0x7c, 0xf8, 0x12, 0x1b,
254  0x96, 0x7f, 0xff, 0x27, 0xca, 0xfe, 0xd3, 0x8b,
255  0x10, 0xb9, 0x5d, 0x05, 0xad, 0x50, 0xed, 0x35,
256  0x32, 0x9c, 0xe6, 0x3b, 0x73, 0xe0, 0x7d );
257 
258  /* Speed tests */
259  memcpy_test_speed ( 0, 0, 64 );
260  memcpy_test_speed ( 0, 0, 128 );
261  memcpy_test_speed ( 0, 0, 256 );
262  for ( dest_offset = 0 ; dest_offset < 4 ; dest_offset++ ) {
263  for ( src_offset = 0 ; src_offset < 4 ; src_offset++ ) {
264  memcpy_test_speed ( dest_offset, src_offset, 4096 );
265  }
266  }
267 }
268 
269 /** memcpy() self-test */
270 struct self_test memcpy_test __self_test = {
271  .name = "memcpy",
272  .exec = memcpy_test_exec,
273 };
void memcpy_12(void *dest, void *src)
Definition: memcpy_test.c:58
#define __attribute__(x)
Definition: compiler.h:10
unsigned long profile_mean(struct profiler *profiler)
Get mean sample value.
Definition: profile.c:241
void memcpy_7(void *dest, void *src)
Definition: memcpy_test.c:53
void memcpy_17(void *dest, void *src)
Definition: memcpy_test.c:63
void memcpy_29(void *dest, void *src)
Definition: memcpy_test.c:75
void memcpy_0(void *dest, void *src)
Definition: memcpy_test.c:46
void memcpy_15(void *dest, void *src)
Definition: memcpy_test.c:61
void memcpy_21(void *dest, void *src)
Definition: memcpy_test.c:67
Self-test infrastructure.
const char * name
Test set name.
Definition: test.h:17
void memcpy_20(void *dest, void *src)
Definition: memcpy_test.c:66
A data structure for storing profiling information.
Definition: profile.h:26
void memcpy_6(void *dest, void *src)
Definition: memcpy_test.c:52
void memcpy_19(void *dest, void *src)
Definition: memcpy_test.c:65
static void profile_stop(struct profiler *profiler)
Stop profiling.
Definition: profile.h:171
A self-test set.
Definition: test.h:15
void memcpy_9(void *dest, void *src)
Definition: memcpy_test.c:55
void memcpy_16(void *dest, void *src)
Definition: memcpy_test.c:62
unsigned long profile_stddev(struct profiler *profiler)
Get sample standard deviation.
Definition: profile.c:275
void * memcpy_var(void *dest, const void *src, size_t len)
Force a call to the variable-length implementation of memcpy()
Definition: memcpy_test.c:87
void memcpy_4(void *dest, void *src)
Definition: memcpy_test.c:50
void memcpy_2(void *dest, void *src)
Definition: memcpy_test.c:48
void * memcpy(void *dest, const void *src, size_t len) __nonnull
void memcpy_30(void *dest, void *src)
Definition: memcpy_test.c:76
void memcpy_27(void *dest, void *src)
Definition: memcpy_test.c:73
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
void memcpy_5(void *dest, void *src)
Definition: memcpy_test.c:51
void memcpy_23(void *dest, void *src)
Definition: memcpy_test.c:69
void memcpy_11(void *dest, void *src)
Definition: memcpy_test.c:57
static void profile_start(struct profiler *profiler)
Start profiling.
Definition: profile.h:158
Profiling.
static void * dest
Definition: strings.h:176
static __always_inline void off_t userptr_t src
Definition: efi_uaccess.h:66
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void memcpy_18(void *dest, void *src)
Definition: memcpy_test.c:64
void memcpy_28(void *dest, void *src)
Definition: memcpy_test.c:74
void memcpy_3(void *dest, void *src)
Definition: memcpy_test.c:49
long int random(void)
Generate a pseudo-random number between 0 and 2147483647L or 2147483562?
Definition: random.c:30
static void memcpy_test_exec(void)
Perform memcpy() self-tests.
Definition: memcpy_test.c:171
unsigned char uint8_t
Definition: stdint.h:10
void memcpy_25(void *dest, void *src)
Definition: memcpy_test.c:71
static void memcpy_test_speed(unsigned int dest_offset, unsigned int src_offset, size_t len)
Test memcpy() speed.
Definition: memcpy_test.c:128
void memcpy_26(void *dest, void *src)
Definition: memcpy_test.c:72
void * malloc(size_t size)
Allocate memory.
Definition: malloc.c:583
void memcpy_14(void *dest, void *src)
Definition: memcpy_test.c:60
struct self_test memcpy_test __self_test
memcpy() self-test
Definition: memcpy_test.c:270
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
uint32_t len
Length.
Definition: ena.h:14
void memcpy_10(void *dest, void *src)
Definition: memcpy_test.c:56
#define PROFILE_COUNT
Number of sample iterations for profiling.
Definition: memcpy_test.c:42
void memcpy_31(void *dest, void *src)
Definition: memcpy_test.c:77
#define DBG(...)
Print a debugging message.
Definition: compiler.h:498
#define ok(success)
Definition: test.h:46
int memcmp(const void *first, const void *second, size_t len)
Compare memory regions.
Definition: string.c:98
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
String functions.
void memcpy_22(void *dest, void *src)
Definition: memcpy_test.c:68
void memcpy_1(void *dest, void *src)
Definition: memcpy_test.c:47
void memcpy_8(void *dest, void *src)
Definition: memcpy_test.c:54
void memcpy_24(void *dest, void *src)
Definition: memcpy_test.c:70
#define MEMCPY_TEST_CONSTANT(...)
Perform a constant-length memcpy() test.
Definition: memcpy_test.c:97
void memcpy_13(void *dest, void *src)
Definition: memcpy_test.c:59
void * memset(void *dest, int character, size_t len) __nonnull