update userguide alignment
[samplevnf.git] / common / vnf_common / app.h
1 /*
2 // Copyright (c) 2017 Intel Corporation
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 */
16
17 #ifndef __INCLUDE_APP_H__
18 #define __INCLUDE_APP_H__
19
20 #include <stdint.h>
21 #include <string.h>
22
23 #include <rte_common.h>
24 #include <rte_mempool.h>
25 #include <rte_ring.h>
26 #include <rte_sched.h>
27 #include <rte_timer.h>
28 #include <cmdline_parse.h>
29
30 #include <rte_ethdev.h>
31
32 #include "cpu_core_map.h"
33 #include "pipeline.h"
34
35 #define APP_PARAM_NAME_SIZE                      PIPELINE_NAME_SIZE
36 #define APP_LINK_PCI_BDF_SIZE                    32
37 struct app_link_params *fdir_p_link;
38 struct app_mempool_params {
39         char *name;
40         uint32_t parsed;
41         uint32_t buffer_size;
42         uint32_t pool_size;
43         uint32_t cache_size;
44         uint32_t cpu_socket_id;
45 };
46
47 struct app_link_params {
48         char *name;
49         uint32_t parsed;
50         uint32_t pmd_id; /* Generated based on port mask */
51         uint32_t arp_q; /* 0 = Disabled (packets go to default queue 0) */
52         uint32_t tcp_syn_q; /* 0 = Disabled (pkts go to default queue) */
53         uint32_t ip_local_q; /* 0 = Disabled (pkts go to default queue 0) */
54         uint32_t tcp_local_q; /* 0 = Disabled (pkts go to default queue 0) */
55         uint32_t udp_local_q; /* 0 = Disabled (pkts go to default queue 0) */
56         uint32_t sctp_local_q; /* 0 = Disabled (pkts go to default queue 0) */
57         uint32_t state; /* DOWN = 0, UP = 1 */
58         uint32_t ip; /* 0 = Invalid */
59         uint8_t ipv6[16];
60         uint32_t depth;         /* Valid only when IP is valid */
61         uint32_t depth_ipv6;
62         uint64_t mac_addr; /* Read from HW */
63         char pci_bdf[APP_LINK_PCI_BDF_SIZE];
64
65         struct rte_eth_conf conf;
66         uint8_t promisc;
67 };
68
69 struct app_pktq_hwq_in_params {
70         char *name;
71         uint32_t parsed;
72         uint32_t mempool_id; /* Position in the app->mempool_params */
73         uint32_t size;
74         uint32_t burst;
75
76         struct rte_eth_rxconf conf;
77 };
78
79 struct app_pktq_hwq_out_params {
80         char *name;
81         uint32_t parsed;
82         uint32_t size;
83         uint32_t burst;
84         uint32_t dropless;
85         uint64_t n_retries;
86         struct rte_eth_txconf conf;
87 };
88
89 struct app_pktq_swq_params {
90         char *name;
91         uint32_t parsed;
92         uint32_t size;
93         uint32_t burst_read;
94         uint32_t burst_write;
95         uint32_t dropless;
96         uint64_t n_retries;
97         uint32_t cpu_socket_id;
98         uint32_t ipv4_frag;
99         uint32_t ipv6_frag;
100         uint32_t ipv4_ras;
101         uint32_t ipv6_ras;
102         uint32_t mtu;
103         uint32_t metadata_size;
104         uint32_t mempool_direct_id;
105         uint32_t mempool_indirect_id;
106 };
107
108 #ifndef APP_FILE_NAME_SIZE
109 #define APP_FILE_NAME_SIZE                       256
110 #endif
111
112 #ifndef APP_MAX_SCHED_SUBPORTS
113 #define APP_MAX_SCHED_SUBPORTS                   8
114 #endif
115
116 #ifndef APP_MAX_SCHED_PIPES
117 #define APP_MAX_SCHED_PIPES                      4096
118 #endif
119
120 struct app_pktq_tm_params {
121         char *name;
122         uint32_t parsed;
123         const char *file_name;
124         struct rte_sched_port_params sched_port_params;
125         struct rte_sched_subport_params
126                 sched_subport_params[APP_MAX_SCHED_SUBPORTS];
127         struct rte_sched_pipe_params
128                 sched_pipe_profiles[RTE_SCHED_PIPE_PROFILES_PER_PORT];
129         int sched_pipe_to_profile[APP_MAX_SCHED_SUBPORTS * APP_MAX_SCHED_PIPES];
130         uint32_t burst_read;
131         uint32_t burst_write;
132 };
133
134 struct app_pktq_source_params {
135         char *name;
136         uint32_t parsed;
137         uint32_t mempool_id; /* Position in the app->mempool_params array */
138         uint32_t burst;
139         char *file_name; /* Full path of PCAP file to be copied to mbufs */
140         uint32_t n_bytes_per_pkt;
141 };
142
143 struct app_pktq_sink_params {
144         char *name;
145         uint8_t parsed;
146         char *file_name; /* Full path of PCAP file to be copied to mbufs */
147         uint32_t n_pkts_to_dump;
148 };
149
150 struct app_msgq_params {
151         char *name;
152         uint32_t parsed;
153         uint32_t size;
154         uint32_t cpu_socket_id;
155 };
156
157 enum app_pktq_in_type {
158         APP_PKTQ_IN_HWQ,
159         APP_PKTQ_IN_SWQ,
160         APP_PKTQ_IN_TM,
161         APP_PKTQ_IN_SOURCE,
162 };
163
164 struct app_pktq_in_params {
165         enum app_pktq_in_type type;
166         uint32_t id; /* Position in the appropriate app array */
167 };
168
169 enum app_pktq_out_type {
170         APP_PKTQ_OUT_HWQ,
171         APP_PKTQ_OUT_SWQ,
172         APP_PKTQ_OUT_TM,
173         APP_PKTQ_OUT_SINK,
174 };
175
176 struct app_pktq_out_params {
177         enum app_pktq_out_type type;
178         uint32_t id; /* Position in the appropriate app array */
179 };
180
181 #ifndef APP_PIPELINE_TYPE_SIZE
182 #define APP_PIPELINE_TYPE_SIZE                   64
183 #endif
184
185 #define APP_MAX_PIPELINE_PKTQ_IN                 PIPELINE_MAX_PORT_IN
186 #define APP_MAX_PIPELINE_PKTQ_OUT                PIPELINE_MAX_PORT_OUT
187 #define APP_MAX_PIPELINE_MSGQ_IN                 PIPELINE_MAX_MSGQ_IN
188 #define APP_MAX_PIPELINE_MSGQ_OUT                PIPELINE_MAX_MSGQ_OUT
189
190 #define APP_MAX_PIPELINE_ARGS                    PIPELINE_MAX_ARGS
191
192 struct app_pipeline_params {
193         char *name;
194         uint8_t parsed;
195
196         char type[APP_PIPELINE_TYPE_SIZE];
197
198         uint32_t socket_id;
199         uint32_t core_id;
200         uint32_t hyper_th_id;
201
202         struct app_pktq_in_params pktq_in[APP_MAX_PIPELINE_PKTQ_IN];
203         struct app_pktq_out_params pktq_out[APP_MAX_PIPELINE_PKTQ_OUT];
204         uint32_t msgq_in[APP_MAX_PIPELINE_MSGQ_IN];
205         uint32_t msgq_out[APP_MAX_PIPELINE_MSGQ_OUT];
206
207         uint32_t n_pktq_in;
208         uint32_t n_pktq_out;
209         uint32_t n_msgq_in;
210         uint32_t n_msgq_out;
211
212         uint32_t timer_period;
213
214         char *args_name[APP_MAX_PIPELINE_ARGS];
215         char *args_value[APP_MAX_PIPELINE_ARGS];
216         uint32_t n_args;
217 };
218
219 struct app_pipeline_data {
220         void *be;
221         void *fe;
222         struct pipeline_type *ptype;
223         uint64_t timer_period;
224         uint32_t enabled;
225 };
226
227 struct app_thread_pipeline_data {
228         uint32_t pipeline_id;
229         void *be;
230         pipeline_be_op_run f_run;
231         pipeline_be_op_timer f_timer;
232         uint64_t timer_period;
233         uint64_t deadline;
234 };
235
236 #ifndef APP_MAX_THREAD_PIPELINES
237 #define APP_MAX_THREAD_PIPELINES                 32
238 #endif
239
240 #ifndef APP_THREAD_TIMER_PERIOD
241 #define APP_THREAD_TIMER_PERIOD                  1
242 #endif
243
244 struct app_thread_data {
245         struct app_thread_pipeline_data regular[APP_MAX_THREAD_PIPELINES];
246         struct app_thread_pipeline_data custom[APP_MAX_THREAD_PIPELINES];
247
248         uint32_t n_regular;
249         uint32_t n_custom;
250
251         uint64_t timer_period;
252         uint64_t thread_req_deadline;
253
254         uint64_t deadline;
255
256         struct rte_ring *msgq_in;
257         struct rte_ring *msgq_out;
258
259         uint64_t headroom_time;
260         uint64_t headroom_cycles;
261         double headroom_ratio;
262 };
263
264 #ifndef APP_MAX_LINKS
265 #define APP_MAX_LINKS                            32
266 #endif
267
268 struct app_eal_params {
269         /* Map lcore set to physical cpu set */
270         char *coremap;
271
272         /* Core ID that is used as master */
273         uint32_t master_lcore_present;
274         uint32_t master_lcore;
275
276         /* Number of memory channels */
277         uint32_t channels_present;
278         uint32_t channels;
279
280         /* Memory to allocate (see also --socket-mem) */
281         uint32_t memory_present;
282         uint32_t memory;
283
284         /* Force number of memory ranks (don't detect) */
285         uint32_t ranks_present;
286         uint32_t ranks;
287
288         /* Add a PCI device in black list. */
289         char *pci_blacklist[APP_MAX_LINKS];
290
291         /* Add a PCI device in white list. */
292         char *pci_whitelist[APP_MAX_LINKS];
293
294         /* Add a virtual device. */
295         char *vdev[APP_MAX_LINKS];
296
297          /* Use VMware TSC map instead of native RDTSC */
298         uint32_t vmware_tsc_map_present;
299         int vmware_tsc_map;
300
301          /* Type of this process (primary|secondary|auto) */
302         char *proc_type;
303
304          /* Set syslog facility */
305         char *syslog;
306
307         /* Set default log level */
308         uint32_t log_level_present;
309         uint32_t log_level;
310
311         /* Display version information on startup */
312         uint32_t version_present;
313         int version;
314
315         /* This help */
316         uint32_t help_present;
317         int help;
318
319          /* Use malloc instead of hugetlbfs */
320         uint32_t no_huge_present;
321         int no_huge;
322
323         /* Disable PCI */
324         uint32_t no_pci_present;
325         int no_pci;
326
327         /* Disable HPET */
328         uint32_t no_hpet_present;
329         int no_hpet;
330
331         /* No shared config (mmap'd files) */
332         uint32_t no_shconf_present;
333         int no_shconf;
334
335         /* Add driver */
336         char *add_driver;
337
338         /*  Memory to allocate on sockets (comma separated values)*/
339         char *socket_mem;
340
341         /* Directory where hugetlbfs is mounted */
342         char *huge_dir;
343
344         /* Prefix for hugepage filenames */
345         char *file_prefix;
346
347         /* Base virtual address */
348         char *base_virtaddr;
349
350         /* Create /dev/uioX (usually done by hotplug) */
351         uint32_t create_uio_dev_present;
352         int create_uio_dev;
353
354         /* Interrupt mode for VFIO (legacy|msi|msix) */
355         char *vfio_intr;
356
357         /* Support running on Xen dom0 without hugetlbfs */
358         uint32_t xen_dom0_present;
359         int xen_dom0;
360 };
361
362 #ifndef APP_APPNAME_SIZE
363 #define APP_APPNAME_SIZE                         256
364 #endif
365
366 #ifndef APP_MAX_MEMPOOLS
367 #define APP_MAX_MEMPOOLS                         8
368 #endif
369
370 #ifndef APP_LINK_MAX_HWQ_IN
371 #define APP_LINK_MAX_HWQ_IN                      64
372 #endif
373
374 #ifndef APP_LINK_MAX_HWQ_OUT
375 #define APP_LINK_MAX_HWQ_OUT                     64
376 #endif
377
378 #define APP_MAX_HWQ_IN                     (APP_MAX_LINKS * APP_LINK_MAX_HWQ_IN)
379
380 #define APP_MAX_HWQ_OUT                   (APP_MAX_LINKS * APP_LINK_MAX_HWQ_OUT)
381
382 #ifndef APP_MAX_PKTQ_SWQ
383 #define APP_MAX_PKTQ_SWQ                         256
384 #endif
385
386 #define APP_MAX_PKTQ_TM                          APP_MAX_LINKS
387
388 #ifndef APP_MAX_PKTQ_SOURCE
389 #define APP_MAX_PKTQ_SOURCE                      32
390 #endif
391
392 #ifndef APP_MAX_PKTQ_SINK
393 #define APP_MAX_PKTQ_SINK                        32
394 #endif
395
396 #ifndef APP_MAX_MSGQ
397 #define APP_MAX_MSGQ                             128
398 #endif
399
400 #ifndef APP_MAX_PIPELINES
401 #define APP_MAX_PIPELINES                        64
402 #endif
403
404 #ifndef APP_EAL_ARGC
405 #define APP_EAL_ARGC                             32
406 #endif
407
408 #ifndef APP_MAX_PIPELINE_TYPES
409 #define APP_MAX_PIPELINE_TYPES                   64
410 #endif
411
412 #ifndef APP_MAX_THREADS
413 #define APP_MAX_THREADS                          RTE_MAX_LCORE
414 #endif
415
416 #ifndef APP_MAX_CMDS
417 #define APP_MAX_CMDS                             128
418 #endif
419
420 #ifndef APP_THREAD_HEADROOM_STATS_COLLECT
421 #define APP_THREAD_HEADROOM_STATS_COLLECT        1
422 #endif
423
424 uint8_t enable_hwlb;
425 uint8_t enable_flow_dir;
426
427 #define APP_CORE_MASK_SIZE                                      \
428         (RTE_MAX_LCORE / 64 + ((RTE_MAX_LCORE % 64) ? 1 : 0))
429
430 struct app_params {
431         /* Config */
432         char app_name[APP_APPNAME_SIZE];
433         const char *config_file;
434         const char *script_file;
435         const char *parser_file;
436         const char *output_file;
437         const char *preproc;
438         const char *preproc_args;
439         uint64_t port_mask;
440         uint32_t log_level;
441
442         struct app_eal_params eal_params;
443         struct app_mempool_params mempool_params[APP_MAX_MEMPOOLS];
444         struct app_link_params link_params[APP_MAX_LINKS];
445         struct app_pktq_hwq_in_params hwq_in_params[APP_MAX_HWQ_IN];
446         struct app_pktq_hwq_out_params hwq_out_params[APP_MAX_HWQ_OUT];
447         struct app_pktq_swq_params swq_params[APP_MAX_PKTQ_SWQ];
448         struct app_pktq_tm_params tm_params[APP_MAX_PKTQ_TM];
449         struct app_pktq_source_params source_params[APP_MAX_PKTQ_SOURCE];
450         struct app_pktq_sink_params sink_params[APP_MAX_PKTQ_SINK];
451         struct app_msgq_params msgq_params[APP_MAX_MSGQ];
452         struct app_pipeline_params pipeline_params[APP_MAX_PIPELINES];
453
454         uint32_t n_mempools;
455         uint32_t n_links;
456         uint32_t n_pktq_hwq_in;
457         uint32_t n_pktq_hwq_out;
458         uint32_t n_pktq_swq;
459         uint32_t n_pktq_tm;
460         uint32_t n_pktq_source;
461         uint32_t n_pktq_sink;
462         uint32_t n_msgq;
463         uint32_t n_pipelines;
464
465         uint32_t header_csum_req;
466         uint32_t n_hwlb_q;
467         /* Init */
468         char *eal_argv[1 + APP_EAL_ARGC];
469         struct cpu_core_map *core_map;
470         uint64_t core_mask[APP_CORE_MASK_SIZE];
471         struct rte_mempool *mempool[APP_MAX_MEMPOOLS];
472         struct rte_ring *swq[APP_MAX_PKTQ_SWQ];
473         struct rte_sched_port *tm[APP_MAX_PKTQ_TM];
474         struct rte_ring *msgq[APP_MAX_MSGQ];
475         struct pipeline_type pipeline_type[APP_MAX_PIPELINE_TYPES];
476         struct app_pipeline_data pipeline_data[APP_MAX_PIPELINES];
477         struct app_thread_data thread_data[APP_MAX_THREADS];
478         cmdline_parse_ctx_t cmds[APP_MAX_CMDS + 1];
479
480         int eal_argc;
481         uint32_t n_pipeline_types;
482         uint32_t n_cmds;
483 };
484
485 #define APP_PARAM_VALID(obj) ((obj)->name != NULL)
486
487 #define APP_PARAM_COUNT(obj_array, n_objs)                              \
488 {                                                                       \
489         size_t i;                                                       \
490                                                                         \
491         n_objs = 0;                                                     \
492         for (i = 0; i < RTE_DIM(obj_array); i++)                        \
493                 if (APP_PARAM_VALID(&((obj_array)[i])))                 \
494                         n_objs++;                                       \
495 }
496
497 #define APP_PARAM_FIND(obj_array, key)                                  \
498 ({                                                                      \
499         ssize_t obj_idx;                                                \
500         const ssize_t obj_count = RTE_DIM(obj_array);                   \
501                                                                         \
502         for (obj_idx = 0; obj_idx < obj_count; obj_idx++) {             \
503                 if (!APP_PARAM_VALID(&((obj_array)[obj_idx])))          \
504                         continue;                                       \
505                                                                         \
506                 if (strcmp(key, (obj_array)[obj_idx].name) == 0)        \
507                         break;                                          \
508         }                                                               \
509         obj_idx < obj_count ? obj_idx : -ENOENT;                        \
510 })
511
512 #define APP_PARAM_FIND_BY_ID(obj_array, prefix, id, obj)                \
513 do {                                                                    \
514         char name[APP_PARAM_NAME_SIZE];                                 \
515         ssize_t pos;                                                    \
516                                                                         \
517         sprintf(name, prefix "%" PRIu32, id);                           \
518         pos = APP_PARAM_FIND(obj_array, name);                          \
519         obj = (pos < 0) ? NULL : &((obj_array)[pos]);                   \
520 } while (0)
521
522 #define APP_PARAM_GET_ID(obj, prefix, id)                               \
523 do                                                                      \
524         sscanf(obj->name, prefix "%" SCNu32, &id);                              \
525 while (0)                                                               \
526
527 #define APP_PARAM_ADD(obj_array, obj_name)                              \
528 ({                                                                      \
529         ssize_t obj_idx;                                                \
530         const ssize_t obj_count = RTE_DIM(obj_array);                   \
531                                                                         \
532         obj_idx = APP_PARAM_FIND(obj_array, obj_name);                  \
533         if (obj_idx < 0) {                                              \
534                 for (obj_idx = 0; obj_idx < obj_count; obj_idx++) {     \
535                         if (!APP_PARAM_VALID(&((obj_array)[obj_idx])))  \
536                                 break;                                  \
537                 }                                                       \
538                                                                         \
539                 if (obj_idx < obj_count) {                              \
540                         (obj_array)[obj_idx].name = strdup(obj_name);   \
541                         if ((obj_array)[obj_idx].name == NULL)          \
542                                 obj_idx = -EINVAL;                      \
543                 } else                                                  \
544                         obj_idx = -ENOMEM;                              \
545         }                                                               \
546         obj_idx;                                                        \
547 })
548
549 #define APP_CHECK(exp, fmt, ...)                                        \
550 do {                                                                    \
551         if (!(exp)) {                                                   \
552                 fprintf(stderr, fmt "\n", ## __VA_ARGS__);              \
553                 abort();                                                \
554         }                                                               \
555 } while (0)
556
557 enum app_log_level {
558         APP_LOG_LEVEL_HIGH = 1,
559         APP_LOG_LEVEL_LOW,
560         APP_LOG_LEVELS
561 };
562
563 #define APP_LOG(app, level, fmt, ...)                                   \
564 do {                                                                    \
565         if (app->log_level >= APP_LOG_LEVEL_ ## level)                  \
566                 fprintf(stdout, "[APP] " fmt "\n", ## __VA_ARGS__);     \
567 } while (0)
568
569 static inline uint32_t
570 app_link_get_n_rxq(struct app_params *app, struct app_link_params *link)
571 {
572         uint32_t n_rxq = 0, link_id, i;
573         uint32_t n_pktq_hwq_in = RTE_MIN(app->n_pktq_hwq_in,
574                 RTE_DIM(app->hwq_in_params));
575
576         APP_PARAM_GET_ID(link, "LINK", link_id);
577
578         for (i = 0; i < n_pktq_hwq_in; i++) {
579                 struct app_pktq_hwq_in_params *p = &app->hwq_in_params[i];
580                 uint32_t rxq_link_id, rxq_queue_id;
581
582                 sscanf(p->name, "RXQ%" SCNu32 ".%" SCNu32,
583                         &rxq_link_id, &rxq_queue_id);
584                 if (rxq_link_id == link_id)
585                         n_rxq++;
586         }
587
588         return n_rxq;
589 }
590
591 static inline uint32_t
592 app_link_get_n_txq(struct app_params *app, struct app_link_params *link)
593 {
594         uint32_t n_txq = 0, link_id, i;
595         uint32_t n_pktq_hwq_out = RTE_MIN(app->n_pktq_hwq_out,
596                 RTE_DIM(app->hwq_out_params));
597
598         APP_PARAM_GET_ID(link, "LINK", link_id);
599
600         for (i = 0; i < n_pktq_hwq_out; i++) {
601                 struct app_pktq_hwq_out_params *p = &app->hwq_out_params[i];
602                 uint32_t txq_link_id, txq_queue_id;
603
604                 sscanf(p->name, "TXQ%" SCNu32 ".%" SCNu32,
605                         &txq_link_id, &txq_queue_id);
606                 if (txq_link_id == link_id)
607                         n_txq++;
608         }
609
610         return n_txq;
611 }
612
613 static inline uint32_t
614 app_rxq_get_readers(struct app_params *app, struct app_pktq_hwq_in_params *rxq)
615 {
616         uint32_t pos = rxq - app->hwq_in_params;
617         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
618                 RTE_DIM(app->pipeline_params));
619         uint32_t n_readers = 0, i;
620
621         for (i = 0; i < n_pipelines; i++) {
622                 struct app_pipeline_params *p = &app->pipeline_params[i];
623                 uint32_t n_pktq_in = RTE_MIN(p->n_pktq_in, RTE_DIM(p->pktq_in));
624                 uint32_t j;
625
626                 for (j = 0; j < n_pktq_in; j++) {
627                         struct app_pktq_in_params *pktq = &p->pktq_in[j];
628
629                         if ((pktq->type == APP_PKTQ_IN_HWQ) &&
630                                 (pktq->id == pos))
631                                 n_readers++;
632                 }
633         }
634
635         return n_readers;
636 }
637
638 static inline uint32_t
639 app_swq_get_readers(struct app_params *app, struct app_pktq_swq_params *swq)
640 {
641         uint32_t pos = swq - app->swq_params;
642         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
643                 RTE_DIM(app->pipeline_params));
644         uint32_t n_readers = 0, i;
645
646         for (i = 0; i < n_pipelines; i++) {
647                 struct app_pipeline_params *p = &app->pipeline_params[i];
648                 uint32_t n_pktq_in = RTE_MIN(p->n_pktq_in, RTE_DIM(p->pktq_in));
649                 uint32_t j;
650
651                 for (j = 0; j < n_pktq_in; j++) {
652                         struct app_pktq_in_params *pktq = &p->pktq_in[j];
653
654                         if ((pktq->type == APP_PKTQ_IN_SWQ) &&
655                                 (pktq->id == pos))
656                                 n_readers++;
657                 }
658         }
659
660         return n_readers;
661 }
662
663 static inline uint32_t
664 app_tm_get_readers(struct app_params *app, struct app_pktq_tm_params *tm)
665 {
666         uint32_t pos = tm - app->tm_params;
667         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
668                 RTE_DIM(app->pipeline_params));
669         uint32_t n_readers = 0, i;
670
671         for (i = 0; i < n_pipelines; i++) {
672                 struct app_pipeline_params *p = &app->pipeline_params[i];
673                 uint32_t n_pktq_in = RTE_MIN(p->n_pktq_in, RTE_DIM(p->pktq_in));
674                 uint32_t j;
675
676                 for (j = 0; j < n_pktq_in; j++) {
677                         struct app_pktq_in_params *pktq = &p->pktq_in[j];
678
679                         if ((pktq->type == APP_PKTQ_IN_TM) &&
680                                 (pktq->id == pos))
681                                 n_readers++;
682                 }
683         }
684
685         return n_readers;
686 }
687
688 static inline uint32_t
689 app_source_get_readers(struct app_params *app,
690 struct app_pktq_source_params *source)
691 {
692         uint32_t pos = source - app->source_params;
693         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
694                 RTE_DIM(app->pipeline_params));
695         uint32_t n_readers = 0, i;
696
697         for (i = 0; i < n_pipelines; i++) {
698                 struct app_pipeline_params *p = &app->pipeline_params[i];
699                 uint32_t n_pktq_in = RTE_MIN(p->n_pktq_in, RTE_DIM(p->pktq_in));
700                 uint32_t j;
701
702                 for (j = 0; j < n_pktq_in; j++) {
703                         struct app_pktq_in_params *pktq = &p->pktq_in[j];
704
705                         if ((pktq->type == APP_PKTQ_IN_SOURCE) &&
706                                 (pktq->id == pos))
707                                 n_readers++;
708                 }
709         }
710
711         return n_readers;
712 }
713
714 static inline uint32_t
715 app_msgq_get_readers(struct app_params *app, struct app_msgq_params *msgq)
716 {
717         uint32_t pos = msgq - app->msgq_params;
718         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
719                 RTE_DIM(app->pipeline_params));
720         uint32_t n_readers = 0, i;
721
722         for (i = 0; i < n_pipelines; i++) {
723                 struct app_pipeline_params *p = &app->pipeline_params[i];
724                 uint32_t n_msgq_in = RTE_MIN(p->n_msgq_in, RTE_DIM(p->msgq_in));
725                 uint32_t j;
726
727                 for (j = 0; j < n_msgq_in; j++)
728                         if (p->msgq_in[j] == pos)
729                                 n_readers++;
730         }
731
732         return n_readers;
733 }
734
735 static inline uint32_t
736 app_txq_get_writers(struct app_params *app, struct app_pktq_hwq_out_params *txq)
737 {
738         uint32_t pos = txq - app->hwq_out_params;
739         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
740                 RTE_DIM(app->pipeline_params));
741         uint32_t n_writers = 0, i;
742
743         for (i = 0; i < n_pipelines; i++) {
744                 struct app_pipeline_params *p = &app->pipeline_params[i];
745                 uint32_t n_pktq_out = RTE_MIN(p->n_pktq_out,
746                         RTE_DIM(p->pktq_out));
747                 uint32_t j;
748
749                 for (j = 0; j < n_pktq_out; j++) {
750                         struct app_pktq_out_params *pktq = &p->pktq_out[j];
751
752                         if ((pktq->type == APP_PKTQ_OUT_HWQ) &&
753                                 (pktq->id == pos))
754                                 n_writers++;
755                 }
756         }
757
758         return n_writers;
759 }
760
761 static inline uint32_t
762 app_swq_get_writers(struct app_params *app, struct app_pktq_swq_params *swq)
763 {
764         uint32_t pos = swq - app->swq_params;
765         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
766                 RTE_DIM(app->pipeline_params));
767         uint32_t n_writers = 0, i;
768
769         for (i = 0; i < n_pipelines; i++) {
770                 struct app_pipeline_params *p = &app->pipeline_params[i];
771                 uint32_t n_pktq_out = RTE_MIN(p->n_pktq_out,
772                         RTE_DIM(p->pktq_out));
773                 uint32_t j;
774
775                 for (j = 0; j < n_pktq_out; j++) {
776                         struct app_pktq_out_params *pktq = &p->pktq_out[j];
777
778                         if ((pktq->type == APP_PKTQ_OUT_SWQ) &&
779                                 (pktq->id == pos))
780                                 n_writers++;
781                 }
782         }
783
784         return n_writers;
785 }
786
787 static inline uint32_t
788 app_tm_get_writers(struct app_params *app, struct app_pktq_tm_params *tm)
789 {
790         uint32_t pos = tm - app->tm_params;
791         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
792                 RTE_DIM(app->pipeline_params));
793         uint32_t n_writers = 0, i;
794
795         for (i = 0; i < n_pipelines; i++) {
796                 struct app_pipeline_params *p = &app->pipeline_params[i];
797                 uint32_t n_pktq_out = RTE_MIN(p->n_pktq_out,
798                         RTE_DIM(p->pktq_out));
799                 uint32_t j;
800
801                 for (j = 0; j < n_pktq_out; j++) {
802                         struct app_pktq_out_params *pktq = &p->pktq_out[j];
803
804                         if ((pktq->type == APP_PKTQ_OUT_TM) &&
805                                 (pktq->id == pos))
806                                 n_writers++;
807                 }
808         }
809
810         return n_writers;
811 }
812
813 static inline uint32_t
814 app_sink_get_writers(struct app_params *app, struct app_pktq_sink_params *sink)
815 {
816         uint32_t pos = sink - app->sink_params;
817         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
818                 RTE_DIM(app->pipeline_params));
819         uint32_t n_writers = 0, i;
820
821         for (i = 0; i < n_pipelines; i++) {
822                 struct app_pipeline_params *p = &app->pipeline_params[i];
823                 uint32_t n_pktq_out = RTE_MIN(p->n_pktq_out,
824                         RTE_DIM(p->pktq_out));
825                 uint32_t j;
826
827                 for (j = 0; j < n_pktq_out; j++) {
828                         struct app_pktq_out_params *pktq = &p->pktq_out[j];
829
830                         if ((pktq->type == APP_PKTQ_OUT_SINK) &&
831                                 (pktq->id == pos))
832                                 n_writers++;
833                 }
834         }
835
836         return n_writers;
837 }
838
839 static inline uint32_t
840 app_core_is_enabled(struct app_params *app, uint32_t lcore_id) {
841         return(app->core_mask[lcore_id / 64] &
842                 (1LLU << (lcore_id % 64)));
843 }
844
845 static inline void
846 app_core_enable_in_core_mask(struct app_params *app, int lcore_id) {
847         app->core_mask[lcore_id / 64] |= 1LLU << (lcore_id % 64);
848
849 }
850
851 static inline void
852 app_core_build_core_mask_string(struct app_params *app, char
853 *mask_buffer) {
854         int i;
855
856         mask_buffer[0] = '\0';
857         for (i = (int)RTE_DIM(app->core_mask); i > 0; i--) {
858                 /* For Hex representation of bits in uint64_t */
859                 char buffer[(64 / 8) * 2 + 1];
860                 memset(buffer, 0, sizeof(buffer));
861                 snprintf(buffer, sizeof(buffer), "%016" PRIx64,
862                          app->core_mask[i-1]);
863                 strcat(mask_buffer, buffer);
864         }
865 }
866
867 static inline uint32_t
868 app_msgq_get_writers(struct app_params *app, struct app_msgq_params *msgq)
869 {
870         uint32_t pos = msgq - app->msgq_params;
871         uint32_t n_pipelines = RTE_MIN(app->n_pipelines,
872                 RTE_DIM(app->pipeline_params));
873         uint32_t n_writers = 0, i;
874
875         for (i = 0; i < n_pipelines; i++) {
876                 struct app_pipeline_params *p = &app->pipeline_params[i];
877                 uint32_t n_msgq_out = RTE_MIN(p->n_msgq_out,
878                         RTE_DIM(p->msgq_out));
879                 uint32_t j;
880
881                 for (j = 0; j < n_msgq_out; j++)
882                         if (p->msgq_out[j] == pos)
883                                 n_writers++;
884         }
885
886         return n_writers;
887 }
888
889 static inline struct app_link_params *
890 app_get_link_for_rxq(struct app_params *app, struct app_pktq_hwq_in_params *p)
891 {
892         char link_name[APP_PARAM_NAME_SIZE];
893         ssize_t link_param_idx;
894         uint32_t rxq_link_id, rxq_queue_id;
895
896         sscanf(p->name, "RXQ%" SCNu32 ".%" SCNu32,
897                 &rxq_link_id, &rxq_queue_id);
898         sprintf(link_name, "LINK%" PRIu32, rxq_link_id);
899         link_param_idx = APP_PARAM_FIND(app->link_params, link_name);
900         APP_CHECK((link_param_idx >= 0),
901                 "Cannot find %s for %s", link_name, p->name);
902
903         return &app->link_params[link_param_idx];
904 }
905
906 static inline struct app_link_params *
907 app_get_link_for_txq(struct app_params *app, struct app_pktq_hwq_out_params *p)
908 {
909         char link_name[APP_PARAM_NAME_SIZE];
910         ssize_t link_param_idx;
911         uint32_t txq_link_id, txq_queue_id;
912
913         sscanf(p->name, "TXQ%" SCNu32 ".%" SCNu32,
914                 &txq_link_id, &txq_queue_id);
915         sprintf(link_name, "LINK%" PRIu32, txq_link_id);
916         link_param_idx = APP_PARAM_FIND(app->link_params, link_name);
917         APP_CHECK((link_param_idx >= 0),
918                 "Cannot find %s for %s", link_name, p->name);
919
920         return &app->link_params[link_param_idx];
921 }
922
923 static inline struct app_link_params *
924 app_get_link_for_tm(struct app_params *app, struct app_pktq_tm_params *p_tm)
925 {
926         char link_name[APP_PARAM_NAME_SIZE];
927         uint32_t link_id;
928         ssize_t link_param_idx;
929
930         sscanf(p_tm->name, "TM%" PRIu32, &link_id);
931         sprintf(link_name, "LINK%" PRIu32, link_id);
932         link_param_idx = APP_PARAM_FIND(app->link_params, link_name);
933         APP_CHECK((link_param_idx >= 0),
934                 "Cannot find %s for %s", link_name, p_tm->name);
935
936         return &app->link_params[link_param_idx];
937 }
938
939 int app_config_init(struct app_params *app);
940
941 int app_config_args(struct app_params *app,
942         int argc, char **argv);
943
944 int app_config_preproc(struct app_params *app);
945
946 int app_config_parse(struct app_params *app,
947         const char *file_name);
948
949 int app_config_parse_tm(struct app_params *app);
950
951 void app_config_save(struct app_params *app,
952         const char *file_name);
953
954 int app_config_check(struct app_params *app);
955
956 int app_init(struct app_params *app);
957
958 int app_thread(void *arg);
959
960 int app_pipeline_type_register(struct app_params *app,
961         struct pipeline_type *ptype);
962
963 struct pipeline_type *app_pipeline_type_find(struct app_params *app,
964         char *name);
965
966 void app_link_up_internal(struct app_params *app,
967         struct app_link_params *cp);
968
969 void app_link_down_internal(struct app_params *app,
970         struct app_link_params *cp);
971
972 #endif