1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2015-2018 Intel Corporation. 3 4Internet Protocol (IP) Pipeline Application 5=========================================== 6 7Application overview 8-------------------- 9 10The *Internet Protocol (IP) Pipeline* application is intended to be a vehicle for rapid development of packet processing 11applications on multi-core CPUs. 12 13Following OpenFlow and P4 design principles, the application can be used to create functional blocks called pipelines out 14of input/output ports, tables and actions in a modular way. Multiple pipelines can be inter-connected through packet queues 15to create complete applications (super-pipelines). 16 17The pipelines are mapped to application threads, with each pipeline executed by a single thread and each thread able to run 18one or several pipelines. The possibilities of creating pipelines out of ports, tables and actions, connecting multiple 19pipelines together and mapping the pipelines to execution threads are endless, therefore this application can be seen as 20a true application generator. 21 22Pipelines are created and managed through Command Line Interface (CLI): 23 24 * Any standard TCP client (e.g. telnet, netcat, custom script, etc) is typically able to connect to the application, send 25 commands through the network and wait for the response before pushing the next command. 26 27 * All the application objects are created and managed through CLI commands: 28 * 'Primitive' objects used to create pipeline ports: memory pools, links (i.e. network interfaces), SW queues, traffic managers, etc. 29 * Action profiles: used to define the actions to be executed by pipeline input/output ports and tables. 30 * Pipeline components: input/output ports, tables, pipelines, mapping of pipelines to execution threads. 31 32Running the application 33----------------------- 34 35The application startup command line is:: 36 37 dpdk-ip_pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT] 38 39The application startup arguments are: 40 41``-s SCRIPT_FILE`` 42 43 * Optional: Yes 44 45 * Default: Not present 46 47 * Argument: Path to the CLI script file to be run at application startup. 48 No CLI script file will run at startup if this argument is not present. 49 50``-h HOST`` 51 52 * Optional: Yes 53 54 * Default: ``0.0.0.0`` 55 56 * Argument: IP Address of the host running ip pipeline application to be used by 57 remote TCP based client (telnet, netcat, etc.) for connection. 58 59``-p PORT`` 60 61 * Optional: Yes 62 63 * Default: ``8086`` 64 65 * Argument: TCP port number at which the ip pipeline is running. 66 This port number should be used by remote TCP client (such as telnet, netcat, etc.) to connect to host application. 67 68Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options. 69 70The following is an example command to run ip pipeline application configured for layer 2 forwarding: 71 72.. code-block:: console 73 74 $ ./<build_dir>/examples/dpdk-ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli 75 76The application should start successfully and display as follows: 77 78.. code-block:: console 79 80 EAL: Detected 40 lcore(s) 81 EAL: Detected 2 NUMA nodes 82 EAL: Multi-process socket /var/run/.rte_unix 83 EAL: Probing VFIO support... 84 EAL: PCI device 0000:02:00.0 on NUMA socket 0 85 EAL: probe driver: 8086:10fb net_ixgbe 86 ... 87 88To run remote client (e.g. telnet) to communicate with the ip pipeline application: 89 90.. code-block:: console 91 92 $ telnet 127.0.0.1 8086 93 94When running a telnet client as above, command prompt is displayed: 95 96.. code-block:: console 97 98 Trying 127.0.0.1... 99 Connected to 127.0.0.1. 100 Escape character is '^]'. 101 102 Welcome to IP Pipeline! 103 104 pipeline> 105 106Once application and telnet client start running, messages can be sent from client to application. 107At any stage, telnet client can be terminated using the quit command. 108 109 110Application stages 111------------------ 112 113Initialization 114~~~~~~~~~~~~~~ 115 116During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data structures 117(i.e. linked lists) for application objects are initialized. In case of any initialization error, an error message 118is displayed and the application is terminated. 119 120.. _ip_pipeline_runtime: 121 122Run-time 123~~~~~~~~ 124 125The main thread is creating and managing all the application objects based on CLI input. 126 127Each data plane thread runs one or several pipelines previously assigned to it in round-robin order. Each data plane thread 128executes two tasks in time-sharing mode: 129 1301. *Packet processing task*: Process bursts of input packets read from the pipeline input ports. 131 1322. *Message handling task*: Periodically, the data plane thread pauses the packet processing task and polls for request 133 messages send by the main thread. Examples: add/remove pipeline to/from current data plane thread, add/delete rules 134 to/from given table of a specific pipeline owned by the current data plane thread, read statistics, etc. 135 136Examples 137-------- 138 139.. _table_examples: 140 141.. tabularcolumns:: |p{3cm}|p{5cm}|p{4cm}|p{4cm}| 142 143.. table:: Pipeline examples provided with the application 144 145 +-----------------------+----------------------+----------------+------------------------------------+ 146 | Name | Table(s) | Actions | Messages | 147 +=======================+======================+================+====================================+ 148 | L2fwd | Stub | Forward | 1. Mempool create | 149 | | | | 2. Link create | 150 | Note: Implemented | | | 3. Pipeline create | 151 | using pipeline with | | | 4. Pipeline port in/out | 152 | a simple pass-through | | | 5. Pipeline table | 153 | connection between | | | 6. Pipeline port in table | 154 | input and output | | | 7. Pipeline enable | 155 | ports. | | | 8. Pipeline table rule add | 156 +-----------------------+----------------------+----------------+------------------------------------+ 157 | Flow classification | Exact match | Forward | 1. Mempool create | 158 | | | | 2. Link create | 159 | | * Key = byte array | | 3. Pipeline create | 160 | | (16 bytes) | | 4. Pipeline port in/out | 161 | | * Offset = 278 | | 5. Pipeline table | 162 | | * Table size = 64K | | 6. Pipeline port in table | 163 | | | | 7. Pipeline enable | 164 | | | | 8. Pipeline table rule add default | 165 | | | | 9. Pipeline table rule add | 166 +-----------------------+----------------------+----------------+------------------------------------+ 167 | KNI | Stub | Forward | 1. Mempool create | 168 | | | | 2. Link create | 169 | | | | 3. Pipeline create | 170 | | | | 4. Pipeline port in/out | 171 | | | | 5. Pipeline table | 172 | | | | 6. Pipeline port in table | 173 | | | | 7. Pipeline enable | 174 | | | | 8. Pipeline table rule add | 175 +-----------------------+----------------------+----------------+------------------------------------+ 176 | Firewall | ACL | Allow/Drop | 1. Mempool create | 177 | | | | 2. Link create | 178 | | * Key = n-tuple | | 3. Pipeline create | 179 | | * Offset = 270 | | 4. Pipeline port in/out | 180 | | * Table size = 4K | | 5. Pipeline table | 181 | | | | 6. Pipeline port in table | 182 | | | | 7. Pipeline enable | 183 | | | | 8. Pipeline table rule add default | 184 | | | | 9. Pipeline table rule add | 185 +-----------------------+----------------------+----------------+------------------------------------+ 186 | IP routing | LPM (IPv4) | Forward | 1. Mempool Create | 187 | | | | 2. Link create | 188 | | * Key = IP dest addr | | 3. Pipeline create | 189 | | * Offset = 286 | | 4. Pipeline port in/out | 190 | | * Table size = 4K | | 5. Pipeline table | 191 | | | | 6. Pipeline port in table | 192 | | | | 7. Pipeline enable | 193 | | | | 8. Pipeline table rule add default | 194 | | | | 9. Pipeline table rule add | 195 +-----------------------+----------------------+----------------+------------------------------------+ 196 | Equal-cost multi-path | LPM (IPv4) | Forward, | 1. Mempool Create | 197 | routing (ECMP) | | load balance, | 2. Link create | 198 | | * Key = IP dest addr | encap ether | 3. Pipeline create | 199 | | * Offset = 286 | | 4. Pipeline port in/out | 200 | | * Table size = 4K | | 5. Pipeline table (LPM) | 201 | | | | 6. Pipeline table (Array) | 202 | | | | 7. Pipeline port in table (LPM) | 203 | | Array | | 8. Pipeline enable | 204 | | | | 9. Pipeline table rule add default | 205 | | * Key = Array index | | 10. Pipeline table rule add(LPM) | 206 | | * Offset = 256 | | 11. Pipeline table rule add(Array) | 207 | | * Size = 64K | | | 208 | | | | | 209 +-----------------------+----------------------+----------------+------------------------------------+ 210 211Command Line Interface (CLI) 212---------------------------- 213 214Link 215~~~~ 216 217 Link configuration :: 218 219 link <link_name> 220 dev <device_name>|port <port_id> 221 rxq <n_queues> <queue_size> <mempool_name> 222 txq <n_queues> <queue_size> promiscuous on | off 223 [rss <qid_0> ... <qid_n>] 224 225 Note: The PCI device name must be specified in the Domain:Bus:Device.Function format. 226 227 228Mempool 229~~~~~~~ 230 231 Mempool create :: 232 233 mempool <mempool_name> buffer <buffer_size> 234 pool <pool_size> cache <cache_size> cpu <cpu_id> 235 236 237Software queue 238~~~~~~~~~~~~~~ 239 240 Create software queue :: 241 242 swq <swq_name> size <size> cpu <cpu_id> 243 244 245Traffic manager 246~~~~~~~~~~~~~~~ 247 248 Add traffic manager subport profile :: 249 250 tmgr subport profile 251 <tb_rate> <tb_size> 252 <tc0_rate> <tc1_rate> <tc2_rate> <tc3_rate> <tc4_rate> 253 <tc5_rate> <tc6_rate> <tc7_rate> <tc8_rate> 254 <tc9_rate> <tc10_rate> <tc11_rate> <tc12_rate> 255 <tc_period> 256 257 Add traffic manager pipe profile :: 258 259 tmgr pipe profile 260 <tb_rate> <tb_size> 261 <tc0_rate> <tc1_rate> <tc2_rate> <tc3_rate> <tc4_rate> 262 <tc5_rate> <tc6_rate> <tc7_rate> <tc8_rate> 263 <tc9_rate> <tc10_rate> <tc11_rate> <tc12_rate> 264 <tc_period> 265 <tc_ov_weight> 266 <wrr_weight0..3> 267 268 Create traffic manager port :: 269 270 tmgr <tmgr_name> 271 rate <rate> 272 spp <n_subports_per_port> 273 pps <n_pipes_per_subport> 274 fo <frame_overhead> 275 mtu <mtu> 276 cpu <cpu_id> 277 278 Configure traffic manager subport :: 279 280 tmgr <tmgr_name> 281 subport <subport_id> 282 profile <subport_profile_id> 283 284 Configure traffic manager pipe :: 285 286 tmgr <tmgr_name> 287 subport <subport_id> 288 pipe from <pipe_id_first> to <pipe_id_last> 289 profile <pipe_profile_id> 290 291 292Tap 293~~~ 294 295 Create tap port :: 296 297 tap <name> 298 299 300Kni 301~~~ 302 303 Create kni port :: 304 305 kni <kni_name> 306 link <link_name> 307 mempool <mempool_name> 308 [thread <thread_id>] 309 310 311Cryptodev 312~~~~~~~~~ 313 314 Create cryptodev port :: 315 316 cryptodev <cryptodev_name> 317 dev <DPDK Cryptodev PMD name> 318 queue <n_queues> <queue_size> 319 320Action profile 321~~~~~~~~~~~~~~ 322 323 Create action profile for pipeline input port :: 324 325 port in action profile <profile_name> 326 [filter match | mismatch offset <key_offset> mask <key_mask> key <key_value> port <port_id>] 327 [balance offset <key_offset> mask <key_mask> port <port_id0> ... <port_id15>] 328 329 Create action profile for the pipeline table :: 330 331 table action profile <profile_name> 332 ipv4 | ipv6 333 offset <ip_offset> 334 fwd 335 [balance offset <key_offset> mask <key_mask> outoffset <out_offset>] 336 [meter srtcm | trtcm 337 tc <n_tc> 338 stats none | pkts | bytes | both] 339 [tm spp <n_subports_per_port> pps <n_pipes_per_subport>] 340 [encap ether | vlan | qinq | mpls | pppoe] 341 [nat src | dst 342 proto udp | tcp] 343 [ttl drop | fwd 344 stats none | pkts] 345 [stats pkts | bytes | both] 346 [sym_crypto cryptodev <cryptodev_name> 347 mempool_create <mempool_name> mempool_init <mempool_name>] 348 [time] 349 350 351Pipeline 352~~~~~~~~ 353 354Create pipeline :: 355 356 pipeline <pipeline_name> 357 period <timer_period_ms> 358 offset_port_id <offset_port_id> 359 cpu <cpu_id> 360 361Create pipeline input port :: 362 363 pipeline <pipeline_name> port in 364 bsz <burst_size> 365 link <link_name> rxq <queue_id> 366 | swq <swq_name> 367 | tmgr <tmgr_name> 368 | tap <tap_name> mempool <mempool_name> mtu <mtu> 369 | kni <kni_name> 370 | source mempool <mempool_name> file <file_name> bpp <n_bytes_per_pkt> 371 [action <port_in_action_profile_name>] 372 [disabled] 373 374Create pipeline output port :: 375 376 pipeline <pipeline_name> port out 377 bsz <burst_size> 378 link <link_name> txq <txq_id> 379 | swq <swq_name> 380 | tmgr <tmgr_name> 381 | tap <tap_name> 382 | kni <kni_name> 383 | sink [file <file_name> pkts <max_n_pkts>] 384 385Create pipeline table :: 386 387 pipeline <pipeline_name> table 388 match 389 acl 390 ipv4 | ipv6 391 offset <ip_header_offset> 392 size <n_rules> 393 | array 394 offset <key_offset> 395 size <n_keys> 396 | hash 397 ext | lru 398 key <key_size> 399 mask <key_mask> 400 offset <key_offset> 401 buckets <n_buckets> 402 size <n_keys> 403 | lpm 404 ipv4 | ipv6 405 offset <ip_header_offset> 406 size <n_rules> 407 | stub 408 [action <table_action_profile_name>] 409 410Connect pipeline input port to table :: 411 412 pipeline <pipeline_name> port in <port_id> table <table_id> 413 414Display statistics for specific pipeline input port, output port 415or table :: 416 417 pipeline <pipeline_name> port in <port_id> stats read [clear] 418 pipeline <pipeline_name> port out <port_id> stats read [clear] 419 pipeline <pipeline_name> table <table_id> stats read [clear] 420 421Enable given input port for specific pipeline instance :: 422 423 pipeline <pipeline_name> port out <port_id> disable 424 425Disable given input port for specific pipeline instance :: 426 427 pipeline <pipeline_name> port out <port_id> disable 428 429Add default rule to table for specific pipeline instance :: 430 431 pipeline <pipeline_name> table <table_id> rule add 432 match 433 default 434 action 435 fwd 436 drop 437 | port <port_id> 438 | meta 439 | table <table_id> 440 441Add rule to table for specific pipeline instance :: 442 443 pipeline <pipeline_name> table <table_id> rule add 444 445 match 446 acl 447 priority <priority> 448 ipv4 | ipv6 <sa> <sa_depth> <da> <da_depth> 449 <sp0> <sp1> <dp0> <dp1> <proto> 450 | array <pos> 451 | hash 452 raw <key> 453 | ipv4_5tuple <sa> <da> <sp> <dp> <proto> 454 | ipv6_5tuple <sa> <da> <sp> <dp> <proto> 455 | ipv4_addr <addr> 456 | ipv6_addr <addr> 457 | qinq <svlan> <cvlan> 458 | lpm 459 ipv4 | ipv6 <addr> <depth> 460 461 action 462 fwd 463 drop 464 | port <port_id> 465 | meta 466 | table <table_id> 467 [balance <out0> ... <out7>] 468 [meter 469 tc0 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 470 [tc1 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 471 tc2 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 472 tc3 meter <meter_profile_id> policer g <pa> y <pa> r <pa>]] 473 [tm subport <subport_id> pipe <pipe_id>] 474 [encap 475 ether <da> <sa> 476 | vlan <da> <sa> <pcp> <dei> <vid> 477 | qinq <da> <sa> <pcp> <dei> <vid> <pcp> <dei> <vid> 478 | mpls unicast | multicast 479 <da> <sa> 480 label0 <label> <tc> <ttl> 481 [label1 <label> <tc> <ttl> 482 [label2 <label> <tc> <ttl> 483 [label3 <label> <tc> <ttl>]]] 484 | pppoe <da> <sa> <session_id>] 485 [nat ipv4 | ipv6 <addr> <port>] 486 [ttl dec | keep] 487 [stats] 488 [time] 489 [sym_crypto 490 encrypt | decrypt 491 type 492 | cipher 493 cipher_algo <algo> cipher_key <key> cipher_iv <iv> 494 | cipher_auth 495 cipher_algo <algo> cipher_key <key> cipher_iv <iv> 496 auth_algo <algo> auth_key <key> digest_size <size> 497 | aead 498 aead_algo <algo> aead_key <key> aead_iv <iv> aead_aad <aad> 499 digest_size <size> 500 data_offset <data_offset>] 501 502 where: 503 <pa> ::= g | y | r | drop 504 505Add bulk rules to table for specific pipeline instance :: 506 507 pipeline <pipeline_name> table <table_id> rule add bulk <file_name> <n_rules> 508 509 Where: 510 - file_name = path to file 511 - File line format = match <match> action <action> 512 513Delete table rule for specific pipeline instance :: 514 515 pipeline <pipeline_name> table <table_id> rule delete 516 match <match> 517 518Delete default table rule for specific pipeline instance :: 519 520 pipeline <pipeline_name> table <table_id> rule delete 521 match 522 default 523 524Add meter profile to the table for specific pipeline instance :: 525 526 pipeline <pipeline_name> table <table_id> meter profile <meter_profile_id> 527 add srtcm cir <cir> cbs <cbs> ebs <ebs> 528 | trtcm cir <cir> pir <pir> cbs <cbs> pbs <pbs> 529 530Delete meter profile from the table for specific pipeline instance :: 531 532 pipeline <pipeline_name> table <table_id> 533 meter profile <meter_profile_id> delete 534 535 536Update the dscp table for meter or traffic manager action for specific 537pipeline instance :: 538 539 pipeline <pipeline_name> table <table_id> dscp <file_name> 540 541 Where: 542 - file_name = path to file 543 - exactly 64 lines 544 - File line format = <tc_id> <tc_queue_id> <color>, with <color> as: g | y | r 545 546 547Pipeline enable/disable 548~~~~~~~~~~~~~~~~~~~~~~~ 549 550 Enable given pipeline instance for specific data plane thread :: 551 552 thread <thread_id> pipeline <pipeline_name> enable 553 554 555 Disable given pipeline instance for specific data plane thread :: 556 557 thread <thread_id> pipeline <pipeline_name> disable 558