io-pkt-v4-hc, io-pkt-v6-hc

Runs on:

QNX Neutrino

Options:

-D

Run the resource manager/protocol layer stack context in a dedicated POSIX thread. By default this is off. This option can offer a performance improvement if you're sending and receiving TCP/IP traffic from applications on a multicore system.

-d driver [driver_options]

Start the specified devnp-* driver:

• You can specify driver without the devnp- prefix or the .so extension. For example, to start the devnp-e1000.so driver, specify -d e1000.
• If you want to load a specific version of a driver, specify the full path of the module (e.g., /lib/dll/devnp-e1000.so).

The driver_options argument is a list of driver-specific options that the stack passes to the driver.

Note:

Use commas, not spaces, to separate the options.

The stack processes various driver options; for more information, see “Generic driver options,” below.

-I

Don't acquire _NTO_TCTL_IO_PRIV in this instance of io-pkt (see ThreadCtl() in the C Library Reference). With this option enabled, drivers loaded into io-pkt can't perform any operation that requires _NTO_TCTL_IO_PRIV, and they can't queue interrupts in an ISR.

-i instance

The stack instance number, which is useful if you're running multiple instances of io-pkt. The io-pkt manager will service mount requests of type io-pktX, where X is the instance number. For example:

io-pkt-v4-hc -i1 -ptcpip prefix=/alt
mount -Tio-pkt1 /lib/dll/devnp-abc100.so

-P priority

The priority to use for io-pkt's main thread. The default is 21.

-p protocol [protocol_options]

The protocol to start, followed by a list of protocol-specific options.

Note: Use commas, not spaces, to separate the options.

The available protocols include:

Protocol	Module
pf-v4	lsm-pf-v4.so (for use with io-pkt-v4-hc)
pf-v6	lsm-pf-v6.so (for use with io-pkt-v6-hc)
qnet	lsm-qnet.so
tcpip	The stack includes TCP/IP; you need to specify this protocol only if you want to pass additional parameters (e.g., prefix=) to it. For more information about the options, see below.

-q interval

Set up the quiesce_all() watchdog. If unquiesce_all() isn't called within interval (1–5) seconds, io-pkt panics. The watchdog is disabled by default.

-r priority

The priority of the watchdog thread, which should be higher than the other io-pkt and socket application priorities. The default is 22.

-S

Don't register a SIGSEGV handler to quiesce the hardware if a segmentation violation occurs. This can help with debugging if it isn't possible to get a backtrace to the original code that generated the SIGSEGV through the signal handler.

-t threads

The number of processing threads to create. By default, one thread is created per CPU. These threads are the packet-processing threads that operate at Layer2 and may become the stack thread. For more information, see the Overview chapter of the QNX Neutrino Core Networking User's Guide.

-U string

Specify the user and groups that io-pkt should drop to when you tell it to stop running as root (see below). The string can be in one of these forms:

• uid[:gid[,sup_gid]*]
• user_name[,sup_gid]*

The default is 99:99,120. In the second form, the primary group is the one specified for user_name in /etc/passwd.

The io-pkt manager drops to the user specified with the -U option when you issue the following sysctl command:

sysctl -w qnx.kern.droproot=value

The value is a hexadecimal number whose bits indicate which abilities io-pkt should keep, or 0 if you want io-pkt to continue to run as root. The QNX_DROPROOT_* flags are defined in <sys/iopkt_ability.h>:

Constant	Value	Ability
QNX_DROPROOT_STD	0x0001	Drop root without keeping any additional abilities (keep the “standard” ones listed below)
QNX_DROPROOT_INTERRUPT	0x0002	PROCMGR_AID_INTERRUPT
QNX_DROPROOT_CONNECTION	0x0004	PROCMGR_AID_CONNECTION
QNX_DROPROOT_TIMER	0x0008	PROCMGR_AID_TIMER
QNX_DROPROOT_PROT_EXEC	0x0010	PROCMGR_AID_PROT_EXEC
QNX_DROPROOT_PATHSPACE	0x0020	Not used; io-pkt keeps PROCMGR_AID_PATHSPACE by default
QNX_DROPROOT_QNET	0x0040	PROCMGR_AID_QNET
QNX_DROPROOT_PUBLIC_CHANNEL	0x0080	PROCMGR_AID_PUBLIC_CHANNEL

By default, io-pkt retains the following abilities:

• IOFUNC_ABILITY_DUP
• IOFUNC_ABILITY_EXEC
• IOFUNC_ABILITY_READ
• PROCMGR_AID_KEYDATA
• PROCMGR_AID_MEM_PHYS
• PROCMGR_AID_PATHSPACE
• PROCMGR_AID_PRIORITY

For more information about abilities, see the entry for procmgr_ability() in the QNX Neutrino C Library Reference.

-u string

Specify the user, group, and access mode for the device nodes that io-pkt creates. Use the following format for string:

type,uid:gid,mode

where:

• type is one of the following values: socket, bpf, pf, config, srt, tun, tap, llmcast, nraw, slip, pppmgr, altq, all.

  The all type sets the user ID, group ID, and mode combination for all of the possible device types.

• uid and gid are either numeric, or the user or group name.
• The mode value is an access mode in octal format (e.g., 0660 for read/write for user and group).

You can specify -u multiple times. Later instances override values set by earlier instances. For example, in the following command, the user ID, group ID, and access mode for the BPF device set using all in the first instance of -u is overriden by the values specified in the second instance:

io-pkt-v6-hc -u all,user1:iopkt,0660 -u bpf,user2:user2,0600  

-w interval

Set up the io-pkt watchdog. If the hardclock_ticks variable doesn't increase in interval (1–5) seconds, io-pkt panics. The watchdog is disabled by default.

TCP/IP options

If you specify the -p tcpip protocol, the protocol_options list can consist of one or more of the following, separated by commas without whitespace:

bigpage_strict

By default, the value of the pagesize option is used only for the mbuf and cluster pools; the other pools are of size sysconf(_SC_PAGESIZE). If you specify this option, the value of the pagesize option is used for all pools.

bigstack[=size]

Use a larger stack size for the loading of drivers. Without this option, drivers are loaded using the default stacksize stack. With this option, a new larger stack is used. The default size of the larger stack is 128 KB, but you can specify a size, in bytes.

cache=0

Disable the caching of packet buffers. This should be needed only as a debugging facility.

confstr_monitor

Monitor changes to configuration strings, in particular CS_HOSTNAME. By default, io-pkt gets the hostname once at startup.

fastforward=X

Enable (1) or disable (0) fastforwarding path. This is useful for gateways. This option enables, and is enabled by, forward; to enable only forward, specify forward,fastforward=0.

forward

Enable forwarding of IPv4 packets between interfaces; this enables fastforward by default. The default is off.

forward6

(io-pkt-v6-hc only) Enable forwarding of IPv6 packets between interfaces; off by default.

ipid_reserved=X

Reserve IPv4 identifier values, where X is between 2 and 32768, and a power of 2. When set, io-pkt does not use the IPv4 identifier values between 0 and X. Default is 0.

ipsec

Enable IPsec support; off by default.

mbuf_cache=X

As mbufs are freed after use, rather than returning them to the internal pool for general consumption, up to X mbufs are cached per thread to allow quicker retrieval on the next allocation.

mtag_cache=X

As mtags are freed after use, rather than returning them to the internal pool for general consumption, up to X mtags are cached per thread to allow quicker retrieval on the next allocation.

This applies only to tags of 16 bytes or less. The default number of tags cached is 128.

mclbytes=size

The mbuf cluster size. A cluster is the largest amount of contiguous memory used by an mbuf. If the MTU is larger than a cluster, multiple clusters are used to hold the packet. The default and minimum cluster size is 2 KB (to fit a standard 1500-byte Ethernet packet); the maximum is 64 KB or the value of the pagesize option, whichever is smaller. This value is rounded down to the nearest power of two.

Specifying the cluster size can improve performance; for more information, see “Jumbo packets and hardware checksumming” in the Network Drivers chapter of the QNX Neutrino Core Networking User's Guide.

mfib_gid_map=string

Specify a semicolon-separated mapping of GIDs to Forwarding Information Bases (FIBs). For example, to map SGID 750 and 760 to FIBs 1 and 2, respectively, specify:

mfib_gid_map=750_1;760_2

num_pool_cache=X

The number of pool caches created for mbuf and cluster pools. The default is 1 for each pool; the maximum is 20.

num_tap_interface=X

The maximum number of TAP interfaces that can be created. The default is 5. You can create TAP interfaces by either the /dev/tap cloning device, or via ifconfig's create command.

num_tun_control_interface=X

The number of TUN control interfaces (e.g., /dev/tun0) to create when io-pkt starts. The default is 4.

You can create TUN device interfaces (as listed by the ifconfig utility) by either opening a precreated control interface or using ifconfig create. The only way to create TUN device interfaces beyond the num_tun_control_interface number is to use ifconfig create.

pagesize=X

The smallest amount of data allocated each time for the mbuf and cluster memory pools, or all pools if you specify bigpage_strict. This quantum is then carved into chunks of varying size, depending on the pool.

The default value is 128 KB, the maximum is 16 MB, and the minimum is sysconf(_SC_PAGESIZE). This value is rounded down to the nearest power of 2. This value also sets the maximum for mclbytes.

pfil_ipsec

Run packet filters on packets before encryption. The default is to do it after encryption.

pkt_cache=X

As mbuf and cluster combinations are freed after use, rather than return them to the internal pool for general consumption, up to X mbufs and clusters are cached per thread to allow quicker retrieval on the next allocation.

pkt_typed_mem=object

Allocate packet buffers from the specified typed memory object. For example:

io-pkt -ptcpip pkt_typed_mem=ram/dma

prefix=/path

The path to prepend to the traditional /dev/socket. The is useful when running multiple stacks (see the -i option). Clients can target a particular stack by using the SOCK environment variable. For example:

io-pkt -i1 -ptcpip prefix=/alt
SOCK=/alt ifconfig -a

recv_ctxt=X

Specify the size of the receive context buffer, in bytes. The default is 65536; the minimum is 2048.

reply_ctxt=X

Specify the number of buffer objects that io-pkt can send in reply to an application in one kernel operation. This setting does not limit the amount of data that can be included in the reply, it just determines how many operations are needed to reply with a given amount of data. The default is 90 objects; the minimum is 32.

reuseport_unicast

If using the SO_REUSEPORT socket option, received unicast UDP packets are delivered to all sockets bound to the port. The default is to deliver only multicast and broadcast to all sockets.

rx_prio=X or rx_pulse_prio=X

The priority for receive threads to use (the default is 21). A driver-specific priority option (if supported by the driver) can override this priority.

smmu=0|1|off|on

Specify whether or not support for the system memory management unit (IOMMU/SMMU) manager is required:

• 0 or off — disable SMMU support. This is the default.
• 1 or on — SMMU support is required; io-pkt exits if it isn't available

If value isn't valid, io-pkt disables SMMU support and sends a message to slogger2.

For more information, see the SMMUMAN User's Guide.

so_txprio_enable

Enable the SO_TXPRIO socket option (see getsockopt() in the QNX Neutrino C Library Reference).

The SO_TXPRIO socket option sets the transmit queue priority on a socket. If you set this priority, then all traffic sent through the socket carries a packet tag of type PACKET_TAG_TXQ whose value is the priority value that you set with setsockopt(). If you don't start io-pkt with this option, and you then try to set SO_TXPRIO, setsockopt() fails and sets errno to EOPNOTSUPP.

The so_txprio_enable option restricts only the capability of the SO_TXPRIO socket option. It has no effect on lsm-llmcast.so, which can generate packets that carry PACKET_TAG_TXQ tags.

Note: Setting the so_txprio_enable option negatively affects the performance of io-pkt. This is true even if application code doesn't call setsockopt() to set the value of SO_TXPRIO. You should enable this option only if you need to set the transmit queue priority.

To complete the priority transmit queue function, a network driver must extract the priority value from the packet's PACKET_TAG_TXQ tag, and then enqueue the packet on the appropriate transmit queue. If a network driver doesn't support extracting PACKET_TAG_TXQ, then it can treat a packet as an ordinary one, and setting the SO_TXPRIO option has no useful effect, other than slowing down the traffic because of the extra work. Therefore application developers should use this option only with a network driver that supports priority transmit queues.

The io-pkt stack code (excluding network drivers) doesn't interpret this priority value in any way. Specifically, io-pkt doesn't associate the transmit queue priority with IP_TOS or IPV6_TCLASS. If you want to associate a transmit queue priority value with IP_TOS or IPV6_TCLASS, you must properly set both IP_TOS (or IPV6_TCLASS) and SO_TXPRIO on the socket, so that traffic through it has the proper type of service and is transmitted at the proper priority by a network driver.

somaxconn=X

Specify the value of SOMAXCONN, the maximum length of the listen queue used to accept new TCP connections. The minimum is the value in <sys/socket.h>.

stackguard

Introduce a guard page between each thread's stack to aid in debugging “blown stack handling” panics. This will cause a SIGSEGV at the point of stack overrun rather than at the end of the operation.

Note: If the value of the stacksize option isn't a multiple of the system page size, then this option increases the stack size until it is. A message is logged to slogger2 in this case advising of the new size. This increase in stack size may change the issue being debugged.

stacksize=X

Specify the size of each thread's stack, in bytes. The default is 4096 (4 KB) in 32-bit architectures, and 8192 (8 KB) in 64-bit architectures.

strict_ts

(QNX Neutrino 7.0.1 or later) Use the io-pkt timer for timestamping BPF. This results in a best-case precision of 1 millisecond, but the timestamps are guaranteed to be monotonic. By default ClockCycles() is used to give timestamps that are precise down to 1 microsecond, at the risk of occasional nonmonotonic timestamps as the ClockCycles() clock is recalibrated against the io-pkt timer.

threads_incr=X

If the supply of functional connections is exhausted, increment their number by this amount, up to the value of threads_max. The default is 25.

Note: The term “threads” in the TCP/IP threads_* options is a misnomer; it really refers to functional TCP/IP connections or blocking operations (read(), write(), accept(), etc.). It has nothing to do with the number of threads running in io-pkt-*.

threads_max=X

Specify the maximum number of functional TCP/IP connections that the stack can service simultaneously. The default is 200.

threads_min=X

Specify the minimum number of functional TCP/IP connections. The default is 15, and the minimum is 4.

timer_pulse_prio=priority

The priority to use for the timer pulse. The default is 21.

Description:

The io-pkt manager provides support for Internet domain sockets, Unix domain sockets, and dynamically loaded networking modules. It comes in the following stack variants:

io-pkt-v4-hc

IPv4 version of the stack that has full encryption and Wi-Fi capability built in and includes hardware-accelerated cryptography capability (Fast IPsec).

io-pkt-v6-hc

IPv6 version of the stack (includes IPv4 as part of v6) that has full encryption and Wi-Fi capability, also with hardware-accelerated cryptography.

After you've launched io-pkt*, you can use the mount command to start drivers or load additional modules such as lsm-pf-v4.so or lsm-pf-v6.so. If you want to pass options to the driver, use the -o option before the name of the shared object. For example:

mount -T io-pkt -o mac=12345678 devnp-abc100.so

The io-pkt manager supports TUN and TAP. To create the interfaces, use ifconfig:

ifconfig tun0 create
ifconfig tap0 create

For more information, see the NetBSD documentation:

• tun
• tap

Generic driver options

The stack processes the following generic driver options:

name=prefix

Override the default interface prefix used for network drivers. For example:

io-pkt-v4-hc -d abc100 name=en

starts the fictitious devnp-abc100.so driver with the “en” interface naming convention (enXX). You can also use this option to assign interface names based on (for example) functionality:

io-pkt-v4-hc -d abc100 pci=0,name=wan

unit=number

The interface number to use. If number is negative, it's ignored. By default, the interfaces are numbered starting at 0.

The stack also processes the following driver options for all USB drivers using the NetBSD-to-QNX conversion library to let you identify a particular USB device using information obtained from running usb -v:

did=ID

Device product ID.

vid=ID

Device vendor ID.

devno=addr

Device address, as reported by the usb utility.

busno=num

Host controller, as reported by the usb utility

For example:

io-pkt-v4-hc -d abc100 did=0x0020,vid=0x13b1,devno=1,busno=1

Examples:

Start the v6 variant of io-pkt using the fictitious devnp-abc100.so driver:

io-pkt-v6-hc -d /lib/dll/devnp-abc100.so \
  memrange=0x10064000,irq=0x80050024,mac=001122334455
ifconfig abc0 10.184