test/mbuf: skip field registration at busy offset
[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_errno.h>
16 #include <rte_debug.h>
17 #include <rte_log.h>
18 #include <rte_memory.h>
19 #include <rte_memcpy.h>
20 #include <rte_launch.h>
21 #include <rte_eal.h>
22 #include <rte_per_lcore.h>
23 #include <rte_lcore.h>
24 #include <rte_atomic.h>
25 #include <rte_branch_prediction.h>
26 #include <rte_ring.h>
27 #include <rte_mempool.h>
28 #include <rte_mbuf.h>
29 #include <rte_random.h>
30 #include <rte_cycles.h>
31 #include <rte_malloc.h>
32 #include <rte_ether.h>
33 #include <rte_ip.h>
34 #include <rte_tcp.h>
35 #include <rte_mbuf_dyn.h>
36
37 #include "test.h"
38
39 #define MEMPOOL_CACHE_SIZE      32
40 #define MBUF_DATA_SIZE          2048
41 #define NB_MBUF                 128
42 #define MBUF_TEST_DATA_LEN      1464
43 #define MBUF_TEST_DATA_LEN2     50
44 #define MBUF_TEST_DATA_LEN3     256
45 #define MBUF_TEST_HDR1_LEN      20
46 #define MBUF_TEST_HDR2_LEN      30
47 #define MBUF_TEST_ALL_HDRS_LEN  (MBUF_TEST_HDR1_LEN+MBUF_TEST_HDR2_LEN)
48 #define MBUF_TEST_SEG_SIZE      64
49 #define MBUF_TEST_BURST         8
50 #define EXT_BUF_TEST_DATA_LEN   1024
51 #define MBUF_MAX_SEG            16
52 #define MBUF_NO_HEADER          0
53 #define MBUF_HEADER             1
54 #define MBUF_NEG_TEST_READ      2
55 #define VAL_NAME(flag)          { flag, #flag }
56
57 /* chain length in bulk test */
58 #define CHAIN_LEN 16
59
60 /* size of private data for mbuf in pktmbuf_pool2 */
61 #define MBUF2_PRIV_SIZE         128
62
63 #define REFCNT_MAX_ITER         64
64 #define REFCNT_MAX_TIMEOUT      10
65 #define REFCNT_MAX_REF          (RTE_MAX_LCORE)
66 #define REFCNT_MBUF_NUM         64
67 #define REFCNT_RING_SIZE        (REFCNT_MBUF_NUM * REFCNT_MAX_REF)
68
69 #define MAGIC_DATA              0x42424242
70
71 #define MAKE_STRING(x)          # x
72
73 #ifdef RTE_MBUF_REFCNT_ATOMIC
74
75 static volatile uint32_t refcnt_stop_workers;
76 static unsigned refcnt_lcore[RTE_MAX_LCORE];
77
78 #endif
79
80 /*
81  * MBUF
82  * ====
83  *
84  * #. Allocate a mbuf pool.
85  *
86  *    - The pool contains NB_MBUF elements, where each mbuf is MBUF_SIZE
87  *      bytes long.
88  *
89  * #. Test multiple allocations of mbufs from this pool.
90  *
91  *    - Allocate NB_MBUF and store pointers in a table.
92  *    - If an allocation fails, return an error.
93  *    - Free all these mbufs.
94  *    - Repeat the same test to check that mbufs were freed correctly.
95  *
96  * #. Test data manipulation in pktmbuf.
97  *
98  *    - Alloc an mbuf.
99  *    - Append data using rte_pktmbuf_append().
100  *    - Test for error in rte_pktmbuf_append() when len is too large.
101  *    - Trim data at the end of mbuf using rte_pktmbuf_trim().
102  *    - Test for error in rte_pktmbuf_trim() when len is too large.
103  *    - Prepend a header using rte_pktmbuf_prepend().
104  *    - Test for error in rte_pktmbuf_prepend() when len is too large.
105  *    - Remove data at the beginning of mbuf using rte_pktmbuf_adj().
106  *    - Test for error in rte_pktmbuf_adj() when len is too large.
107  *    - Check that appended data is not corrupt.
108  *    - Free the mbuf.
109  *    - Between all these tests, check data_len and pkt_len, and
110  *      that the mbuf is contiguous.
111  *    - Repeat the test to check that allocation operations
112  *      reinitialize the mbuf correctly.
113  *
114  * #. Test packet cloning
115  *    - Clone a mbuf and verify the data
116  *    - Clone the cloned mbuf and verify the data
117  *    - Attach a mbuf to another that does not have the same priv_size.
118  */
119
120 #define GOTO_FAIL(str, ...) do {                                        \
121                 printf("mbuf test FAILED (l.%d): <" str ">\n",          \
122                        __LINE__,  ##__VA_ARGS__);                       \
123                 goto fail;                                              \
124 } while(0)
125
126 /*
127  * test data manipulation in mbuf with non-ascii data
128  */
129 static int
130 test_pktmbuf_with_non_ascii_data(struct rte_mempool *pktmbuf_pool)
131 {
132         struct rte_mbuf *m = NULL;
133         char *data;
134
135         m = rte_pktmbuf_alloc(pktmbuf_pool);
136         if (m == NULL)
137                 GOTO_FAIL("Cannot allocate mbuf");
138         if (rte_pktmbuf_pkt_len(m) != 0)
139                 GOTO_FAIL("Bad length");
140
141         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN);
142         if (data == NULL)
143                 GOTO_FAIL("Cannot append data");
144         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
145                 GOTO_FAIL("Bad pkt length");
146         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
147                 GOTO_FAIL("Bad data length");
148         memset(data, 0xff, rte_pktmbuf_pkt_len(m));
149         if (!rte_pktmbuf_is_contiguous(m))
150                 GOTO_FAIL("Buffer should be continuous");
151         rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
152
153         rte_pktmbuf_free(m);
154
155         return 0;
156
157 fail:
158         if(m) {
159                 rte_pktmbuf_free(m);
160         }
161         return -1;
162 }
163
164 /*
165  * test data manipulation in mbuf
166  */
167 static int
168 test_one_pktmbuf(struct rte_mempool *pktmbuf_pool)
169 {
170         struct rte_mbuf *m = NULL;
171         char *data, *data2, *hdr;
172         unsigned i;
173
174         printf("Test pktmbuf API\n");
175
176         /* alloc a mbuf */
177
178         m = rte_pktmbuf_alloc(pktmbuf_pool);
179         if (m == NULL)
180                 GOTO_FAIL("Cannot allocate mbuf");
181         if (rte_pktmbuf_pkt_len(m) != 0)
182                 GOTO_FAIL("Bad length");
183
184         rte_pktmbuf_dump(stdout, m, 0);
185
186         /* append data */
187
188         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN);
189         if (data == NULL)
190                 GOTO_FAIL("Cannot append data");
191         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
192                 GOTO_FAIL("Bad pkt length");
193         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
194                 GOTO_FAIL("Bad data length");
195         memset(data, 0x66, rte_pktmbuf_pkt_len(m));
196         if (!rte_pktmbuf_is_contiguous(m))
197                 GOTO_FAIL("Buffer should be continuous");
198         rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
199         rte_pktmbuf_dump(stdout, m, 2*MBUF_TEST_DATA_LEN);
200
201         /* this append should fail */
202
203         data2 = rte_pktmbuf_append(m, (uint16_t)(rte_pktmbuf_tailroom(m) + 1));
204         if (data2 != NULL)
205                 GOTO_FAIL("Append should not succeed");
206
207         /* append some more data */
208
209         data2 = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN2);
210         if (data2 == NULL)
211                 GOTO_FAIL("Cannot append data");
212         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_DATA_LEN2)
213                 GOTO_FAIL("Bad pkt length");
214         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_DATA_LEN2)
215                 GOTO_FAIL("Bad data length");
216         if (!rte_pktmbuf_is_contiguous(m))
217                 GOTO_FAIL("Buffer should be continuous");
218
219         /* trim data at the end of mbuf */
220
221         if (rte_pktmbuf_trim(m, MBUF_TEST_DATA_LEN2) < 0)
222                 GOTO_FAIL("Cannot trim data");
223         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
224                 GOTO_FAIL("Bad pkt length");
225         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
226                 GOTO_FAIL("Bad data length");
227         if (!rte_pktmbuf_is_contiguous(m))
228                 GOTO_FAIL("Buffer should be continuous");
229
230         /* this trim should fail */
231
232         if (rte_pktmbuf_trim(m, (uint16_t)(rte_pktmbuf_data_len(m) + 1)) == 0)
233                 GOTO_FAIL("trim should not succeed");
234
235         /* prepend one header */
236
237         hdr = rte_pktmbuf_prepend(m, MBUF_TEST_HDR1_LEN);
238         if (hdr == NULL)
239                 GOTO_FAIL("Cannot prepend");
240         if (data - hdr != MBUF_TEST_HDR1_LEN)
241                 GOTO_FAIL("Prepend failed");
242         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_HDR1_LEN)
243                 GOTO_FAIL("Bad pkt length");
244         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_HDR1_LEN)
245                 GOTO_FAIL("Bad data length");
246         if (!rte_pktmbuf_is_contiguous(m))
247                 GOTO_FAIL("Buffer should be continuous");
248         memset(hdr, 0x55, MBUF_TEST_HDR1_LEN);
249
250         /* prepend another header */
251
252         hdr = rte_pktmbuf_prepend(m, MBUF_TEST_HDR2_LEN);
253         if (hdr == NULL)
254                 GOTO_FAIL("Cannot prepend");
255         if (data - hdr != MBUF_TEST_ALL_HDRS_LEN)
256                 GOTO_FAIL("Prepend failed");
257         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_ALL_HDRS_LEN)
258                 GOTO_FAIL("Bad pkt length");
259         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN + MBUF_TEST_ALL_HDRS_LEN)
260                 GOTO_FAIL("Bad data length");
261         if (!rte_pktmbuf_is_contiguous(m))
262                 GOTO_FAIL("Buffer should be continuous");
263         memset(hdr, 0x55, MBUF_TEST_HDR2_LEN);
264
265         rte_mbuf_sanity_check(m, 1);
266         rte_mbuf_sanity_check(m, 0);
267         rte_pktmbuf_dump(stdout, m, 0);
268
269         /* this prepend should fail */
270
271         hdr = rte_pktmbuf_prepend(m, (uint16_t)(rte_pktmbuf_headroom(m) + 1));
272         if (hdr != NULL)
273                 GOTO_FAIL("prepend should not succeed");
274
275         /* remove data at beginning of mbuf (adj) */
276
277         if (data != rte_pktmbuf_adj(m, MBUF_TEST_ALL_HDRS_LEN))
278                 GOTO_FAIL("rte_pktmbuf_adj failed");
279         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN)
280                 GOTO_FAIL("Bad pkt length");
281         if (rte_pktmbuf_data_len(m) != MBUF_TEST_DATA_LEN)
282                 GOTO_FAIL("Bad data length");
283         if (!rte_pktmbuf_is_contiguous(m))
284                 GOTO_FAIL("Buffer should be continuous");
285
286         /* this adj should fail */
287
288         if (rte_pktmbuf_adj(m, (uint16_t)(rte_pktmbuf_data_len(m) + 1)) != NULL)
289                 GOTO_FAIL("rte_pktmbuf_adj should not succeed");
290
291         /* check data */
292
293         if (!rte_pktmbuf_is_contiguous(m))
294                 GOTO_FAIL("Buffer should be continuous");
295
296         for (i=0; i<MBUF_TEST_DATA_LEN; i++) {
297                 if (data[i] != 0x66)
298                         GOTO_FAIL("Data corrupted at offset %u", i);
299         }
300
301         /* free mbuf */
302
303         rte_pktmbuf_free(m);
304         m = NULL;
305         return 0;
306
307 fail:
308         if (m)
309                 rte_pktmbuf_free(m);
310         return -1;
311 }
312
313 static uint16_t
314 testclone_refcnt_read(struct rte_mbuf *m)
315 {
316         return RTE_MBUF_HAS_PINNED_EXTBUF(m) ?
317                rte_mbuf_ext_refcnt_read(m->shinfo) :
318                rte_mbuf_refcnt_read(m);
319 }
320
321 static int
322 testclone_testupdate_testdetach(struct rte_mempool *pktmbuf_pool,
323                                 struct rte_mempool *clone_pool)
324 {
325         struct rte_mbuf *m = NULL;
326         struct rte_mbuf *clone = NULL;
327         struct rte_mbuf *clone2 = NULL;
328         unaligned_uint32_t *data;
329
330         /* alloc a mbuf */
331         m = rte_pktmbuf_alloc(pktmbuf_pool);
332         if (m == NULL)
333                 GOTO_FAIL("ooops not allocating mbuf");
334
335         if (rte_pktmbuf_pkt_len(m) != 0)
336                 GOTO_FAIL("Bad length");
337
338         rte_pktmbuf_append(m, sizeof(uint32_t));
339         data = rte_pktmbuf_mtod(m, unaligned_uint32_t *);
340         *data = MAGIC_DATA;
341
342         /* clone the allocated mbuf */
343         clone = rte_pktmbuf_clone(m, clone_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         if (testclone_refcnt_read(m) != 2)
352                 GOTO_FAIL("invalid refcnt in m\n");
353
354         /* free the clone */
355         rte_pktmbuf_free(clone);
356         clone = NULL;
357
358         /* same test with a chained mbuf */
359         m->next = rte_pktmbuf_alloc(pktmbuf_pool);
360         if (m->next == NULL)
361                 GOTO_FAIL("Next Pkt Null\n");
362         m->nb_segs = 2;
363
364         rte_pktmbuf_append(m->next, sizeof(uint32_t));
365         m->pkt_len = 2 * sizeof(uint32_t);
366
367         data = rte_pktmbuf_mtod(m->next, unaligned_uint32_t *);
368         *data = MAGIC_DATA;
369
370         clone = rte_pktmbuf_clone(m, clone_pool);
371         if (clone == NULL)
372                 GOTO_FAIL("cannot clone data\n");
373
374         data = rte_pktmbuf_mtod(clone, unaligned_uint32_t *);
375         if (*data != MAGIC_DATA)
376                 GOTO_FAIL("invalid data in clone\n");
377
378         data = rte_pktmbuf_mtod(clone->next, unaligned_uint32_t *);
379         if (*data != MAGIC_DATA)
380                 GOTO_FAIL("invalid data in clone->next\n");
381
382         if (testclone_refcnt_read(m) != 2)
383                 GOTO_FAIL("invalid refcnt in m\n");
384
385         if (testclone_refcnt_read(m->next) != 2)
386                 GOTO_FAIL("invalid refcnt in m->next\n");
387
388         /* try to clone the clone */
389
390         clone2 = rte_pktmbuf_clone(clone, clone_pool);
391         if (clone2 == NULL)
392                 GOTO_FAIL("cannot clone the clone\n");
393
394         data = rte_pktmbuf_mtod(clone2, unaligned_uint32_t *);
395         if (*data != MAGIC_DATA)
396                 GOTO_FAIL("invalid data in clone2\n");
397
398         data = rte_pktmbuf_mtod(clone2->next, unaligned_uint32_t *);
399         if (*data != MAGIC_DATA)
400                 GOTO_FAIL("invalid data in clone2->next\n");
401
402         if (testclone_refcnt_read(m) != 3)
403                 GOTO_FAIL("invalid refcnt in m\n");
404
405         if (testclone_refcnt_read(m->next) != 3)
406                 GOTO_FAIL("invalid refcnt in m->next\n");
407
408         /* free mbuf */
409         rte_pktmbuf_free(m);
410         rte_pktmbuf_free(clone);
411         rte_pktmbuf_free(clone2);
412
413         m = NULL;
414         clone = NULL;
415         clone2 = NULL;
416         printf("%s ok\n", __func__);
417         return 0;
418
419 fail:
420         if (m)
421                 rte_pktmbuf_free(m);
422         if (clone)
423                 rte_pktmbuf_free(clone);
424         if (clone2)
425                 rte_pktmbuf_free(clone2);
426         return -1;
427 }
428
429 static int
430 test_pktmbuf_copy(struct rte_mempool *pktmbuf_pool,
431                   struct rte_mempool *clone_pool)
432 {
433         struct rte_mbuf *m = NULL;
434         struct rte_mbuf *copy = NULL;
435         struct rte_mbuf *copy2 = NULL;
436         struct rte_mbuf *clone = NULL;
437         unaligned_uint32_t *data;
438
439         /* alloc a mbuf */
440         m = rte_pktmbuf_alloc(pktmbuf_pool);
441         if (m == NULL)
442                 GOTO_FAIL("ooops not allocating mbuf");
443
444         if (rte_pktmbuf_pkt_len(m) != 0)
445                 GOTO_FAIL("Bad length");
446
447         rte_pktmbuf_append(m, sizeof(uint32_t));
448         data = rte_pktmbuf_mtod(m, unaligned_uint32_t *);
449         *data = MAGIC_DATA;
450
451         /* copy the allocated mbuf */
452         copy = rte_pktmbuf_copy(m, pktmbuf_pool, 0, UINT32_MAX);
453         if (copy == NULL)
454                 GOTO_FAIL("cannot copy data\n");
455
456         if (rte_pktmbuf_pkt_len(copy) != sizeof(uint32_t))
457                 GOTO_FAIL("copy length incorrect\n");
458
459         if (rte_pktmbuf_data_len(copy) != sizeof(uint32_t))
460                 GOTO_FAIL("copy data length incorrect\n");
461
462         data = rte_pktmbuf_mtod(copy, unaligned_uint32_t *);
463         if (*data != MAGIC_DATA)
464                 GOTO_FAIL("invalid data in copy\n");
465
466         /* free the copy */
467         rte_pktmbuf_free(copy);
468         copy = NULL;
469
470         /* same test with a cloned mbuf */
471         clone = rte_pktmbuf_clone(m, clone_pool);
472         if (clone == NULL)
473                 GOTO_FAIL("cannot clone data\n");
474
475         if ((!RTE_MBUF_HAS_PINNED_EXTBUF(m) &&
476              !RTE_MBUF_CLONED(clone)) ||
477             (RTE_MBUF_HAS_PINNED_EXTBUF(m) &&
478              !RTE_MBUF_HAS_EXTBUF(clone)))
479                 GOTO_FAIL("clone did not give a cloned mbuf\n");
480
481         copy = rte_pktmbuf_copy(clone, pktmbuf_pool, 0, UINT32_MAX);
482         if (copy == NULL)
483                 GOTO_FAIL("cannot copy cloned mbuf\n");
484
485         if (RTE_MBUF_CLONED(copy))
486                 GOTO_FAIL("copy of clone is cloned?\n");
487
488         if (rte_pktmbuf_pkt_len(copy) != sizeof(uint32_t))
489                 GOTO_FAIL("copy clone length incorrect\n");
490
491         if (rte_pktmbuf_data_len(copy) != sizeof(uint32_t))
492                 GOTO_FAIL("copy clone data length incorrect\n");
493
494         data = rte_pktmbuf_mtod(copy, unaligned_uint32_t *);
495         if (*data != MAGIC_DATA)
496                 GOTO_FAIL("invalid data in clone copy\n");
497         rte_pktmbuf_free(clone);
498         rte_pktmbuf_free(copy);
499         copy = NULL;
500         clone = NULL;
501
502
503         /* same test with a chained mbuf */
504         m->next = rte_pktmbuf_alloc(pktmbuf_pool);
505         if (m->next == NULL)
506                 GOTO_FAIL("Next Pkt Null\n");
507         m->nb_segs = 2;
508
509         rte_pktmbuf_append(m->next, sizeof(uint32_t));
510         m->pkt_len = 2 * sizeof(uint32_t);
511         data = rte_pktmbuf_mtod(m->next, unaligned_uint32_t *);
512         *data = MAGIC_DATA + 1;
513
514         copy = rte_pktmbuf_copy(m, pktmbuf_pool, 0, UINT32_MAX);
515         if (copy == NULL)
516                 GOTO_FAIL("cannot copy data\n");
517
518         if (rte_pktmbuf_pkt_len(copy) != 2 * sizeof(uint32_t))
519                 GOTO_FAIL("chain copy length incorrect\n");
520
521         if (rte_pktmbuf_data_len(copy) != 2 * sizeof(uint32_t))
522                 GOTO_FAIL("chain copy data length incorrect\n");
523
524         data = rte_pktmbuf_mtod(copy, unaligned_uint32_t *);
525         if (data[0] != MAGIC_DATA || data[1] != MAGIC_DATA + 1)
526                 GOTO_FAIL("invalid data in copy\n");
527
528         rte_pktmbuf_free(copy2);
529
530         /* test offset copy */
531         copy2 = rte_pktmbuf_copy(copy, pktmbuf_pool,
532                                  sizeof(uint32_t), UINT32_MAX);
533         if (copy2 == NULL)
534                 GOTO_FAIL("cannot copy the copy\n");
535
536         if (rte_pktmbuf_pkt_len(copy2) != sizeof(uint32_t))
537                 GOTO_FAIL("copy with offset, length incorrect\n");
538
539         if (rte_pktmbuf_data_len(copy2) != sizeof(uint32_t))
540                 GOTO_FAIL("copy with offset, data length incorrect\n");
541
542         data = rte_pktmbuf_mtod(copy2, unaligned_uint32_t *);
543         if (data[0] != MAGIC_DATA + 1)
544                 GOTO_FAIL("copy with offset, invalid data\n");
545
546         rte_pktmbuf_free(copy2);
547
548         /* test truncation copy */
549         copy2 = rte_pktmbuf_copy(copy, pktmbuf_pool,
550                                  0, sizeof(uint32_t));
551         if (copy2 == NULL)
552                 GOTO_FAIL("cannot copy the copy\n");
553
554         if (rte_pktmbuf_pkt_len(copy2) != sizeof(uint32_t))
555                 GOTO_FAIL("copy with truncate, length incorrect\n");
556
557         if (rte_pktmbuf_data_len(copy2) != sizeof(uint32_t))
558                 GOTO_FAIL("copy with truncate, data length incorrect\n");
559
560         data = rte_pktmbuf_mtod(copy2, unaligned_uint32_t *);
561         if (data[0] != MAGIC_DATA)
562                 GOTO_FAIL("copy with truncate, invalid data\n");
563
564         /* free mbuf */
565         rte_pktmbuf_free(m);
566         rte_pktmbuf_free(copy);
567         rte_pktmbuf_free(copy2);
568
569         m = NULL;
570         copy = NULL;
571         copy2 = NULL;
572         printf("%s ok\n", __func__);
573         return 0;
574
575 fail:
576         if (m)
577                 rte_pktmbuf_free(m);
578         if (copy)
579                 rte_pktmbuf_free(copy);
580         if (copy2)
581                 rte_pktmbuf_free(copy2);
582         return -1;
583 }
584
585 static int
586 test_attach_from_different_pool(struct rte_mempool *pktmbuf_pool,
587                                 struct rte_mempool *pktmbuf_pool2)
588 {
589         struct rte_mbuf *m = NULL;
590         struct rte_mbuf *clone = NULL;
591         struct rte_mbuf *clone2 = NULL;
592         char *data, *c_data, *c_data2;
593
594         /* alloc a mbuf */
595         m = rte_pktmbuf_alloc(pktmbuf_pool);
596         if (m == NULL)
597                 GOTO_FAIL("cannot allocate mbuf");
598
599         if (rte_pktmbuf_pkt_len(m) != 0)
600                 GOTO_FAIL("Bad length");
601
602         data = rte_pktmbuf_mtod(m, char *);
603
604         /* allocate a new mbuf from the second pool, and attach it to the first
605          * mbuf */
606         clone = rte_pktmbuf_alloc(pktmbuf_pool2);
607         if (clone == NULL)
608                 GOTO_FAIL("cannot allocate mbuf from second pool\n");
609
610         /* check data room size and priv size, and erase priv */
611         if (rte_pktmbuf_data_room_size(clone->pool) != 0)
612                 GOTO_FAIL("data room size should be 0\n");
613         if (rte_pktmbuf_priv_size(clone->pool) != MBUF2_PRIV_SIZE)
614                 GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
615         memset(clone + 1, 0, MBUF2_PRIV_SIZE);
616
617         /* save data pointer to compare it after detach() */
618         c_data = rte_pktmbuf_mtod(clone, char *);
619         if (c_data != (char *)clone + sizeof(*clone) + MBUF2_PRIV_SIZE)
620                 GOTO_FAIL("bad data pointer in clone");
621         if (rte_pktmbuf_headroom(clone) != 0)
622                 GOTO_FAIL("bad headroom in clone");
623
624         rte_pktmbuf_attach(clone, m);
625
626         if (rte_pktmbuf_mtod(clone, char *) != data)
627                 GOTO_FAIL("clone was not attached properly\n");
628         if (rte_pktmbuf_headroom(clone) != RTE_PKTMBUF_HEADROOM)
629                 GOTO_FAIL("bad headroom in clone after attach");
630         if (rte_mbuf_refcnt_read(m) != 2)
631                 GOTO_FAIL("invalid refcnt in m\n");
632
633         /* allocate a new mbuf from the second pool, and attach it to the first
634          * cloned mbuf */
635         clone2 = rte_pktmbuf_alloc(pktmbuf_pool2);
636         if (clone2 == NULL)
637                 GOTO_FAIL("cannot allocate clone2 from second pool\n");
638
639         /* check data room size and priv size, and erase priv */
640         if (rte_pktmbuf_data_room_size(clone2->pool) != 0)
641                 GOTO_FAIL("data room size should be 0\n");
642         if (rte_pktmbuf_priv_size(clone2->pool) != MBUF2_PRIV_SIZE)
643                 GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
644         memset(clone2 + 1, 0, MBUF2_PRIV_SIZE);
645
646         /* save data pointer to compare it after detach() */
647         c_data2 = rte_pktmbuf_mtod(clone2, char *);
648         if (c_data2 != (char *)clone2 + sizeof(*clone2) + MBUF2_PRIV_SIZE)
649                 GOTO_FAIL("bad data pointer in clone2");
650         if (rte_pktmbuf_headroom(clone2) != 0)
651                 GOTO_FAIL("bad headroom in clone2");
652
653         rte_pktmbuf_attach(clone2, clone);
654
655         if (rte_pktmbuf_mtod(clone2, char *) != data)
656                 GOTO_FAIL("clone2 was not attached properly\n");
657         if (rte_pktmbuf_headroom(clone2) != RTE_PKTMBUF_HEADROOM)
658                 GOTO_FAIL("bad headroom in clone2 after attach");
659         if (rte_mbuf_refcnt_read(m) != 3)
660                 GOTO_FAIL("invalid refcnt in m\n");
661
662         /* detach the clones */
663         rte_pktmbuf_detach(clone);
664         if (c_data != rte_pktmbuf_mtod(clone, char *))
665                 GOTO_FAIL("clone was not detached properly\n");
666         if (rte_mbuf_refcnt_read(m) != 2)
667                 GOTO_FAIL("invalid refcnt in m\n");
668
669         rte_pktmbuf_detach(clone2);
670         if (c_data2 != rte_pktmbuf_mtod(clone2, char *))
671                 GOTO_FAIL("clone2 was not detached properly\n");
672         if (rte_mbuf_refcnt_read(m) != 1)
673                 GOTO_FAIL("invalid refcnt in m\n");
674
675         /* free the clones and the initial mbuf */
676         rte_pktmbuf_free(clone2);
677         rte_pktmbuf_free(clone);
678         rte_pktmbuf_free(m);
679         printf("%s ok\n", __func__);
680         return 0;
681
682 fail:
683         if (m)
684                 rte_pktmbuf_free(m);
685         if (clone)
686                 rte_pktmbuf_free(clone);
687         if (clone2)
688                 rte_pktmbuf_free(clone2);
689         return -1;
690 }
691
692 /*
693  * test allocation and free of mbufs
694  */
695 static int
696 test_pktmbuf_pool(struct rte_mempool *pktmbuf_pool)
697 {
698         unsigned i;
699         struct rte_mbuf *m[NB_MBUF];
700         int ret = 0;
701
702         for (i=0; i<NB_MBUF; i++)
703                 m[i] = NULL;
704
705         /* alloc NB_MBUF mbufs */
706         for (i=0; i<NB_MBUF; i++) {
707                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
708                 if (m[i] == NULL) {
709                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
710                         ret = -1;
711                 }
712         }
713         struct rte_mbuf *extra = NULL;
714         extra = rte_pktmbuf_alloc(pktmbuf_pool);
715         if(extra != NULL) {
716                 printf("Error pool not empty");
717                 ret = -1;
718         }
719         extra = rte_pktmbuf_clone(m[0], pktmbuf_pool);
720         if(extra != NULL) {
721                 printf("Error pool not empty");
722                 ret = -1;
723         }
724         /* free them */
725         for (i=0; i<NB_MBUF; i++) {
726                 if (m[i] != NULL)
727                         rte_pktmbuf_free(m[i]);
728         }
729
730         return ret;
731 }
732
733 /*
734  * test bulk allocation and bulk free of mbufs
735  */
736 static int
737 test_pktmbuf_pool_bulk(void)
738 {
739         struct rte_mempool *pool = NULL;
740         struct rte_mempool *pool2 = NULL;
741         unsigned int i;
742         struct rte_mbuf *m;
743         struct rte_mbuf *mbufs[NB_MBUF];
744         int ret = 0;
745
746         /* We cannot use the preallocated mbuf pools because their caches
747          * prevent us from bulk allocating all objects in them.
748          * So we create our own mbuf pools without caches.
749          */
750         printf("Create mbuf pools for bulk allocation.\n");
751         pool = rte_pktmbuf_pool_create("test_pktmbuf_bulk",
752                         NB_MBUF, 0, 0, MBUF_DATA_SIZE, SOCKET_ID_ANY);
753         if (pool == NULL) {
754                 printf("rte_pktmbuf_pool_create() failed. rte_errno %d\n",
755                        rte_errno);
756                 goto err;
757         }
758         pool2 = rte_pktmbuf_pool_create("test_pktmbuf_bulk2",
759                         NB_MBUF, 0, 0, MBUF_DATA_SIZE, SOCKET_ID_ANY);
760         if (pool2 == NULL) {
761                 printf("rte_pktmbuf_pool_create() failed. rte_errno %d\n",
762                        rte_errno);
763                 goto err;
764         }
765
766         /* Preconditions: Mempools must be full. */
767         if (!(rte_mempool_full(pool) && rte_mempool_full(pool2))) {
768                 printf("Test precondition failed: mempools not full\n");
769                 goto err;
770         }
771         if (!(rte_mempool_avail_count(pool) == NB_MBUF &&
772                         rte_mempool_avail_count(pool2) == NB_MBUF)) {
773                 printf("Test precondition failed: mempools: %u+%u != %u+%u",
774                        rte_mempool_avail_count(pool),
775                        rte_mempool_avail_count(pool2),
776                        NB_MBUF, NB_MBUF);
777                 goto err;
778         }
779
780         printf("Test single bulk alloc, followed by multiple bulk free.\n");
781
782         /* Bulk allocate all mbufs in the pool, in one go. */
783         ret = rte_pktmbuf_alloc_bulk(pool, mbufs, NB_MBUF);
784         if (ret != 0) {
785                 printf("rte_pktmbuf_alloc_bulk() failed: %d\n", ret);
786                 goto err;
787         }
788         /* Test that they have been removed from the pool. */
789         if (!rte_mempool_empty(pool)) {
790                 printf("mempool not empty\n");
791                 goto err;
792         }
793         /* Bulk free all mbufs, in four steps. */
794         RTE_BUILD_BUG_ON(NB_MBUF % 4 != 0);
795         for (i = 0; i < NB_MBUF; i += NB_MBUF / 4) {
796                 rte_pktmbuf_free_bulk(&mbufs[i], NB_MBUF / 4);
797                 /* Test that they have been returned to the pool. */
798                 if (rte_mempool_avail_count(pool) != i + NB_MBUF / 4) {
799                         printf("mempool avail count incorrect\n");
800                         goto err;
801                 }
802         }
803
804         printf("Test multiple bulk alloc, followed by single bulk free.\n");
805
806         /* Bulk allocate all mbufs in the pool, in four steps. */
807         for (i = 0; i < NB_MBUF; i += NB_MBUF / 4) {
808                 ret = rte_pktmbuf_alloc_bulk(pool, &mbufs[i], NB_MBUF / 4);
809                 if (ret != 0) {
810                         printf("rte_pktmbuf_alloc_bulk() failed: %d\n", ret);
811                         goto err;
812                 }
813         }
814         /* Test that they have been removed from the pool. */
815         if (!rte_mempool_empty(pool)) {
816                 printf("mempool not empty\n");
817                 goto err;
818         }
819         /* Bulk free all mbufs, in one go. */
820         rte_pktmbuf_free_bulk(mbufs, NB_MBUF);
821         /* Test that they have been returned to the pool. */
822         if (!rte_mempool_full(pool)) {
823                 printf("mempool not full\n");
824                 goto err;
825         }
826
827         printf("Test bulk free of single long chain.\n");
828
829         /* Bulk allocate all mbufs in the pool, in one go. */
830         ret = rte_pktmbuf_alloc_bulk(pool, mbufs, NB_MBUF);
831         if (ret != 0) {
832                 printf("rte_pktmbuf_alloc_bulk() failed: %d\n", ret);
833                 goto err;
834         }
835         /* Create a long mbuf chain. */
836         for (i = 1; i < NB_MBUF; i++) {
837                 ret = rte_pktmbuf_chain(mbufs[0], mbufs[i]);
838                 if (ret != 0) {
839                         printf("rte_pktmbuf_chain() failed: %d\n", ret);
840                         goto err;
841                 }
842                 mbufs[i] = NULL;
843         }
844         /* Free the mbuf chain containing all the mbufs. */
845         rte_pktmbuf_free_bulk(mbufs, 1);
846         /* Test that they have been returned to the pool. */
847         if (!rte_mempool_full(pool)) {
848                 printf("mempool not full\n");
849                 goto err;
850         }
851
852         printf("Test bulk free of multiple chains using multiple pools.\n");
853
854         /* Create mbuf chains containing mbufs from different pools. */
855         RTE_BUILD_BUG_ON(CHAIN_LEN % 2 != 0);
856         RTE_BUILD_BUG_ON(NB_MBUF % (CHAIN_LEN / 2) != 0);
857         for (i = 0; i < NB_MBUF * 2; i++) {
858                 m = rte_pktmbuf_alloc((i & 4) ? pool2 : pool);
859                 if (m == NULL) {
860                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
861                         goto err;
862                 }
863                 if ((i % CHAIN_LEN) == 0)
864                         mbufs[i / CHAIN_LEN] = m;
865                 else
866                         rte_pktmbuf_chain(mbufs[i / CHAIN_LEN], m);
867         }
868         /* Test that both pools have been emptied. */
869         if (!(rte_mempool_empty(pool) && rte_mempool_empty(pool2))) {
870                 printf("mempools not empty\n");
871                 goto err;
872         }
873         /* Free one mbuf chain. */
874         rte_pktmbuf_free_bulk(mbufs, 1);
875         /* Test that the segments have been returned to the pools. */
876         if (!(rte_mempool_avail_count(pool) == CHAIN_LEN / 2 &&
877                         rte_mempool_avail_count(pool2) == CHAIN_LEN / 2)) {
878                 printf("all segments of first mbuf have not been returned\n");
879                 goto err;
880         }
881         /* Free the remaining mbuf chains. */
882         rte_pktmbuf_free_bulk(&mbufs[1], NB_MBUF * 2 / CHAIN_LEN - 1);
883         /* Test that they have been returned to the pools. */
884         if (!(rte_mempool_full(pool) && rte_mempool_full(pool2))) {
885                 printf("mempools not full\n");
886                 goto err;
887         }
888
889         ret = 0;
890         goto done;
891
892 err:
893         ret = -1;
894
895 done:
896         printf("Free mbuf pools for bulk allocation.\n");
897         rte_mempool_free(pool);
898         rte_mempool_free(pool2);
899         return ret;
900 }
901
902 /*
903  * test that the pointer to the data on a packet mbuf is set properly
904  */
905 static int
906 test_pktmbuf_pool_ptr(struct rte_mempool *pktmbuf_pool)
907 {
908         unsigned i;
909         struct rte_mbuf *m[NB_MBUF];
910         int ret = 0;
911
912         for (i=0; i<NB_MBUF; i++)
913                 m[i] = NULL;
914
915         /* alloc NB_MBUF mbufs */
916         for (i=0; i<NB_MBUF; i++) {
917                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
918                 if (m[i] == NULL) {
919                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
920                         ret = -1;
921                         break;
922                 }
923                 m[i]->data_off += 64;
924         }
925
926         /* free them */
927         for (i=0; i<NB_MBUF; i++) {
928                 if (m[i] != NULL)
929                         rte_pktmbuf_free(m[i]);
930         }
931
932         for (i=0; i<NB_MBUF; i++)
933                 m[i] = NULL;
934
935         /* alloc NB_MBUF mbufs */
936         for (i=0; i<NB_MBUF; i++) {
937                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
938                 if (m[i] == NULL) {
939                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
940                         ret = -1;
941                         break;
942                 }
943                 if (m[i]->data_off != RTE_PKTMBUF_HEADROOM) {
944                         printf("invalid data_off\n");
945                         ret = -1;
946                 }
947         }
948
949         /* free them */
950         for (i=0; i<NB_MBUF; i++) {
951                 if (m[i] != NULL)
952                         rte_pktmbuf_free(m[i]);
953         }
954
955         return ret;
956 }
957
958 static int
959 test_pktmbuf_free_segment(struct rte_mempool *pktmbuf_pool)
960 {
961         unsigned i;
962         struct rte_mbuf *m[NB_MBUF];
963         int ret = 0;
964
965         for (i=0; i<NB_MBUF; i++)
966                 m[i] = NULL;
967
968         /* alloc NB_MBUF mbufs */
969         for (i=0; i<NB_MBUF; i++) {
970                 m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
971                 if (m[i] == NULL) {
972                         printf("rte_pktmbuf_alloc() failed (%u)\n", i);
973                         ret = -1;
974                 }
975         }
976
977         /* free them */
978         for (i=0; i<NB_MBUF; i++) {
979                 if (m[i] != NULL) {
980                         struct rte_mbuf *mb, *mt;
981
982                         mb = m[i];
983                         while(mb != NULL) {
984                                 mt = mb;
985                                 mb = mb->next;
986                                 rte_pktmbuf_free_seg(mt);
987                         }
988                 }
989         }
990
991         return ret;
992 }
993
994 /*
995  * Stress test for rte_mbuf atomic refcnt.
996  * Implies that RTE_MBUF_REFCNT_ATOMIC is defined.
997  * For more efficiency, recommended to run with RTE_LIBRTE_MBUF_DEBUG defined.
998  */
999
1000 #ifdef RTE_MBUF_REFCNT_ATOMIC
1001
1002 static int
1003 test_refcnt_worker(void *arg)
1004 {
1005         unsigned lcore, free;
1006         void *mp = 0;
1007         struct rte_ring *refcnt_mbuf_ring = arg;
1008
1009         lcore = rte_lcore_id();
1010         printf("%s started at lcore %u\n", __func__, lcore);
1011
1012         free = 0;
1013         while (refcnt_stop_workers == 0) {
1014                 if (rte_ring_dequeue(refcnt_mbuf_ring, &mp) == 0) {
1015                         free++;
1016                         rte_pktmbuf_free(mp);
1017                 }
1018         }
1019
1020         refcnt_lcore[lcore] += free;
1021         printf("%s finished at lcore %u, "
1022                "number of freed mbufs: %u\n",
1023                __func__, lcore, free);
1024         return 0;
1025 }
1026
1027 static void
1028 test_refcnt_iter(unsigned int lcore, unsigned int iter,
1029                  struct rte_mempool *refcnt_pool,
1030                  struct rte_ring *refcnt_mbuf_ring)
1031 {
1032         uint16_t ref;
1033         unsigned i, n, tref, wn;
1034         struct rte_mbuf *m;
1035
1036         tref = 0;
1037
1038         /* For each mbuf in the pool:
1039          * - allocate mbuf,
1040          * - increment it's reference up to N+1,
1041          * - enqueue it N times into the ring for worker cores to free.
1042          */
1043         for (i = 0, n = rte_mempool_avail_count(refcnt_pool);
1044             i != n && (m = rte_pktmbuf_alloc(refcnt_pool)) != NULL;
1045             i++) {
1046                 ref = RTE_MAX(rte_rand() % REFCNT_MAX_REF, 1UL);
1047                 tref += ref;
1048                 if ((ref & 1) != 0) {
1049                         rte_pktmbuf_refcnt_update(m, ref);
1050                         while (ref-- != 0)
1051                                 rte_ring_enqueue(refcnt_mbuf_ring, m);
1052                 } else {
1053                         while (ref-- != 0) {
1054                                 rte_pktmbuf_refcnt_update(m, 1);
1055                                 rte_ring_enqueue(refcnt_mbuf_ring, m);
1056                         }
1057                 }
1058                 rte_pktmbuf_free(m);
1059         }
1060
1061         if (i != n)
1062                 rte_panic("(lcore=%u, iter=%u): was able to allocate only "
1063                           "%u from %u mbufs\n", lcore, iter, i, n);
1064
1065         /* wait till worker lcores  will consume all mbufs */
1066         while (!rte_ring_empty(refcnt_mbuf_ring))
1067                 ;
1068
1069         /* check that all mbufs are back into mempool by now */
1070         for (wn = 0; wn != REFCNT_MAX_TIMEOUT; wn++) {
1071                 if ((i = rte_mempool_avail_count(refcnt_pool)) == n) {
1072                         refcnt_lcore[lcore] += tref;
1073                         printf("%s(lcore=%u, iter=%u) completed, "
1074                             "%u references processed\n",
1075                             __func__, lcore, iter, tref);
1076                         return;
1077                 }
1078                 rte_delay_ms(100);
1079         }
1080
1081         rte_panic("(lcore=%u, iter=%u): after %us only "
1082                   "%u of %u mbufs left free\n", lcore, iter, wn, i, n);
1083 }
1084
1085 static int
1086 test_refcnt_main(struct rte_mempool *refcnt_pool,
1087                    struct rte_ring *refcnt_mbuf_ring)
1088 {
1089         unsigned i, lcore;
1090
1091         lcore = rte_lcore_id();
1092         printf("%s started at lcore %u\n", __func__, lcore);
1093
1094         for (i = 0; i != REFCNT_MAX_ITER; i++)
1095                 test_refcnt_iter(lcore, i, refcnt_pool, refcnt_mbuf_ring);
1096
1097         refcnt_stop_workers = 1;
1098         rte_wmb();
1099
1100         printf("%s finished at lcore %u\n", __func__, lcore);
1101         return 0;
1102 }
1103
1104 #endif
1105
1106 static int
1107 test_refcnt_mbuf(void)
1108 {
1109 #ifdef RTE_MBUF_REFCNT_ATOMIC
1110         unsigned int main_lcore, worker, tref;
1111         int ret = -1;
1112         struct rte_mempool *refcnt_pool = NULL;
1113         struct rte_ring *refcnt_mbuf_ring = NULL;
1114
1115         if (rte_lcore_count() < 2) {
1116                 printf("Not enough cores for test_refcnt_mbuf, expecting at least 2\n");
1117                 return TEST_SKIPPED;
1118         }
1119
1120         printf("starting %s, at %u lcores\n", __func__, rte_lcore_count());
1121
1122         /* create refcnt pool & ring if they don't exist */
1123
1124         refcnt_pool = rte_pktmbuf_pool_create(MAKE_STRING(refcnt_pool),
1125                                               REFCNT_MBUF_NUM, 0, 0, 0,
1126                                               SOCKET_ID_ANY);
1127         if (refcnt_pool == NULL) {
1128                 printf("%s: cannot allocate " MAKE_STRING(refcnt_pool) "\n",
1129                        __func__);
1130                 return -1;
1131         }
1132
1133         refcnt_mbuf_ring = rte_ring_create("refcnt_mbuf_ring",
1134                                            rte_align32pow2(REFCNT_RING_SIZE), SOCKET_ID_ANY,
1135                                            RING_F_SP_ENQ);
1136         if (refcnt_mbuf_ring == NULL) {
1137                 printf("%s: cannot allocate " MAKE_STRING(refcnt_mbuf_ring)
1138                        "\n", __func__);
1139                 goto err;
1140         }
1141
1142         refcnt_stop_workers = 0;
1143         memset(refcnt_lcore, 0, sizeof (refcnt_lcore));
1144
1145         rte_eal_mp_remote_launch(test_refcnt_worker, refcnt_mbuf_ring, SKIP_MAIN);
1146
1147         test_refcnt_main(refcnt_pool, refcnt_mbuf_ring);
1148
1149         rte_eal_mp_wait_lcore();
1150
1151         /* check that we porcessed all references */
1152         tref = 0;
1153         main_lcore = rte_get_main_lcore();
1154
1155         RTE_LCORE_FOREACH_WORKER(worker)
1156                 tref += refcnt_lcore[worker];
1157
1158         if (tref != refcnt_lcore[main_lcore])
1159                 rte_panic("referenced mbufs: %u, freed mbufs: %u\n",
1160                           tref, refcnt_lcore[main_lcore]);
1161
1162         rte_mempool_dump(stdout, refcnt_pool);
1163         rte_ring_dump(stdout, refcnt_mbuf_ring);
1164
1165         ret = 0;
1166
1167 err:
1168         rte_mempool_free(refcnt_pool);
1169         rte_ring_free(refcnt_mbuf_ring);
1170         return ret;
1171 #else
1172         return 0;
1173 #endif
1174 }
1175
1176 #include <unistd.h>
1177 #include <sys/wait.h>
1178
1179 /* use fork() to test mbuf errors panic */
1180 static int
1181 verify_mbuf_check_panics(struct rte_mbuf *buf)
1182 {
1183         int pid;
1184         int status;
1185
1186         pid = fork();
1187
1188         if (pid == 0) {
1189                 rte_mbuf_sanity_check(buf, 1); /* should panic */
1190                 exit(0);  /* return normally if it doesn't panic */
1191         } else if (pid < 0){
1192                 printf("Fork Failed\n");
1193                 return -1;
1194         }
1195         wait(&status);
1196         if(status == 0)
1197                 return -1;
1198
1199         return 0;
1200 }
1201
1202 static int
1203 test_failing_mbuf_sanity_check(struct rte_mempool *pktmbuf_pool)
1204 {
1205         struct rte_mbuf *buf;
1206         struct rte_mbuf badbuf;
1207
1208         printf("Checking rte_mbuf_sanity_check for failure conditions\n");
1209
1210         /* get a good mbuf to use to make copies */
1211         buf = rte_pktmbuf_alloc(pktmbuf_pool);
1212         if (buf == NULL)
1213                 return -1;
1214
1215         printf("Checking good mbuf initially\n");
1216         if (verify_mbuf_check_panics(buf) != -1)
1217                 return -1;
1218
1219         printf("Now checking for error conditions\n");
1220
1221         if (verify_mbuf_check_panics(NULL)) {
1222                 printf("Error with NULL mbuf test\n");
1223                 return -1;
1224         }
1225
1226         badbuf = *buf;
1227         badbuf.pool = NULL;
1228         if (verify_mbuf_check_panics(&badbuf)) {
1229                 printf("Error with bad-pool mbuf test\n");
1230                 return -1;
1231         }
1232
1233         badbuf = *buf;
1234         badbuf.buf_iova = 0;
1235         if (verify_mbuf_check_panics(&badbuf)) {
1236                 printf("Error with bad-physaddr mbuf test\n");
1237                 return -1;
1238         }
1239
1240         badbuf = *buf;
1241         badbuf.buf_addr = NULL;
1242         if (verify_mbuf_check_panics(&badbuf)) {
1243                 printf("Error with bad-addr mbuf test\n");
1244                 return -1;
1245         }
1246
1247         badbuf = *buf;
1248         badbuf.refcnt = 0;
1249         if (verify_mbuf_check_panics(&badbuf)) {
1250                 printf("Error with bad-refcnt(0) mbuf test\n");
1251                 return -1;
1252         }
1253
1254         badbuf = *buf;
1255         badbuf.refcnt = UINT16_MAX;
1256         if (verify_mbuf_check_panics(&badbuf)) {
1257                 printf("Error with bad-refcnt(MAX) mbuf test\n");
1258                 return -1;
1259         }
1260
1261         return 0;
1262 }
1263
1264 static int
1265 test_mbuf_linearize(struct rte_mempool *pktmbuf_pool, int pkt_len,
1266                     int nb_segs)
1267 {
1268
1269         struct rte_mbuf *m = NULL, *mbuf = NULL;
1270         uint8_t *data;
1271         int data_len = 0;
1272         int remain;
1273         int seg, seg_len;
1274         int i;
1275
1276         if (pkt_len < 1) {
1277                 printf("Packet size must be 1 or more (is %d)\n", pkt_len);
1278                 return -1;
1279         }
1280
1281         if (nb_segs < 1) {
1282                 printf("Number of segments must be 1 or more (is %d)\n",
1283                                 nb_segs);
1284                 return -1;
1285         }
1286
1287         seg_len = pkt_len / nb_segs;
1288         if (seg_len == 0)
1289                 seg_len = 1;
1290
1291         remain = pkt_len;
1292
1293         /* Create chained mbuf_src and fill it generated data */
1294         for (seg = 0; remain > 0; seg++) {
1295
1296                 m = rte_pktmbuf_alloc(pktmbuf_pool);
1297                 if (m == NULL) {
1298                         printf("Cannot create segment for source mbuf");
1299                         goto fail;
1300                 }
1301
1302                 /* Make sure if tailroom is zeroed */
1303                 memset(rte_pktmbuf_mtod(m, uint8_t *), 0,
1304                                 rte_pktmbuf_tailroom(m));
1305
1306                 data_len = remain;
1307                 if (data_len > seg_len)
1308                         data_len = seg_len;
1309
1310                 data = (uint8_t *)rte_pktmbuf_append(m, data_len);
1311                 if (data == NULL) {
1312                         printf("Cannot append %d bytes to the mbuf\n",
1313                                         data_len);
1314                         goto fail;
1315                 }
1316
1317                 for (i = 0; i < data_len; i++)
1318                         data[i] = (seg * seg_len + i) % 0x0ff;
1319
1320                 if (seg == 0)
1321                         mbuf = m;
1322                 else
1323                         rte_pktmbuf_chain(mbuf, m);
1324
1325                 remain -= data_len;
1326         }
1327
1328         /* Create destination buffer to store coalesced data */
1329         if (rte_pktmbuf_linearize(mbuf)) {
1330                 printf("Mbuf linearization failed\n");
1331                 goto fail;
1332         }
1333
1334         if (!rte_pktmbuf_is_contiguous(mbuf)) {
1335                 printf("Source buffer should be contiguous after "
1336                                 "linearization\n");
1337                 goto fail;
1338         }
1339
1340         data = rte_pktmbuf_mtod(mbuf, uint8_t *);
1341
1342         for (i = 0; i < pkt_len; i++)
1343                 if (data[i] != (i % 0x0ff)) {
1344                         printf("Incorrect data in linearized mbuf\n");
1345                         goto fail;
1346                 }
1347
1348         rte_pktmbuf_free(mbuf);
1349         return 0;
1350
1351 fail:
1352         if (mbuf)
1353                 rte_pktmbuf_free(mbuf);
1354         return -1;
1355 }
1356
1357 static int
1358 test_mbuf_linearize_check(struct rte_mempool *pktmbuf_pool)
1359 {
1360         struct test_mbuf_array {
1361                 int size;
1362                 int nb_segs;
1363         } mbuf_array[] = {
1364                         { 128, 1 },
1365                         { 64, 64 },
1366                         { 512, 10 },
1367                         { 250, 11 },
1368                         { 123, 8 },
1369         };
1370         unsigned int i;
1371
1372         printf("Test mbuf linearize API\n");
1373
1374         for (i = 0; i < RTE_DIM(mbuf_array); i++)
1375                 if (test_mbuf_linearize(pktmbuf_pool, mbuf_array[i].size,
1376                                 mbuf_array[i].nb_segs)) {
1377                         printf("Test failed for %d, %d\n", mbuf_array[i].size,
1378                                         mbuf_array[i].nb_segs);
1379                         return -1;
1380                 }
1381
1382         return 0;
1383 }
1384
1385 /*
1386  * Helper function for test_tx_ofload
1387  */
1388 static inline void
1389 set_tx_offload(struct rte_mbuf *mb, uint64_t il2, uint64_t il3, uint64_t il4,
1390         uint64_t tso, uint64_t ol3, uint64_t ol2)
1391 {
1392         mb->l2_len = il2;
1393         mb->l3_len = il3;
1394         mb->l4_len = il4;
1395         mb->tso_segsz = tso;
1396         mb->outer_l3_len = ol3;
1397         mb->outer_l2_len = ol2;
1398 }
1399
1400 static int
1401 test_tx_offload(void)
1402 {
1403         struct rte_mbuf *mb;
1404         uint64_t tm, v1, v2;
1405         size_t sz;
1406         uint32_t i;
1407
1408         static volatile struct {
1409                 uint16_t l2;
1410                 uint16_t l3;
1411                 uint16_t l4;
1412                 uint16_t tso;
1413         } txof;
1414
1415         const uint32_t num = 0x10000;
1416
1417         txof.l2 = rte_rand() % (1 <<  RTE_MBUF_L2_LEN_BITS);
1418         txof.l3 = rte_rand() % (1 <<  RTE_MBUF_L3_LEN_BITS);
1419         txof.l4 = rte_rand() % (1 <<  RTE_MBUF_L4_LEN_BITS);
1420         txof.tso = rte_rand() % (1 <<   RTE_MBUF_TSO_SEGSZ_BITS);
1421
1422         printf("%s started, tx_offload = {\n"
1423                 "\tl2_len=%#hx,\n"
1424                 "\tl3_len=%#hx,\n"
1425                 "\tl4_len=%#hx,\n"
1426                 "\ttso_segsz=%#hx,\n"
1427                 "\touter_l3_len=%#x,\n"
1428                 "\touter_l2_len=%#x,\n"
1429                 "};\n",
1430                 __func__,
1431                 txof.l2, txof.l3, txof.l4, txof.tso, txof.l3, txof.l2);
1432
1433         sz = sizeof(*mb) * num;
1434         mb = rte_zmalloc(NULL, sz, RTE_CACHE_LINE_SIZE);
1435         if (mb == NULL) {
1436                 printf("%s failed, out of memory\n", __func__);
1437                 return -ENOMEM;
1438         }
1439
1440         memset(mb, 0, sz);
1441         tm = rte_rdtsc_precise();
1442
1443         for (i = 0; i != num; i++)
1444                 set_tx_offload(mb + i, txof.l2, txof.l3, txof.l4,
1445                         txof.tso, txof.l3, txof.l2);
1446
1447         tm = rte_rdtsc_precise() - tm;
1448         printf("%s set tx_offload by bit-fields: %u iterations, %"
1449                 PRIu64 " cycles, %#Lf cycles/iter\n",
1450                 __func__, num, tm, (long double)tm / num);
1451
1452         v1 = mb[rte_rand() % num].tx_offload;
1453
1454         memset(mb, 0, sz);
1455         tm = rte_rdtsc_precise();
1456
1457         for (i = 0; i != num; i++)
1458                 mb[i].tx_offload = rte_mbuf_tx_offload(txof.l2, txof.l3,
1459                         txof.l4, txof.tso, txof.l3, txof.l2, 0);
1460
1461         tm = rte_rdtsc_precise() - tm;
1462         printf("%s set raw tx_offload: %u iterations, %"
1463                 PRIu64 " cycles, %#Lf cycles/iter\n",
1464                 __func__, num, tm, (long double)tm / num);
1465
1466         v2 = mb[rte_rand() % num].tx_offload;
1467
1468         rte_free(mb);
1469
1470         printf("%s finished\n"
1471                 "expected tx_offload value: 0x%" PRIx64 ";\n"
1472                 "rte_mbuf_tx_offload value: 0x%" PRIx64 ";\n",
1473                 __func__, v1, v2);
1474
1475         return (v1 == v2) ? 0 : -EINVAL;
1476 }
1477
1478 static int
1479 test_get_rx_ol_flag_list(void)
1480 {
1481         int len = 6, ret = 0;
1482         char buf[256] = "";
1483         int buflen = 0;
1484
1485         /* Test case to check with null buffer */
1486         ret = rte_get_rx_ol_flag_list(0, NULL, 0);
1487         if (ret != -1)
1488                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1489
1490         /* Test case to check with zero buffer len */
1491         ret = rte_get_rx_ol_flag_list(PKT_RX_L4_CKSUM_MASK, buf, 0);
1492         if (ret != -1)
1493                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1494
1495         buflen = strlen(buf);
1496         if (buflen != 0)
1497                 GOTO_FAIL("%s buffer should be empty, received = %d\n",
1498                                 __func__, buflen);
1499
1500         /* Test case to check with reduced buffer len */
1501         ret = rte_get_rx_ol_flag_list(0, buf, len);
1502         if (ret != -1)
1503                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1504
1505         buflen = strlen(buf);
1506         if (buflen != (len - 1))
1507                 GOTO_FAIL("%s invalid buffer length retrieved, expected: %d,"
1508                                 "received = %d\n", __func__,
1509                                 (len - 1), buflen);
1510
1511         /* Test case to check with zero mask value */
1512         ret = rte_get_rx_ol_flag_list(0, buf, sizeof(buf));
1513         if (ret != 0)
1514                 GOTO_FAIL("%s expected: 0, received = %d\n", __func__, ret);
1515
1516         buflen = strlen(buf);
1517         if (buflen == 0)
1518                 GOTO_FAIL("%s expected: %s, received length = 0\n", __func__,
1519                                 "non-zero, buffer should not be empty");
1520
1521         /* Test case to check with valid mask value */
1522         ret = rte_get_rx_ol_flag_list(PKT_RX_SEC_OFFLOAD, buf, sizeof(buf));
1523         if (ret != 0)
1524                 GOTO_FAIL("%s expected: 0, received = %d\n", __func__, ret);
1525
1526         buflen = strlen(buf);
1527         if (buflen == 0)
1528                 GOTO_FAIL("%s expected: %s, received length = 0\n", __func__,
1529                                 "non-zero, buffer should not be empty");
1530
1531         return 0;
1532 fail:
1533         return -1;
1534 }
1535
1536 static int
1537 test_get_tx_ol_flag_list(void)
1538 {
1539         int len = 6, ret = 0;
1540         char buf[256] = "";
1541         int buflen = 0;
1542
1543         /* Test case to check with null buffer */
1544         ret = rte_get_tx_ol_flag_list(0, NULL, 0);
1545         if (ret != -1)
1546                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1547
1548         /* Test case to check with zero buffer len */
1549         ret = rte_get_tx_ol_flag_list(PKT_TX_IP_CKSUM, buf, 0);
1550         if (ret != -1)
1551                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1552
1553         buflen = strlen(buf);
1554         if (buflen != 0) {
1555                 GOTO_FAIL("%s buffer should be empty, received = %d\n",
1556                                 __func__, buflen);
1557         }
1558
1559         /* Test case to check with reduced buffer len */
1560         ret = rte_get_tx_ol_flag_list(0, buf, len);
1561         if (ret != -1)
1562                 GOTO_FAIL("%s expected: -1, received = %d\n", __func__, ret);
1563
1564         buflen = strlen(buf);
1565         if (buflen != (len - 1))
1566                 GOTO_FAIL("%s invalid buffer length retrieved, expected: %d,"
1567                                 "received = %d\n", __func__,
1568                                 (len - 1), buflen);
1569
1570         /* Test case to check with zero mask value */
1571         ret = rte_get_tx_ol_flag_list(0, buf, sizeof(buf));
1572         if (ret != 0)
1573                 GOTO_FAIL("%s expected: 0, received = %d\n", __func__, ret);
1574
1575         buflen = strlen(buf);
1576         if (buflen == 0)
1577                 GOTO_FAIL("%s expected: %s, received length = 0\n", __func__,
1578                                 "non-zero, buffer should not be empty");
1579
1580         /* Test case to check with valid mask value */
1581         ret = rte_get_tx_ol_flag_list(PKT_TX_UDP_CKSUM, buf, sizeof(buf));
1582         if (ret != 0)
1583                 GOTO_FAIL("%s expected: 0, received = %d\n", __func__, ret);
1584
1585         buflen = strlen(buf);
1586         if (buflen == 0)
1587                 GOTO_FAIL("%s expected: %s, received length = 0\n", __func__,
1588                                 "non-zero, buffer should not be empty");
1589
1590         return 0;
1591 fail:
1592         return -1;
1593
1594 }
1595
1596 struct flag_name {
1597         uint64_t flag;
1598         const char *name;
1599 };
1600
1601 static int
1602 test_get_rx_ol_flag_name(void)
1603 {
1604         uint16_t i;
1605         const char *flag_str = NULL;
1606         const struct flag_name rx_flags[] = {
1607                 VAL_NAME(PKT_RX_VLAN),
1608                 VAL_NAME(PKT_RX_RSS_HASH),
1609                 VAL_NAME(PKT_RX_FDIR),
1610                 VAL_NAME(PKT_RX_L4_CKSUM_BAD),
1611                 VAL_NAME(PKT_RX_L4_CKSUM_GOOD),
1612                 VAL_NAME(PKT_RX_L4_CKSUM_NONE),
1613                 VAL_NAME(PKT_RX_IP_CKSUM_BAD),
1614                 VAL_NAME(PKT_RX_IP_CKSUM_GOOD),
1615                 VAL_NAME(PKT_RX_IP_CKSUM_NONE),
1616                 VAL_NAME(PKT_RX_EIP_CKSUM_BAD),
1617                 VAL_NAME(PKT_RX_VLAN_STRIPPED),
1618                 VAL_NAME(PKT_RX_IEEE1588_PTP),
1619                 VAL_NAME(PKT_RX_IEEE1588_TMST),
1620                 VAL_NAME(PKT_RX_FDIR_ID),
1621                 VAL_NAME(PKT_RX_FDIR_FLX),
1622                 VAL_NAME(PKT_RX_QINQ_STRIPPED),
1623                 VAL_NAME(PKT_RX_LRO),
1624                 VAL_NAME(PKT_RX_TIMESTAMP),
1625                 VAL_NAME(PKT_RX_SEC_OFFLOAD),
1626                 VAL_NAME(PKT_RX_SEC_OFFLOAD_FAILED),
1627                 VAL_NAME(PKT_RX_OUTER_L4_CKSUM_BAD),
1628                 VAL_NAME(PKT_RX_OUTER_L4_CKSUM_GOOD),
1629                 VAL_NAME(PKT_RX_OUTER_L4_CKSUM_INVALID),
1630         };
1631
1632         /* Test case to check with valid flag */
1633         for (i = 0; i < RTE_DIM(rx_flags); i++) {
1634                 flag_str = rte_get_rx_ol_flag_name(rx_flags[i].flag);
1635                 if (flag_str == NULL)
1636                         GOTO_FAIL("%s: Expected flagname = %s; received null\n",
1637                                         __func__, rx_flags[i].name);
1638                 if (strcmp(flag_str, rx_flags[i].name) != 0)
1639                         GOTO_FAIL("%s: Expected flagname = %s; received = %s\n",
1640                                 __func__, rx_flags[i].name, flag_str);
1641         }
1642         /* Test case to check with invalid flag */
1643         flag_str = rte_get_rx_ol_flag_name(0);
1644         if (flag_str != NULL) {
1645                 GOTO_FAIL("%s: Expected flag name = null; received = %s\n",
1646                                 __func__, flag_str);
1647         }
1648
1649         return 0;
1650 fail:
1651         return -1;
1652 }
1653
1654 static int
1655 test_get_tx_ol_flag_name(void)
1656 {
1657         uint16_t i;
1658         const char *flag_str = NULL;
1659         const struct flag_name tx_flags[] = {
1660                 VAL_NAME(PKT_TX_VLAN),
1661                 VAL_NAME(PKT_TX_IP_CKSUM),
1662                 VAL_NAME(PKT_TX_TCP_CKSUM),
1663                 VAL_NAME(PKT_TX_SCTP_CKSUM),
1664                 VAL_NAME(PKT_TX_UDP_CKSUM),
1665                 VAL_NAME(PKT_TX_IEEE1588_TMST),
1666                 VAL_NAME(PKT_TX_TCP_SEG),
1667                 VAL_NAME(PKT_TX_IPV4),
1668                 VAL_NAME(PKT_TX_IPV6),
1669                 VAL_NAME(PKT_TX_OUTER_IP_CKSUM),
1670                 VAL_NAME(PKT_TX_OUTER_IPV4),
1671                 VAL_NAME(PKT_TX_OUTER_IPV6),
1672                 VAL_NAME(PKT_TX_TUNNEL_VXLAN),
1673                 VAL_NAME(PKT_TX_TUNNEL_GRE),
1674                 VAL_NAME(PKT_TX_TUNNEL_IPIP),
1675                 VAL_NAME(PKT_TX_TUNNEL_GENEVE),
1676                 VAL_NAME(PKT_TX_TUNNEL_MPLSINUDP),
1677                 VAL_NAME(PKT_TX_TUNNEL_VXLAN_GPE),
1678                 VAL_NAME(PKT_TX_TUNNEL_IP),
1679                 VAL_NAME(PKT_TX_TUNNEL_UDP),
1680                 VAL_NAME(PKT_TX_QINQ),
1681                 VAL_NAME(PKT_TX_MACSEC),
1682                 VAL_NAME(PKT_TX_SEC_OFFLOAD),
1683                 VAL_NAME(PKT_TX_UDP_SEG),
1684                 VAL_NAME(PKT_TX_OUTER_UDP_CKSUM),
1685         };
1686
1687         /* Test case to check with valid flag */
1688         for (i = 0; i < RTE_DIM(tx_flags); i++) {
1689                 flag_str = rte_get_tx_ol_flag_name(tx_flags[i].flag);
1690                 if (flag_str == NULL)
1691                         GOTO_FAIL("%s: Expected flagname = %s; received null\n",
1692                                 __func__, tx_flags[i].name);
1693                 if (strcmp(flag_str, tx_flags[i].name) != 0)
1694                         GOTO_FAIL("%s: Expected flagname = %s; received = %s\n",
1695                                 __func__, tx_flags[i].name, flag_str);
1696         }
1697         /* Test case to check with invalid flag */
1698         flag_str = rte_get_tx_ol_flag_name(0);
1699         if (flag_str != NULL) {
1700                 GOTO_FAIL("%s: Expected flag name = null; received = %s\n",
1701                                 __func__, flag_str);
1702         }
1703
1704         return 0;
1705 fail:
1706         return -1;
1707
1708 }
1709
1710 static int
1711 test_mbuf_validate_tx_offload(const char *test_name,
1712                 struct rte_mempool *pktmbuf_pool,
1713                 uint64_t ol_flags,
1714                 uint16_t segsize,
1715                 int expected_retval)
1716 {
1717         struct rte_mbuf *m = NULL;
1718         int ret = 0;
1719
1720         /* alloc a mbuf and do sanity check */
1721         m = rte_pktmbuf_alloc(pktmbuf_pool);
1722         if (m == NULL)
1723                 GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
1724         if (rte_pktmbuf_pkt_len(m) != 0)
1725                 GOTO_FAIL("%s: Bad packet length\n", __func__);
1726         rte_mbuf_sanity_check(m, 0);
1727         m->ol_flags = ol_flags;
1728         m->tso_segsz = segsize;
1729         ret = rte_validate_tx_offload(m);
1730         if (ret != expected_retval)
1731                 GOTO_FAIL("%s(%s): expected ret val: %d; received: %d\n",
1732                                 __func__, test_name, expected_retval, ret);
1733         rte_pktmbuf_free(m);
1734         m = NULL;
1735         return 0;
1736 fail:
1737         if (m) {
1738                 rte_pktmbuf_free(m);
1739                 m = NULL;
1740         }
1741         return -1;
1742 }
1743
1744 static int
1745 test_mbuf_validate_tx_offload_one(struct rte_mempool *pktmbuf_pool)
1746 {
1747         /* test to validate tx offload flags */
1748         uint64_t ol_flags = 0;
1749
1750         /* test to validate if IP checksum is counted only for IPV4 packet */
1751         /* set both IP checksum and IPV6 flags */
1752         ol_flags |= PKT_TX_IP_CKSUM;
1753         ol_flags |= PKT_TX_IPV6;
1754         if (test_mbuf_validate_tx_offload("MBUF_TEST_IP_CKSUM_IPV6_SET",
1755                                 pktmbuf_pool,
1756                                 ol_flags, 0, -EINVAL) < 0)
1757                 GOTO_FAIL("%s failed: IP cksum is set incorrect.\n", __func__);
1758         /* resetting ol_flags for next testcase */
1759         ol_flags = 0;
1760
1761         /* test to validate if IP type is set when required */
1762         ol_flags |= PKT_TX_L4_MASK;
1763         if (test_mbuf_validate_tx_offload("MBUF_TEST_IP_TYPE_NOT_SET",
1764                                 pktmbuf_pool,
1765                                 ol_flags, 0, -EINVAL) < 0)
1766                 GOTO_FAIL("%s failed: IP type is not set.\n", __func__);
1767
1768         /* test if IP type is set when TCP SEG is on */
1769         ol_flags |= PKT_TX_TCP_SEG;
1770         if (test_mbuf_validate_tx_offload("MBUF_TEST_IP_TYPE_NOT_SET",
1771                                 pktmbuf_pool,
1772                                 ol_flags, 0, -EINVAL) < 0)
1773                 GOTO_FAIL("%s failed: IP type is not set.\n", __func__);
1774
1775         ol_flags = 0;
1776         /* test to confirm IP type (IPV4/IPV6) is set */
1777         ol_flags = PKT_TX_L4_MASK;
1778         ol_flags |= PKT_TX_IPV6;
1779         if (test_mbuf_validate_tx_offload("MBUF_TEST_IP_TYPE_SET",
1780                                 pktmbuf_pool,
1781                                 ol_flags, 0, 0) < 0)
1782                 GOTO_FAIL("%s failed: tx offload flag error.\n", __func__);
1783
1784         ol_flags = 0;
1785         /* test to check TSO segment size is non-zero */
1786         ol_flags |= PKT_TX_IPV4;
1787         ol_flags |= PKT_TX_TCP_SEG;
1788         /* set 0 tso segment size */
1789         if (test_mbuf_validate_tx_offload("MBUF_TEST_NULL_TSO_SEGSZ",
1790                                 pktmbuf_pool,
1791                                 ol_flags, 0, -EINVAL) < 0)
1792                 GOTO_FAIL("%s failed: tso segment size is null.\n", __func__);
1793
1794         /* retain IPV4 and PKT_TX_TCP_SEG mask */
1795         /* set valid tso segment size but IP CKSUM not set */
1796         if (test_mbuf_validate_tx_offload("MBUF_TEST_TSO_IP_CKSUM_NOT_SET",
1797                                 pktmbuf_pool,
1798                                 ol_flags, 512, -EINVAL) < 0)
1799                 GOTO_FAIL("%s failed: IP CKSUM is not set.\n", __func__);
1800
1801         /* test to validate if IP checksum is set for TSO capability */
1802         /* retain IPV4, TCP_SEG, tso_seg size */
1803         ol_flags |= PKT_TX_IP_CKSUM;
1804         if (test_mbuf_validate_tx_offload("MBUF_TEST_TSO_IP_CKSUM_SET",
1805                                 pktmbuf_pool,
1806                                 ol_flags, 512, 0) < 0)
1807                 GOTO_FAIL("%s failed: tx offload flag error.\n", __func__);
1808
1809         /* test to confirm TSO for IPV6 type */
1810         ol_flags = 0;
1811         ol_flags |= PKT_TX_IPV6;
1812         ol_flags |= PKT_TX_TCP_SEG;
1813         if (test_mbuf_validate_tx_offload("MBUF_TEST_TSO_IPV6_SET",
1814                                 pktmbuf_pool,
1815                                 ol_flags, 512, 0) < 0)
1816                 GOTO_FAIL("%s failed: TSO req not met.\n", __func__);
1817
1818         ol_flags = 0;
1819         /* test if outer IP checksum set for non outer IPv4 packet */
1820         ol_flags |= PKT_TX_IPV6;
1821         ol_flags |= PKT_TX_OUTER_IP_CKSUM;
1822         if (test_mbuf_validate_tx_offload("MBUF_TEST_OUTER_IPV4_NOT_SET",
1823                                 pktmbuf_pool,
1824                                 ol_flags, 512, -EINVAL) < 0)
1825                 GOTO_FAIL("%s failed: Outer IP cksum set.\n", __func__);
1826
1827         ol_flags = 0;
1828         /* test to confirm outer IP checksum is set for outer IPV4 packet */
1829         ol_flags |= PKT_TX_OUTER_IP_CKSUM;
1830         ol_flags |= PKT_TX_OUTER_IPV4;
1831         if (test_mbuf_validate_tx_offload("MBUF_TEST_OUTER_IPV4_SET",
1832                                 pktmbuf_pool,
1833                                 ol_flags, 512, 0) < 0)
1834                 GOTO_FAIL("%s failed: tx offload flag error.\n", __func__);
1835
1836         ol_flags = 0;
1837         /* test to confirm if packets with no TX_OFFLOAD_MASK are skipped */
1838         if (test_mbuf_validate_tx_offload("MBUF_TEST_OL_MASK_NOT_SET",
1839                                 pktmbuf_pool,
1840                                 ol_flags, 512, 0) < 0)
1841                 GOTO_FAIL("%s failed: tx offload flag error.\n", __func__);
1842         return 0;
1843 fail:
1844         return -1;
1845 }
1846
1847 /*
1848  * Test for allocating a bulk of mbufs
1849  * define an array with positive sizes for mbufs allocations.
1850  */
1851 static int
1852 test_pktmbuf_alloc_bulk(struct rte_mempool *pktmbuf_pool)
1853 {
1854         int ret = 0;
1855         unsigned int idx, loop;
1856         unsigned int alloc_counts[] = {
1857                 0,
1858                 MEMPOOL_CACHE_SIZE - 1,
1859                 MEMPOOL_CACHE_SIZE + 1,
1860                 MEMPOOL_CACHE_SIZE * 1.5,
1861                 MEMPOOL_CACHE_SIZE * 2,
1862                 MEMPOOL_CACHE_SIZE * 2 - 1,
1863                 MEMPOOL_CACHE_SIZE * 2 + 1,
1864                 MEMPOOL_CACHE_SIZE,
1865         };
1866
1867         /* allocate a large array of mbuf pointers */
1868         struct rte_mbuf *mbufs[NB_MBUF] = { 0 };
1869         for (idx = 0; idx < RTE_DIM(alloc_counts); idx++) {
1870                 ret = rte_pktmbuf_alloc_bulk(pktmbuf_pool, mbufs,
1871                                 alloc_counts[idx]);
1872                 if (ret == 0) {
1873                         for (loop = 0; loop < alloc_counts[idx] &&
1874                                         mbufs[loop] != NULL; loop++)
1875                                 rte_pktmbuf_free(mbufs[loop]);
1876                 } else if (ret != 0) {
1877                         printf("%s: Bulk alloc failed count(%u); ret val(%d)\n",
1878                                         __func__, alloc_counts[idx], ret);
1879                         return -1;
1880                 }
1881         }
1882         return 0;
1883 }
1884
1885 /*
1886  * Negative testing for allocating a bulk of mbufs
1887  */
1888 static int
1889 test_neg_pktmbuf_alloc_bulk(struct rte_mempool *pktmbuf_pool)
1890 {
1891         int ret = 0;
1892         unsigned int idx, loop;
1893         unsigned int neg_alloc_counts[] = {
1894                 MEMPOOL_CACHE_SIZE - NB_MBUF,
1895                 NB_MBUF + 1,
1896                 NB_MBUF * 8,
1897                 UINT_MAX
1898         };
1899         struct rte_mbuf *mbufs[NB_MBUF * 8] = { 0 };
1900
1901         for (idx = 0; idx < RTE_DIM(neg_alloc_counts); idx++) {
1902                 ret = rte_pktmbuf_alloc_bulk(pktmbuf_pool, mbufs,
1903                                 neg_alloc_counts[idx]);
1904                 if (ret == 0) {
1905                         printf("%s: Bulk alloc must fail! count(%u); ret(%d)\n",
1906                                         __func__, neg_alloc_counts[idx], ret);
1907                         for (loop = 0; loop < neg_alloc_counts[idx] &&
1908                                         mbufs[loop] != NULL; loop++)
1909                                 rte_pktmbuf_free(mbufs[loop]);
1910                         return -1;
1911                 }
1912         }
1913         return 0;
1914 }
1915
1916 /*
1917  * Test to read mbuf packet using rte_pktmbuf_read
1918  */
1919 static int
1920 test_pktmbuf_read(struct rte_mempool *pktmbuf_pool)
1921 {
1922         struct rte_mbuf *m = NULL;
1923         char *data = NULL;
1924         const char *data_copy = NULL;
1925         int off;
1926
1927         /* alloc a mbuf */
1928         m = rte_pktmbuf_alloc(pktmbuf_pool);
1929         if (m == NULL)
1930                 GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
1931         if (rte_pktmbuf_pkt_len(m) != 0)
1932                 GOTO_FAIL("%s: Bad packet length\n", __func__);
1933         rte_mbuf_sanity_check(m, 0);
1934
1935         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN2);
1936         if (data == NULL)
1937                 GOTO_FAIL("%s: Cannot append data\n", __func__);
1938         if (rte_pktmbuf_pkt_len(m) != MBUF_TEST_DATA_LEN2)
1939                 GOTO_FAIL("%s: Bad packet length\n", __func__);
1940         memset(data, 0xfe, MBUF_TEST_DATA_LEN2);
1941
1942         /* read the data from mbuf */
1943         data_copy = rte_pktmbuf_read(m, 0, MBUF_TEST_DATA_LEN2, NULL);
1944         if (data_copy == NULL)
1945                 GOTO_FAIL("%s: Error in reading data!\n", __func__);
1946         for (off = 0; off < MBUF_TEST_DATA_LEN2; off++) {
1947                 if (data_copy[off] != (char)0xfe)
1948                         GOTO_FAIL("Data corrupted at offset %u", off);
1949         }
1950         rte_pktmbuf_free(m);
1951         m = NULL;
1952
1953         return 0;
1954 fail:
1955         if (m) {
1956                 rte_pktmbuf_free(m);
1957                 m = NULL;
1958         }
1959         return -1;
1960 }
1961
1962 /*
1963  * Test to read mbuf packet data from offset
1964  */
1965 static int
1966 test_pktmbuf_read_from_offset(struct rte_mempool *pktmbuf_pool)
1967 {
1968         struct rte_mbuf *m = NULL;
1969         struct ether_hdr *hdr = NULL;
1970         char *data = NULL;
1971         const char *data_copy = NULL;
1972         unsigned int off;
1973         unsigned int hdr_len = sizeof(struct rte_ether_hdr);
1974
1975         /* alloc a mbuf */
1976         m = rte_pktmbuf_alloc(pktmbuf_pool);
1977         if (m == NULL)
1978                 GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
1979
1980         if (rte_pktmbuf_pkt_len(m) != 0)
1981                 GOTO_FAIL("%s: Bad packet length\n", __func__);
1982         rte_mbuf_sanity_check(m, 0);
1983
1984         /* prepend an ethernet header */
1985         hdr = (struct ether_hdr *)rte_pktmbuf_prepend(m, hdr_len);
1986         if (hdr == NULL)
1987                 GOTO_FAIL("%s: Cannot prepend header\n", __func__);
1988         if (rte_pktmbuf_pkt_len(m) != hdr_len)
1989                 GOTO_FAIL("%s: Bad pkt length", __func__);
1990         if (rte_pktmbuf_data_len(m) != hdr_len)
1991                 GOTO_FAIL("%s: Bad data length", __func__);
1992         memset(hdr, 0xde, hdr_len);
1993
1994         /* read mbuf header info from 0 offset */
1995         data_copy = rte_pktmbuf_read(m, 0, hdr_len, NULL);
1996         if (data_copy == NULL)
1997                 GOTO_FAIL("%s: Error in reading header!\n", __func__);
1998         for (off = 0; off < hdr_len; off++) {
1999                 if (data_copy[off] != (char)0xde)
2000                         GOTO_FAIL("Header info corrupted at offset %u", off);
2001         }
2002
2003         /* append sample data after ethernet header */
2004         data = rte_pktmbuf_append(m, MBUF_TEST_DATA_LEN2);
2005         if (data == NULL)
2006                 GOTO_FAIL("%s: Cannot append data\n", __func__);
2007         if (rte_pktmbuf_pkt_len(m) != hdr_len + MBUF_TEST_DATA_LEN2)
2008                 GOTO_FAIL("%s: Bad packet length\n", __func__);
2009         if (rte_pktmbuf_data_len(m) != hdr_len + MBUF_TEST_DATA_LEN2)
2010                 GOTO_FAIL("%s: Bad data length\n", __func__);
2011         memset(data, 0xcc, MBUF_TEST_DATA_LEN2);
2012
2013         /* read mbuf data after header info */
2014         data_copy = rte_pktmbuf_read(m, hdr_len, MBUF_TEST_DATA_LEN2, NULL);
2015         if (data_copy == NULL)
2016                 GOTO_FAIL("%s: Error in reading header data!\n", __func__);
2017         for (off = 0; off < MBUF_TEST_DATA_LEN2; off++) {
2018                 if (data_copy[off] != (char)0xcc)
2019                         GOTO_FAIL("Data corrupted at offset %u", off);
2020         }
2021
2022         /* partial reading of mbuf data */
2023         data_copy = rte_pktmbuf_read(m, hdr_len + 5, MBUF_TEST_DATA_LEN2 - 5,
2024                         NULL);
2025         if (data_copy == NULL)
2026                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2027         if (strlen(data_copy) != MBUF_TEST_DATA_LEN2 - 5)
2028                 GOTO_FAIL("%s: Incorrect data length!\n", __func__);
2029         for (off = 0; off < MBUF_TEST_DATA_LEN2 - 5; off++) {
2030                 if (data_copy[off] != (char)0xcc)
2031                         GOTO_FAIL("Data corrupted at offset %u", off);
2032         }
2033
2034         /* read length greater than mbuf data_len */
2035         if (rte_pktmbuf_read(m, hdr_len, rte_pktmbuf_data_len(m) + 1,
2036                                 NULL) != NULL)
2037                 GOTO_FAIL("%s: Requested len is larger than mbuf data len!\n",
2038                                 __func__);
2039
2040         /* read length greater than mbuf pkt_len */
2041         if (rte_pktmbuf_read(m, hdr_len, rte_pktmbuf_pkt_len(m) + 1,
2042                                 NULL) != NULL)
2043                 GOTO_FAIL("%s: Requested len is larger than mbuf pkt len!\n",
2044                                 __func__);
2045
2046         /* read data of zero len from valid offset */
2047         data_copy = rte_pktmbuf_read(m, hdr_len, 0, NULL);
2048         if (data_copy == NULL)
2049                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2050         if (strlen(data_copy) != MBUF_TEST_DATA_LEN2)
2051                 GOTO_FAIL("%s: Corrupted data content!\n", __func__);
2052         for (off = 0; off < MBUF_TEST_DATA_LEN2; off++) {
2053                 if (data_copy[off] != (char)0xcc)
2054                         GOTO_FAIL("Data corrupted at offset %u", off);
2055         }
2056
2057         /* read data of zero length from zero offset */
2058         data_copy = rte_pktmbuf_read(m, 0, 0, NULL);
2059         if (data_copy == NULL)
2060                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2061         /* check if the received address is the beginning of header info */
2062         if (hdr != (const struct ether_hdr *)data_copy)
2063                 GOTO_FAIL("%s: Corrupted data address!\n", __func__);
2064
2065         /* read data of max length from valid offset */
2066         data_copy = rte_pktmbuf_read(m, hdr_len, UINT_MAX, NULL);
2067         if (data_copy == NULL)
2068                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2069         /* check if the received address is the beginning of data segment */
2070         if (data_copy != data)
2071                 GOTO_FAIL("%s: Corrupted data address!\n", __func__);
2072
2073         /* try to read from mbuf with max size offset */
2074         data_copy = rte_pktmbuf_read(m, UINT_MAX, 0, NULL);
2075         if (data_copy != NULL)
2076                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2077
2078         /* try to read from mbuf with max size offset and len */
2079         data_copy = rte_pktmbuf_read(m, UINT_MAX, UINT_MAX, NULL);
2080         if (data_copy != NULL)
2081                 GOTO_FAIL("%s: Error in reading packet data!\n", __func__);
2082
2083         rte_pktmbuf_dump(stdout, m, rte_pktmbuf_pkt_len(m));
2084
2085         rte_pktmbuf_free(m);
2086         m = NULL;
2087
2088         return 0;
2089 fail:
2090         if (m) {
2091                 rte_pktmbuf_free(m);
2092                 m = NULL;
2093         }
2094         return -1;
2095 }
2096
2097 struct test_case {
2098         unsigned int seg_count;
2099         unsigned int flags;
2100         uint32_t read_off;
2101         uint32_t read_len;
2102         unsigned int seg_lengths[MBUF_MAX_SEG];
2103 };
2104
2105 /* create a mbuf with different sized segments
2106  *  and fill with data [0x00 0x01 0x02 ...]
2107  */
2108 static struct rte_mbuf *
2109 create_packet(struct rte_mempool *pktmbuf_pool,
2110                 struct test_case *test_data)
2111 {
2112         uint16_t i, ret, seg, seg_len = 0;
2113         uint32_t last_index = 0;
2114         unsigned int seg_lengths[MBUF_MAX_SEG];
2115         unsigned int hdr_len;
2116         struct rte_mbuf *pkt = NULL;
2117         struct rte_mbuf *pkt_seg = NULL;
2118         char *hdr = NULL;
2119         char *data = NULL;
2120
2121         memcpy(seg_lengths, test_data->seg_lengths,
2122                         sizeof(unsigned int)*test_data->seg_count);
2123         for (seg = 0; seg < test_data->seg_count; seg++) {
2124                 hdr_len = 0;
2125                 seg_len =  seg_lengths[seg];
2126                 pkt_seg = rte_pktmbuf_alloc(pktmbuf_pool);
2127                 if (pkt_seg == NULL)
2128                         GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
2129                 if (rte_pktmbuf_pkt_len(pkt_seg) != 0)
2130                         GOTO_FAIL("%s: Bad packet length\n", __func__);
2131                 rte_mbuf_sanity_check(pkt_seg, 0);
2132                 /* Add header only for the first segment */
2133                 if (test_data->flags == MBUF_HEADER && seg == 0) {
2134                         hdr_len = sizeof(struct rte_ether_hdr);
2135                         /* prepend a header and fill with dummy data */
2136                         hdr = (char *)rte_pktmbuf_prepend(pkt_seg, hdr_len);
2137                         if (hdr == NULL)
2138                                 GOTO_FAIL("%s: Cannot prepend header\n",
2139                                                 __func__);
2140                         if (rte_pktmbuf_pkt_len(pkt_seg) != hdr_len)
2141                                 GOTO_FAIL("%s: Bad pkt length", __func__);
2142                         if (rte_pktmbuf_data_len(pkt_seg) != hdr_len)
2143                                 GOTO_FAIL("%s: Bad data length", __func__);
2144                         for (i = 0; i < hdr_len; i++)
2145                                 hdr[i] = (last_index + i) % 0xffff;
2146                         last_index += hdr_len;
2147                 }
2148                 /* skip appending segment with 0 length */
2149                 if (seg_len == 0)
2150                         continue;
2151                 data = rte_pktmbuf_append(pkt_seg, seg_len);
2152                 if (data == NULL)
2153                         GOTO_FAIL("%s: Cannot append data segment\n", __func__);
2154                 if (rte_pktmbuf_pkt_len(pkt_seg) != hdr_len + seg_len)
2155                         GOTO_FAIL("%s: Bad packet segment length: %d\n",
2156                                         __func__, rte_pktmbuf_pkt_len(pkt_seg));
2157                 if (rte_pktmbuf_data_len(pkt_seg) != hdr_len + seg_len)
2158                         GOTO_FAIL("%s: Bad data length\n", __func__);
2159                 for (i = 0; i < seg_len; i++)
2160                         data[i] = (last_index + i) % 0xffff;
2161                 /* to fill continuous data from one seg to another */
2162                 last_index += i;
2163                 /* create chained mbufs */
2164                 if (seg == 0)
2165                         pkt = pkt_seg;
2166                 else {
2167                         ret = rte_pktmbuf_chain(pkt, pkt_seg);
2168                         if (ret != 0)
2169                                 GOTO_FAIL("%s:FAIL: Chained mbuf creation %d\n",
2170                                                 __func__, ret);
2171                 }
2172
2173                 pkt_seg = pkt_seg->next;
2174         }
2175         return pkt;
2176 fail:
2177         if (pkt != NULL) {
2178                 rte_pktmbuf_free(pkt);
2179                 pkt = NULL;
2180         }
2181         if (pkt_seg != NULL) {
2182                 rte_pktmbuf_free(pkt_seg);
2183                 pkt_seg = NULL;
2184         }
2185         return NULL;
2186 }
2187
2188 static int
2189 test_pktmbuf_read_from_chain(struct rte_mempool *pktmbuf_pool)
2190 {
2191         struct rte_mbuf *m;
2192         struct test_case test_cases[] = {
2193                 {
2194                         .seg_lengths = { 100, 100, 100 },
2195                         .seg_count = 3,
2196                         .flags = MBUF_NO_HEADER,
2197                         .read_off = 0,
2198                         .read_len = 300
2199                 },
2200                 {
2201                         .seg_lengths = { 100, 125, 150 },
2202                         .seg_count = 3,
2203                         .flags = MBUF_NO_HEADER,
2204                         .read_off = 99,
2205                         .read_len = 201
2206                 },
2207                 {
2208                         .seg_lengths = { 100, 100 },
2209                         .seg_count = 2,
2210                         .flags = MBUF_NO_HEADER,
2211                         .read_off = 0,
2212                         .read_len = 100
2213                 },
2214                 {
2215                         .seg_lengths = { 100, 200 },
2216                         .seg_count = 2,
2217                         .flags = MBUF_HEADER,
2218                         .read_off = sizeof(struct rte_ether_hdr),
2219                         .read_len = 150
2220                 },
2221                 {
2222                         .seg_lengths = { 1000, 100 },
2223                         .seg_count = 2,
2224                         .flags = MBUF_NO_HEADER,
2225                         .read_off = 0,
2226                         .read_len = 1000
2227                 },
2228                 {
2229                         .seg_lengths = { 1024, 0, 100 },
2230                         .seg_count = 3,
2231                         .flags = MBUF_NO_HEADER,
2232                         .read_off = 100,
2233                         .read_len = 1001
2234                 },
2235                 {
2236                         .seg_lengths = { 1000, 1, 1000 },
2237                         .seg_count = 3,
2238                         .flags = MBUF_NO_HEADER,
2239                         .read_off = 1000,
2240                         .read_len = 2
2241                 },
2242                 {
2243                         .seg_lengths = { MBUF_TEST_DATA_LEN,
2244                                         MBUF_TEST_DATA_LEN2,
2245                                         MBUF_TEST_DATA_LEN3, 800, 10 },
2246                         .seg_count = 5,
2247                         .flags = MBUF_NEG_TEST_READ,
2248                         .read_off = 1000,
2249                         .read_len = MBUF_DATA_SIZE
2250                 },
2251         };
2252
2253         uint32_t i, pos;
2254         const char *data_copy = NULL;
2255         char data_buf[MBUF_DATA_SIZE];
2256
2257         memset(data_buf, 0, MBUF_DATA_SIZE);
2258
2259         for (i = 0; i < RTE_DIM(test_cases); i++) {
2260                 m = create_packet(pktmbuf_pool, &test_cases[i]);
2261                 if (m == NULL)
2262                         GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
2263
2264                 data_copy = rte_pktmbuf_read(m, test_cases[i].read_off,
2265                                 test_cases[i].read_len, data_buf);
2266                 if (test_cases[i].flags == MBUF_NEG_TEST_READ) {
2267                         if (data_copy != NULL)
2268                                 GOTO_FAIL("%s: mbuf data read should fail!\n",
2269                                                 __func__);
2270                         else {
2271                                 rte_pktmbuf_free(m);
2272                                 m = NULL;
2273                                 continue;
2274                         }
2275                 }
2276                 if (data_copy == NULL)
2277                         GOTO_FAIL("%s: Error in reading packet data!\n",
2278                                         __func__);
2279                 for (pos = 0; pos < test_cases[i].read_len; pos++) {
2280                         if (data_copy[pos] !=
2281                                         (char)((test_cases[i].read_off + pos)
2282                                                 % 0xffff))
2283                                 GOTO_FAIL("Data corrupted at offset %u is %2X",
2284                                                 pos, data_copy[pos]);
2285                 }
2286                 rte_pktmbuf_dump(stdout, m, rte_pktmbuf_pkt_len(m));
2287                 rte_pktmbuf_free(m);
2288                 m = NULL;
2289         }
2290         return 0;
2291
2292 fail:
2293         if (m != NULL) {
2294                 rte_pktmbuf_free(m);
2295                 m = NULL;
2296         }
2297         return -1;
2298 }
2299
2300 /* Define a free call back function to be used for external buffer */
2301 static void
2302 ext_buf_free_callback_fn(void *addr __rte_unused, void *opaque)
2303 {
2304         void *ext_buf_addr = opaque;
2305
2306         if (ext_buf_addr == NULL) {
2307                 printf("External buffer address is invalid\n");
2308                 return;
2309         }
2310         rte_free(ext_buf_addr);
2311         ext_buf_addr = NULL;
2312         printf("External buffer freed via callback\n");
2313 }
2314
2315 /*
2316  * Test to initialize shared data in external buffer before attaching to mbuf
2317  *  - Allocate mbuf with no data.
2318  *  - Allocate external buffer with size should be large enough to accommodate
2319  *     rte_mbuf_ext_shared_info.
2320  *  - Invoke pktmbuf_ext_shinfo_init_helper to initialize shared data.
2321  *  - Invoke rte_pktmbuf_attach_extbuf to attach external buffer to the mbuf.
2322  *  - Clone another mbuf and attach the same external buffer to it.
2323  *  - Invoke rte_pktmbuf_detach_extbuf to detach the external buffer from mbuf.
2324  */
2325 static int
2326 test_pktmbuf_ext_shinfo_init_helper(struct rte_mempool *pktmbuf_pool)
2327 {
2328         struct rte_mbuf *m = NULL;
2329         struct rte_mbuf *clone = NULL;
2330         struct rte_mbuf_ext_shared_info *ret_shinfo = NULL;
2331         rte_iova_t buf_iova;
2332         void *ext_buf_addr = NULL;
2333         uint16_t buf_len = EXT_BUF_TEST_DATA_LEN +
2334                                 sizeof(struct rte_mbuf_ext_shared_info);
2335
2336         /* alloc a mbuf */
2337         m = rte_pktmbuf_alloc(pktmbuf_pool);
2338         if (m == NULL)
2339                 GOTO_FAIL("%s: mbuf allocation failed!\n", __func__);
2340         if (rte_pktmbuf_pkt_len(m) != 0)
2341                 GOTO_FAIL("%s: Bad packet length\n", __func__);
2342         rte_mbuf_sanity_check(m, 0);
2343
2344         ext_buf_addr = rte_malloc("External buffer", buf_len,
2345                         RTE_CACHE_LINE_SIZE);
2346         if (ext_buf_addr == NULL)
2347                 GOTO_FAIL("%s: External buffer allocation failed\n", __func__);
2348
2349         ret_shinfo = rte_pktmbuf_ext_shinfo_init_helper(ext_buf_addr, &buf_len,
2350                 ext_buf_free_callback_fn, ext_buf_addr);
2351         if (ret_shinfo == NULL)
2352                 GOTO_FAIL("%s: Shared info initialization failed!\n", __func__);
2353
2354         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 1)
2355                 GOTO_FAIL("%s: External refcount is not 1\n", __func__);
2356
2357         if (rte_mbuf_refcnt_read(m) != 1)
2358                 GOTO_FAIL("%s: Invalid refcnt in mbuf\n", __func__);
2359
2360         buf_iova = rte_mempool_virt2iova(ext_buf_addr);
2361         rte_pktmbuf_attach_extbuf(m, ext_buf_addr, buf_iova, buf_len,
2362                 ret_shinfo);
2363         if (m->ol_flags != EXT_ATTACHED_MBUF)
2364                 GOTO_FAIL("%s: External buffer is not attached to mbuf\n",
2365                                 __func__);
2366
2367         /* allocate one more mbuf */
2368         clone = rte_pktmbuf_clone(m, pktmbuf_pool);
2369         if (clone == NULL)
2370                 GOTO_FAIL("%s: mbuf clone allocation failed!\n", __func__);
2371         if (rte_pktmbuf_pkt_len(clone) != 0)
2372                 GOTO_FAIL("%s: Bad packet length\n", __func__);
2373
2374         /* attach the same external buffer to the cloned mbuf */
2375         rte_pktmbuf_attach_extbuf(clone, ext_buf_addr, buf_iova, buf_len,
2376                         ret_shinfo);
2377         if (clone->ol_flags != EXT_ATTACHED_MBUF)
2378                 GOTO_FAIL("%s: External buffer is not attached to mbuf\n",
2379                                 __func__);
2380
2381         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 2)
2382                 GOTO_FAIL("%s: Invalid ext_buf ref_cnt\n", __func__);
2383
2384         /* test to manually update ext_buf_ref_cnt from 2 to 3*/
2385         rte_mbuf_ext_refcnt_update(ret_shinfo, 1);
2386         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 3)
2387                 GOTO_FAIL("%s: Update ext_buf ref_cnt failed\n", __func__);
2388
2389         /* reset the ext_refcnt before freeing the external buffer */
2390         rte_mbuf_ext_refcnt_set(ret_shinfo, 2);
2391         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 2)
2392                 GOTO_FAIL("%s: set ext_buf ref_cnt failed\n", __func__);
2393
2394         /* detach the external buffer from mbufs */
2395         rte_pktmbuf_detach_extbuf(m);
2396         /* check if ref cnt is decremented */
2397         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 1)
2398                 GOTO_FAIL("%s: Invalid ext_buf ref_cnt\n", __func__);
2399
2400         rte_pktmbuf_detach_extbuf(clone);
2401         if (rte_mbuf_ext_refcnt_read(ret_shinfo) != 0)
2402                 GOTO_FAIL("%s: Invalid ext_buf ref_cnt\n", __func__);
2403
2404         rte_pktmbuf_free(m);
2405         m = NULL;
2406         rte_pktmbuf_free(clone);
2407         clone = NULL;
2408
2409         return 0;
2410
2411 fail:
2412         if (m) {
2413                 rte_pktmbuf_free(m);
2414                 m = NULL;
2415         }
2416         if (clone) {
2417                 rte_pktmbuf_free(clone);
2418                 clone = NULL;
2419         }
2420         if (ext_buf_addr != NULL) {
2421                 rte_free(ext_buf_addr);
2422                 ext_buf_addr = NULL;
2423         }
2424         return -1;
2425 }
2426
2427 /*
2428  * Test the mbuf pool with pinned external data buffers
2429  *  - Allocate memory zone for external buffer
2430  *  - Create the mbuf pool with pinned external buffer
2431  *  - Check the created pool with relevant mbuf pool unit tests
2432  */
2433 static int
2434 test_pktmbuf_ext_pinned_buffer(struct rte_mempool *std_pool)
2435 {
2436
2437         struct rte_pktmbuf_extmem ext_mem;
2438         struct rte_mempool *pinned_pool = NULL;
2439         const struct rte_memzone *mz = NULL;
2440
2441         printf("Test mbuf pool with external pinned data buffers\n");
2442
2443         /* Allocate memzone for the external data buffer */
2444         mz = rte_memzone_reserve("pinned_pool",
2445                                  NB_MBUF * MBUF_DATA_SIZE,
2446                                  SOCKET_ID_ANY,
2447                                  RTE_MEMZONE_2MB | RTE_MEMZONE_SIZE_HINT_ONLY);
2448         if (mz == NULL)
2449                 GOTO_FAIL("%s: Memzone allocation failed\n", __func__);
2450
2451         /* Create the mbuf pool with pinned external data buffer */
2452         ext_mem.buf_ptr = mz->addr;
2453         ext_mem.buf_iova = mz->iova;
2454         ext_mem.buf_len = mz->len;
2455         ext_mem.elt_size = MBUF_DATA_SIZE;
2456
2457         pinned_pool = rte_pktmbuf_pool_create_extbuf("test_pinned_pool",
2458                                 NB_MBUF, MEMPOOL_CACHE_SIZE, 0,
2459                                 MBUF_DATA_SIZE, SOCKET_ID_ANY,
2460                                 &ext_mem, 1);
2461         if (pinned_pool == NULL)
2462                 GOTO_FAIL("%s: Mbuf pool with pinned external"
2463                           " buffer creation failed\n", __func__);
2464         /* test multiple mbuf alloc */
2465         if (test_pktmbuf_pool(pinned_pool) < 0)
2466                 GOTO_FAIL("%s: test_mbuf_pool(pinned) failed\n",
2467                           __func__);
2468
2469         /* do it another time to check that all mbufs were freed */
2470         if (test_pktmbuf_pool(pinned_pool) < 0)
2471                 GOTO_FAIL("%s: test_mbuf_pool(pinned) failed (2)\n",
2472                           __func__);
2473
2474         /* test that the data pointer on a packet mbuf is set properly */
2475         if (test_pktmbuf_pool_ptr(pinned_pool) < 0)
2476                 GOTO_FAIL("%s: test_pktmbuf_pool_ptr(pinned) failed\n",
2477                           __func__);
2478
2479         /* test data manipulation in mbuf with non-ascii data */
2480         if (test_pktmbuf_with_non_ascii_data(pinned_pool) < 0)
2481                 GOTO_FAIL("%s: test_pktmbuf_with_non_ascii_data(pinned)"
2482                           " failed\n", __func__);
2483
2484         /* test free pktmbuf segment one by one */
2485         if (test_pktmbuf_free_segment(pinned_pool) < 0)
2486                 GOTO_FAIL("%s: test_pktmbuf_free_segment(pinned) failed\n",
2487                           __func__);
2488
2489         if (testclone_testupdate_testdetach(pinned_pool, std_pool) < 0)
2490                 GOTO_FAIL("%s: testclone_and_testupdate(pinned) failed\n",
2491                           __func__);
2492
2493         if (test_pktmbuf_copy(pinned_pool, std_pool) < 0)
2494                 GOTO_FAIL("%s: test_pktmbuf_copy(pinned) failed\n",
2495                           __func__);
2496
2497         if (test_failing_mbuf_sanity_check(pinned_pool) < 0)
2498                 GOTO_FAIL("%s: test_failing_mbuf_sanity_check(pinned)"
2499                           " failed\n", __func__);
2500
2501         if (test_mbuf_linearize_check(pinned_pool) < 0)
2502                 GOTO_FAIL("%s: test_mbuf_linearize_check(pinned) failed\n",
2503                           __func__);
2504
2505         /* test for allocating a bulk of mbufs with various sizes */
2506         if (test_pktmbuf_alloc_bulk(pinned_pool) < 0)
2507                 GOTO_FAIL("%s: test_rte_pktmbuf_alloc_bulk(pinned) failed\n",
2508                           __func__);
2509
2510         /* test for allocating a bulk of mbufs with various sizes */
2511         if (test_neg_pktmbuf_alloc_bulk(pinned_pool) < 0)
2512                 GOTO_FAIL("%s: test_neg_rte_pktmbuf_alloc_bulk(pinned)"
2513                           " failed\n", __func__);
2514
2515         /* test to read mbuf packet */
2516         if (test_pktmbuf_read(pinned_pool) < 0)
2517                 GOTO_FAIL("%s: test_rte_pktmbuf_read(pinned) failed\n",
2518                           __func__);
2519
2520         /* test to read mbuf packet from offset */
2521         if (test_pktmbuf_read_from_offset(pinned_pool) < 0)
2522                 GOTO_FAIL("%s: test_rte_pktmbuf_read_from_offset(pinned)"
2523                           " failed\n", __func__);
2524
2525         /* test to read data from chain of mbufs with data segments */
2526         if (test_pktmbuf_read_from_chain(pinned_pool) < 0)
2527                 GOTO_FAIL("%s: test_rte_pktmbuf_read_from_chain(pinned)"
2528                           " failed\n", __func__);
2529
2530         RTE_SET_USED(std_pool);
2531         rte_mempool_free(pinned_pool);
2532         rte_memzone_free(mz);
2533         return 0;
2534
2535 fail:
2536         rte_mempool_free(pinned_pool);
2537         rte_memzone_free(mz);
2538         return -1;
2539 }
2540
2541 static int
2542 test_mbuf_dyn(struct rte_mempool *pktmbuf_pool)
2543 {
2544         const struct rte_mbuf_dynfield dynfield = {
2545                 .name = "test-dynfield",
2546                 .size = sizeof(uint8_t),
2547                 .align = __alignof__(uint8_t),
2548                 .flags = 0,
2549         };
2550         const struct rte_mbuf_dynfield dynfield2 = {
2551                 .name = "test-dynfield2",
2552                 .size = sizeof(uint16_t),
2553                 .align = __alignof__(uint16_t),
2554                 .flags = 0,
2555         };
2556         const struct rte_mbuf_dynfield dynfield3 = {
2557                 .name = "test-dynfield3",
2558                 .size = sizeof(uint8_t),
2559                 .align = __alignof__(uint8_t),
2560                 .flags = 0,
2561         };
2562         const struct rte_mbuf_dynfield dynfield_fail_big = {
2563                 .name = "test-dynfield-fail-big",
2564                 .size = 256,
2565                 .align = 1,
2566                 .flags = 0,
2567         };
2568         const struct rte_mbuf_dynfield dynfield_fail_align = {
2569                 .name = "test-dynfield-fail-align",
2570                 .size = 1,
2571                 .align = 3,
2572                 .flags = 0,
2573         };
2574         const struct rte_mbuf_dynflag dynflag = {
2575                 .name = "test-dynflag",
2576                 .flags = 0,
2577         };
2578         const struct rte_mbuf_dynflag dynflag2 = {
2579                 .name = "test-dynflag2",
2580                 .flags = 0,
2581         };
2582         const struct rte_mbuf_dynflag dynflag3 = {
2583                 .name = "test-dynflag3",
2584                 .flags = 0,
2585         };
2586         struct rte_mbuf *m = NULL;
2587         int offset, offset2, offset3;
2588         int flag, flag2, flag3;
2589         int ret;
2590
2591         printf("Test mbuf dynamic fields and flags\n");
2592         rte_mbuf_dyn_dump(stdout);
2593
2594         offset = rte_mbuf_dynfield_register(&dynfield);
2595         if (offset == -1)
2596                 GOTO_FAIL("failed to register dynamic field, offset=%d: %s",
2597                         offset, strerror(errno));
2598
2599         ret = rte_mbuf_dynfield_register(&dynfield);
2600         if (ret != offset)
2601                 GOTO_FAIL("failed to lookup dynamic field, ret=%d: %s",
2602                         ret, strerror(errno));
2603
2604         offset2 = rte_mbuf_dynfield_register(&dynfield2);
2605         if (offset2 == -1 || offset2 == offset || (offset2 & 1))
2606                 GOTO_FAIL("failed to register dynamic field 2, offset2=%d: %s",
2607                         offset2, strerror(errno));
2608
2609         offset3 = rte_mbuf_dynfield_register_offset(&dynfield3,
2610                                 offsetof(struct rte_mbuf, dynfield1[1]));
2611         if (offset3 != offsetof(struct rte_mbuf, dynfield1[1])) {
2612                 if (rte_errno == EBUSY)
2613                         printf("mbuf test error skipped: dynfield is busy\n");
2614                 else
2615                         GOTO_FAIL("failed to register dynamic field 3, offset="
2616                                 "%d: %s", offset3, strerror(errno));
2617         }
2618
2619         printf("dynfield: offset=%d, offset2=%d, offset3=%d\n",
2620                 offset, offset2, offset3);
2621
2622         ret = rte_mbuf_dynfield_register(&dynfield_fail_big);
2623         if (ret != -1)
2624                 GOTO_FAIL("dynamic field creation should fail (too big)");
2625
2626         ret = rte_mbuf_dynfield_register(&dynfield_fail_align);
2627         if (ret != -1)
2628                 GOTO_FAIL("dynamic field creation should fail (bad alignment)");
2629
2630         ret = rte_mbuf_dynfield_register_offset(&dynfield_fail_align,
2631                                 offsetof(struct rte_mbuf, ol_flags));
2632         if (ret != -1)
2633                 GOTO_FAIL("dynamic field creation should fail (not avail)");
2634
2635         flag = rte_mbuf_dynflag_register(&dynflag);
2636         if (flag == -1)
2637                 GOTO_FAIL("failed to register dynamic flag, flag=%d: %s",
2638                         flag, strerror(errno));
2639
2640         ret = rte_mbuf_dynflag_register(&dynflag);
2641         if (ret != flag)
2642                 GOTO_FAIL("failed to lookup dynamic flag, ret=%d: %s",
2643                         ret, strerror(errno));
2644
2645         flag2 = rte_mbuf_dynflag_register(&dynflag2);
2646         if (flag2 == -1 || flag2 == flag)
2647                 GOTO_FAIL("failed to register dynamic flag 2, flag2=%d: %s",
2648                         flag2, strerror(errno));
2649
2650         flag3 = rte_mbuf_dynflag_register_bitnum(&dynflag3,
2651                                                 rte_bsf64(PKT_LAST_FREE));
2652         if (flag3 != rte_bsf64(PKT_LAST_FREE))
2653                 GOTO_FAIL("failed to register dynamic flag 3, flag3=%d: %s",
2654                         flag3, strerror(errno));
2655
2656         printf("dynflag: flag=%d, flag2=%d, flag3=%d\n", flag, flag2, flag3);
2657
2658         /* set, get dynamic field */
2659         m = rte_pktmbuf_alloc(pktmbuf_pool);
2660         if (m == NULL)
2661                 GOTO_FAIL("Cannot allocate mbuf");
2662
2663         *RTE_MBUF_DYNFIELD(m, offset, uint8_t *) = 1;
2664         if (*RTE_MBUF_DYNFIELD(m, offset, uint8_t *) != 1)
2665                 GOTO_FAIL("failed to read dynamic field");
2666         *RTE_MBUF_DYNFIELD(m, offset2, uint16_t *) = 1000;
2667         if (*RTE_MBUF_DYNFIELD(m, offset2, uint16_t *) != 1000)
2668                 GOTO_FAIL("failed to read dynamic field");
2669
2670         /* set a dynamic flag */
2671         m->ol_flags |= (1ULL << flag);
2672
2673         rte_mbuf_dyn_dump(stdout);
2674         rte_pktmbuf_free(m);
2675         return 0;
2676 fail:
2677         rte_pktmbuf_free(m);
2678         return -1;
2679 }
2680
2681 static int
2682 test_mbuf(void)
2683 {
2684         int ret = -1;
2685         struct rte_mempool *pktmbuf_pool = NULL;
2686         struct rte_mempool *pktmbuf_pool2 = NULL;
2687
2688
2689         RTE_BUILD_BUG_ON(sizeof(struct rte_mbuf) != RTE_CACHE_LINE_MIN_SIZE * 2);
2690
2691         /* create pktmbuf pool if it does not exist */
2692         pktmbuf_pool = rte_pktmbuf_pool_create("test_pktmbuf_pool",
2693                         NB_MBUF, MEMPOOL_CACHE_SIZE, 0, MBUF_DATA_SIZE,
2694                         SOCKET_ID_ANY);
2695
2696         if (pktmbuf_pool == NULL) {
2697                 printf("cannot allocate mbuf pool\n");
2698                 goto err;
2699         }
2700
2701         /* test registration of dynamic fields and flags */
2702         if (test_mbuf_dyn(pktmbuf_pool) < 0) {
2703                 printf("mbuf dynflag test failed\n");
2704                 goto err;
2705         }
2706
2707         /* create a specific pktmbuf pool with a priv_size != 0 and no data
2708          * room size */
2709         pktmbuf_pool2 = rte_pktmbuf_pool_create("test_pktmbuf_pool2",
2710                         NB_MBUF, MEMPOOL_CACHE_SIZE, MBUF2_PRIV_SIZE, 0,
2711                         SOCKET_ID_ANY);
2712
2713         if (pktmbuf_pool2 == NULL) {
2714                 printf("cannot allocate mbuf pool\n");
2715                 goto err;
2716         }
2717
2718         /* test multiple mbuf alloc */
2719         if (test_pktmbuf_pool(pktmbuf_pool) < 0) {
2720                 printf("test_mbuf_pool() failed\n");
2721                 goto err;
2722         }
2723
2724         /* do it another time to check that all mbufs were freed */
2725         if (test_pktmbuf_pool(pktmbuf_pool) < 0) {
2726                 printf("test_mbuf_pool() failed (2)\n");
2727                 goto err;
2728         }
2729
2730         /* test bulk mbuf alloc and free */
2731         if (test_pktmbuf_pool_bulk() < 0) {
2732                 printf("test_pktmbuf_pool_bulk() failed\n");
2733                 goto err;
2734         }
2735
2736         /* test that the pointer to the data on a packet mbuf is set properly */
2737         if (test_pktmbuf_pool_ptr(pktmbuf_pool) < 0) {
2738                 printf("test_pktmbuf_pool_ptr() failed\n");
2739                 goto err;
2740         }
2741
2742         /* test data manipulation in mbuf */
2743         if (test_one_pktmbuf(pktmbuf_pool) < 0) {
2744                 printf("test_one_mbuf() failed\n");
2745                 goto err;
2746         }
2747
2748
2749         /*
2750          * do it another time, to check that allocation reinitialize
2751          * the mbuf correctly
2752          */
2753         if (test_one_pktmbuf(pktmbuf_pool) < 0) {
2754                 printf("test_one_mbuf() failed (2)\n");
2755                 goto err;
2756         }
2757
2758         if (test_pktmbuf_with_non_ascii_data(pktmbuf_pool) < 0) {
2759                 printf("test_pktmbuf_with_non_ascii_data() failed\n");
2760                 goto err;
2761         }
2762
2763         /* test free pktmbuf segment one by one */
2764         if (test_pktmbuf_free_segment(pktmbuf_pool) < 0) {
2765                 printf("test_pktmbuf_free_segment() failed.\n");
2766                 goto err;
2767         }
2768
2769         if (testclone_testupdate_testdetach(pktmbuf_pool, pktmbuf_pool) < 0) {
2770                 printf("testclone_and_testupdate() failed \n");
2771                 goto err;
2772         }
2773
2774         if (test_pktmbuf_copy(pktmbuf_pool, pktmbuf_pool) < 0) {
2775                 printf("test_pktmbuf_copy() failed\n");
2776                 goto err;
2777         }
2778
2779         if (test_attach_from_different_pool(pktmbuf_pool, pktmbuf_pool2) < 0) {
2780                 printf("test_attach_from_different_pool() failed\n");
2781                 goto err;
2782         }
2783
2784         if (test_refcnt_mbuf() < 0) {
2785                 printf("test_refcnt_mbuf() failed \n");
2786                 goto err;
2787         }
2788
2789         if (test_failing_mbuf_sanity_check(pktmbuf_pool) < 0) {
2790                 printf("test_failing_mbuf_sanity_check() failed\n");
2791                 goto err;
2792         }
2793
2794         if (test_mbuf_linearize_check(pktmbuf_pool) < 0) {
2795                 printf("test_mbuf_linearize_check() failed\n");
2796                 goto err;
2797         }
2798
2799         if (test_tx_offload() < 0) {
2800                 printf("test_tx_offload() failed\n");
2801                 goto err;
2802         }
2803
2804         if (test_get_rx_ol_flag_list() < 0) {
2805                 printf("test_rte_get_rx_ol_flag_list() failed\n");
2806                 goto err;
2807         }
2808
2809         if (test_get_tx_ol_flag_list() < 0) {
2810                 printf("test_rte_get_tx_ol_flag_list() failed\n");
2811                 goto err;
2812         }
2813
2814         if (test_get_rx_ol_flag_name() < 0) {
2815                 printf("test_rte_get_rx_ol_flag_name() failed\n");
2816                 goto err;
2817         }
2818
2819         if (test_get_tx_ol_flag_name() < 0) {
2820                 printf("test_rte_get_tx_ol_flag_name() failed\n");
2821                 goto err;
2822         }
2823
2824         if (test_mbuf_validate_tx_offload_one(pktmbuf_pool) < 0) {
2825                 printf("test_mbuf_validate_tx_offload_one() failed\n");
2826                 goto err;
2827         }
2828
2829         /* test for allocating a bulk of mbufs with various sizes */
2830         if (test_pktmbuf_alloc_bulk(pktmbuf_pool) < 0) {
2831                 printf("test_rte_pktmbuf_alloc_bulk() failed\n");
2832                 goto err;
2833         }
2834
2835         /* test for allocating a bulk of mbufs with various sizes */
2836         if (test_neg_pktmbuf_alloc_bulk(pktmbuf_pool) < 0) {
2837                 printf("test_neg_rte_pktmbuf_alloc_bulk() failed\n");
2838                 goto err;
2839         }
2840
2841         /* test to read mbuf packet */
2842         if (test_pktmbuf_read(pktmbuf_pool) < 0) {
2843                 printf("test_rte_pktmbuf_read() failed\n");
2844                 goto err;
2845         }
2846
2847         /* test to read mbuf packet from offset */
2848         if (test_pktmbuf_read_from_offset(pktmbuf_pool) < 0) {
2849                 printf("test_rte_pktmbuf_read_from_offset() failed\n");
2850                 goto err;
2851         }
2852
2853         /* test to read data from chain of mbufs with data segments */
2854         if (test_pktmbuf_read_from_chain(pktmbuf_pool) < 0) {
2855                 printf("test_rte_pktmbuf_read_from_chain() failed\n");
2856                 goto err;
2857         }
2858
2859         /* test to initialize shared info. at the end of external buffer */
2860         if (test_pktmbuf_ext_shinfo_init_helper(pktmbuf_pool) < 0) {
2861                 printf("test_pktmbuf_ext_shinfo_init_helper() failed\n");
2862                 goto err;
2863         }
2864
2865         /* test the mbuf pool with pinned external data buffers */
2866         if (test_pktmbuf_ext_pinned_buffer(pktmbuf_pool) < 0) {
2867                 printf("test_pktmbuf_ext_pinned_buffer() failed\n");
2868                 goto err;
2869         }
2870
2871
2872         ret = 0;
2873 err:
2874         rte_mempool_free(pktmbuf_pool);
2875         rte_mempool_free(pktmbuf_pool2);
2876         return ret;
2877 }
2878 #undef GOTO_FAIL
2879
2880 REGISTER_TEST_COMMAND(mbuf_autotest, test_mbuf);