test/mbuf: fix forged mbuf in clone test
[dpdk.git] / app / test / test_mbuf.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4
5 #include <string.h>
6 #include <stdarg.h>
7 #include <stdio.h>
8 #include <stdlib.h>
9 #include <stdint.h>
10 #include <inttypes.h>
11 #include <errno.h>
12 #include <sys/queue.h>
13
14 #include <rte_common.h>
15 #include <rte_debug.h>
16 #include <rte_log.h>
17 #include <rte_memory.h>
18 #include <rte_memcpy.h>
19 #include <rte_launch.h>
20 #include <rte_eal.h>
21 #include <rte_per_lcore.h>
22 #include <rte_lcore.h>
23 #include <rte_atomic.h>
24 #include <rte_branch_prediction.h>
25 #include <rte_ring.h>
26 #include <rte_mempool.h>
27 #include <rte_mbuf.h>
28 #include <rte_random.h>
29 #include <rte_cycles.h>
30 #include <rte_malloc.h>
31
32 #include "test.h"
33
34 #define MBUF_DATA_SIZE          2048
35 #define NB_MBUF                 128
36 #define MBUF_TEST_DATA_LEN      1464
37 #define MBUF_TEST_DATA_LEN2     50
38 #define MBUF_TEST_HDR1_LEN      20
39 #define MBUF_TEST_HDR2_LEN      30
40 #define MBUF_TEST_ALL_HDRS_LEN  (MBUF_TEST_HDR1_LEN+MBUF_TEST_HDR2_LEN)
41
42 /* size of private data for mbuf in pktmbuf_pool2 */
43 #define MBUF2_PRIV_SIZE         128
44
45 #define REFCNT_MAX_ITER         64
46 #define REFCNT_MAX_TIMEOUT      10
47 #define REFCNT_MAX_REF          (RTE_MAX_LCORE)
48 #define REFCNT_MBUF_NUM         64
49 #define REFCNT_RING_SIZE        (REFCNT_MBUF_NUM * REFCNT_MAX_REF)
50
51 #define MAGIC_DATA              0x42424242
52
53 #define MAKE_STRING(x)          # x
54
55 #ifdef RTE_MBUF_REFCNT_ATOMIC
56
57 static volatile uint32_t refcnt_stop_slaves;
58 static unsigned refcnt_lcore[RTE_MAX_LCORE];
59
60 #endif
61
62 /*
63  * MBUF
64  * ====
65  *
66  * #. Allocate a mbuf pool.
67  *
68  *    - The pool contains NB_MBUF elements, where each mbuf is MBUF_SIZE
69  *      bytes long.
70  *
71  * #. Test multiple allocations of mbufs from this pool.
72  *
73  *    - Allocate NB_MBUF and store pointers in a table.
74  *    - If an allocation fails, return an error.
75  *    - Free all these mbufs.
76  *    - Repeat the same test to check that mbufs were freed correctly.
77  *
78  * #. Test data manipulation in pktmbuf.
79  *
80  *    - Alloc an mbuf.
81  *    - Append data using rte_pktmbuf_append().
82  *    - Test for error in rte_pktmbuf_append() when len is too large.
83  *    - Trim data at the end of mbuf using rte_pktmbuf_trim().
84  *    - Test for error in rte_pktmbuf_trim() when len is too large.
85  *    - Prepend a header using rte_pktmbuf_prepend().
86  *    - Test for error in rte_pktmbuf_prepend() when len is too large.
87  *    - Remove data at the beginning of mbuf using rte_pktmbuf_adj().
88  *    - Test for error in rte_pktmbuf_adj() when len is too large.
89  *    - Check that appended data is not corrupt.
90  *    - Free the mbuf.
91  *    - Between all these tests, check data_len and pkt_len, and
92  *      that the mbuf is contiguous.
93  *    - Repeat the test to check that allocation operations
94  *      reinitialize the mbuf correctly.
95  *
96  * #. Test packet cloning
97  *    - Clone a mbuf and verify the data
98  *    - Clone the cloned mbuf and verify the data
99  *    - Attach a mbuf to another that does not have the same priv_size.
100  */
101
102 #define GOTO_FAIL(str, ...) do {                                        \
103                 printf("mbuf test FAILED (l.%d): <" str ">\n",          \
104                        __LINE__,  ##__VA_ARGS__);                       \
105                 goto fail;                                              \
106 } while(0)
107
108 /*
109  * test data manipulation in mbuf with non-ascii data
110  */
111 static int
112 test_pktmbuf_with_non_ascii_data(struct rte_mempool *pktmbuf_pool)
113 {
114         struct rte_mbuf *m = NULL;
115         char *data;
116
117         m = rte_pktmbuf_alloc(pktmbuf_pool);
118         if (m == NULL)
119                 GOTO_FAIL("Cannot allocate mbuf");
120         if (rte_pktmbuf_pkt_len(m) != 0)
121                 GOTO_FAIL("Bad length");
122
123         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN);
124         if (data == NULL)
125                 GOTO_FAIL("Cannot append data");
126         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
127                 GOTO_FAIL("Bad pkt length");
128         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
129                 GOTO_FAIL("Bad data length");
130         memset(data, 0xff, rte_pktmbuf_pkt_len(m));
131         if (!rte_pktmbuf_is_contiguous(m))
132                 GOTO_FAIL("Buffer should be continuous");
133         rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
134
135         rte_pktmbuf_free(m);
136
137         return 0;
138
139 fail:
140         if(m) {
141                 rte_pktmbuf_free(m);
142         }
143         return -1;
144 }
145
146 /*
147  * test data manipulation in mbuf
148  */
149 static int
150 test_one_pktmbuf(struct rte_mempool *pktmbuf_pool)
151 {
152         struct rte_mbuf *m = NULL;
153         char *data, *data2, *hdr;
154         unsigned i;
155
156         printf("Test pktmbuf API\n");
157
158         /* alloc a mbuf */
159
160         m = rte_pktmbuf_alloc(pktmbuf_pool);
161         if (m == NULL)
162                 GOTO_FAIL("Cannot allocate mbuf");
163         if (rte_pktmbuf_pkt_len(m) != 0)
164                 GOTO_FAIL("Bad length");
165
166         rte_pktmbuf_dump(stdout, m, 0);
167
168         /* append data */
169
170         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN);
171         if (data == NULL)
172                 GOTO_FAIL("Cannot append data");
173         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
174                 GOTO_FAIL("Bad pkt length");
175         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
176                 GOTO_FAIL("Bad data length");
177         memset(data, 0x66, rte_pktmbuf_pkt_len(m));
178         if (!rte_pktmbuf_is_contiguous(m))
179                 GOTO_FAIL("Buffer should be continuous");
180         rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
181         rte_pktmbuf_dump(stdout, m, 2*MBUF_TEST_DATA_LEN);
182
183         /* this append should fail */
184
185         data2 = rte_pktmbuf_append(m, (uint16_t)(rte_pktmbuf_tailroom(m) + 1));
186         if (data2 != NULL)
187                 GOTO_FAIL("Append should not succeed");
188
189         /* append some more data */
190
191         data2 = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN2);
192         if (data2 == NULL)
193                 GOTO_FAIL("Cannot append data");
194         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_DATA_LEN2)
195                 GOTO_FAIL("Bad pkt length");
196         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_DATA_LEN2)
197                 GOTO_FAIL("Bad data length");
198         if (!rte_pktmbuf_is_contiguous(m))
199                 GOTO_FAIL("Buffer should be continuous");
200
201         /* trim data at the end of mbuf */
202
203         if (rte_pktmbuf_trim(m, MBUF_TEST_DATA_LEN2) < 0)
204                 GOTO_FAIL("Cannot trim data");
205         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
206                 GOTO_FAIL("Bad pkt length");
207         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
208                 GOTO_FAIL("Bad data length");
209         if (!rte_pktmbuf_is_contiguous(m))
210                 GOTO_FAIL("Buffer should be continuous");
211
212         /* this trim should fail */
213
214         if (rte_pktmbuf_trim(m, (uint16_t)(rte_pktmbuf_data_len(m) + 1)) == 0)
215                 GOTO_FAIL("trim should not succeed");
216
217         /* prepend one header */
218
219         hdr = rte_pktmbuf_prepend(m, MBUF_TEST_HDR1_LEN);
220         if (hdr == NULL)
221                 GOTO_FAIL("Cannot prepend");
222         if (data - hdr != MBUF_TEST_HDR1_LEN)
223                 GOTO_FAIL("Prepend failed");
224         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_HDR1_LEN)
225                 GOTO_FAIL("Bad pkt length");
226         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_HDR1_LEN)
227                 GOTO_FAIL("Bad data length");
228         if (!rte_pktmbuf_is_contiguous(m))
229                 GOTO_FAIL("Buffer should be continuous");
230         memset(hdr, 0x55, MBUF_TEST_HDR1_LEN);
231
232         /* prepend another header */
233
234         hdr = rte_pktmbuf_prepend(m, MBUF_TEST_HDR2_LEN);
235         if (hdr == NULL)
236                 GOTO_FAIL("Cannot prepend");
237         if (data - hdr != MBUF_TEST_ALL_HDRS_LEN)
238                 GOTO_FAIL("Prepend failed");
239         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_ALL_HDRS_LEN)
240                 GOTO_FAIL("Bad pkt length");
241         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_ALL_HDRS_LEN)
242                 GOTO_FAIL("Bad data length");
243         if (!rte_pktmbuf_is_contiguous(m))
244                 GOTO_FAIL("Buffer should be continuous");
245         memset(hdr, 0x55, MBUF_TEST_HDR2_LEN);
246
247         rte_mbuf_sanity_check(m, 1);
248         rte_mbuf_sanity_check(m, 0);
249         rte_pktmbuf_dump(stdout, m, 0);
250
251         /* this prepend should fail */
252
253         hdr = rte_pktmbuf_prepend(m, (uint16_t)(rte_pktmbuf_headroom(m) + 1));
254         if (hdr != NULL)
255                 GOTO_FAIL("prepend should not succeed");
256
257         /* remove data at beginning of mbuf (adj) */
258
259         if (data != rte_pktmbuf_adj(m, MBUF_TEST_ALL_HDRS_LEN))
260                 GOTO_FAIL("rte_pktmbuf_adj failed");
261         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
262                 GOTO_FAIL("Bad pkt length");
263         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
264                 GOTO_FAIL("Bad data length");
265         if (!rte_pktmbuf_is_contiguous(m))
266                 GOTO_FAIL("Buffer should be continuous");
267
268         /* this adj should fail */
269
270         if (rte_pktmbuf_adj(m, (uint16_t)(rte_pktmbuf_data_len(m) + 1)) != NULL)
271                 GOTO_FAIL("rte_pktmbuf_adj should not succeed");
272
273         /* check data */
274
275         if (!rte_pktmbuf_is_contiguous(m))
276                 GOTO_FAIL("Buffer should be continuous");
277
278         for (i=0; i<MBUF_TEST_DATA_LEN; i++) {
279                 if (data[i] != 0x66)
280                         GOTO_FAIL("Data corrupted at offset %u", i);
281         }
282
283         /* free mbuf */
284
285         rte_pktmbuf_free(m);
286         m = NULL;
287         return 0;
288
289 fail:
290         if (m)
291                 rte_pktmbuf_free(m);
292         return -1;
293 }
294
295 static int
296 testclone_testupdate_testdetach(struct rte_mempool *pktmbuf_pool)
297 {
298         struct rte_mbuf *m = NULL;
299         struct rte_mbuf *clone = NULL;
300         struct rte_mbuf *clone2 = NULL;
301         unaligned_uint32_t *data;
302
303         /* alloc a mbuf */
304         m = rte_pktmbuf_alloc(pktmbuf_pool);
305         if (m == NULL)
306                 GOTO_FAIL("ooops not allocating mbuf");
307
308         if (rte_pktmbuf_pkt_len(m) != 0)
309                 GOTO_FAIL("Bad length");
310
311         rte_pktmbuf_append(m, sizeof(uint32_t));
312         data = rte_pktmbuf_mtod(m, unaligned_uint32_t *);
313         *data = MAGIC_DATA;
314
315         /* clone the allocated mbuf */
316         clone = rte_pktmbuf_clone(m, pktmbuf_pool);
317         if (clone == NULL)
318                 GOTO_FAIL("cannot clone data\n");
319
320         data = rte_pktmbuf_mtod(clone, unaligned_uint32_t *);
321         if (*data != MAGIC_DATA)
322                 GOTO_FAIL("invalid data in clone\n");
323
324         if (rte_mbuf_refcnt_read(m) != 2)
325                 GOTO_FAIL("invalid refcnt in m\n");
326
327         /* free the clone */
328         rte_pktmbuf_free(clone);
329         clone = NULL;
330
331         /* same test with a chained mbuf */
332         m->next = rte_pktmbuf_alloc(pktmbuf_pool);
333         if (m->next == NULL)
334                 GOTO_FAIL("Next Pkt Null\n");
335         m->nb_segs = 2;
336
337         rte_pktmbuf_append(m->next, sizeof(uint32_t));
338         m->pkt_len = 2 * sizeof(uint32_t);
339
340         data = rte_pktmbuf_mtod(m->next, unaligned_uint32_t *);
341         *data = MAGIC_DATA;
342
343         clone = rte_pktmbuf_clone(m, pktmbuf_pool);
344         if (clone == NULL)
345                 GOTO_FAIL("cannot clone data\n");
346
347         data = rte_pktmbuf_mtod(clone, unaligned_uint32_t *);
348         if (*data != MAGIC_DATA)
349                 GOTO_FAIL("invalid data in clone\n");
350
351         data = rte_pktmbuf_mtod(clone->next, unaligned_uint32_t *);
352         if (*data != MAGIC_DATA)
353                 GOTO_FAIL("invalid data in clone->next\n");
354
355         if (rte_mbuf_refcnt_read(m) != 2)
356                 GOTO_FAIL("invalid refcnt in m\n");
357
358         if (rte_mbuf_refcnt_read(m->next) != 2)
359                 GOTO_FAIL("invalid refcnt in m->next\n");
360
361         /* try to clone the clone */
362
363         clone2 = rte_pktmbuf_clone(clone, pktmbuf_pool);
364         if (clone2 == NULL)
365                 GOTO_FAIL("cannot clone the clone\n");
366
367         data = rte_pktmbuf_mtod(clone2, unaligned_uint32_t *);
368         if (*data != MAGIC_DATA)
369                 GOTO_FAIL("invalid data in clone2\n");
370
371         data = rte_pktmbuf_mtod(clone2->next, unaligned_uint32_t *);
372         if (*data != MAGIC_DATA)
373                 GOTO_FAIL("invalid data in clone2->next\n");
374
375         if (rte_mbuf_refcnt_read(m) != 3)
376                 GOTO_FAIL("invalid refcnt in m\n");
377
378         if (rte_mbuf_refcnt_read(m->next) != 3)
379                 GOTO_FAIL("invalid refcnt in m->next\n");
380
381         /* free mbuf */
382         rte_pktmbuf_free(m);
383         rte_pktmbuf_free(clone);
384         rte_pktmbuf_free(clone2);
385
386         m = NULL;
387         clone = NULL;
388         clone2 = NULL;
389         printf("%s ok\n", __func__);
390         return 0;
391
392 fail:
393         if (m)
394                 rte_pktmbuf_free(m);
395         if (clone)
396                 rte_pktmbuf_free(clone);
397         if (clone2)
398                 rte_pktmbuf_free(clone2);
399         return -1;
400 }
401
402 static int
403 test_attach_from_different_pool(struct rte_mempool *pktmbuf_pool,
404                                 struct rte_mempool *pktmbuf_pool2)
405 {
406         struct rte_mbuf *m = NULL;
407         struct rte_mbuf *clone = NULL;
408         struct rte_mbuf *clone2 = NULL;
409         char *data, *c_data, *c_data2;
410
411         /* alloc a mbuf */
412         m = rte_pktmbuf_alloc(pktmbuf_pool);
413         if (m == NULL)
414                 GOTO_FAIL("cannot allocate mbuf");
415
416         if (rte_pktmbuf_pkt_len(m) != 0)
417                 GOTO_FAIL("Bad length");
418
419         data = rte_pktmbuf_mtod(m, char *);
420
421         /* allocate a new mbuf from the second pool, and attach it to the first
422          * mbuf */
423         clone = rte_pktmbuf_alloc(pktmbuf_pool2);
424         if (clone == NULL)
425                 GOTO_FAIL("cannot allocate mbuf from second pool\n");
426
427         /* check data room size and priv size, and erase priv */
428         if (rte_pktmbuf_data_room_size(clone->pool) != 0)
429                 GOTO_FAIL("data room size should be 0\n");
430         if (rte_pktmbuf_priv_size(clone->pool) != MBUF2_PRIV_SIZE)
431                 GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
432         memset(clone + 1, 0, MBUF2_PRIV_SIZE);
433
434         /* save data pointer to compare it after detach() */
435         c_data = rte_pktmbuf_mtod(clone, char *);
436         if (c_data != (char *)clone + sizeof(*clone) + MBUF2_PRIV_SIZE)
437                 GOTO_FAIL("bad data pointer in clone");
438         if (rte_pktmbuf_headroom(clone) != 0)
439                 GOTO_FAIL("bad headroom in clone");
440
441         rte_pktmbuf_attach(clone, m);
442
443         if (rte_pktmbuf_mtod(clone, char *) != data)
444                 GOTO_FAIL("clone was not attached properly\n");
445         if (rte_pktmbuf_headroom(clone) != RTE_PKTMBUF_HEADROOM)
446                 GOTO_FAIL("bad headroom in clone after attach");
447         if (rte_mbuf_refcnt_read(m) != 2)
448                 GOTO_FAIL("invalid refcnt in m\n");
449
450         /* allocate a new mbuf from the second pool, and attach it to the first
451          * cloned mbuf */
452         clone2 = rte_pktmbuf_alloc(pktmbuf_pool2);
453         if (clone2 == NULL)
454                 GOTO_FAIL("cannot allocate clone2 from second pool\n");
455
456         /* check data room size and priv size, and erase priv */
457         if (rte_pktmbuf_data_room_size(clone2->pool) != 0)
458                 GOTO_FAIL("data room size should be 0\n");
459         if (rte_pktmbuf_priv_size(clone2->pool) != MBUF2_PRIV_SIZE)
460                 GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
461         memset(clone2 + 1, 0, MBUF2_PRIV_SIZE);
462
463         /* save data pointer to compare it after detach() */
464         c_data2 = rte_pktmbuf_mtod(clone2, char *);
465         if (c_data2 != (char *)clone2 + sizeof(*clone2) + MBUF2_PRIV_SIZE)
466                 GOTO_FAIL("bad data pointer in clone2");
467         if (rte_pktmbuf_headroom(clone2) != 0)
468                 GOTO_FAIL("bad headroom in clone2");
469
470         rte_pktmbuf_attach(clone2, clone);
471
472         if (rte_pktmbuf_mtod(clone2, char *) != data)
473                 GOTO_FAIL("clone2 was not attached properly\n");
474         if (rte_pktmbuf_headroom(clone2) != RTE_PKTMBUF_HEADROOM)
475                 GOTO_FAIL("bad headroom in clone2 after attach");
476         if (rte_mbuf_refcnt_read(m) != 3)
477                 GOTO_FAIL("invalid refcnt in m\n");
478
479         /* detach the clones */
480         rte_pktmbuf_detach(clone);
481         if (c_data != rte_pktmbuf_mtod(clone, char *))
482                 GOTO_FAIL("clone was not detached properly\n");
483         if (rte_mbuf_refcnt_read(m) != 2)
484                 GOTO_FAIL("invalid refcnt in m\n");
485
486         rte_pktmbuf_detach(clone2);
487         if (c_data2 != rte_pktmbuf_mtod(clone2, char *))
488                 GOTO_FAIL("clone2 was not detached properly\n");
489         if (rte_mbuf_refcnt_read(m) != 1)
490                 GOTO_FAIL("invalid refcnt in m\n");
491
492         /* free the clones and the initial mbuf */
493         rte_pktmbuf_free(clone2);
494         rte_pktmbuf_free(clone);
495         rte_pktmbuf_free(m);
496         printf("%s ok\n", __func__);
497         return 0;
498
499 fail:
500         if (m)
501                 rte_pktmbuf_free(m);
502         if (clone)
503                 rte_pktmbuf_free(clone);
504         if (clone2)
505                 rte_pktmbuf_free(clone2);
506         return -1;
507 }
508 #undef GOTO_FAIL
509
510 /*
511  * test allocation and free of mbufs
512  */
513 static int
514 test_pktmbuf_pool(struct rte_mempool *pktmbuf_pool)
515 {
516         unsigned i;
517         struct rte_mbuf *m[NB_MBUF];
518         int ret = 0;
519
520         for (i=0; i<NB_MBUF; i++)
521                 m[i] = NULL;
522
523         /* alloc NB_MBUF mbufs */
524         for (i=0; i<NB_MBUF; i++) {
525                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
526                 if (m[i] == NULL) {
527                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
528                         ret = -1;
529                 }
530         }
531         struct rte_mbuf *extra = NULL;
532         extra = rte_pktmbuf_alloc(pktmbuf_pool);
533         if(extra != NULL) {
534                 printf("Error pool not empty");
535                 ret = -1;
536         }
537         extra = rte_pktmbuf_clone(m[0], pktmbuf_pool);
538         if(extra != NULL) {
539                 printf("Error pool not empty");
540                 ret = -1;
541         }
542         /* free them */
543         for (i=0; i<NB_MBUF; i++) {
544                 if (m[i] != NULL)
545                         rte_pktmbuf_free(m[i]);
546         }
547
548         return ret;
549 }
550
551 /*
552  * test that the pointer to the data on a packet mbuf is set properly
553  */
554 static int
555 test_pktmbuf_pool_ptr(struct rte_mempool *pktmbuf_pool)
556 {
557         unsigned i;
558         struct rte_mbuf *m[NB_MBUF];
559         int ret = 0;
560
561         for (i=0; i<NB_MBUF; i++)
562                 m[i] = NULL;
563
564         /* alloc NB_MBUF mbufs */
565         for (i=0; i<NB_MBUF; i++) {
566                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
567                 if (m[i] == NULL) {
568                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
569                         ret = -1;
570                         break;
571                 }
572                 m[i]->data_off += 64;
573         }
574
575         /* free them */
576         for (i=0; i<NB_MBUF; i++) {
577                 if (m[i] != NULL)
578                         rte_pktmbuf_free(m[i]);
579         }
580
581         for (i=0; i<NB_MBUF; i++)
582                 m[i] = NULL;
583
584         /* alloc NB_MBUF mbufs */
585         for (i=0; i<NB_MBUF; i++) {
586                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
587                 if (m[i] == NULL) {
588                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
589                         ret = -1;
590                         break;
591                 }
592                 if (m[i]->data_off != RTE_PKTMBUF_HEADROOM) {
593                         printf("invalid data_off\n");
594                         ret = -1;
595                 }
596         }
597
598         /* free them */
599         for (i=0; i<NB_MBUF; i++) {
600                 if (m[i] != NULL)
601                         rte_pktmbuf_free(m[i]);
602         }
603
604         return ret;
605 }
606
607 static int
608 test_pktmbuf_free_segment(struct rte_mempool *pktmbuf_pool)
609 {
610         unsigned i;
611         struct rte_mbuf *m[NB_MBUF];
612         int ret = 0;
613
614         for (i=0; i<NB_MBUF; i++)
615                 m[i] = NULL;
616
617         /* alloc NB_MBUF mbufs */
618         for (i=0; i<NB_MBUF; i++) {
619                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
620                 if (m[i] == NULL) {
621                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
622                         ret = -1;
623                 }
624         }
625
626         /* free them */
627         for (i=0; i<NB_MBUF; i++) {
628                 if (m[i] != NULL) {
629                         struct rte_mbuf *mb, *mt;
630
631                         mb = m[i];
632                         while(mb != NULL) {
633                                 mt = mb;
634                                 mb = mb->next;
635                                 rte_pktmbuf_free_seg(mt);
636                         }
637                 }
638         }
639
640         return ret;
641 }
642
643 /*
644  * Stress test for rte_mbuf atomic refcnt.
645  * Implies that RTE_MBUF_REFCNT_ATOMIC is defined.
646  * For more efficiency, recommended to run with RTE_LIBRTE_MBUF_DEBUG defined.
647  */
648
649 #ifdef RTE_MBUF_REFCNT_ATOMIC
650
651 static int
652 test_refcnt_slave(void *arg)
653 {
654         unsigned lcore, free;
655         void *mp = 0;
656         struct rte_ring *refcnt_mbuf_ring = arg;
657
658         lcore = rte_lcore_id();
659         printf("%s started at lcore %u\n", __func__, lcore);
660
661         free = 0;
662         while (refcnt_stop_slaves == 0) {
663                 if (rte_ring_dequeue(refcnt_mbuf_ring, &mp) == 0) {
664                         free++;
665                         rte_pktmbuf_free(mp);
666                 }
667         }
668
669         refcnt_lcore[lcore] += free;
670         printf("%s finished at lcore %u, "
671                "number of freed mbufs: %u\n",
672                __func__, lcore, free);
673         return 0;
674 }
675
676 static void
677 test_refcnt_iter(unsigned int lcore, unsigned int iter,
678                  struct rte_mempool *refcnt_pool,
679                  struct rte_ring *refcnt_mbuf_ring)
680 {
681         uint16_t ref;
682         unsigned i, n, tref, wn;
683         struct rte_mbuf *m;
684
685         tref = 0;
686
687         /* For each mbuf in the pool:
688          * - allocate mbuf,
689          * - increment it's reference up to N+1,
690          * - enqueue it N times into the ring for slave cores to free.
691          */
692         for (i = 0, n = rte_mempool_avail_count(refcnt_pool);
693             i != n && (m = rte_pktmbuf_alloc(refcnt_pool)) != NULL;
694             i++) {
695                 ref = RTE_MAX(rte_rand() % REFCNT_MAX_REF, 1UL);
696                 tref += ref;
697                 if ((ref & 1) != 0) {
698                         rte_pktmbuf_refcnt_update(m, ref);
699                         while (ref-- != 0)
700                                 rte_ring_enqueue(refcnt_mbuf_ring, m);
701                 } else {
702                         while (ref-- != 0) {
703                                 rte_pktmbuf_refcnt_update(m, 1);
704                                 rte_ring_enqueue(refcnt_mbuf_ring, m);
705                         }
706                 }
707                 rte_pktmbuf_free(m);
708         }
709
710         if (i != n)
711                 rte_panic("(lcore=%u, iter=%u): was able to allocate only "
712                           "%u from %u mbufs\n", lcore, iter, i, n);
713
714         /* wait till slave lcores  will consume all mbufs */
715         while (!rte_ring_empty(refcnt_mbuf_ring))
716                 ;
717
718         /* check that all mbufs are back into mempool by now */
719         for (wn = 0; wn != REFCNT_MAX_TIMEOUT; wn++) {
720                 if ((i = rte_mempool_avail_count(refcnt_pool)) == n) {
721                         refcnt_lcore[lcore] += tref;
722                         printf("%s(lcore=%u, iter=%u) completed, "
723                             "%u references processed\n",
724                             __func__, lcore, iter, tref);
725                         return;
726                 }
727                 rte_delay_ms(100);
728         }
729
730         rte_panic("(lcore=%u, iter=%u): after %us only "
731                   "%u of %u mbufs left free\n", lcore, iter, wn, i, n);
732 }
733
734 static int
735 test_refcnt_master(struct rte_mempool *refcnt_pool,
736                    struct rte_ring *refcnt_mbuf_ring)
737 {
738         unsigned i, lcore;
739
740         lcore = rte_lcore_id();
741         printf("%s started at lcore %u\n", __func__, lcore);
742
743         for (i = 0; i != REFCNT_MAX_ITER; i++)
744                 test_refcnt_iter(lcore, i, refcnt_pool, refcnt_mbuf_ring);
745
746         refcnt_stop_slaves = 1;
747         rte_wmb();
748
749         printf("%s finished at lcore %u\n", __func__, lcore);
750         return 0;
751 }
752
753 #endif
754
755 static int
756 test_refcnt_mbuf(void)
757 {
758 #ifdef RTE_MBUF_REFCNT_ATOMIC
759         unsigned int master, slave, tref;
760         int ret = -1;
761         struct rte_mempool *refcnt_pool = NULL;
762         struct rte_ring *refcnt_mbuf_ring = NULL;
763
764         if (rte_lcore_count() < 2) {
765                 printf("Not enough cores for test_refcnt_mbuf, expecting at least 2\n");
766                 return TEST_SKIPPED;
767         }
768
769         printf("starting %s, at %u lcores\n", __func__, rte_lcore_count());
770
771         /* create refcnt pool & ring if they don't exist */
772
773         refcnt_pool = rte_pktmbuf_pool_create(MAKE_STRING(refcnt_pool),
774                                               REFCNT_MBUF_NUM, 0, 0, 0,
775                                               SOCKET_ID_ANY);
776         if (refcnt_pool == NULL) {
777                 printf("%s: cannot allocate " MAKE_STRING(refcnt_pool) "\n",
778                     __func__);
779                 return -1;
780         }
781
782         refcnt_mbuf_ring = rte_ring_create("refcnt_mbuf_ring",
783                         rte_align32pow2(REFCNT_RING_SIZE), SOCKET_ID_ANY,
784                                         RING_F_SP_ENQ);
785         if (refcnt_mbuf_ring == NULL) {
786                 printf("%s: cannot allocate " MAKE_STRING(refcnt_mbuf_ring)
787                     "\n", __func__);
788                 goto err;
789         }
790
791         refcnt_stop_slaves = 0;
792         memset(refcnt_lcore, 0, sizeof (refcnt_lcore));
793
794         rte_eal_mp_remote_launch(test_refcnt_slave, refcnt_mbuf_ring,
795                                  SKIP_MASTER);
796
797         test_refcnt_master(refcnt_pool, refcnt_mbuf_ring);
798
799         rte_eal_mp_wait_lcore();
800
801         /* check that we porcessed all references */
802         tref = 0;
803         master = rte_get_master_lcore();
804
805         RTE_LCORE_FOREACH_SLAVE(slave)
806                 tref += refcnt_lcore[slave];
807
808         if (tref != refcnt_lcore[master])
809                 rte_panic("refernced mbufs: %u, freed mbufs: %u\n",
810                           tref, refcnt_lcore[master]);
811
812         rte_mempool_dump(stdout, refcnt_pool);
813         rte_ring_dump(stdout, refcnt_mbuf_ring);
814
815         ret = 0;
816
817 err:
818         rte_mempool_free(refcnt_pool);
819         rte_ring_free(refcnt_mbuf_ring);
820         return ret;
821 #else
822         return 0;
823 #endif
824 }
825
826 #include <unistd.h>
827 #include <sys/wait.h>
828
829 /* use fork() to test mbuf errors panic */
830 static int
831 verify_mbuf_check_panics(struct rte_mbuf *buf)
832 {
833         int pid;
834         int status;
835
836         pid = fork();
837
838         if (pid == 0) {
839                 rte_mbuf_sanity_check(buf, 1); /* should panic */
840                 exit(0);  /* return normally if it doesn't panic */
841         } else if (pid < 0){
842                 printf("Fork Failed\n");
843                 return -1;
844         }
845         wait(&status);
846         if(status == 0)
847                 return -1;
848
849         return 0;
850 }
851
852 static int
853 test_failing_mbuf_sanity_check(struct rte_mempool *pktmbuf_pool)
854 {
855         struct rte_mbuf *buf;
856         struct rte_mbuf badbuf;
857
858         printf("Checking rte_mbuf_sanity_check for failure conditions\n");
859
860         /* get a good mbuf to use to make copies */
861         buf = rte_pktmbuf_alloc(pktmbuf_pool);
862         if (buf == NULL)
863                 return -1;
864         printf("Checking good mbuf initially\n");
865         if (verify_mbuf_check_panics(buf) != -1)
866                 return -1;
867
868         printf("Now checking for error conditions\n");
869
870         if (verify_mbuf_check_panics(NULL)) {
871                 printf("Error with NULL mbuf test\n");
872                 return -1;
873         }
874
875         badbuf = *buf;
876         badbuf.pool = NULL;
877         if (verify_mbuf_check_panics(&badbuf)) {
878                 printf("Error with bad-pool mbuf test\n");
879                 return -1;
880         }
881
882         badbuf = *buf;
883         badbuf.buf_iova = 0;
884         if (verify_mbuf_check_panics(&badbuf)) {
885                 printf("Error with bad-physaddr mbuf test\n");
886                 return -1;
887         }
888
889         badbuf = *buf;
890         badbuf.buf_addr = NULL;
891         if (verify_mbuf_check_panics(&badbuf)) {
892                 printf("Error with bad-addr mbuf test\n");
893                 return -1;
894         }
895
896         badbuf = *buf;
897         badbuf.refcnt = 0;
898         if (verify_mbuf_check_panics(&badbuf)) {
899                 printf("Error with bad-refcnt(0) mbuf test\n");
900                 return -1;
901         }
902
903         badbuf = *buf;
904         badbuf.refcnt = UINT16_MAX;
905         if (verify_mbuf_check_panics(&badbuf)) {
906                 printf("Error with bad-refcnt(MAX) mbuf test\n");
907                 return -1;
908         }
909
910         return 0;
911 }
912
913 static int
914 test_mbuf_linearize(struct rte_mempool *pktmbuf_pool, int pkt_len,
915                     int nb_segs)
916 {
917
918         struct rte_mbuf *m = NULL, *mbuf = NULL;
919         uint8_t *data;
920         int data_len = 0;
921         int remain;
922         int seg, seg_len;
923         int i;
924
925         if (pkt_len < 1) {
926                 printf("Packet size must be 1 or more (is %d)\n", pkt_len);
927                 return -1;
928         }
929
930         if (nb_segs < 1) {
931                 printf("Number of segments must be 1 or more (is %d)\n",
932                                 nb_segs);
933                 return -1;
934         }
935
936         seg_len = pkt_len / nb_segs;
937         if (seg_len == 0)
938                 seg_len = 1;
939
940         remain = pkt_len;
941
942         /* Create chained mbuf_src and fill it generated data */
943         for (seg = 0; remain > 0; seg++) {
944
945                 m = rte_pktmbuf_alloc(pktmbuf_pool);
946                 if (m == NULL) {
947                         printf("Cannot create segment for source mbuf");
948                         goto fail;
949                 }
950
951                 /* Make sure if tailroom is zeroed */
952                 memset(rte_pktmbuf_mtod(m, uint8_t *), 0,
953                                 rte_pktmbuf_tailroom(m));
954
955                 data_len = remain;
956                 if (data_len > seg_len)
957                         data_len = seg_len;
958
959                 data = (uint8_t *)rte_pktmbuf_append(m, data_len);
960                 if (data == NULL) {
961                         printf("Cannot append %d bytes to the mbuf\n",
962                                         data_len);
963                         goto fail;
964                 }
965
966                 for (i = 0; i < data_len; i++)
967                         data[i] = (seg * seg_len + i) % 0x0ff;
968
969                 if (seg == 0)
970                         mbuf = m;
971                 else
972                         rte_pktmbuf_chain(mbuf, m);
973
974                 remain -= data_len;
975         }
976
977         /* Create destination buffer to store coalesced data */
978         if (rte_pktmbuf_linearize(mbuf)) {
979                 printf("Mbuf linearization failed\n");
980                 goto fail;
981         }
982
983         if (!rte_pktmbuf_is_contiguous(mbuf)) {
984                 printf("Source buffer should be contiguous after "
985                                 "linearization\n");
986                 goto fail;
987         }
988
989         data = rte_pktmbuf_mtod(mbuf, uint8_t *);
990
991         for (i = 0; i < pkt_len; i++)
992                 if (data[i] != (i % 0x0ff)) {
993                         printf("Incorrect data in linearized mbuf\n");
994                         goto fail;
995                 }
996
997         rte_pktmbuf_free(mbuf);
998         return 0;
999
1000 fail:
1001         if (mbuf)
1002                 rte_pktmbuf_free(mbuf);
1003         return -1;
1004 }
1005
1006 static int
1007 test_mbuf_linearize_check(struct rte_mempool *pktmbuf_pool)
1008 {
1009         struct test_mbuf_array {
1010                 int size;
1011                 int nb_segs;
1012         } mbuf_array[] = {
1013                         { 128, 1 },
1014                         { 64, 64 },
1015                         { 512, 10 },
1016                         { 250, 11 },
1017                         { 123, 8 },
1018         };
1019         unsigned int i;
1020
1021         printf("Test mbuf linearize API\n");
1022
1023         for (i = 0; i < RTE_DIM(mbuf_array); i++)
1024                 if (test_mbuf_linearize(pktmbuf_pool, mbuf_array[i].size,
1025                                 mbuf_array[i].nb_segs)) {
1026                         printf("Test failed for %d, %d\n", mbuf_array[i].size,
1027                                         mbuf_array[i].nb_segs);
1028                         return -1;
1029                 }
1030
1031         return 0;
1032 }
1033
1034 /*
1035  * Helper function for test_tx_ofload
1036  */
1037 static inline void
1038 set_tx_offload(struct rte_mbuf *mb, uint64_t il2, uint64_t il3, uint64_t il4,
1039         uint64_t tso, uint64_t ol3, uint64_t ol2)
1040 {
1041         mb->l2_len = il2;
1042         mb->l3_len = il3;
1043         mb->l4_len = il4;
1044         mb->tso_segsz = tso;
1045         mb->outer_l3_len = ol3;
1046         mb->outer_l2_len = ol2;
1047 }
1048
1049 static int
1050 test_tx_offload(void)
1051 {
1052         struct rte_mbuf *mb;
1053         uint64_t tm, v1, v2;
1054         size_t sz;
1055         uint32_t i;
1056
1057         static volatile struct {
1058                 uint16_t l2;
1059                 uint16_t l3;
1060                 uint16_t l4;
1061                 uint16_t tso;
1062         } txof;
1063
1064         const uint32_t num = 0x10000;
1065
1066         txof.l2 = rte_rand() % (1 <<  RTE_MBUF_L2_LEN_BITS);
1067         txof.l3 = rte_rand() % (1 <<  RTE_MBUF_L3_LEN_BITS);
1068         txof.l4 = rte_rand() % (1 <<  RTE_MBUF_L4_LEN_BITS);
1069         txof.tso = rte_rand() % (1 <<   RTE_MBUF_TSO_SEGSZ_BITS);
1070
1071         printf("%s started, tx_offload = {\n"
1072                 "\tl2_len=%#hx,\n"
1073                 "\tl3_len=%#hx,\n"
1074                 "\tl4_len=%#hx,\n"
1075                 "\ttso_segsz=%#hx,\n"
1076                 "\touter_l3_len=%#x,\n"
1077                 "\touter_l2_len=%#x,\n"
1078                 "};\n",
1079                 __func__,
1080                 txof.l2, txof.l3, txof.l4, txof.tso, txof.l3, txof.l2);
1081
1082         sz = sizeof(*mb) * num;
1083         mb = rte_zmalloc(NULL, sz, RTE_CACHE_LINE_SIZE);
1084         if (mb == NULL) {
1085                 printf("%s failed, out of memory\n", __func__);
1086                 return -ENOMEM;
1087         }
1088
1089         memset(mb, 0, sz);
1090         tm = rte_rdtsc_precise();
1091
1092         for (i = 0; i != num; i++)
1093                 set_tx_offload(mb + i, txof.l2, txof.l3, txof.l4,
1094                         txof.tso, txof.l3, txof.l2);
1095
1096         tm = rte_rdtsc_precise() - tm;
1097         printf("%s set tx_offload by bit-fields: %u iterations, %"
1098                 PRIu64 " cycles, %#Lf cycles/iter\n",
1099                 __func__, num, tm, (long double)tm / num);
1100
1101         v1 = mb[rte_rand() % num].tx_offload;
1102
1103         memset(mb, 0, sz);
1104         tm = rte_rdtsc_precise();
1105
1106         for (i = 0; i != num; i++)
1107                 mb[i].tx_offload = rte_mbuf_tx_offload(txof.l2, txof.l3,
1108                         txof.l4, txof.tso, txof.l3, txof.l2, 0);
1109
1110         tm = rte_rdtsc_precise() - tm;
1111         printf("%s set raw tx_offload: %u iterations, %"
1112                 PRIu64 " cycles, %#Lf cycles/iter\n",
1113                 __func__, num, tm, (long double)tm / num);
1114
1115         v2 = mb[rte_rand() % num].tx_offload;
1116
1117         rte_free(mb);
1118
1119         printf("%s finished\n"
1120                 "expected tx_offload value: 0x%" PRIx64 ";\n"
1121                 "rte_mbuf_tx_offload value: 0x%" PRIx64 ";\n",
1122                 __func__, v1, v2);
1123
1124         return (v1 == v2) ? 0 : -EINVAL;
1125 }
1126
1127 static int
1128 test_mbuf(void)
1129 {
1130         int ret = -1;
1131         struct rte_mempool *pktmbuf_pool = NULL;
1132         struct rte_mempool *pktmbuf_pool2 = NULL;
1133
1134
1135         RTE_BUILD_BUG_ON(sizeof(struct rte_mbuf) != RTE_CACHE_LINE_MIN_SIZE * 2);
1136
1137         /* create pktmbuf pool if it does not exist */
1138         pktmbuf_pool = rte_pktmbuf_pool_create("test_pktmbuf_pool",
1139                         NB_MBUF, 32, 0, MBUF_DATA_SIZE, SOCKET_ID_ANY);
1140
1141         if (pktmbuf_pool == NULL) {
1142                 printf("cannot allocate mbuf pool\n");
1143                 goto err;
1144         }
1145
1146         /* create a specific pktmbuf pool with a priv_size != 0 and no data
1147          * room size */
1148         pktmbuf_pool2 = rte_pktmbuf_pool_create("test_pktmbuf_pool2",
1149                         NB_MBUF, 32, MBUF2_PRIV_SIZE, 0, SOCKET_ID_ANY);
1150
1151         if (pktmbuf_pool2 == NULL) {
1152                 printf("cannot allocate mbuf pool\n");
1153                 goto err;
1154         }
1155
1156         /* test multiple mbuf alloc */
1157         if (test_pktmbuf_pool(pktmbuf_pool) < 0) {
1158                 printf("test_mbuf_pool() failed\n");
1159                 goto err;
1160         }
1161
1162         /* do it another time to check that all mbufs were freed */
1163         if (test_pktmbuf_pool(pktmbuf_pool) < 0) {
1164                 printf("test_mbuf_pool() failed (2)\n");
1165                 goto err;
1166         }
1167
1168         /* test that the pointer to the data on a packet mbuf is set properly */
1169         if (test_pktmbuf_pool_ptr(pktmbuf_pool) < 0) {
1170                 printf("test_pktmbuf_pool_ptr() failed\n");
1171                 goto err;
1172         }
1173
1174         /* test data manipulation in mbuf */
1175         if (test_one_pktmbuf(pktmbuf_pool) < 0) {
1176                 printf("test_one_mbuf() failed\n");
1177                 goto err;
1178         }
1179
1180
1181         /*
1182          * do it another time, to check that allocation reinitialize
1183          * the mbuf correctly
1184          */
1185         if (test_one_pktmbuf(pktmbuf_pool) < 0) {
1186                 printf("test_one_mbuf() failed (2)\n");
1187                 goto err;
1188         }
1189
1190         if (test_pktmbuf_with_non_ascii_data(pktmbuf_pool) < 0) {
1191                 printf("test_pktmbuf_with_non_ascii_data() failed\n");
1192                 goto err;
1193         }
1194
1195         /* test free pktmbuf segment one by one */
1196         if (test_pktmbuf_free_segment(pktmbuf_pool) < 0) {
1197                 printf("test_pktmbuf_free_segment() failed.\n");
1198                 goto err;
1199         }
1200
1201         if (testclone_testupdate_testdetach(pktmbuf_pool) < 0) {
1202                 printf("testclone_and_testupdate() failed \n");
1203                 goto err;
1204         }
1205
1206         if (test_attach_from_different_pool(pktmbuf_pool, pktmbuf_pool2) < 0) {
1207                 printf("test_attach_from_different_pool() failed\n");
1208                 goto err;
1209         }
1210
1211         if (test_refcnt_mbuf() < 0) {
1212                 printf("test_refcnt_mbuf() failed \n");
1213                 goto err;
1214         }
1215
1216         if (test_failing_mbuf_sanity_check(pktmbuf_pool) < 0) {
1217                 printf("test_failing_mbuf_sanity_check() failed\n");
1218                 goto err;
1219         }
1220
1221         if (test_mbuf_linearize_check(pktmbuf_pool) < 0) {
1222                 printf("test_mbuf_linearize_check() failed\n");
1223                 goto err;
1224         }
1225
1226         if (test_tx_offload() < 0) {
1227                 printf("test_tx_offload() failed\n");
1228                 goto err;
1229         }
1230
1231         ret = 0;
1232 err:
1233         rte_mempool_free(pktmbuf_pool);
1234         rte_mempool_free(pktmbuf_pool2);
1235         return ret;
1236 }
1237
1238 REGISTER_TEST_COMMAND(mbuf_autotest, test_mbuf);