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 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/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 strcutures 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 master 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 master 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 creat | 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> 253 <tc_period> 254 255 256 Add traffic manager pipe profile :: 257 258 tmgr pipe profile 259 <tb_rate> <tb_size> 260 <tc0_rate> <tc1_rate> <tc2_rate> <tc3_rate> 261 <tc_period> 262 <tc_ov_weight> <wrr_weight0..15> 263 264 Create traffic manager port :: 265 266 tmgr <tmgr_name> 267 rate <rate> 268 spp <n_subports_per_port> 269 pps <n_pipes_per_subport> 270 qsize <qsize_tc0> 271 <qsize_tc1> <qsize_tc2> <qsize_tc3> 272 fo <frame_overhead> mtu <mtu> cpu <cpu_id> 273 274 Configure traffic manager subport :: 275 276 tmgr <tmgr_name> 277 subport <subport_id> 278 profile <subport_profile_id> 279 280 Configure traffic manager pipe :: 281 282 tmgr <tmgr_name> 283 subport <subport_id> 284 pipe from <pipe_id_first> to <pipe_id_last> 285 profile <pipe_profile_id> 286 287 288Tap 289~~~ 290 291 Create tap port :: 292 293 tap <name> 294 295 296Kni 297~~~ 298 299 Create kni port :: 300 301 kni <kni_name> 302 link <link_name> 303 mempool <mempool_name> 304 [thread <thread_id>] 305 306 307Action profile 308~~~~~~~~~~~~~~ 309 310 Create action profile for pipeline input port :: 311 312 port in action profile <profile_name> 313 [filter match | mismatch offset <key_offset> mask <key_mask> key <key_value> port <port_id>] 314 [balance offset <key_offset> mask <key_mask> port <port_id0> ... <port_id15>] 315 316 Create action profile for the pipeline table :: 317 318 table action profile <profile_name> 319 ipv4 | ipv6 320 offset <ip_offset> 321 fwd 322 [balance offset <key_offset> mask <key_mask> outoffset <out_offset>] 323 [meter srtcm | trtcm 324 tc <n_tc> 325 stats none | pkts | bytes | both] 326 [tm spp <n_subports_per_port> pps <n_pipes_per_subport>] 327 [encap ether | vlan | qinq | mpls | pppoe] 328 [nat src | dst 329 proto udp | tcp] 330 [ttl drop | fwd 331 stats none | pkts] 332 [stats pkts | bytes | both] 333 [time] 334 335 336Pipeline 337~~~~~~~~ 338 339Create pipeline :: 340 341 pipeline <pipeline_name> 342 period <timer_period_ms> 343 offset_port_id <offset_port_id> 344 cpu <cpu_id> 345 346Create pipeline input port :: 347 348 pipeline <pipeline_name> port in 349 bsz <burst_size> 350 link <link_name> rxq <queue_id> 351 | swq <swq_name> 352 | tmgr <tmgr_name> 353 | tap <tap_name> mempool <mempool_name> mtu <mtu> 354 | kni <kni_name> 355 | source mempool <mempool_name> file <file_name> bpp <n_bytes_per_pkt> 356 [action <port_in_action_profile_name>] 357 [disabled] 358 359Create pipeline output port :: 360 361 pipeline <pipeline_name> port out 362 bsz <burst_size> 363 link <link_name> txq <txq_id> 364 | swq <swq_name> 365 | tmgr <tmgr_name> 366 | tap <tap_name> 367 | kni <kni_name> 368 | sink [file <file_name> pkts <max_n_pkts>] 369 370Create pipeline table :: 371 372 pipeline <pipeline_name> table 373 match 374 acl 375 ipv4 | ipv6 376 offset <ip_header_offset> 377 size <n_rules> 378 | array 379 offset <key_offset> 380 size <n_keys> 381 | hash 382 ext | lru 383 key <key_size> 384 mask <key_mask> 385 offset <key_offset> 386 buckets <n_buckets> 387 size <n_keys> 388 | lpm 389 ipv4 | ipv6 390 offset <ip_header_offset> 391 size <n_rules> 392 | stub 393 [action <table_action_profile_name>] 394 395Connect pipeline input port to table :: 396 397 pipeline <pipeline_name> port in <port_id> table <table_id> 398 399Display statistics for specific pipeline input port, output port 400or table :: 401 402 pipeline <pipeline_name> port in <port_id> stats read [clear] 403 pipeline <pipeline_name> port out <port_id> stats read [clear] 404 pipeline <pipeline_name> table <table_id> stats read [clear] 405 406Enable given input port for specific pipeline instance :: 407 408 pipeline <pipeline_name> port out <port_id> disable 409 410Disable given input port for specific pipeline instance :: 411 412 pipeline <pipeline_name> port out <port_id> disable 413 414Add default rule to table for specific pipeline instance :: 415 416 pipeline <pipeline_name> table <table_id> rule add 417 match 418 default 419 action 420 fwd 421 drop 422 | port <port_id> 423 | meta 424 | table <table_id> 425 426Add rule to table for specific pipeline instance :: 427 428 pipeline <pipeline_name> table <table_id> rule add 429 430 match 431 acl 432 priority <priority> 433 ipv4 | ipv6 <sa> <sa_depth> <da> <da_depth> 434 <sp0> <sp1> <dp0> <dp1> <proto> 435 | array <pos> 436 | hash 437 raw <key> 438 | ipv4_5tuple <sa> <da> <sp> <dp> <proto> 439 | ipv6_5tuple <sa> <da> <sp> <dp> <proto> 440 | ipv4_addr <addr> 441 | ipv6_addr <addr> 442 | qinq <svlan> <cvlan> 443 | lpm 444 ipv4 | ipv6 <addr> <depth> 445 446 action 447 fwd 448 drop 449 | port <port_id> 450 | meta 451 | table <table_id> 452 [balance <out0> ... <out7>] 453 [meter 454 tc0 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 455 [tc1 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 456 tc2 meter <meter_profile_id> policer g <pa> y <pa> r <pa> 457 tc3 meter <meter_profile_id> policer g <pa> y <pa> r <pa>]] 458 [tm subport <subport_id> pipe <pipe_id>] 459 [encap 460 ether <da> <sa> 461 | vlan <da> <sa> <pcp> <dei> <vid> 462 | qinq <da> <sa> <pcp> <dei> <vid> <pcp> <dei> <vid> 463 | mpls unicast | multicast 464 <da> <sa> 465 label0 <label> <tc> <ttl> 466 [label1 <label> <tc> <ttl> 467 [label2 <label> <tc> <ttl> 468 [label3 <label> <tc> <ttl>]]] 469 | pppoe <da> <sa> <session_id>] 470 [nat ipv4 | ipv6 <addr> <port>] 471 [ttl dec | keep] 472 [stats] 473 [time] 474 475 where: 476 <pa> ::= g | y | r | drop 477 478Add bulk rules to table for specific pipeline instance :: 479 480 pipeline <pipeline_name> table <table_id> rule add bulk <file_name> <n_rules> 481 482 Where: 483 - file_name = path to file 484 - File line format = match <match> action <action> 485 486Delete table rule for specific pipeline instance :: 487 488 pipeline <pipeline_name> table <table_id> rule delete 489 match <match> 490 491Delete default table rule for specific pipeline instance :: 492 493 pipeline <pipeline_name> table <table_id> rule delete 494 match 495 default 496 497Add meter profile to the table for specific pipeline instance :: 498 499 pipeline <pipeline_name> table <table_id> meter profile <meter_profile_id> 500 add srtcm cir <cir> cbs <cbs> ebs <ebs> 501 | trtcm cir <cir> pir <pir> cbs <cbs> pbs <pbs> 502 503Delete meter profile from the table for specific pipeline instance :: 504 505 pipeline <pipeline_name> table <table_id> 506 meter profile <meter_profile_id> delete 507 508 509Update the dscp table for meter or traffic manager action for specific 510pipeline instance :: 511 512 pipeline <pipeline_name> table <table_id> dscp <file_name> 513 514 Where: 515 - file_name = path to file 516 - exactly 64 lines 517 - File line format = <tc_id> <tc_queue_id> <color>, with <color> as: g | y | r 518 519 520Pipeline enable/disable 521~~~~~~~~~~~~~~~~~~~~~~~ 522 523 Enable given pipeline instance for specific data plane thread :: 524 525 thread <thread_id> pipeline <pipeline_name> enable 526 527 528 Disable given pipeline instance for specific data plane thread :: 529 530 thread <thread_id> pipeline <pipeline_name> disable 531