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 /* Creates a shallow copy of mbuf */
 249 struct rte_mbuf *
 250 rte_pktmbuf_clone(struct rte_mbuf *md, struct rte_mempool *mp)
 251 {
 252         struct rte_mbuf *mc, *mi, **prev;
 253         uint32_t pktlen;
 254         uint16_t nseg;
 255
 256         mc = rte_pktmbuf_alloc(mp);
 257         if (unlikely(mc == NULL))
 258                 return NULL;
 259
 260         mi = mc;
 261         prev = &mi->next;
 262         pktlen = md->pkt_len;
 263         nseg = 0;
 264
 265         do {
 266                 nseg++;
 267                 rte_pktmbuf_attach(mi, md);
 268                 *prev = mi;
 269                 prev = &mi->next;
 270         } while ((md = md->next) != NULL &&
 271             (mi = rte_pktmbuf_alloc(mp)) != NULL);
 272
 273         *prev = NULL;
 274         mc->nb_segs = nseg;
 275         mc->pkt_len = pktlen;
 276
 277         /* Allocation of new indirect segment failed */
 278         if (unlikely(mi == NULL)) {
 279                 rte_pktmbuf_free(mc);
 280                 return NULL;
 281         }
 282
 283         __rte_mbuf_sanity_check(mc, 1);
 284         return mc;
 285 }
 286
 287 /* convert multi-segment mbuf to single mbuf */
 288 int
 289 __rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
 290 {
 291         size_t seg_len, copy_len;
 292         struct rte_mbuf *m;
 293         struct rte_mbuf *m_next;
 294         char *buffer;
 295
 296         /* Extend first segment to the total packet length */
 297         copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
 298
 299         if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
 300                 return -1;
 301
 302         buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
 303         mbuf->data_len = (uint16_t)(mbuf->pkt_len);
 304
 305         /* Append data from next segments to the first one */
 306         m = mbuf->next;
 307         while (m != NULL) {
 308                 m_next = m->next;
 309
 310                 seg_len = rte_pktmbuf_data_len(m);
 311                 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
 312                 buffer += seg_len;
 313
 314                 rte_pktmbuf_free_seg(m);
 315                 m = m_next;
 316         }
 317
 318         mbuf->next = NULL;
 319         mbuf->nb_segs = 1;
 320
 321         return 0;
 322 }
 323
 324 /* Create a deep copy of mbuf */
 325 struct rte_mbuf *
 326 rte_pktmbuf_copy(const struct rte_mbuf *m, struct rte_mempool *mp,
 327                  uint32_t off, uint32_t len)
 328 {
 329         const struct rte_mbuf *seg = m;
 330         struct rte_mbuf *mc, *m_last, **prev;
 331
 332         /* garbage in check */
 333         __rte_mbuf_sanity_check(m, 1);
 334
 335         /* check for request to copy at offset past end of mbuf */
 336         if (unlikely(off >= m->pkt_len))
 337                 return NULL;
 338
 339         mc = rte_pktmbuf_alloc(mp);
 340         if (unlikely(mc == NULL))
 341                 return NULL;
 342
 343         /* truncate requested length to available data */
 344         if (len > m->pkt_len - off)
 345                 len = m->pkt_len - off;
 346
 347         __rte_pktmbuf_copy_hdr(mc, m);
 348
 349         /* copied mbuf is not indirect or external */
 350         mc->ol_flags = m->ol_flags & ~(IND_ATTACHED_MBUF|EXT_ATTACHED_MBUF);
 351
 352         prev = &mc->next;
 353         m_last = mc;
 354         while (len > 0) {
 355                 uint32_t copy_len;
 356
 357                 /* skip leading mbuf segments */
 358                 while (off >= seg->data_len) {
 359                         off -= seg->data_len;
 360                         seg = seg->next;
 361                 }
 362
 363                 /* current buffer is full, chain a new one */
 364                 if (rte_pktmbuf_tailroom(m_last) == 0) {
 365                         m_last = rte_pktmbuf_alloc(mp);
 366                         if (unlikely(m_last == NULL)) {
 367                                 rte_pktmbuf_free(mc);
 368                                 return NULL;
 369                         }
 370                         ++mc->nb_segs;
 371                         *prev = m_last;
 372                         prev = &m_last->next;
 373                 }
 374
 375                 /*
 376                  * copy the min of data in input segment (seg)
 377                  * vs space available in output (m_last)
 378                  */
 379                 copy_len = RTE_MIN(seg->data_len - off, len);
 380                 if (copy_len > rte_pktmbuf_tailroom(m_last))
 381                         copy_len = rte_pktmbuf_tailroom(m_last);
 382
 383                 /* append from seg to m_last */
 384                 rte_memcpy(rte_pktmbuf_mtod_offset(m_last, char *,
 385                                                    m_last->data_len),
 386                            rte_pktmbuf_mtod_offset(seg, char *, off),
 387                            copy_len);
 388
 389                 /* update offsets and lengths */
 390                 m_last->data_len += copy_len;
 391                 mc->pkt_len += copy_len;
 392                 off += copy_len;
 393                 len -= copy_len;
 394         }
 395
 396         /* garbage out check */
 397         __rte_mbuf_sanity_check(mc, 1);
 398         return mc;
 399 }
 400
 401 /* dump a mbuf on console */
 402 void
 403 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 404 {
 405         unsigned int len;
 406         unsigned int nb_segs;
 407
 408         __rte_mbuf_sanity_check(m, 1);
 409
 410         fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
 411                m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
 412         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 413                "in_port=%u\n", m->pkt_len, m->ol_flags,
 414                (unsigned)m->nb_segs, (unsigned)m->port);
 415         nb_segs = m->nb_segs;
 416
 417         while (m && nb_segs != 0) {
 418                 __rte_mbuf_sanity_check(m, 0);
 419
 420                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
 421                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 422                 len = dump_len;
 423                 if (len > m->data_len)
 424                         len = m->data_len;
 425                 if (len != 0)
 426                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 427                 dump_len -= len;
 428                 m = m->next;
 429                 nb_segs --;
 430         }
 431 }
 432
 433 /* read len data bytes in a mbuf at specified offset (internal) */
 434 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
 435         uint32_t len, void *buf)
 436 {
 437         const struct rte_mbuf *seg = m;
 438         uint32_t buf_off = 0, copy_len;
 439
 440         if (off + len > rte_pktmbuf_pkt_len(m))
 441                 return NULL;
 442
 443         while (off >= rte_pktmbuf_data_len(seg)) {
 444                 off -= rte_pktmbuf_data_len(seg);
 445                 seg = seg->next;
 446         }
 447
 448         if (off + len <= rte_pktmbuf_data_len(seg))
 449                 return rte_pktmbuf_mtod_offset(seg, char *, off);
 450
 451         /* rare case: header is split among several segments */
 452         while (len > 0) {
 453                 copy_len = rte_pktmbuf_data_len(seg) - off;
 454                 if (copy_len > len)
 455                         copy_len = len;
 456                 rte_memcpy((char *)buf + buf_off,
 457                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
 458                 off = 0;
 459                 buf_off += copy_len;
 460                 len -= copy_len;
 461                 seg = seg->next;
 462         }
 463
 464         return buf;
 465 }
 466
 467 /*
 468  * Get the name of a RX offload flag. Must be kept synchronized with flag
 469  * definitions in rte_mbuf.h.
 470  */
 471 const char *rte_get_rx_ol_flag_name(uint64_t mask)
 472 {
 473         switch (mask) {
 474         case PKT_RX_VLAN: return "PKT_RX_VLAN";
 475         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
 476         case PKT_RX_FDIR: return "PKT_RX_FDIR";
 477         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
 478         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
 479         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
 480         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
 481         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
 482         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
 483         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
 484         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
 485         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
 486         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
 487         case PKT_RX_FDIR_ID: return "PKT_RX_FDIR_ID";
 488         case PKT_RX_FDIR_FLX: return "PKT_RX_FDIR_FLX";
 489         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
 490         case PKT_RX_QINQ: return "PKT_RX_QINQ";
 491         case PKT_RX_LRO: return "PKT_RX_LRO";
 492         case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
 493         case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
 494         case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
 495         case PKT_RX_OUTER_L4_CKSUM_BAD: return "PKT_RX_OUTER_L4_CKSUM_BAD";
 496         case PKT_RX_OUTER_L4_CKSUM_GOOD: return "PKT_RX_OUTER_L4_CKSUM_GOOD";
 497         case PKT_RX_OUTER_L4_CKSUM_INVALID:
 498                 return "PKT_RX_OUTER_L4_CKSUM_INVALID";
 499
 500         default: return NULL;
 501         }
 502 }
 503
 504 struct flag_mask {
 505         uint64_t flag;
 506         uint64_t mask;
 507         const char *default_name;
 508 };
 509
 510 /* write the list of rx ol flags in buffer buf */
 511 int
 512 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 513 {
 514         const struct flag_mask rx_flags[] = {
 515                 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
 516                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
 517                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
 518                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
 519                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
 520                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
 521                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
 522                   "PKT_RX_L4_CKSUM_UNKNOWN" },
 523                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
 524                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
 525                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
 526                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
 527                   "PKT_RX_IP_CKSUM_UNKNOWN" },
 528                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
 529                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
 530                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
 531                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
 532                 { PKT_RX_FDIR_ID, PKT_RX_FDIR_ID, NULL },
 533                 { PKT_RX_FDIR_FLX, PKT_RX_FDIR_FLX, NULL },
 534                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
 535                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
 536                 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
 537                 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
 538                 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
 539                 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
 540                 { PKT_RX_OUTER_L4_CKSUM_BAD, PKT_RX_OUTER_L4_CKSUM_MASK, NULL },
 541                 { PKT_RX_OUTER_L4_CKSUM_GOOD, PKT_RX_OUTER_L4_CKSUM_MASK,
 542                   NULL },
 543                 { PKT_RX_OUTER_L4_CKSUM_INVALID, PKT_RX_OUTER_L4_CKSUM_MASK,
 544                   NULL },
 545                 { PKT_RX_OUTER_L4_CKSUM_UNKNOWN, PKT_RX_OUTER_L4_CKSUM_MASK,
 546                   "PKT_RX_OUTER_L4_CKSUM_UNKNOWN" },
 547         };
 548         const char *name;
 549         unsigned int i;
 550         int ret;
 551
 552         if (buflen == 0)
 553                 return -1;
 554
 555         buf[0] = '\0';
 556         for (i = 0; i < RTE_DIM(rx_flags); i++) {
 557                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
 558                         continue;
 559                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
 560                 if (name == NULL)
 561                         name = rx_flags[i].default_name;
 562                 ret = snprintf(buf, buflen, "%s ", name);
 563                 if (ret < 0)
 564                         return -1;
 565                 if ((size_t)ret >= buflen)
 566                         return -1;
 567                 buf += ret;
 568                 buflen -= ret;
 569         }
 570
 571         return 0;
 572 }
 573
 574 /*
 575  * Get the name of a TX offload flag. Must be kept synchronized with flag
 576  * definitions in rte_mbuf.h.
 577  */
 578 const char *rte_get_tx_ol_flag_name(uint64_t mask)
 579 {
 580         switch (mask) {
 581         case PKT_TX_VLAN: return "PKT_TX_VLAN";
 582         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
 583         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
 584         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
 585         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
 586         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
 587         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
 588         case PKT_TX_IPV4: return "PKT_TX_IPV4";
 589         case PKT_TX_IPV6: return "PKT_TX_IPV6";
 590         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
 591         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
 592         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
 593         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
 594         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
 595         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
 596         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
 597         case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
 598         case PKT_TX_TUNNEL_VXLAN_GPE: return "PKT_TX_TUNNEL_VXLAN_GPE";
 599         case PKT_TX_TUNNEL_IP: return "PKT_TX_TUNNEL_IP";
 600         case PKT_TX_TUNNEL_UDP: return "PKT_TX_TUNNEL_UDP";
 601         case PKT_TX_QINQ: return "PKT_TX_QINQ";
 602         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
 603         case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
 604         case PKT_TX_UDP_SEG: return "PKT_TX_UDP_SEG";
 605         case PKT_TX_OUTER_UDP_CKSUM: return "PKT_TX_OUTER_UDP_CKSUM";
 606         case PKT_TX_METADATA: return "PKT_TX_METADATA";
 607         default: return NULL;
 608         }
 609 }
 610
 611 /* write the list of tx ol flags in buffer buf */
 612 int
 613 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 614 {
 615         const struct flag_mask tx_flags[] = {
 616                 { PKT_TX_VLAN, PKT_TX_VLAN, NULL },
 617                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
 618                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
 619                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
 620                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
 621                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
 622                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
 623                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
 624                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
 625                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
 626                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
 627                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
 628                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
 629                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK, NULL },
 630                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK, NULL },
 631                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK, NULL },
 632                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK, NULL },
 633                 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK, NULL },
 634                 { PKT_TX_TUNNEL_VXLAN_GPE, PKT_TX_TUNNEL_MASK, NULL },
 635                 { PKT_TX_TUNNEL_IP, PKT_TX_TUNNEL_MASK, NULL },
 636                 { PKT_TX_TUNNEL_UDP, PKT_TX_TUNNEL_MASK, NULL },
 637                 { PKT_TX_QINQ, PKT_TX_QINQ, NULL },
 638                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
 639                 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
 640                 { PKT_TX_UDP_SEG, PKT_TX_UDP_SEG, NULL },
 641                 { PKT_TX_OUTER_UDP_CKSUM, PKT_TX_OUTER_UDP_CKSUM, NULL },
 642                 { PKT_TX_METADATA, PKT_TX_METADATA, NULL },
 643         };
 644         const char *name;
 645         unsigned int i;
 646         int ret;
 647
 648         if (buflen == 0)
 649                 return -1;
 650
 651         buf[0] = '\0';
 652         for (i = 0; i < RTE_DIM(tx_flags); i++) {
 653                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
 654                         continue;
 655                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
 656                 if (name == NULL)
 657                         name = tx_flags[i].default_name;
 658                 ret = snprintf(buf, buflen, "%s ", name);
 659                 if (ret < 0)
 660                         return -1;
 661                 if ((size_t)ret >= buflen)
 662                         return -1;
 663                 buf += ret;
 664                 buflen -= ret;
 665         }
 666
 667         return 0;
 668 }