lib/librte_mbuf/rte_mbuf.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation.
   3  * Copyright 2014 6WIND S.A.
   4  */
   5
   6 #include <string.h>
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <stdint.h>
  10 #include <stdarg.h>
  11 #include <inttypes.h>
  12 #include <errno.h>
  13 #include <ctype.h>
  14 #include <sys/queue.h>
  15
  16 #include <rte_compat.h>
  17 #include <rte_debug.h>
  18 #include <rte_common.h>
  19 #include <rte_log.h>
  20 #include <rte_memory.h>
  21 #include <rte_launch.h>
  22 #include <rte_eal.h>
  23 #include <rte_per_lcore.h>
  24 #include <rte_lcore.h>
  25 #include <rte_atomic.h>
  26 #include <rte_branch_prediction.h>
  27 #include <rte_mempool.h>
  28 #include <rte_mbuf.h>
  29 #include <rte_mbuf_pool_ops.h>
  30 #include <rte_string_fns.h>
  31 #include <rte_hexdump.h>
  32 #include <rte_errno.h>
  33 #include <rte_memcpy.h>
  34
  35 /*
  36  * pktmbuf pool constructor, given as a callback function to
  37  * rte_mempool_create(), or called directly if using
  38  * rte_mempool_create_empty()/rte_mempool_populate()
  39  */
  40 void
  41 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
  42 {
  43         struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
  44         struct rte_pktmbuf_pool_private default_mbp_priv;
  45         uint16_t roomsz;
  46
  47         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
  48
  49         /* if no structure is provided, assume no mbuf private area */
  50         user_mbp_priv = opaque_arg;
  51         if (user_mbp_priv == NULL) {
  52                 default_mbp_priv.mbuf_priv_size = 0;
  53                 if (mp->elt_size > sizeof(struct rte_mbuf))
  54                         roomsz = mp->elt_size - sizeof(struct rte_mbuf);
  55                 else
  56                         roomsz = 0;
  57                 default_mbp_priv.mbuf_data_room_size = roomsz;
  58                 user_mbp_priv = &default_mbp_priv;
  59         }
  60
  61         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
  62                 user_mbp_priv->mbuf_data_room_size +
  63                 user_mbp_priv->mbuf_priv_size);
  64
  65         mbp_priv = rte_mempool_get_priv(mp);
  66         memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
  67 }
  68
  69 /*
  70  * pktmbuf constructor, given as a callback function to
  71  * rte_mempool_obj_iter() or rte_mempool_create().
  72  * Set the fields of a packet mbuf to their default values.
  73  */
  74 void
  75 rte_pktmbuf_init(struct rte_mempool *mp,
  76                  __attribute__((unused)) void *opaque_arg,
  77                  void *_m,
  78                  __attribute__((unused)) unsigned i)
  79 {
  80         struct rte_mbuf *m = _m;
  81         uint32_t mbuf_size, buf_len, priv_size;
  82
  83         priv_size = rte_pktmbuf_priv_size(mp);
  84         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
  85         buf_len = rte_pktmbuf_data_room_size(mp);
  86
  87         RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
  88         RTE_ASSERT(mp->elt_size >= mbuf_size);
  89         RTE_ASSERT(buf_len <= UINT16_MAX);
  90
  91         memset(m, 0, mbuf_size);
  92         /* start of buffer is after mbuf structure and priv data */
  93         m->priv_size = priv_size;
  94         m->buf_addr = (char *)m + mbuf_size;
  95         m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
  96         m->buf_len = (uint16_t)buf_len;
  97
  98         /* keep some headroom between start of buffer and data */
  99         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
 100
 101         /* init some constant fields */
 102         m->pool = mp;
 103         m->nb_segs = 1;
 104         m->port = MBUF_INVALID_PORT;
 105         rte_mbuf_refcnt_set(m, 1);
 106         m->next = NULL;
 107 }
 108
 109 /* Helper to create a mbuf pool with given mempool ops name*/
 110 struct rte_mempool *
 111 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
 112         unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
 113         int socket_id, const char *ops_name)
 114 {
 115         struct rte_mempool *mp;
 116         struct rte_pktmbuf_pool_private mbp_priv;
 117         const char *mp_ops_name = ops_name;
 118         unsigned elt_size;
 119         int ret;
 120
 121         if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
 122                 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
 123                         priv_size);
 124                 rte_errno = EINVAL;
 125                 return NULL;
 126         }
 127         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
 128                 (unsigned)data_room_size;
 129         mbp_priv.mbuf_data_room_size = data_room_size;
 130         mbp_priv.mbuf_priv_size = priv_size;
 131
 132         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
 133                  sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
 134         if (mp == NULL)
 135                 return NULL;
 136
 137         if (mp_ops_name == NULL)
 138                 mp_ops_name = rte_mbuf_best_mempool_ops();
 139         ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
 140         if (ret != 0) {
 141                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
 142                 rte_mempool_free(mp);
 143                 rte_errno = -ret;
 144                 return NULL;
 145         }
 146         rte_pktmbuf_pool_init(mp, &mbp_priv);
 147
 148         ret = rte_mempool_populate_default(mp);
 149         if (ret < 0) {
 150                 rte_mempool_free(mp);
 151                 rte_errno = -ret;
 152                 return NULL;
 153         }
 154
 155         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
 156
 157         return mp;
 158 }
 159
 160 /* helper to create a mbuf pool */
 161 struct rte_mempool *
 162 rte_pktmbuf_pool_create(const char *name, unsigned int n,
 163         unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
 164         int socket_id)
 165 {
 166         return rte_pktmbuf_pool_create_by_ops(name, n, cache_size, priv_size,
 167                         data_room_size, socket_id, NULL);
 168 }
 169
 170 /* do some sanity checks on a mbuf: panic if it fails */
 171 void
 172 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
 173 {
 174         const char *reason;
 175
 176         if (rte_mbuf_check(m, is_header, &reason))
 177                 rte_panic("%s\n", reason);
 178 }
 179
 180 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
 181                    const char **reason)
 182 {
 183         unsigned int nb_segs, pkt_len;
 184
 185         if (m == NULL) {
 186                 *reason = "mbuf is NULL";
 187                 return -1;
 188         }
 189
 190         /* generic checks */
 191         if (m->pool == NULL) {
 192                 *reason = "bad mbuf pool";
 193                 return -1;
 194         }
 195         if (m->buf_iova == 0) {
 196                 *reason = "bad IO addr";
 197                 return -1;
 198         }
 199         if (m->buf_addr == NULL) {
 200                 *reason = "bad virt addr";
 201                 return -1;
 202         }
 203
 204         uint16_t cnt = rte_mbuf_refcnt_read(m);
 205         if ((cnt == 0) || (cnt == UINT16_MAX)) {
 206                 *reason = "bad ref cnt";
 207                 return -1;
 208         }
 209
 210         /* nothing to check for sub-segments */
 211         if (is_header == 0)
 212                 return 0;
 213
 214         /* data_len is supposed to be not more than pkt_len */
 215         if (m->data_len > m->pkt_len) {
 216                 *reason = "bad data_len";
 217                 return -1;
 218         }
 219
 220         nb_segs = m->nb_segs;
 221         pkt_len = m->pkt_len;
 222
 223         do {
 224                 if (m->data_off > m->buf_len) {
 225                         *reason = "data offset too big in mbuf segment";
 226                         return -1;
 227                 }
 228                 if (m->data_off + m->data_len > m->buf_len) {
 229                         *reason = "data length too big in mbuf segment";
 230                         return -1;
 231                 }
 232                 nb_segs -= 1;
 233                 pkt_len -= m->data_len;
 234         } while ((m = m->next) != NULL);
 235
 236         if (nb_segs) {
 237                 *reason = "bad nb_segs";
 238                 return -1;
 239         }
 240         if (pkt_len) {
 241                 *reason = "bad pkt_len";
 242                 return -1;
 243         }
 244
 245         return 0;
 246 }
 247
 248 /**
 249  * @internal helper function for freeing a bulk of packet mbuf segments
 250  * via an array holding the packet mbuf segments from the same mempool
 251  * pending to be freed.
 252  *
 253  * @param m
 254  *  The packet mbuf segment to be freed.
 255  * @param pending
 256  *  Pointer to the array of packet mbuf segments pending to be freed.
 257  * @param nb_pending
 258  *  Pointer to the number of elements held in the array.
 259  * @param pending_sz
 260  *  Number of elements the array can hold.
 261  *  Note: The compiler should optimize this parameter away when using a
 262  *  constant value, such as RTE_PKTMBUF_FREE_PENDING_SZ.
 263  */
 264 static void
 265 __rte_pktmbuf_free_seg_via_array(struct rte_mbuf *m,
 266         struct rte_mbuf ** const pending, unsigned int * const nb_pending,
 267         const unsigned int pending_sz)
 268 {
 269         m = rte_pktmbuf_prefree_seg(m);
 270         if (likely(m != NULL)) {
 271                 if (*nb_pending == pending_sz ||
 272                     (*nb_pending > 0 && m->pool != pending[0]->pool)) {
 273                         rte_mempool_put_bulk(pending[0]->pool,
 274                                         (void **)pending, *nb_pending);
 275                         *nb_pending = 0;
 276                 }
 277
 278                 pending[(*nb_pending)++] = m;
 279         }
 280 }
 281
 282 /**
 283  * Size of the array holding mbufs from the same mempool pending to be freed
 284  * in bulk.
 285  */
 286 #define RTE_PKTMBUF_FREE_PENDING_SZ 64
 287
 288 /* Free a bulk of packet mbufs back into their original mempools. */
 289 void rte_pktmbuf_free_bulk(struct rte_mbuf **mbufs, unsigned int count)
 290 {
 291         struct rte_mbuf *m, *m_next, *pending[RTE_PKTMBUF_FREE_PENDING_SZ];
 292         unsigned int idx, nb_pending = 0;
 293
 294         for (idx = 0; idx < count; idx++) {
 295                 m = mbufs[idx];
 296                 if (unlikely(m == NULL))
 297                         continue;
 298
 299                 __rte_mbuf_sanity_check(m, 1);
 300
 301                 do {
 302                         m_next = m->next;
 303                         __rte_pktmbuf_free_seg_via_array(m,
 304                                         pending, &nb_pending,
 305                                         RTE_PKTMBUF_FREE_PENDING_SZ);
 306                         m = m_next;
 307                 } while (m != NULL);
 308         }
 309
 310         if (nb_pending > 0)
 311                 rte_mempool_put_bulk(pending[0]->pool, (void **)pending, nb_pending);
 312 }
 313
 314 /* Creates a shallow copy of mbuf */
 315 struct rte_mbuf *
 316 rte_pktmbuf_clone(struct rte_mbuf *md, struct rte_mempool *mp)
 317 {
 318         struct rte_mbuf *mc, *mi, **prev;
 319         uint32_t pktlen;
 320         uint16_t nseg;
 321
 322         mc = rte_pktmbuf_alloc(mp);
 323         if (unlikely(mc == NULL))
 324                 return NULL;
 325
 326         mi = mc;
 327         prev = &mi->next;
 328         pktlen = md->pkt_len;
 329         nseg = 0;
 330
 331         do {
 332                 nseg++;
 333                 rte_pktmbuf_attach(mi, md);
 334                 *prev = mi;
 335                 prev = &mi->next;
 336         } while ((md = md->next) != NULL &&
 337             (mi = rte_pktmbuf_alloc(mp)) != NULL);
 338
 339         *prev = NULL;
 340         mc->nb_segs = nseg;
 341         mc->pkt_len = pktlen;
 342
 343         /* Allocation of new indirect segment failed */
 344         if (unlikely(mi == NULL)) {
 345                 rte_pktmbuf_free(mc);
 346                 return NULL;
 347         }
 348
 349         __rte_mbuf_sanity_check(mc, 1);
 350         return mc;
 351 }
 352
 353 /* convert multi-segment mbuf to single mbuf */
 354 int
 355 __rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
 356 {
 357         size_t seg_len, copy_len;
 358         struct rte_mbuf *m;
 359         struct rte_mbuf *m_next;
 360         char *buffer;
 361
 362         /* Extend first segment to the total packet length */
 363         copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
 364
 365         if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
 366                 return -1;
 367
 368         buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
 369         mbuf->data_len = (uint16_t)(mbuf->pkt_len);
 370
 371         /* Append data from next segments to the first one */
 372         m = mbuf->next;
 373         while (m != NULL) {
 374                 m_next = m->next;
 375
 376                 seg_len = rte_pktmbuf_data_len(m);
 377                 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
 378                 buffer += seg_len;
 379
 380                 rte_pktmbuf_free_seg(m);
 381                 m = m_next;
 382         }
 383
 384         mbuf->next = NULL;
 385         mbuf->nb_segs = 1;
 386
 387         return 0;
 388 }
 389
 390 /* Create a deep copy of mbuf */
 391 struct rte_mbuf *
 392 rte_pktmbuf_copy(const struct rte_mbuf *m, struct rte_mempool *mp,
 393                  uint32_t off, uint32_t len)
 394 {
 395         const struct rte_mbuf *seg = m;
 396         struct rte_mbuf *mc, *m_last, **prev;
 397
 398         /* garbage in check */
 399         __rte_mbuf_sanity_check(m, 1);
 400
 401         /* check for request to copy at offset past end of mbuf */
 402         if (unlikely(off >= m->pkt_len))
 403                 return NULL;
 404
 405         mc = rte_pktmbuf_alloc(mp);
 406         if (unlikely(mc == NULL))
 407                 return NULL;
 408
 409         /* truncate requested length to available data */
 410         if (len > m->pkt_len - off)
 411                 len = m->pkt_len - off;
 412
 413         __rte_pktmbuf_copy_hdr(mc, m);
 414
 415         /* copied mbuf is not indirect or external */
 416         mc->ol_flags = m->ol_flags & ~(IND_ATTACHED_MBUF|EXT_ATTACHED_MBUF);
 417
 418         prev = &mc->next;
 419         m_last = mc;
 420         while (len > 0) {
 421                 uint32_t copy_len;
 422
 423                 /* skip leading mbuf segments */
 424                 while (off >= seg->data_len) {
 425                         off -= seg->data_len;
 426                         seg = seg->next;
 427                 }
 428
 429                 /* current buffer is full, chain a new one */
 430                 if (rte_pktmbuf_tailroom(m_last) == 0) {
 431                         m_last = rte_pktmbuf_alloc(mp);
 432                         if (unlikely(m_last == NULL)) {
 433                                 rte_pktmbuf_free(mc);
 434                                 return NULL;
 435                         }
 436                         ++mc->nb_segs;
 437                         *prev = m_last;
 438                         prev = &m_last->next;
 439                 }
 440
 441                 /*
 442                  * copy the min of data in input segment (seg)
 443                  * vs space available in output (m_last)
 444                  */
 445                 copy_len = RTE_MIN(seg->data_len - off, len);
 446                 if (copy_len > rte_pktmbuf_tailroom(m_last))
 447                         copy_len = rte_pktmbuf_tailroom(m_last);
 448
 449                 /* append from seg to m_last */
 450                 rte_memcpy(rte_pktmbuf_mtod_offset(m_last, char *,
 451                                                    m_last->data_len),
 452                            rte_pktmbuf_mtod_offset(seg, char *, off),
 453                            copy_len);
 454
 455                 /* update offsets and lengths */
 456                 m_last->data_len += copy_len;
 457                 mc->pkt_len += copy_len;
 458                 off += copy_len;
 459                 len -= copy_len;
 460         }
 461
 462         /* garbage out check */
 463         __rte_mbuf_sanity_check(mc, 1);
 464         return mc;
 465 }
 466
 467 /* dump a mbuf on console */
 468 void
 469 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 470 {
 471         unsigned int len;
 472         unsigned int nb_segs;
 473
 474         __rte_mbuf_sanity_check(m, 1);
 475
 476         fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
 477                m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
 478         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 479                "in_port=%u\n", m->pkt_len, m->ol_flags,
 480                (unsigned)m->nb_segs, (unsigned)m->port);
 481         nb_segs = m->nb_segs;
 482
 483         while (m && nb_segs != 0) {
 484                 __rte_mbuf_sanity_check(m, 0);
 485
 486                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
 487                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 488                 len = dump_len;
 489                 if (len > m->data_len)
 490                         len = m->data_len;
 491                 if (len != 0)
 492                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 493                 dump_len -= len;
 494                 m = m->next;
 495                 nb_segs --;
 496         }
 497 }
 498
 499 /* read len data bytes in a mbuf at specified offset (internal) */
 500 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
 501         uint32_t len, void *buf)
 502 {
 503         const struct rte_mbuf *seg = m;
 504         uint32_t buf_off = 0, copy_len;
 505
 506         if (off + len > rte_pktmbuf_pkt_len(m))
 507                 return NULL;
 508
 509         while (off >= rte_pktmbuf_data_len(seg)) {
 510                 off -= rte_pktmbuf_data_len(seg);
 511                 seg = seg->next;
 512         }
 513
 514         if (off + len <= rte_pktmbuf_data_len(seg))
 515                 return rte_pktmbuf_mtod_offset(seg, char *, off);
 516
 517         /* rare case: header is split among several segments */
 518         while (len > 0) {
 519                 copy_len = rte_pktmbuf_data_len(seg) - off;
 520                 if (copy_len > len)
 521                         copy_len = len;
 522                 rte_memcpy((char *)buf + buf_off,
 523                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
 524                 off = 0;
 525                 buf_off += copy_len;
 526                 len -= copy_len;
 527                 seg = seg->next;
 528         }
 529
 530         return buf;
 531 }
 532
 533 /*
 534  * Get the name of a RX offload flag. Must be kept synchronized with flag
 535  * definitions in rte_mbuf.h.
 536  */
 537 const char *rte_get_rx_ol_flag_name(uint64_t mask)
 538 {
 539         switch (mask) {
 540         case PKT_RX_VLAN: return "PKT_RX_VLAN";
 541         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
 542         case PKT_RX_FDIR: return "PKT_RX_FDIR";
 543         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
 544         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
 545         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
 546         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
 547         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
 548         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
 549         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
 550         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
 551         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
 552         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
 553         case PKT_RX_FDIR_ID: return "PKT_RX_FDIR_ID";
 554         case PKT_RX_FDIR_FLX: return "PKT_RX_FDIR_FLX";
 555         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
 556         case PKT_RX_QINQ: return "PKT_RX_QINQ";
 557         case PKT_RX_LRO: return "PKT_RX_LRO";
 558         case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
 559         case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
 560         case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
 561         case PKT_RX_OUTER_L4_CKSUM_BAD: return "PKT_RX_OUTER_L4_CKSUM_BAD";
 562         case PKT_RX_OUTER_L4_CKSUM_GOOD: return "PKT_RX_OUTER_L4_CKSUM_GOOD";
 563         case PKT_RX_OUTER_L4_CKSUM_INVALID:
 564                 return "PKT_RX_OUTER_L4_CKSUM_INVALID";
 565
 566         default: return NULL;
 567         }
 568 }
 569
 570 struct flag_mask {
 571         uint64_t flag;
 572         uint64_t mask;
 573         const char *default_name;
 574 };
 575
 576 /* write the list of rx ol flags in buffer buf */
 577 int
 578 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 579 {
 580         const struct flag_mask rx_flags[] = {
 581                 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
 582                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
 583                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
 584                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
 585                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
 586                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
 587                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
 588                   "PKT_RX_L4_CKSUM_UNKNOWN" },
 589                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
 590                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
 591                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
 592                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
 593                   "PKT_RX_IP_CKSUM_UNKNOWN" },
 594                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
 595                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
 596                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
 597                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
 598                 { PKT_RX_FDIR_ID, PKT_RX_FDIR_ID, NULL },
 599                 { PKT_RX_FDIR_FLX, PKT_RX_FDIR_FLX, NULL },
 600                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
 601                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
 602                 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
 603                 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
 604                 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
 605                 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
 606                 { PKT_RX_OUTER_L4_CKSUM_BAD, PKT_RX_OUTER_L4_CKSUM_MASK, NULL },
 607                 { PKT_RX_OUTER_L4_CKSUM_GOOD, PKT_RX_OUTER_L4_CKSUM_MASK,
 608                   NULL },
 609                 { PKT_RX_OUTER_L4_CKSUM_INVALID, PKT_RX_OUTER_L4_CKSUM_MASK,
 610                   NULL },
 611                 { PKT_RX_OUTER_L4_CKSUM_UNKNOWN, PKT_RX_OUTER_L4_CKSUM_MASK,
 612                   "PKT_RX_OUTER_L4_CKSUM_UNKNOWN" },
 613         };
 614         const char *name;
 615         unsigned int i;
 616         int ret;
 617
 618         if (buflen == 0)
 619                 return -1;
 620
 621         buf[0] = '\0';
 622         for (i = 0; i < RTE_DIM(rx_flags); i++) {
 623                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
 624                         continue;
 625                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
 626                 if (name == NULL)
 627                         name = rx_flags[i].default_name;
 628                 ret = snprintf(buf, buflen, "%s ", name);
 629                 if (ret < 0)
 630                         return -1;
 631                 if ((size_t)ret >= buflen)
 632                         return -1;
 633                 buf += ret;
 634                 buflen -= ret;
 635         }
 636
 637         return 0;
 638 }
 639
 640 /*
 641  * Get the name of a TX offload flag. Must be kept synchronized with flag
 642  * definitions in rte_mbuf.h.
 643  */
 644 const char *rte_get_tx_ol_flag_name(uint64_t mask)
 645 {
 646         switch (mask) {
 647         case PKT_TX_VLAN: return "PKT_TX_VLAN";
 648         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
 649         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
 650         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
 651         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
 652         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
 653         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
 654         case PKT_TX_IPV4: return "PKT_TX_IPV4";
 655         case PKT_TX_IPV6: return "PKT_TX_IPV6";
 656         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
 657         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
 658         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
 659         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
 660         case PKT_TX_TUNNEL_GTP: return "PKT_TX_TUNNEL_GTP";
 661         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
 662         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
 663         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
 664         case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
 665         case PKT_TX_TUNNEL_VXLAN_GPE: return "PKT_TX_TUNNEL_VXLAN_GPE";
 666         case PKT_TX_TUNNEL_IP: return "PKT_TX_TUNNEL_IP";
 667         case PKT_TX_TUNNEL_UDP: return "PKT_TX_TUNNEL_UDP";
 668         case PKT_TX_QINQ: return "PKT_TX_QINQ";
 669         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
 670         case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
 671         case PKT_TX_UDP_SEG: return "PKT_TX_UDP_SEG";
 672         case PKT_TX_OUTER_UDP_CKSUM: return "PKT_TX_OUTER_UDP_CKSUM";
 673         default: return NULL;
 674         }
 675 }
 676
 677 /* write the list of tx ol flags in buffer buf */
 678 int
 679 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 680 {
 681         const struct flag_mask tx_flags[] = {
 682                 { PKT_TX_VLAN, PKT_TX_VLAN, NULL },
 683                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
 684                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
 685                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
 686                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
 687                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
 688                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
 689                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
 690                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
 691                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
 692                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
 693                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
 694                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
 695                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK, NULL },
 696                 { PKT_TX_TUNNEL_GTP, PKT_TX_TUNNEL_MASK, NULL },
 697                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK, NULL },
 698                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK, NULL },
 699                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK, NULL },
 700                 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK, NULL },
 701                 { PKT_TX_TUNNEL_VXLAN_GPE, PKT_TX_TUNNEL_MASK, NULL },
 702                 { PKT_TX_TUNNEL_IP, PKT_TX_TUNNEL_MASK, NULL },
 703                 { PKT_TX_TUNNEL_UDP, PKT_TX_TUNNEL_MASK, NULL },
 704                 { PKT_TX_QINQ, PKT_TX_QINQ, NULL },
 705                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
 706                 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
 707                 { PKT_TX_UDP_SEG, PKT_TX_UDP_SEG, NULL },
 708                 { PKT_TX_OUTER_UDP_CKSUM, PKT_TX_OUTER_UDP_CKSUM, NULL },
 709         };
 710         const char *name;
 711         unsigned int i;
 712         int ret;
 713
 714         if (buflen == 0)
 715                 return -1;
 716
 717         buf[0] = '\0';
 718         for (i = 0; i < RTE_DIM(tx_flags); i++) {
 719                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
 720                         continue;
 721                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
 722                 if (name == NULL)
 723                         name = tx_flags[i].default_name;
 724                 ret = snprintf(buf, buflen, "%s ", name);
 725                 if (ret < 0)
 726                         return -1;
 727                 if ((size_t)ret >= buflen)
 728                         return -1;
 729                 buf += ret;
 730                 buflen -= ret;
 731         }
 732
 733         return 0;
 734 }