QAT_SLA_MGR(8)

NAME
qat_sla_mgr - manage QAT rate limiting Service Level Agreements

SYNOPSIS
qat_sla_mgr command [arguments]

DESCRIPTION
qat_sla_mgr is the command-line interface for managing rate limiting Service Level Agreements (SLAs) on Intel QuickAssist Technology (QAT) devices using the in-tree kernel driver.

It operates on the sysfs interface exposed by the intel_qat kernel module. Root access is required. All throughput values are expressed in Megabits per second (Mbps).

SLAs are managed at the Physical Function (PF) level. The VF address is only needed at creation time to derive the ring-pair mask. VFs passed through to a guest VM are not supported.

Both qat_sla_mgr and qat_sla_rl.py must reside in the same directory.

COMMANDS

create vf_addr cir pir service
    Create a new SLA for the given VF address. Prints the assigned SLA ID on success. Use this ID with the PF address for subsequent update and delete operations.

    vf_addr
        PCI Bus:Device.Function address of the VF (e.g. 6b:01.0 or 0000:6b:01.0).

    cir Committed Information Rate in Mbps. Must be a positive integer.

    pir Peak Information Rate in Mbps. Must be greater than or equal to cir.

    service
        Service type. One of: asym, sym, dc, decomp, dcc.

update pf_addr sla_id cir pir
    Update an existing SLA identified by sla_id.

    pf_addr
        PCI address of the PF.

    sla_id
        SLA identifier returned by the create command.

    cir New Committed Information Rate in Mbps.

    pir New Peak Information Rate in Mbps.

delete pf_addr sla_id
    Delete the SLA identified by sla_id.

delete_all pf_addr
    Delete all SLAs on the given PF.

list pf_addr
    List all configured SLAs on the given PF. For each SLA, prints the ID, CIR, PIR (in Mbps), service type, ring-pair mask, and VF address (if SR-IOV is enabled).

caps pf_addr
    Print the maximum and remaining capacity (in Mbps) for every service configured on the device. Services are discovered at runtime via sysfs.

help
    Display a brief usage summary.

PCI ADDRESS FORMAT
PCI addresses may be specified with or without the domain prefix:

    BB:DD.F
        Bus, Device, Function (domain defaults to 0000).

    DDDD:BB:DD.F
        Domain, Bus, Device, Function.

SERVICES

asym
    Asymmetric cryptography.

sym Symmetric cryptography.

dc  Compression.

decomp
    Decompression.

dcc Chained compression and crypto.

EXIT STATUS

0   Success.

1   Failure. An error message is printed to stdout with details; check the kernel log for additional information.

EXAMPLES
Query all device capabilities:
    # ./qat_sla_mgr caps 0000:6b:00.0
    Remaining capacity for 'asym' is: 173750 of: 173750
    Remaining capacity for 'dc' is: 45000 of: 45000
    Remaining capacity for 'sym' is: 95000 of: 95000

Create an SLA for a VF with 5000 Mbps CIR and 9000 Mbps PIR:
    # ./qat_sla_mgr create 0000:6b:01.0 5000 9000 sym
    SLA ID: 0

List SLAs on a PF:
    # ./qat_sla_mgr list 0000:6b:00.0
      SLA ID: 0
      CIR: 5000
      PIR: 9000
      SRV: sym
      RP: 0xf
      VF: 0000:6b:01.0

Update SLA 0 to 8000/8000 Mbps:
    # ./qat_sla_mgr update 0000:6b:00.0 0 8000 8000

Delete SLA 0:
    # ./qat_sla_mgr delete 0000:6b:00.0 0

Delete all SLAs on a PF:
    # ./qat_sla_mgr delete_all 0000:6b:00.0

ENVIRONMENT
qat_sla_mgr requires the intel_qat in-tree kernel module to be loaded. If an out-of-tree QAT driver is detected, an error message directs the user to the appropriate out-of-tree utility.

FILES

/sys/bus/pci/devices/<bdf>/qat_rl/
    Sysfs directory used by the kernel for rate limiting configuration.

/sys/bus/pci/devices/<bdf>/qat/rp2srv
    Sysfs file mapping ring pairs to services; used by caps to discover configured services.

SEE ALSO
Kernel sysfs-driver-qat_rl documentation:

https://docs.kernel.org/ABI/testing/sysfs-driver-qat_rl

AUTHORS
Intel Corporation.