€•      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ4/translations/zh_CN/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/zh_TW/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/it_IT/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/ja_JP/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/ko_KR/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/pt_BR/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/sp_SP/driver-api/crypto/iaa/iaa-crypto”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1hµhhh²hh³ŒN/var/lib/git/docbuild/linux/Documentation/driver-api/crypto/iaa/iaa-crypto.rst”h´KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ)IAA Compression Accelerator Crypto Driver”h]”hŒ)IAA Compression Accelerator Crypto Driver”…””}”(hhÏh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhhÊh²hh³hÇh´KubhŒ	paragraph”“”)”}”(hŒ)Tom Zanussi <tom.zanussi@linux.intel.com>”h]”(hŒTom Zanussi <”…””}”(hhßh²hh³Nh´NubhŒ	reference”“”)”}”(hŒtom.zanussi@linux.intel.com”h]”hŒtom.zanussi@linux.intel.com”…””}”(hhéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ"mailto:tom.zanussi@linux.intel.com”uh1hçhhßubhŒ>”…””}”(hhßh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÞ)”}”(hŒÊThe IAA crypto driver supports compression/decompression compatible
with the DEFLATE compression standard described in RFC 1951, which is
the compression/decompression algorithm exported by this module.”h]”hŒÊThe IAA crypto driver supports compression/decompression compatible
with the DEFLATE compression standard described in RFC 1951, which is
the compression/decompression algorithm exported by this module.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K	hhÊh²hubhÞ)”}”(hŒ(The IAA hardware spec can be found here:”h]”hŒ(The IAA hardware spec can be found here:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhŒblock_quote”“”)”}”(hŒ1https://cdrdv2.intel.com/v1/dl/getContent/721858
”h]”hÞ)”}”(hŒ0https://cdrdv2.intel.com/v1/dl/getContent/721858”h]”hè)”}”(hj'  h]”hŒ0https://cdrdv2.intel.com/v1/dl/getContent/721858”…””}”(hj)  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j'  uh1hçhj%  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khj!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´KhhÊh²hubhÞ)”}”(hŒoThe iaa_crypto driver is designed to work as a layer underneath
higher-level compression devices such as zswap.”h]”hŒoThe iaa_crypto driver is designed to work as a layer underneath
higher-level compression devices such as zswap.”…””}”(hjC  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÞ)”}”(hŒ¶Users can select IAA compress/decompress acceleration by specifying
one of the supported IAA compression algorithms in whatever facility
allows compression algorithms to be selected.”h]”hŒ¶Users can select IAA compress/decompress acceleration by specifying
one of the supported IAA compression algorithms in whatever facility
allows compression algorithms to be selected.”…””}”(hjQ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÞ)”}”(hŒ…For example, a zswap device can select the IAA 'fixed' mode
represented by selecting the 'deflate-iaa' crypto compression
algorithm::”h]”hŒŒFor example, a zswap device can select the IAA â€˜fixedâ€™ mode
represented by selecting the â€˜deflate-iaaâ€™ crypto compression
algorithm:”…””}”(hj_  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhŒliteral_block”“”)”}”(hŒ<# echo deflate-iaa > /sys/module/zswap/parameters/compressor”h]”hŒ<# echo deflate-iaa > /sys/module/zswap/parameters/compressor”…””}”hjo  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KhhÊh²hubhÞ)”}”(hŒaThis will tell zswap to use the IAA 'fixed' compression mode for all
compresses and decompresses.”h]”hŒeThis will tell zswap to use the IAA â€˜fixedâ€™ compression mode for all
compresses and decompresses.”…””}”(hj}  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÞ)”}”(hŒGCurrently, there is only one compression modes available, 'fixed'
mode.”h]”hŒKCurrently, there is only one compression modes available, â€˜fixedâ€™
mode.”…””}”(hj‹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K!hhÊh²hubhÞ)”}”(hXò  The 'fixed' compression mode implements the compression scheme
specified by RFC 1951 and is given the crypto algorithm name
'deflate-iaa'.  (Because the IAA hardware has a 4k history-window
limitation, only buffers <= 4k, or that have been compressed using a
<= 4k history window, are technically compliant with the deflate spec,
which allows for a window of up to 32k.  Because of this limitation,
the IAA fixed mode deflate algorithm is given its own algorithm name
rather than simply 'deflate').”h]”hXþ  The â€˜fixedâ€™ compression mode implements the compression scheme
specified by RFC 1951 and is given the crypto algorithm name
â€˜deflate-iaaâ€™.  (Because the IAA hardware has a 4k history-window
limitation, only buffers <= 4k, or that have been compressed using a
<= 4k history window, are technically compliant with the deflate spec,
which allows for a window of up to 32k.  Because of this limitation,
the IAA fixed mode deflate algorithm is given its own algorithm name
rather than simply â€˜deflateâ€™).”…””}”(hj™  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K$hhÊh²hubhÉ)”}”(hhh]”(hÎ)”}”(hŒConfig options and other setup”h]”hŒConfig options and other setup”…””}”(hjª  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj§  h²hh³hÇh´K/ubhÞ)”}”(hŒLThe IAA crypto driver is available via menuconfig using the following
path::”h]”hŒKThe IAA crypto driver is available via menuconfig using the following
path:”…””}”(hj¸  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K1hj§  h²hubjn  )”}”(hŒ`Cryptographic API -> Hardware crypto devices -> Support for Intel(R) IAA Compression Accelerator”h]”hŒ`Cryptographic API -> Hardware crypto devices -> Support for Intel(R) IAA Compression Accelerator”…””}”hjÆ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´K4hj§  h²hubhÞ)”}”(hŒIIn the configuration file the option called CONFIG_CRYPTO_DEV_IAA_CRYPTO.”h]”hŒIIn the configuration file the option called CONFIG_CRYPTO_DEV_IAA_CRYPTO.”…””}”(hjÔ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K6hj§  h²hubhÞ)”}”(hŒmThe IAA crypto driver also supports statistics, which are available
via menuconfig using the following path::”h]”hŒlThe IAA crypto driver also supports statistics, which are available
via menuconfig using the following path:”…””}”(hjâ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K8hj§  h²hubjn  )”}”(hŒŽCryptographic API -> Hardware crypto devices -> Support for Intel(R) IAA Compression -> Enable Intel(R) IAA Compression Accelerator Statistics”h]”hŒŽCryptographic API -> Hardware crypto devices -> Support for Intel(R) IAA Compression -> Enable Intel(R) IAA Compression Accelerator Statistics”…””}”hjð  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´K;hj§  h²hubhÞ)”}”(hŒOIn the configuration file the option called CONFIG_CRYPTO_DEV_IAA_CRYPTO_STATS.”h]”hŒOIn the configuration file the option called CONFIG_CRYPTO_DEV_IAA_CRYPTO_STATS.”…””}”(hjþ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K=hj§  h²hubhÞ)”}”(hŒ5The following config options should also be enabled::”h]”hŒ4The following config options should also be enabled:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K?hj§  h²hubjn  )”}”(hŒ¡CONFIG_IRQ_REMAP=y
CONFIG_INTEL_IOMMU=y
CONFIG_INTEL_IOMMU_SVM=y
CONFIG_PCI_ATS=y
CONFIG_PCI_PRI=y
CONFIG_PCI_PASID=y
CONFIG_INTEL_IDXD=m
CONFIG_INTEL_IDXD_SVM=y”h]”hŒ¡CONFIG_IRQ_REMAP=y
CONFIG_INTEL_IOMMU=y
CONFIG_INTEL_IOMMU_SVM=y
CONFIG_PCI_ATS=y
CONFIG_PCI_PRI=y
CONFIG_PCI_PASID=y
CONFIG_INTEL_IDXD=m
CONFIG_INTEL_IDXD_SVM=y”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KAhj§  h²hubhÞ)”}”(hŒÄIAA is one of the first Intel accelerator IPs that can work in
conjunction with the Intel IOMMU.  There are multiple modes that exist
for testing. Based on IOMMU configuration, there are 3 modes::”h]”hŒÃIAA is one of the first Intel accelerator IPs that can work in
conjunction with the Intel IOMMU.  There are multiple modes that exist
for testing. Based on IOMMU configuration, there are 3 modes:”…””}”(hj(  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KJhj§  h²hubjn  )”}”(hŒ- Scalable
- Legacy
- No IOMMU”h]”hŒ- Scalable
- Legacy
- No IOMMU”…””}”hj6  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KNhj§  h²hubhÉ)”}”(hhh]”(hÎ)”}”(hŒScalable mode”h]”hŒScalable mode”…””}”(hjG  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjD  h²hh³hÇh´KTubhÞ)”}”(hŒqScalable mode supports Shared Virtual Memory (SVM or SVA). It is
entered when using the kernel boot commandline::”h]”hŒpScalable mode supports Shared Virtual Memory (SVM or SVA). It is
entered when using the kernel boot commandline:”…””}”(hjU  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KVhjD  h²hubjn  )”}”(hŒintel_iommu=on,sm_on”h]”hŒintel_iommu=on,sm_on”…””}”hjc  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KYhjD  h²hubhÞ)”}”(hŒwith VT-d turned on in BIOS.”h]”hŒwith VT-d turned on in BIOS.”…””}”(hjq  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K[hjD  h²hubhÞ)”}”(hŒOWith scalable mode, both shared and dedicated workqueues are available
for use.”h]”hŒOWith scalable mode, both shared and dedicated workqueues are available
for use.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K]hjD  h²hubhÞ)”}”(hŒBFor scalable mode, the following BIOS settings should be enabled::”h]”hŒAFor scalable mode, the following BIOS settings should be enabled:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K`hjD  h²hubjn  )”}”(hŒ©Socket Configuration > IIO Configuration > Intel VT for Directed I/O (VT-d) > Intel VT for Directed I/O

Socket Configuration > IIO Configuration > PCIe ENQCMD > ENQCMDS”h]”hŒ©Socket Configuration > IIO Configuration > Intel VT for Directed I/O (VT-d) > Intel VT for Directed I/O

Socket Configuration > IIO Configuration > PCIe ENQCMD > ENQCMDS”…””}”hj›  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KbhjD  h²hubeh}”(h]”Œscalable-mode”ah ]”h"]”Œscalable mode”ah$]”h&]”uh1hÈhj§  h²hh³hÇh´KTubhÉ)”}”(hhh]”(hÎ)”}”(hŒLegacy mode”h]”hŒLegacy mode”…””}”(hj´  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj±  h²hh³hÇh´KhubhÞ)”}”(hŒ?Legacy mode is entered when using the kernel boot commandline::”h]”hŒ>Legacy mode is entered when using the kernel boot commandline:”…””}”(hjÂ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kjhj±  h²hubjn  )”}”(hŒintel_iommu=off”h]”hŒintel_iommu=off”…””}”hjÐ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Klhj±  h²hubhÞ)”}”(hŒ!or VT-d is not turned on in BIOS.”h]”hŒ!or VT-d is not turned on in BIOS.”…””}”(hjÞ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Knhj±  h²hubhÞ)”}”(hŒ¨If you have booted into Linux and not sure if VT-d is on, do a "dmesg
| grep -i dmar". If you don't see a number of DMAR devices enumerated,
most likely VT-d is not on.”h]”hŒ®If you have booted into Linux and not sure if VT-d is on, do a â€œdmesg
| grep -i dmarâ€. If you donâ€™t see a number of DMAR devices enumerated,
most likely VT-d is not on.”…””}”(hjì  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kphj±  h²hubhÞ)”}”(hŒBWith legacy mode, only dedicated workqueues are available for use.”h]”hŒBWith legacy mode, only dedicated workqueues are available for use.”…””}”(hjú  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kthj±  h²hubeh}”(h]”Œlegacy-mode”ah ]”h"]”Œlegacy mode”ah$]”h&]”uh1hÈhj§  h²hh³hÇh´KhubhÉ)”}”(hhh]”(hÎ)”}”(hŒNo IOMMU mode”h]”hŒNo IOMMU mode”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj  h²hh³hÇh´KxubhÞ)”}”(hŒANo IOMMU mode is entered when using the kernel boot commandline::”h]”hŒ@No IOMMU mode is entered when using the kernel boot commandline:”…””}”(hj!  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kzhj  h²hubjn  )”}”(hŒ
iommu=off.”h]”hŒ
iommu=off.”…””}”hj/  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´K|hj  h²hubhÞ)”}”(hŒDWith no IOMMU mode, only dedicated workqueues are available for use.”h]”hŒDWith no IOMMU mode, only dedicated workqueues are available for use.”…””}”(hj=  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K~hj  h²hubeh}”(h]”Œno-iommu-mode”ah ]”h"]”Œno iommu mode”ah$]”h&]”uh1hÈhj§  h²hh³hÇh´Kxubeh}”(h]”Œconfig-options-and-other-setup”ah ]”h"]”Œconfig options and other setup”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K/ubhÉ)”}”(hhh]”(hÎ)”}”(hŒUsage”h]”hŒUsage”…””}”(hj^  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj[  h²hh³hÇh´K‚ubhÉ)”}”(hhh]”(hÎ)”}”(hŒaccel-config”h]”hŒaccel-config”…””}”(hjo  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjl  h²hh³hÇh´K…ubhÞ)”}”(hXž  When loaded, the iaa_crypto driver automatically creates a default
configuration and enables it, and assigns default driver attributes.
If a different configuration or set of driver attributes is required,
the user must first disable the IAA devices and workqueues, reset the
configuration, and then re-register the deflate-iaa algorithm with the
crypto subsystem by removing and reinserting the iaa_crypto module.”h]”hXž  When loaded, the iaa_crypto driver automatically creates a default
configuration and enables it, and assigns default driver attributes.
If a different configuration or set of driver attributes is required,
the user must first disable the IAA devices and workqueues, reset the
configuration, and then re-register the deflate-iaa algorithm with the
crypto subsystem by removing and reinserting the iaa_crypto module.”…””}”(hj}  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K‡hjl  h²hubhÞ)”}”(hŒpThe :ref:`iaa_disable_script` in the 'Use Cases'
section below can be used to disable the default configuration.”h]”(hŒThe ”…””}”(hj‹  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_disable_script`”h]”hŒinline”“”)”}”(hj•  h]”hŒiaa_disable_script”…””}”(hj™  h²hh³Nh´Nubah}”(h]”h ]”(Œxref”Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hj“  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”Œ driver-api/crypto/iaa/iaa-crypto”Œ	refdomain”j¤  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆŒ	reftarget”Œiaa_disable_script”uh1hh³hÇh´KŽhj‹  ubhŒW in the â€˜Use Casesâ€™
section below can be used to disable the default configuration.”…””}”(hj‹  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KŽhjl  h²hubhÞ)”}”(hŒMSee :ref:`iaa_default_config` below for details of the default
configuration.”h]”(hŒSee ”…””}”(hjÂ  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_default_config`”h]”j˜  )”}”(hjÌ  h]”hŒiaa_default_config”…””}”(hjÎ  h²hh³Nh´Nubah}”(h]”h ]”(j£  Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hjÊ  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j°  Œ	refdomain”jØ  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆj¶  Œiaa_default_config”uh1hh³hÇh´K‘hjÂ  ubhŒ0 below for details of the default
configuration.”…””}”(hjÂ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K‘hjl  h²hubhÞ)”}”(hŒÏMore likely than not, however, and because of the complexity and
configurability of the accelerator devices, the user will want to
configure the device and manually enable the desired devices and
workqueues.”h]”hŒÏMore likely than not, however, and because of the complexity and
configurability of the accelerator devices, the user will want to
configure the device and manually enable the desired devices and
workqueues.”…””}”(hjô  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K”hjl  h²hubhÞ)”}”(hX™  The userspace tool to help doing that is called accel-config.  Using
accel-config to configure device or loading a previously saved config
is highly recommended.  The device can be controlled via sysfs
directly but comes with the warning that you should do this ONLY if
you know exactly what you are doing.  The following sections will not
cover the sysfs interface but assumes you will be using accel-config.”h]”hX™  The userspace tool to help doing that is called accel-config.  Using
accel-config to configure device or loading a previously saved config
is highly recommended.  The device can be controlled via sysfs
directly but comes with the warning that you should do this ONLY if
you know exactly what you are doing.  The following sections will not
cover the sysfs interface but assumes you will be using accel-config.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K™hjl  h²hubhÞ)”}”(hŒyThe :ref:`iaa_sysfs_config` section in the appendix below can be
consulted for the sysfs interface details if interested.”h]”(hŒThe ”…””}”(hj  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_sysfs_config`”h]”j˜  )”}”(hj  h]”hŒiaa_sysfs_config”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”(j£  Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hj  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j°  Œ	refdomain”j&  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆj¶  Œiaa_sysfs_config”uh1hh³hÇh´K hj  ubhŒ^ section in the appendix below can be
consulted for the sysfs interface details if interested.”…””}”(hj  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K hjl  h²hubhÞ)”}”(hŒPThe accel-config tool along with instructions for building it can be
found here:”h]”hŒPThe accel-config tool along with instructions for building it can be
found here:”…””}”(hjB  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K£hjl  h²hubj   )”}”(hŒ-https://github.com/intel/idxd-config/#readme
”h]”hÞ)”}”(hŒ,https://github.com/intel/idxd-config/#readme”h]”hè)”}”(hjV  h]”hŒ,https://github.com/intel/idxd-config/#readme”…””}”(hjX  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jV  uh1hçhjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K¦hjP  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´K¦hjl  h²hubeh}”(h]”Œaccel-config”ah ]”h"]”Œaccel-config”ah$]”h&]”uh1hÈhj[  h²hh³hÇh´K…ubhÉ)”}”(hhh]”(hÎ)”}”(hŒTypical usage”h]”hŒTypical usage”…””}”(hj}  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjz  h²hh³hÇh´K©ubhÞ)”}”(hŒ³In order for the iaa_crypto module to actually do any
compression/decompression work on behalf of a facility, one or more
IAA workqueues need to be bound to the iaa_crypto driver.”h]”hŒ³In order for the iaa_crypto module to actually do any
compression/decompression work on behalf of a facility, one or more
IAA workqueues need to be bound to the iaa_crypto driver.”…””}”(hj‹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K«hjz  h²hubhÞ)”}”(hŒöFor instance, here's an example of configuring an IAA workqueue and
binding it to the iaa_crypto driver (note that device names are
specified as 'iax' rather than 'iaa' - this is because upstream still
has the old 'iax' device naming in place) ::”h]”hX  For instance, hereâ€™s an example of configuring an IAA workqueue and
binding it to the iaa_crypto driver (note that device names are
specified as â€˜iaxâ€™ rather than â€˜iaaâ€™ - this is because upstream still
has the old â€˜iaxâ€™ device naming in place)”…””}”(hj™  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K¯hjz  h²hubjn  )”}”(hXR  # configure wq1.0

accel-config config-wq --group-id=0 --mode=dedicated --type=kernel --priority=10 --name="iaa_crypto" --driver-name="crypto" iax1/wq1.0

accel-config config-engine iax1/engine1.0 --group-id=0

# enable IAA device iax1

accel-config enable-device iax1

# enable wq1.0 on IAX device iax1

accel-config enable-wq iax1/wq1.0”h]”hXR  # configure wq1.0

accel-config config-wq --group-id=0 --mode=dedicated --type=kernel --priority=10 --name="iaa_crypto" --driver-name="crypto" iax1/wq1.0

accel-config config-engine iax1/engine1.0 --group-id=0

# enable IAA device iax1

accel-config enable-device iax1

# enable wq1.0 on IAX device iax1

accel-config enable-wq iax1/wq1.0”…””}”hj§  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´K´hjz  h²hubhÞ)”}”(hXã  Whenever a new workqueue is bound to or unbound from the iaa_crypto
driver, the available workqueues are 'rebalanced' such that work
submitted from a particular CPU is given to the most appropriate
workqueue available.  Current best practice is to configure and bind
at least one workqueue for each IAA device, but as long as there is at
least one workqueue configured and bound to any IAA device in the
system, the iaa_crypto driver will work, albeit most likely not as
efficiently.”h]”hXç  Whenever a new workqueue is bound to or unbound from the iaa_crypto
driver, the available workqueues are â€˜rebalancedâ€™ such that work
submitted from a particular CPU is given to the most appropriate
workqueue available.  Current best practice is to configure and bind
at least one workqueue for each IAA device, but as long as there is at
least one workqueue configured and bound to any IAA device in the
system, the iaa_crypto driver will work, albeit most likely not as
efficiently.”…””}”(hjµ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KÂhjz  h²hubhÞ)”}”(hŒ¾The IAA crypto algorigthms is operational and compression and
decompression operations are fully enabled following the successful
binding of the first IAA workqueue to the iaa_crypto driver.”h]”hŒ¾The IAA crypto algorigthms is operational and compression and
decompression operations are fully enabled following the successful
binding of the first IAA workqueue to the iaa_crypto driver.”…””}”(hjÃ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KËhjz  h²hubhÞ)”}”(hŒ»Similarly, the IAA crypto algorithm is not operational and compression
and decompression operations are disabled following the unbinding of
the last IAA worqueue to the iaa_crypto driver.”h]”hŒ»Similarly, the IAA crypto algorithm is not operational and compression
and decompression operations are disabled following the unbinding of
the last IAA worqueue to the iaa_crypto driver.”…””}”(hjÑ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KÏhjz  h²hubhÞ)”}”(hŒ‘As a result, the IAA crypto algorithms and thus the IAA hardware are
only available when one or more workques are bound to the iaa_crypto
driver.”h]”hŒ‘As a result, the IAA crypto algorithms and thus the IAA hardware are
only available when one or more workques are bound to the iaa_crypto
driver.”…””}”(hjß  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KÓhjz  h²hubhÞ)”}”(hŒ{When there are no IAA workqueues bound to the driver, the IAA crypto
algorithms can be unregistered by removing the module.”h]”hŒ{When there are no IAA workqueues bound to the driver, the IAA crypto
algorithms can be unregistered by removing the module.”…””}”(hjí  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K×hjz  h²hubeh}”(h]”Œtypical-usage”ah ]”h"]”Œtypical usage”ah$]”h&]”uh1hÈhj[  h²hh³hÇh´K©ubhÉ)”}”(hhh]”(hÎ)”}”(hŒDriver attributes”h]”hŒDriver attributes”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj  h²hh³hÇh´KÜubhÞ)”}”(hX&  There are a couple user-configurable driver attributes that can be
used to configure various modes of operation.  They're listed below,
along with their default values.  To set any of these attributes, echo
the appropriate values to the attribute file located under
/sys/bus/dsa/drivers/crypto/”h]”hX(  There are a couple user-configurable driver attributes that can be
used to configure various modes of operation.  Theyâ€™re listed below,
along with their default values.  To set any of these attributes, echo
the appropriate values to the attribute file located under
/sys/bus/dsa/drivers/crypto/”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KÞhj  h²hubhÞ)”}”(hŒ¸The attribute settings at the time the IAA algorithms are registered
are captured in each algorithm's crypto_ctx and used for all compresses
and decompresses when using that algorithm.”h]”hŒºThe attribute settings at the time the IAA algorithms are registered
are captured in each algorithmâ€™s crypto_ctx and used for all compresses
and decompresses when using that algorithm.”…””}”(hj"  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kähj  h²hubhÞ)”}”(hŒThe available attributes are:”h]”hŒThe available attributes are:”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kèhj  h²hubj   )”}”(hX›	  - verify_compress

  Toggle compression verification.  If set, each compress will be
  internally decompressed and the contents verified, returning error
  codes if unsuccessful.  This can be toggled with 0/1::

    echo 0 > /sys/bus/dsa/drivers/crypto/verify_compress

  The default setting is '1' - verify all compresses.

- sync_mode

  Select mode to be used to wait for completion of each compresses
  and decompress operation.

  The crypto async interface support implemented by iaa_crypto
  provides an implementation that satisfies the interface but does
  so in a synchronous manner - it fills and submits the IDXD
  descriptor and then loops around waiting for it to complete before
  returning.  This isn't a problem at the moment, since all existing
  callers (e.g. zswap) wrap any asynchronous callees in a
  synchronous wrapper anyway.

  The iaa_crypto driver does however provide true asynchronous
  support for callers that can make use of it.  In this mode, it
  fills and submits the IDXD descriptor, then returns immediately
  with -EINPROGRESS.  The caller can then either poll for completion
  itself, which requires specific code in the caller which currently
  nothing in the upstream kernel implements, or go to sleep and wait
  for an interrupt signaling completion.  This latter mode is
  supported by current users in the kernel such as zswap via
  synchronous wrappers.  Although it is supported this mode is
  significantly slower than the synchronous mode that does the
  polling in the iaa_crypto driver previously mentioned.

  This mode can be enabled by writing 'async_irq' to the sync_mode
  iaa_crypto driver attribute::

    echo async_irq > /sys/bus/dsa/drivers/crypto/sync_mode

  Async mode without interrupts (caller must poll) can be enabled by
  writing 'async' to it (please see Caveat)::

    echo async > /sys/bus/dsa/drivers/crypto/sync_mode

  The mode that does the polling in the iaa_crypto driver can be
  enabled by writing 'sync' to it::

    echo sync > /sys/bus/dsa/drivers/crypto/sync_mode

  The default mode is 'sync'.

  Caveat: since the only mechanism that iaa_crypto currently implements
  for async polling without interrupts is via the 'sync' mode as
  described earlier, writing 'async' to
  '/sys/bus/dsa/drivers/crypto/sync_mode' will internally enable the
  'sync' mode. This is to ensure correct iaa_crypto behavior until true
  async polling without interrupts is enabled in iaa_crypto.
”h]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hX8  verify_compress

Toggle compression verification.  If set, each compress will be
internally decompressed and the contents verified, returning error
codes if unsuccessful.  This can be toggled with 0/1::

  echo 0 > /sys/bus/dsa/drivers/crypto/verify_compress

The default setting is '1' - verify all compresses.
”h]”(hÞ)”}”(hŒverify_compress”h]”hŒverify_compress”…””}”(hjM  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KêhjI  ubhÞ)”}”(hŒ¹Toggle compression verification.  If set, each compress will be
internally decompressed and the contents verified, returning error
codes if unsuccessful.  This can be toggled with 0/1::”h]”hŒ¸Toggle compression verification.  If set, each compress will be
internally decompressed and the contents verified, returning error
codes if unsuccessful.  This can be toggled with 0/1:”…””}”(hj[  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KìhjI  ubjn  )”}”(hŒ4echo 0 > /sys/bus/dsa/drivers/crypto/verify_compress”h]”hŒ4echo 0 > /sys/bus/dsa/drivers/crypto/verify_compress”…””}”hji  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´KðhjI  ubhÞ)”}”(hŒ3The default setting is '1' - verify all compresses.”h]”hŒ7The default setting is â€˜1â€™ - verify all compresses.”…””}”(hjw  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KòhjI  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjD  ubjH  )”}”(hX  sync_mode

Select mode to be used to wait for completion of each compresses
and decompress operation.

The crypto async interface support implemented by iaa_crypto
provides an implementation that satisfies the interface but does
so in a synchronous manner - it fills and submits the IDXD
descriptor and then loops around waiting for it to complete before
returning.  This isn't a problem at the moment, since all existing
callers (e.g. zswap) wrap any asynchronous callees in a
synchronous wrapper anyway.

The iaa_crypto driver does however provide true asynchronous
support for callers that can make use of it.  In this mode, it
fills and submits the IDXD descriptor, then returns immediately
with -EINPROGRESS.  The caller can then either poll for completion
itself, which requires specific code in the caller which currently
nothing in the upstream kernel implements, or go to sleep and wait
for an interrupt signaling completion.  This latter mode is
supported by current users in the kernel such as zswap via
synchronous wrappers.  Although it is supported this mode is
significantly slower than the synchronous mode that does the
polling in the iaa_crypto driver previously mentioned.

This mode can be enabled by writing 'async_irq' to the sync_mode
iaa_crypto driver attribute::

  echo async_irq > /sys/bus/dsa/drivers/crypto/sync_mode

Async mode without interrupts (caller must poll) can be enabled by
writing 'async' to it (please see Caveat)::

  echo async > /sys/bus/dsa/drivers/crypto/sync_mode

The mode that does the polling in the iaa_crypto driver can be
enabled by writing 'sync' to it::

  echo sync > /sys/bus/dsa/drivers/crypto/sync_mode

The default mode is 'sync'.

Caveat: since the only mechanism that iaa_crypto currently implements
for async polling without interrupts is via the 'sync' mode as
described earlier, writing 'async' to
'/sys/bus/dsa/drivers/crypto/sync_mode' will internally enable the
'sync' mode. This is to ensure correct iaa_crypto behavior until true
async polling without interrupts is enabled in iaa_crypto.
”h]”(hÞ)”}”(hŒ	sync_mode”h]”hŒ	sync_mode”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kôhj‹  ubhÞ)”}”(hŒZSelect mode to be used to wait for completion of each compresses
and decompress operation.”h]”hŒZSelect mode to be used to wait for completion of each compresses
and decompress operation.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Köhj‹  ubhÞ)”}”(hX’  The crypto async interface support implemented by iaa_crypto
provides an implementation that satisfies the interface but does
so in a synchronous manner - it fills and submits the IDXD
descriptor and then loops around waiting for it to complete before
returning.  This isn't a problem at the moment, since all existing
callers (e.g. zswap) wrap any asynchronous callees in a
synchronous wrapper anyway.”h]”hX”  The crypto async interface support implemented by iaa_crypto
provides an implementation that satisfies the interface but does
so in a synchronous manner - it fills and submits the IDXD
descriptor and then loops around waiting for it to complete before
returning.  This isnâ€™t a problem at the moment, since all existing
callers (e.g. zswap) wrap any asynchronous callees in a
synchronous wrapper anyway.”…””}”(hj«  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kùhj‹  ubhÞ)”}”(hX¬  The iaa_crypto driver does however provide true asynchronous
support for callers that can make use of it.  In this mode, it
fills and submits the IDXD descriptor, then returns immediately
with -EINPROGRESS.  The caller can then either poll for completion
itself, which requires specific code in the caller which currently
nothing in the upstream kernel implements, or go to sleep and wait
for an interrupt signaling completion.  This latter mode is
supported by current users in the kernel such as zswap via
synchronous wrappers.  Although it is supported this mode is
significantly slower than the synchronous mode that does the
polling in the iaa_crypto driver previously mentioned.”h]”hX¬  The iaa_crypto driver does however provide true asynchronous
support for callers that can make use of it.  In this mode, it
fills and submits the IDXD descriptor, then returns immediately
with -EINPROGRESS.  The caller can then either poll for completion
itself, which requires specific code in the caller which currently
nothing in the upstream kernel implements, or go to sleep and wait
for an interrupt signaling completion.  This latter mode is
supported by current users in the kernel such as zswap via
synchronous wrappers.  Although it is supported this mode is
significantly slower than the synchronous mode that does the
polling in the iaa_crypto driver previously mentioned.”…””}”(hj¹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubhÞ)”}”(hŒ^This mode can be enabled by writing 'async_irq' to the sync_mode
iaa_crypto driver attribute::”h]”hŒaThis mode can be enabled by writing â€˜async_irqâ€™ to the sync_mode
iaa_crypto driver attribute:”…””}”(hjÇ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubjn  )”}”(hŒ6echo async_irq > /sys/bus/dsa/drivers/crypto/sync_mode”h]”hŒ6echo async_irq > /sys/bus/dsa/drivers/crypto/sync_mode”…””}”hjÕ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mhj‹  ubhÞ)”}”(hŒnAsync mode without interrupts (caller must poll) can be enabled by
writing 'async' to it (please see Caveat)::”h]”hŒqAsync mode without interrupts (caller must poll) can be enabled by
writing â€˜asyncâ€™ to it (please see Caveat):”…””}”(hjã  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubjn  )”}”(hŒ2echo async > /sys/bus/dsa/drivers/crypto/sync_mode”h]”hŒ2echo async > /sys/bus/dsa/drivers/crypto/sync_mode”…””}”hjñ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mhj‹  ubhÞ)”}”(hŒ`The mode that does the polling in the iaa_crypto driver can be
enabled by writing 'sync' to it::”h]”hŒcThe mode that does the polling in the iaa_crypto driver can be
enabled by writing â€˜syncâ€™ to it:”…””}”(hjÿ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubjn  )”}”(hŒ1echo sync > /sys/bus/dsa/drivers/crypto/sync_mode”h]”hŒ1echo sync > /sys/bus/dsa/drivers/crypto/sync_mode”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mhj‹  ubhÞ)”}”(hŒThe default mode is 'sync'.”h]”hŒThe default mode is â€˜syncâ€™.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubhÞ)”}”(hXn  Caveat: since the only mechanism that iaa_crypto currently implements
for async polling without interrupts is via the 'sync' mode as
described earlier, writing 'async' to
'/sys/bus/dsa/drivers/crypto/sync_mode' will internally enable the
'sync' mode. This is to ensure correct iaa_crypto behavior until true
async polling without interrupts is enabled in iaa_crypto.”h]”hX~  Caveat: since the only mechanism that iaa_crypto currently implements
for async polling without interrupts is via the â€˜syncâ€™ mode as
described earlier, writing â€˜asyncâ€™ to
â€˜/sys/bus/dsa/drivers/crypto/sync_modeâ€™ will internally enable the
â€˜syncâ€™ mode. This is to ensure correct iaa_crypto behavior until true
async polling without interrupts is enabled in iaa_crypto.”…””}”(hj)  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj‹  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjD  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jB  h³hÇh´Kêhj>  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´Kêhj  h²hubhŒtarget”“”)”}”(hŒ.. _iaa_default_config:”h]”h}”(h]”h ]”h"]”h$]”h&]”Œrefid”Œiaa-default-config”uh1jK  h´M%hj  h²hh³hÇubeh}”(h]”Œdriver-attributes”ah ]”h"]”Œdriver attributes”ah$]”h&]”uh1hÈhj[  h²hh³hÇh´KÜubhÉ)”}”(hhh]”(hÎ)”}”(hŒIAA Default Configuration”h]”hŒIAA Default Configuration”…””}”(hjd  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhja  h²hh³hÇh´M(ubhÞ)”}”(hŒ€When the iaa_crypto driver is loaded, each IAA device has a single
work queue configured for it, with the following attributes::”h]”hŒWhen the iaa_crypto driver is loaded, each IAA device has a single
work queue configured for it, with the following attributes:”…””}”(hjr  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M*hja  h²hubjn  )”}”(hŒámode              "dedicated"
threshold         0
size              Total WQ Size from WQCAP
priority          10
type              IDXD_WQT_KERNEL
group             0
name              "iaa_crypto"
driver_name       "crypto"”h]”hŒámode              "dedicated"
threshold         0
size              Total WQ Size from WQCAP
priority          10
type              IDXD_WQT_KERNEL
group             0
name              "iaa_crypto"
driver_name       "crypto"”…””}”hj€  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M-hja  h²hubhÞ)”}”(hŒ~The devices and workqueues are also enabled and therefore the driver
is ready to be used without any additional configuration.”h]”hŒ~The devices and workqueues are also enabled and therefore the driver
is ready to be used without any additional configuration.”…””}”(hjŽ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M6hja  h²hubhÞ)”}”(hŒGThe default driver attributes in effect when the driver is loaded are::”h]”hŒFThe default driver attributes in effect when the driver is loaded are:”…””}”(hjœ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M9hja  h²hubjn  )”}”(hŒ,sync_mode         "sync"
verify_compress   1”h]”hŒ,sync_mode         "sync"
verify_compress   1”…””}”hjª  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M;hja  h²hubhÞ)”}”(hX—  In order to change either the device/work queue or driver attributes,
the enabled devices and workqueues must first be disabled.  In order
to have the new configuration applied to the deflate-iaa crypto
algorithm, it needs to be re-registered by removing and reinserting
the iaa_crypto module.  The :ref:`iaa_disable_script` in the 'Use
Cases' section below can be used to disable the default configuration.”h]”(hX+  In order to change either the device/work queue or driver attributes,
the enabled devices and workqueues must first be disabled.  In order
to have the new configuration applied to the deflate-iaa crypto
algorithm, it needs to be re-registered by removing and reinserting
the iaa_crypto module.  The ”…””}”(hj¸  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_disable_script`”h]”j˜  )”}”(hjÂ  h]”hŒiaa_disable_script”…””}”(hjÄ  h²hh³Nh´Nubah}”(h]”h ]”(j£  Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hjÀ  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j°  Œ	refdomain”jÎ  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆj¶  Œiaa_disable_script”uh1hh³hÇh´M>hj¸  ubhŒW in the â€˜Use
Casesâ€™ section below can be used to disable the default configuration.”…””}”(hj¸  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M>hja  h²hubeh}”(h]”(Œiaa-default-configuration”jX  eh ]”h"]”(Œiaa default configuration”Œiaa_default_config”eh$]”h&]”uh1hÈhj[  h²hh³hÇh´M(Œexpect_referenced_by_name”}”jð  jM  sŒexpect_referenced_by_id”}”jX  jM  subeh}”(h]”Œusage”ah ]”h"]”Œusage”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K‚ubhÉ)”}”(hhh]”(hÎ)”}”(hŒ
Statistics”h]”hŒ
Statistics”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjÿ  h²hh³hÇh´MFubhÞ)”}”(hŒ‹If the optional debugfs statistics support is enabled, the IAA crypto
driver will generate statistics which can be accessed in debugfs at::”h]”hŒŠIf the optional debugfs statistics support is enabled, the IAA crypto
driver will generate statistics which can be accessed in debugfs at:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MHhjÿ  h²hubjn  )”}”(hX  # ls -al /sys/kernel/debug/iaa-crypto/
total 0
drwxr-xr-x  2 root root 0 Mar  3 07:55 .
drwx------ 53 root root 0 Mar  3 07:55 ..
-rw-r--r--  1 root root 0 Mar  3 07:55 global_stats
-rw-r--r--  1 root root 0 Mar  3 07:55 stats_reset
-rw-r--r--  1 root root 0 Mar  3 07:55 wq_stats”h]”hX  # ls -al /sys/kernel/debug/iaa-crypto/
total 0
drwxr-xr-x  2 root root 0 Mar  3 07:55 .
drwx------ 53 root root 0 Mar  3 07:55 ..
-rw-r--r--  1 root root 0 Mar  3 07:55 global_stats
-rw-r--r--  1 root root 0 Mar  3 07:55 stats_reset
-rw-r--r--  1 root root 0 Mar  3 07:55 wq_stats”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MKhjÿ  h²hubhÞ)”}”(hŒlThe global_stats file shows a set of global statistics collected since
the driver has been loaded or reset::”h]”hŒkThe global_stats file shows a set of global statistics collected since
the driver has been loaded or reset:”…””}”(hj,  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MShjÿ  h²hubjn  )”}”(hX*  # cat global_stats
global stats:
  total_comp_calls: 4300
  total_decomp_calls: 4164
  total_sw_decomp_calls: 0
  total_comp_bytes_out: 5993989
  total_decomp_bytes_in: 5993989
  total_completion_einval_errors: 0
  total_completion_timeout_errors: 0
  total_completion_comp_buf_overflow_errors: 136”h]”hX*  # cat global_stats
global stats:
  total_comp_calls: 4300
  total_decomp_calls: 4164
  total_sw_decomp_calls: 0
  total_comp_bytes_out: 5993989
  total_decomp_bytes_in: 5993989
  total_completion_einval_errors: 0
  total_completion_timeout_errors: 0
  total_completion_comp_buf_overflow_errors: 136”…””}”hj:  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MVhjÿ  h²hubhÞ)”}”(hŒiThe wq_stats file shows per-wq stats, a set for each iaa device and wq
in addition to some global stats::”h]”hŒhThe wq_stats file shows per-wq stats, a set for each iaa device and wq
in addition to some global stats:”…””}”(hjH  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mahjÿ  h²hubjn  )”}”(hXy  # cat wq_stats
iaa device:
  id: 1
  n_wqs: 1
  comp_calls: 0
  comp_bytes: 0
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 0
    comp_bytes: 0
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 3
  n_wqs: 1
  comp_calls: 0
  comp_bytes: 0
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 0
    comp_bytes: 0
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 5
  n_wqs: 1
  comp_calls: 1360
  comp_bytes: 1999776
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 1360
    comp_bytes: 1999776
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 7
  n_wqs: 1
  comp_calls: 2940
  comp_bytes: 3994213
  decomp_calls: 4164
  decomp_bytes: 5993989
  wqs:
    name: iaa_crypto
    comp_calls: 2940
    comp_bytes: 3994213
    decomp_calls: 4164
    decomp_bytes: 5993989
  ...”h]”hXy  # cat wq_stats
iaa device:
  id: 1
  n_wqs: 1
  comp_calls: 0
  comp_bytes: 0
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 0
    comp_bytes: 0
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 3
  n_wqs: 1
  comp_calls: 0
  comp_bytes: 0
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 0
    comp_bytes: 0
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 5
  n_wqs: 1
  comp_calls: 1360
  comp_bytes: 1999776
  decomp_calls: 0
  decomp_bytes: 0
  wqs:
    name: iaa_crypto
    comp_calls: 1360
    comp_bytes: 1999776
    decomp_calls: 0
    decomp_bytes: 0

iaa device:
  id: 7
  n_wqs: 1
  comp_calls: 2940
  comp_bytes: 3994213
  decomp_calls: 4164
  decomp_bytes: 5993989
  wqs:
    name: iaa_crypto
    comp_calls: 2940
    comp_bytes: 3994213
    decomp_calls: 4164
    decomp_bytes: 5993989
  ...”…””}”hjV  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mdhjÿ  h²hubhÞ)”}”(hŒZWriting to 'stats_reset' resets all the stats, including the
per-device and per-wq stats::”h]”hŒ]Writing to â€˜stats_resetâ€™ resets all the stats, including the
per-device and per-wq stats:”…””}”(hjd  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mžhjÿ  h²hubjn  )”}”(hX  # echo 1 > stats_reset
# cat wq_stats
  global stats:
  total_comp_calls: 0
  total_decomp_calls: 0
  total_comp_bytes_out: 0
  total_decomp_bytes_in: 0
  total_completion_einval_errors: 0
  total_completion_timeout_errors: 0
  total_completion_comp_buf_overflow_errors: 0
  ...”h]”hX  # echo 1 > stats_reset
# cat wq_stats
  global stats:
  total_comp_calls: 0
  total_decomp_calls: 0
  total_comp_bytes_out: 0
  total_decomp_bytes_in: 0
  total_completion_einval_errors: 0
  total_completion_timeout_errors: 0
  total_completion_comp_buf_overflow_errors: 0
  ...”…””}”hjr  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M¡hjÿ  h²hubeh}”(h]”Œ
statistics”ah ]”h"]”Œ
statistics”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´MFubhÉ)”}”(hhh]”(hÎ)”}”(hŒ	Use cases”h]”hŒ	Use cases”…””}”(hj‹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjˆ  h²hh³hÇh´M¯ubhÉ)”}”(hhh]”(hÎ)”}”(hŒSimple zswap test”h]”hŒSimple zswap test”…””}”(hjœ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj™  h²hh³hÇh´M²ubhÞ)”}”(hŒFor this example, the kernel should be configured according to the
dedicated mode options described above, and zswap should be enabled as
well::”h]”hŒFor this example, the kernel should be configured according to the
dedicated mode options described above, and zswap should be enabled as
well:”…””}”(hjª  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M´hj™  h²hubjn  )”}”(hŒCONFIG_ZSWAP=y”h]”hŒCONFIG_ZSWAP=y”…””}”hj¸  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M¸hj™  h²hubhÞ)”}”(hX  This is a simple test that uses iaa_compress as the compressor for a
swap (zswap) device.  It sets up the zswap device and then uses the
memory_memadvise program listed below to forcibly swap out and in a
specified number of pages, demonstrating both compress and decompress.”h]”hX  This is a simple test that uses iaa_compress as the compressor for a
swap (zswap) device.  It sets up the zswap device and then uses the
memory_memadvise program listed below to forcibly swap out and in a
specified number of pages, demonstrating both compress and decompress.”…””}”(hjÆ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mºhj™  h²hubhÞ)”}”(hŒ¢The zswap test expects the work queues for each IAA device on the
system to be configured properly as a kernel workqueue with a
workqueue driver_name of "crypto".”h]”hŒ¦The zswap test expects the work queues for each IAA device on the
system to be configured properly as a kernel workqueue with a
workqueue driver_name of â€œcryptoâ€.”…””}”(hjÔ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M¿hj™  h²hubhÞ)”}”(hŒ@The first step is to make sure the iaa_crypto module is loaded::”h]”hŒ?The first step is to make sure the iaa_crypto module is loaded:”…””}”(hjâ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÃhj™  h²hubjn  )”}”(hŒmodprobe iaa_crypto”h]”hŒmodprobe iaa_crypto”…””}”hjð  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MÅhj™  h²hubhÞ)”}”(hX  If the IAA devices and workqueues haven't previously been disabled and
reconfigured, then the default configuration should be in place and no
further IAA configuration is necessary.  See :ref:`iaa_default_config`
below for details of the default configuration.”h]”(hŒ½If the IAA devices and workqueues havenâ€™t previously been disabled and
reconfigured, then the default configuration should be in place and no
further IAA configuration is necessary.  See ”…””}”(hjþ  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_default_config`”h]”j˜  )”}”(hj  h]”hŒiaa_default_config”…””}”(hj
  h²hh³Nh´Nubah}”(h]”h ]”(j£  Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hj  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j°  Œ	refdomain”j  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆj¶  Œiaa_default_config”uh1hh³hÇh´MÇhjþ  ubhŒ0
below for details of the default configuration.”…””}”(hjþ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÇhj™  h²hubhÞ)”}”(hŒ[If the default configuration is in place, you should see the iaa
devices and wq0s enabled::”h]”hŒZIf the default configuration is in place, you should see the iaa
devices and wq0s enabled:”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÌhj™  h²hubjn  )”}”(hŒa# cat /sys/bus/dsa/devices/iax1/state
enabled
# cat /sys/bus/dsa/devices/iax1/wq1.0/state
enabled”h]”hŒa# cat /sys/bus/dsa/devices/iax1/state
enabled
# cat /sys/bus/dsa/devices/iax1/wq1.0/state
enabled”…””}”hj>  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MÏhj™  h²hubhÞ)”}”(hŒmTo demonstrate that the following steps work as expected, these
commands can be used to enable debug output::”h]”hŒlTo demonstrate that the following steps work as expected, these
commands can be used to enable debug output:”…””}”(hjL  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÔhj™  h²hubjn  )”}”(hŒ# echo -n 'module iaa_crypto +p' > /sys/kernel/debug/dynamic_debug/control
# echo -n 'module idxd +p' > /sys/kernel/debug/dynamic_debug/control”h]”hŒ# echo -n 'module iaa_crypto +p' > /sys/kernel/debug/dynamic_debug/control
# echo -n 'module idxd +p' > /sys/kernel/debug/dynamic_debug/control”…””}”hjZ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M×hj™  h²hubhÞ)”}”(hŒ,Use the following commands to enable zswap::”h]”hŒ+Use the following commands to enable zswap:”…””}”(hjh  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÚhj™  h²hubjn  )”}”(hX`  # echo 0 > /sys/module/zswap/parameters/enabled
# echo 50 > /sys/module/zswap/parameters/max_pool_percent
# echo deflate-iaa > /sys/module/zswap/parameters/compressor
# echo 1 > /sys/module/zswap/parameters/enabled
# echo 100 > /proc/sys/vm/swappiness
# echo never > /sys/kernel/mm/transparent_hugepage/enabled
# echo 1 > /proc/sys/vm/overcommit_memory”h]”hX`  # echo 0 > /sys/module/zswap/parameters/enabled
# echo 50 > /sys/module/zswap/parameters/max_pool_percent
# echo deflate-iaa > /sys/module/zswap/parameters/compressor
# echo 1 > /sys/module/zswap/parameters/enabled
# echo 100 > /proc/sys/vm/swappiness
# echo never > /sys/kernel/mm/transparent_hugepage/enabled
# echo 1 > /proc/sys/vm/overcommit_memory”…””}”hjv  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MÜhj™  h²hubhÞ)”}”(hŒ¦Now you can now run the zswap workload you want to measure. For
example, using the memory_memadvise code below, the following command
will swap in and out 100 pages::”h]”hŒ¥Now you can now run the zswap workload you want to measure. For
example, using the memory_memadvise code below, the following command
will swap in and out 100 pages:”…””}”(hj„  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mähj™  h²hubjn  )”}”(hŒƒ./memory_madvise 100

Allocating 100 pages to swap in/out
Swapping out 100 pages
Swapping in 100 pages
Swapped out and in 100 pages”h]”hŒƒ./memory_madvise 100

Allocating 100 pages to swap in/out
Swapping out 100 pages
Swapping in 100 pages
Swapped out and in 100 pages”…””}”hj’  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mèhj™  h²hubhÞ)”}”(hŒAYou should see something like the following in the dmesg output::”h]”hŒ@You should see something like the following in the dmesg output:”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mïhj™  h²hubjn  )”}”(hXÔ  [  404.202972] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, src_addr 223925c000, nr_sgs 1, req->src 00000000ee7cb5e6, req->slen 4096, sg_dma_len(sg) 4096
[  404.202973] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, dst_addr 21dadf8000, nr_sgs 1, req->dst 000000008d6acea8, req->dlen 4096, sg_dma_len(sg) 8192
[  404.202975] idxd 0000:e7:02.0: iaa_compress: desc->src1_addr 223925c000, desc->src1_size 4096, desc->dst_addr 21dadf8000, desc->max_dst_size 4096, desc->src2_addr 2203543000, desc->src2_size 1568
[  404.202981] idxd 0000:e7:02.0: iaa_compress_verify: (verify) desc->src1_addr 21dadf8000, desc->src1_size 228, desc->dst_addr 223925c000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
...”h]”hXÔ  [  404.202972] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, src_addr 223925c000, nr_sgs 1, req->src 00000000ee7cb5e6, req->slen 4096, sg_dma_len(sg) 4096
[  404.202973] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, dst_addr 21dadf8000, nr_sgs 1, req->dst 000000008d6acea8, req->dlen 4096, sg_dma_len(sg) 8192
[  404.202975] idxd 0000:e7:02.0: iaa_compress: desc->src1_addr 223925c000, desc->src1_size 4096, desc->dst_addr 21dadf8000, desc->max_dst_size 4096, desc->src2_addr 2203543000, desc->src2_size 1568
[  404.202981] idxd 0000:e7:02.0: iaa_compress_verify: (verify) desc->src1_addr 21dadf8000, desc->src1_size 228, desc->dst_addr 223925c000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
...”…””}”hj®  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mñhj™  h²hubhÞ)”}”(hŒžNow that basic functionality has been demonstrated, the defaults can
be erased and replaced with a different configuration.  To do that,
first disable zswap::”h]”hŒNow that basic functionality has been demonstrated, the defaults can
be erased and replaced with a different configuration.  To do that,
first disable zswap:”…””}”(hj¼  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M÷hj™  h²hubjn  )”}”(hX  # echo lzo > /sys/module/zswap/parameters/compressor
# swapoff -a
# echo 0 > /sys/module/zswap/parameters/accept_threshold_percent
# echo 0 > /sys/module/zswap/parameters/max_pool_percent
# echo 0 > /sys/module/zswap/parameters/enabled
# echo 0 > /sys/module/zswap/parameters/enabled”h]”hX  # echo lzo > /sys/module/zswap/parameters/compressor
# swapoff -a
# echo 0 > /sys/module/zswap/parameters/accept_threshold_percent
# echo 0 > /sys/module/zswap/parameters/max_pool_percent
# echo 0 > /sys/module/zswap/parameters/enabled
# echo 0 > /sys/module/zswap/parameters/enabled”…””}”hjÊ  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mûhj™  h²hubhÞ)”}”(hŒmThen run the :ref:`iaa_disable_script` in the 'Use Cases' section
below to disable the default configuration.”h]”(hŒThen run the ”…””}”(hjØ  h²hh³Nh´Nubh)”}”(hŒ:ref:`iaa_disable_script`”h]”j˜  )”}”(hjâ  h]”hŒiaa_disable_script”…””}”(hjä  h²hh³Nh´Nubah}”(h]”h ]”(j£  Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j—  hjà  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j°  Œ	refdomain”jî  Œreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆj¶  Œiaa_disable_script”uh1hh³hÇh´MhjØ  ubhŒK in the â€˜Use Casesâ€™ section
below to disable the default configuration.”…””}”(hjØ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj™  h²hubhÞ)”}”(hŒFinally turn swap back on::”h]”hŒFinally turn swap back on:”…””}”(hj
	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj™  h²hubjn  )”}”(hŒ# swapon -a”h]”hŒ# swapon -a”…””}”hj	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mhj™  h²hubhÞ)”}”(hŒ€Following all that the IAA device(s) can now be re-configured and
enabled as desired for further testing.  Below is one example.”h]”hŒ€Following all that the IAA device(s) can now be re-configured and
enabled as desired for further testing.  Below is one example.”…””}”(hj&	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M	hj™  h²hubhÞ)”}”(hŒ¢The zswap test expects the work queues for each IAA device on the
system to be configured properly as a kernel workqueue with a
workqueue driver_name of "crypto".”h]”hŒ¦The zswap test expects the work queues for each IAA device on the
system to be configured properly as a kernel workqueue with a
workqueue driver_name of â€œcryptoâ€.”…””}”(hj4	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj™  h²hubhÞ)”}”(hŒ*The below script automatically does that::”h]”hŒ)The below script automatically does that:”…””}”(hjB	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mhj™  h²hubjn  )”}”(hXÕ  #!/bin/bash

echo "IAA devices:"
lspci -d:0cfe
echo "# IAA devices:"
lspci -d:0cfe | wc -l

#
# count iaa instances
#
iaa_dev_id="0cfe"
num_iaa=$(lspci -d:${iaa_dev_id} | wc -l)
echo "Found ${num_iaa} IAA instances"

#
# disable iaa wqs and devices
#
echo "Disable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo disable wq iax${i}/wq${i}.0
    accel-config disable-wq iax${i}/wq${i}.0
    echo disable iaa iax${i}
    accel-config disable-device iax${i}
done

echo "End Disable IAA"

echo "Reload iaa_crypto module"

rmmod iaa_crypto
modprobe iaa_crypto

echo "End Reload iaa_crypto module"

#
# configure iaa wqs and devices
#
echo "Configure IAA"
for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    accel-config config-wq --group-id=0 --mode=dedicated --wq-size=128 --priority=10 --type=kernel --name="iaa_crypto" --driver-name="crypto" iax${i}/wq${i}.0
    accel-config config-engine iax${i}/engine${i}.0 --group-id=0
done

echo "End Configure IAA"

#
# enable iaa wqs and devices
#
echo "Enable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo enable iaa iax${i}
    accel-config enable-device iax${i}
    echo enable wq iax${i}/wq${i}.0
    accel-config enable-wq iax${i}/wq${i}.0
done

echo "End Enable IAA"”h]”hXÕ  #!/bin/bash

echo "IAA devices:"
lspci -d:0cfe
echo "# IAA devices:"
lspci -d:0cfe | wc -l

#
# count iaa instances
#
iaa_dev_id="0cfe"
num_iaa=$(lspci -d:${iaa_dev_id} | wc -l)
echo "Found ${num_iaa} IAA instances"

#
# disable iaa wqs and devices
#
echo "Disable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo disable wq iax${i}/wq${i}.0
    accel-config disable-wq iax${i}/wq${i}.0
    echo disable iaa iax${i}
    accel-config disable-device iax${i}
done

echo "End Disable IAA"

echo "Reload iaa_crypto module"

rmmod iaa_crypto
modprobe iaa_crypto

echo "End Reload iaa_crypto module"

#
# configure iaa wqs and devices
#
echo "Configure IAA"
for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    accel-config config-wq --group-id=0 --mode=dedicated --wq-size=128 --priority=10 --type=kernel --name="iaa_crypto" --driver-name="crypto" iax${i}/wq${i}.0
    accel-config config-engine iax${i}/engine${i}.0 --group-id=0
done

echo "End Configure IAA"

#
# enable iaa wqs and devices
#
echo "Enable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo enable iaa iax${i}
    accel-config enable-device iax${i}
    echo enable wq iax${i}/wq${i}.0
    accel-config enable-wq iax${i}/wq${i}.0
done

echo "End Enable IAA"”…””}”hjP	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mhj™  h²hubhÞ)”}”(hŒåWhen the workqueues are bound to the iaa_crypto driver, you should
see something similar to the following in dmesg output if you've
enabled debug output (echo -n 'module iaa_crypto +p' >
/sys/kernel/debug/dynamic_debug/control)::”h]”hŒêWhen the workqueues are bound to the iaa_crypto driver, you should
see something similar to the following in dmesg output if youâ€™ve
enabled debug output (echo -n â€˜module iaa_crypto +pâ€™ >
/sys/kernel/debug/dynamic_debug/control):”…””}”(hj^	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MNhj™  h²hubjn  )”}”(hXr  [   60.752344] idxd 0000:f6:02.0: add_iaa_wq: added wq 000000004068d14d to iaa 00000000c9585ba2, n_wq 1
[   60.752346] iaa_crypto: rebalance_wq_table: nr_nodes=2, nr_cpus 160, nr_iaa 8, cpus_per_iaa 20
[   60.752347] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752349] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752350] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752352] iaa_crypto: rebalance_wq_table: assigned wq for cpu=0, node=0 = wq 00000000c8bb4452
[   60.752354] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752355] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752356] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752358] iaa_crypto: rebalance_wq_table: assigned wq for cpu=1, node=0 = wq 00000000c8bb4452
[   60.752359] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752360] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752361] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752362] iaa_crypto: rebalance_wq_table: assigned wq for cpu=2, node=0 = wq 00000000c8bb4452
[   60.752364] iaa_crypto: rebalance_wq_table: iaa=0
.
.
.”h]”hXr  [   60.752344] idxd 0000:f6:02.0: add_iaa_wq: added wq 000000004068d14d to iaa 00000000c9585ba2, n_wq 1
[   60.752346] iaa_crypto: rebalance_wq_table: nr_nodes=2, nr_cpus 160, nr_iaa 8, cpus_per_iaa 20
[   60.752347] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752349] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752350] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752352] iaa_crypto: rebalance_wq_table: assigned wq for cpu=0, node=0 = wq 00000000c8bb4452
[   60.752354] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752355] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752356] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752358] iaa_crypto: rebalance_wq_table: assigned wq for cpu=1, node=0 = wq 00000000c8bb4452
[   60.752359] iaa_crypto: rebalance_wq_table: iaa=0
[   60.752360] idxd 0000:6a:02.0: request_iaa_wq: getting wq from iaa_device 0000000042d7bc52 (0)
[   60.752361] idxd 0000:6a:02.0: request_iaa_wq: returning unused wq 00000000c8bb4452 (0) from iaa device 0000000042d7bc52 (0)
[   60.752362] iaa_crypto: rebalance_wq_table: assigned wq for cpu=2, node=0 = wq 00000000c8bb4452
[   60.752364] iaa_crypto: rebalance_wq_table: iaa=0
.
.
.”…””}”hjl	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MShj™  h²hubhÞ)”}”(hŒÓOnce the workqueues and devices have been enabled, the IAA crypto
algorithms are enabled and available.  When the IAA crypto algorithms
have been successfully enabled, you should see the following dmesg
output::”h]”hŒÒOnce the workqueues and devices have been enabled, the IAA crypto
algorithms are enabled and available.  When the IAA crypto algorithms
have been successfully enabled, you should see the following dmesg
output:”…””}”(hjz	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mfhj™  h²hubjn  )”}”(hŒD[   64.893759] iaa_crypto: iaa_crypto_enable: iaa_crypto now ENABLED”h]”hŒD[   64.893759] iaa_crypto: iaa_crypto_enable: iaa_crypto now ENABLED”…””}”hjˆ	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mkhj™  h²hubhÞ)”}”(hŒdNow run the following zswap-specific setup commands to have zswap use
the 'fixed' compression mode::”h]”hŒgNow run the following zswap-specific setup commands to have zswap use
the â€˜fixedâ€™ compression mode:”…””}”(hj–	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mmhj™  h²hubjn  )”}”(hXS  echo 0 > /sys/module/zswap/parameters/enabled
echo 50 > /sys/module/zswap/parameters/max_pool_percent
echo deflate-iaa > /sys/module/zswap/parameters/compressor
echo 1 > /sys/module/zswap/parameters/enabled

echo 100 > /proc/sys/vm/swappiness
echo never > /sys/kernel/mm/transparent_hugepage/enabled
echo 1 > /proc/sys/vm/overcommit_memory”h]”hXS  echo 0 > /sys/module/zswap/parameters/enabled
echo 50 > /sys/module/zswap/parameters/max_pool_percent
echo deflate-iaa > /sys/module/zswap/parameters/compressor
echo 1 > /sys/module/zswap/parameters/enabled

echo 100 > /proc/sys/vm/swappiness
echo never > /sys/kernel/mm/transparent_hugepage/enabled
echo 1 > /proc/sys/vm/overcommit_memory”…””}”hj¤	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mphj™  h²hubhÞ)”}”(hŒšFinally, you can now run the zswap workload you want to measure. For
example, using the code below, the following command will swap in and
out 100 pages::”h]”hŒ™Finally, you can now run the zswap workload you want to measure. For
example, using the code below, the following command will swap in and
out 100 pages:”…””}”(hj²	  h²hh³Nh´Nubah}”(h]”h ]”•Ye      h"]”h$]”h&]”uh1hÝh³hÇh´Myhj™  h²hubjn  )”}”(hŒƒ./memory_madvise 100

Allocating 100 pages to swap in/out
Swapping out 100 pages
Swapping in 100 pages
Swapped out and in 100 pages”h]”hŒƒ./memory_madvise 100

Allocating 100 pages to swap in/out
Swapping out 100 pages
Swapping in 100 pages
Swapped out and in 100 pages”…””}”hjÀ	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M}hj™  h²hubhÞ)”}”(hŒ«You should see something like the following in the dmesg output if
you've enabled debug output (echo -n 'module iaa_crypto +p' >
/sys/kernel/debug/dynamic_debug/control)::”h]”hŒ°You should see something like the following in the dmesg output if
youâ€™ve enabled debug output (echo -n â€˜module iaa_crypto +pâ€™ >
/sys/kernel/debug/dynamic_debug/control):”…””}”(hjÎ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M„hj™  h²hubjn  )”}”(hXÌ  [  404.202972] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, src_addr 223925c000, nr_sgs 1, req->src 00000000ee7cb5e6, req->slen 4096, sg_dma_len(sg) 4096
[  404.202973] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, dst_addr 21dadf8000, nr_sgs 1, req->dst 000000008d6acea8, req->dlen 4096, sg_dma_len(sg) 8192
[  404.202975] idxd 0000:e7:02.0: iaa_compress: desc->src1_addr 223925c000, desc->src1_size 4096, desc->dst_addr 21dadf8000, desc->max_dst_size 4096, desc->src2_addr 2203543000, desc->src2_size 1568
[  404.202981] idxd 0000:e7:02.0: iaa_compress_verify: (verify) desc->src1_addr 21dadf8000, desc->src1_size 228, desc->dst_addr 223925c000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
[  409.203227] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, src_addr 21ddd8b100, nr_sgs 1, req->src 0000000084adab64, req->slen 228, sg_dma_len(sg) 228
[  409.203235] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, dst_addr 21ee3dc000, nr_sgs 1, req->dst 000000004e2990d0, req->dlen 4096, sg_dma_len(sg) 4096
[  409.203239] idxd 0000:e7:02.0: iaa_decompress: desc->src1_addr 21ddd8b100, desc->src1_size 228, desc->dst_addr 21ee3dc000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
[  409.203254] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, src_addr 21ddd8b100, nr_sgs 1, req->src 0000000084adab64, req->slen 228, sg_dma_len(sg) 228
[  409.203256] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, dst_addr 21f1551000, nr_sgs 1, req->dst 000000004e2990d0, req->dlen 4096, sg_dma_len(sg) 4096
[  409.203257] idxd 0000:e7:02.0: iaa_decompress: desc->src1_addr 21ddd8b100, desc->src1_size 228, desc->dst_addr 21f1551000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0”h]”hXÌ  [  404.202972] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, src_addr 223925c000, nr_sgs 1, req->src 00000000ee7cb5e6, req->slen 4096, sg_dma_len(sg) 4096
[  404.202973] idxd 0000:e7:02.0: iaa_comp_acompress: dma_map_sg, dst_addr 21dadf8000, nr_sgs 1, req->dst 000000008d6acea8, req->dlen 4096, sg_dma_len(sg) 8192
[  404.202975] idxd 0000:e7:02.0: iaa_compress: desc->src1_addr 223925c000, desc->src1_size 4096, desc->dst_addr 21dadf8000, desc->max_dst_size 4096, desc->src2_addr 2203543000, desc->src2_size 1568
[  404.202981] idxd 0000:e7:02.0: iaa_compress_verify: (verify) desc->src1_addr 21dadf8000, desc->src1_size 228, desc->dst_addr 223925c000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
[  409.203227] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, src_addr 21ddd8b100, nr_sgs 1, req->src 0000000084adab64, req->slen 228, sg_dma_len(sg) 228
[  409.203235] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, dst_addr 21ee3dc000, nr_sgs 1, req->dst 000000004e2990d0, req->dlen 4096, sg_dma_len(sg) 4096
[  409.203239] idxd 0000:e7:02.0: iaa_decompress: desc->src1_addr 21ddd8b100, desc->src1_size 228, desc->dst_addr 21ee3dc000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0
[  409.203254] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, src_addr 21ddd8b100, nr_sgs 1, req->src 0000000084adab64, req->slen 228, sg_dma_len(sg) 228
[  409.203256] idxd 0000:e7:02.0: iaa_comp_adecompress: dma_map_sg, dst_addr 21f1551000, nr_sgs 1, req->dst 000000004e2990d0, req->dlen 4096, sg_dma_len(sg) 4096
[  409.203257] idxd 0000:e7:02.0: iaa_decompress: desc->src1_addr 21ddd8b100, desc->src1_size 228, desc->dst_addr 21f1551000, desc->max_dst_size 4096, desc->src2_addr 0, desc->src2_size 0”…””}”hjÜ	  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´Mˆhj™  h²hubhÞ)”}”(hŒÅIn order to unregister the IAA crypto algorithms, and register new
ones using different parameters, any users of the current algorithm
should be stopped and the IAA workqueues and devices disabled.”h]”hŒÅIn order to unregister the IAA crypto algorithms, and register new
ones using different parameters, any users of the current algorithm
should be stopped and the IAA workqueues and devices disabled.”…””}”(hjê	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M“hj™  h²hubhÞ)”}”(hŒ„In the case of zswap, remove the IAA crypto algorithm as the
compressor and turn off swap (to remove all references to
iaa_crypto)::”h]”hŒƒIn the case of zswap, remove the IAA crypto algorithm as the
compressor and turn off swap (to remove all references to
iaa_crypto):”…””}”(hjø	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M—hj™  h²hubjn  )”}”(hŒâecho lzo > /sys/module/zswap/parameters/compressor
swapoff -a

echo 0 > /sys/module/zswap/parameters/accept_threshold_percent
echo 0 > /sys/module/zswap/parameters/max_pool_percent
echo 0 > /sys/module/zswap/parameters/enabled”h]”hŒâecho lzo > /sys/module/zswap/parameters/compressor
swapoff -a

echo 0 > /sys/module/zswap/parameters/accept_threshold_percent
echo 0 > /sys/module/zswap/parameters/max_pool_percent
echo 0 > /sys/module/zswap/parameters/enabled”…””}”hj
  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M›hj™  h²hubhÞ)”}”(hŒ_Once zswap is disabled and no longer using iaa_crypto, the IAA wqs and
devices can be disabled.”h]”hŒ_Once zswap is disabled and no longer using iaa_crypto, the IAA wqs and
devices can be disabled.”…””}”(hj
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M¢hj™  h²hubjL  )”}”(hŒ.. _iaa_disable_script:”h]”h}”(h]”h ]”h"]”h$]”h&]”jW  Œiaa-disable-script”uh1jK  h´M¥hj™  h²hh³hÇubeh}”(h]”Œsimple-zswap-test”ah ]”h"]”Œsimple zswap test”ah$]”h&]”uh1hÈhjˆ  h²hh³hÇh´M²ubhÉ)”}”(hhh]”(hÎ)”}”(hŒIAA disable script”h]”hŒIAA disable script”…””}”(hj8
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj5
  h²hh³hÇh´M¨ubhÞ)”}”(hŒ*The below script automatically does that::”h]”hŒ)The below script automatically does that:”…””}”(hjF
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Mªhj5
  h²hubjn  )”}”(hXð  #!/bin/bash

echo "IAA devices:"
lspci -d:0cfe
echo "# IAA devices:"
lspci -d:0cfe | wc -l

#
# count iaa instances
#
iaa_dev_id="0cfe"
num_iaa=$(lspci -d:${iaa_dev_id} | wc -l)
echo "Found ${num_iaa} IAA instances"

#
# disable iaa wqs and devices
#
echo "Disable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo disable wq iax${i}/wq${i}.0
    accel-config disable-wq iax${i}/wq${i}.0
    echo disable iaa iax${i}
    accel-config disable-device iax${i}
done

echo "End Disable IAA"”h]”hXð  #!/bin/bash

echo "IAA devices:"
lspci -d:0cfe
echo "# IAA devices:"
lspci -d:0cfe | wc -l

#
# count iaa instances
#
iaa_dev_id="0cfe"
num_iaa=$(lspci -d:${iaa_dev_id} | wc -l)
echo "Found ${num_iaa} IAA instances"

#
# disable iaa wqs and devices
#
echo "Disable IAA"

for ((i = 1; i < ${num_iaa} * 2; i += 2)); do
    echo disable wq iax${i}/wq${i}.0
    accel-config disable-wq iax${i}/wq${i}.0
    echo disable iaa iax${i}
    accel-config disable-device iax${i}
done

echo "End Disable IAA"”…””}”hjT
  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M¬hj5
  h²hubhÞ)”}”(hŒvFinally, at this point the iaa_crypto module can be removed, which
will unregister the current IAA crypto algorithms::”h]”hŒuFinally, at this point the iaa_crypto module can be removed, which
will unregister the current IAA crypto algorithms:”…””}”(hjb
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÈhj5
  h²hubjn  )”}”(hŒrmmod iaa_crypto”h]”hŒrmmod iaa_crypto”…””}”hjp
  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MËhj5
  h²hubhÞ)”}”(hŒ=memory_madvise.c (gcc -o memory_memadvise memory_madvise.c)::”h]”hŒ<memory_madvise.c (gcc -o memory_memadvise memory_madvise.c):”…””}”(hj~
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MÎhj5
  h²hubjn  )”}”(hXâ  #include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/mman.h>
#include <linux/mman.h>

#ifndef MADV_PAGEOUT
#define MADV_PAGEOUT    21      /* force pages out immediately */
#endif

#define PG_SZ           4096

int main(int argc, char **argv)
{
      int i, nr_pages = 1;
      int64_t *dump_ptr;
      char *addr, *a;
      int loop = 1;

      if (argc > 1)
              nr_pages = atoi(argv[1]);

      printf("Allocating %d pages to swap in/out\n", nr_pages);

      /* allocate pages */
      addr = mmap(NULL, nr_pages * PG_SZ, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_ANONYMOUS, -1, 0);
      *addr = 1;

      /* initialize data in page to all '*' chars */
      memset(addr, '*', nr_pages * PG_SZ);

       printf("Swapping out %d pages\n", nr_pages);

      /* Tell kernel to swap it out */
      madvise(addr, nr_pages * PG_SZ, MADV_PAGEOUT);

      while (loop > 0) {
              /* Wait for swap out to finish */
              sleep(5);

              a = addr;

              printf("Swapping in %d pages\n", nr_pages);

              /* Access the page ... this will swap it back in again */
              for (i = 0; i < nr_pages; i++) {
                      if (a[0] != '*') {
                              printf("Bad data from decompress!!!!!\n");

                              dump_ptr = (int64_t *)a;
                               for (int j = 0; j < 100; j++) {
                                      printf("  page %d data: %#llx\n", i, *dump_ptr);
                                      dump_ptr++;
                              }
                      }

                      a += PG_SZ;
              }

              loop --;
      }

     printf("Swapped out and in %d pages\n", nr_pages);”h]”hXâ  #include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/mman.h>
#include <linux/mman.h>

#ifndef MADV_PAGEOUT
#define MADV_PAGEOUT    21      /* force pages out immediately */
#endif

#define PG_SZ           4096

int main(int argc, char **argv)
{
      int i, nr_pages = 1;
      int64_t *dump_ptr;
      char *addr, *a;
      int loop = 1;

      if (argc > 1)
              nr_pages = atoi(argv[1]);

      printf("Allocating %d pages to swap in/out\n", nr_pages);

      /* allocate pages */
      addr = mmap(NULL, nr_pages * PG_SZ, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_ANONYMOUS, -1, 0);
      *addr = 1;

      /* initialize data in page to all '*' chars */
      memset(addr, '*', nr_pages * PG_SZ);

       printf("Swapping out %d pages\n", nr_pages);

      /* Tell kernel to swap it out */
      madvise(addr, nr_pages * PG_SZ, MADV_PAGEOUT);

      while (loop > 0) {
              /* Wait for swap out to finish */
              sleep(5);

              a = addr;

              printf("Swapping in %d pages\n", nr_pages);

              /* Access the page ... this will swap it back in again */
              for (i = 0; i < nr_pages; i++) {
                      if (a[0] != '*') {
                              printf("Bad data from decompress!!!!!\n");

                              dump_ptr = (int64_t *)a;
                               for (int j = 0; j < 100; j++) {
                                      printf("  page %d data: %#llx\n", i, *dump_ptr);
                                      dump_ptr++;
                              }
                      }

                      a += PG_SZ;
              }

              loop --;
      }

     printf("Swapped out and in %d pages\n", nr_pages);”…””}”hjŒ
  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MÐhj5
  h²hubeh}”(h]”(j,
  Œid1”eh ]”h"]”(Œiaa disable script”Œiaa_disable_script”eh$]”h&]”uh1hÈhjˆ  h²hh³hÇh´M¨jó  }”j 
  j"
  sjõ  }”j,
  j"
  subeh}”(h]”Œ	use-cases”ah ]”h"]”Œ	use cases”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´M¯ubhÉ)”}”(hhh]”(hÎ)”}”(hŒAppendix”h]”hŒAppendix”…””}”(hj°
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj­
  h²hh³hÇh´MubjL  )”}”(hŒ.. _iaa_sysfs_config:”h]”h}”(h]”h ]”h"]”h$]”h&]”jW  Œiaa-sysfs-config”uh1jK  h´Mhj­
  h²hh³hÇubhÉ)”}”(hhh]”(hÎ)”}”(hŒIAA sysfs config interface”h]”hŒIAA sysfs config interface”…””}”(hjÌ
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjÉ
  h²hh³hÇh´MubhÞ)”}”(hXJ  Below is a description of the IAA sysfs interface, which as mentioned
in the main document, should only be used if you know exactly what you
are doing.  Even then, there's no compelling reason to use it directly
since accel-config can do everything the sysfs interface can and in
fact accel-config is based on it under the covers.”h]”hXL  Below is a description of the IAA sysfs interface, which as mentioned
in the main document, should only be used if you know exactly what you
are doing.  Even then, thereâ€™s no compelling reason to use it directly
since accel-config can do everything the sysfs interface can and in
fact accel-config is based on it under the covers.”…””}”(hjÚ
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MhjÉ
  h²hubhÞ)”}”(hXg  The 'IAA config path' is /sys/bus/dsa/devices and contains
subdirectories representing each IAA device, workqueue, engine, and
group.  Note that in the sysfs interface, the IAA devices are actually
named using iax e.g. iax1, iax3, etc. (Note that IAA devices are the
odd-numbered devices; the even-numbered devices are DSA devices and
can be ignored for IAA).”h]”hXk  The â€˜IAA config pathâ€™ is /sys/bus/dsa/devices and contains
subdirectories representing each IAA device, workqueue, engine, and
group.  Note that in the sysfs interface, the IAA devices are actually
named using iax e.g. iax1, iax3, etc. (Note that IAA devices are the
odd-numbered devices; the even-numbered devices are DSA devices and
can be ignored for IAA).”…””}”(hjè
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MhjÉ
  h²hubhÞ)”}”(hŒuThe 'IAA device bind path' is /sys/bus/dsa/drivers/idxd/bind and is
the file that is written to enable an IAA device.”h]”hŒyThe â€˜IAA device bind pathâ€™ is /sys/bus/dsa/drivers/idxd/bind and is
the file that is written to enable an IAA device.”…””}”(hjö
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M&hjÉ
  h²hubhÞ)”}”(hŒ}The 'IAA workqueue bind path' is /sys/bus/dsa/drivers/crypto/bind and
is the file that is written to enable an IAA workqueue.”h]”hŒThe â€˜IAA workqueue bind pathâ€™ is /sys/bus/dsa/drivers/crypto/bind and
is the file that is written to enable an IAA workqueue.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M)hjÉ
  h²hubhÞ)”}”(hŒSimilarly /sys/bus/dsa/drivers/idxd/unbind and
/sys/bus/dsa/drivers/crypto/unbind are used to disable IAA devices and
workqueues.”h]”hŒSimilarly /sys/bus/dsa/drivers/idxd/unbind and
/sys/bus/dsa/drivers/crypto/unbind are used to disable IAA devices and
workqueues.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M,hjÉ
  h²hubhÞ)”}”(hŒRThe basic sequence of commands needed to set up the IAA devices and
workqueues is:”h]”hŒRThe basic sequence of commands needed to set up the IAA devices and
workqueues is:”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M0hjÉ
  h²hubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hX³  For each device::
1) Disable any workqueues enabled on the device.  For example to
   disable workques 0 and 1 on IAA device 3::

     # echo wq3.0 > /sys/bus/dsa/drivers/crypto/unbind
     # echo wq3.1 > /sys/bus/dsa/drivers/crypto/unbind

2) Disable the device. For example to disable IAA device 3::

     # echo iax3 > /sys/bus/dsa/drivers/idxd/unbind

3) configure the desired workqueues.  For example, to configure
   workqueue 3 on IAA device 3::

     # echo dedicated > /sys/bus/dsa/devices/iax3/wq3.3/mode
     # echo 128 > /sys/bus/dsa/devices/iax3/wq3.3/size
     # echo 0 > /sys/bus/dsa/devices/iax3/wq3.3/group_id
     # echo 10 > /sys/bus/dsa/devices/iax3/wq3.3/priority
     # echo "kernel" > /sys/bus/dsa/devices/iax3/wq3.3/type
     # echo "iaa_crypto" > /sys/bus/dsa/devices/iax3/wq3.3/name
     # echo "crypto" > /sys/bus/dsa/devices/iax3/wq3.3/driver_name

4) Enable the device. For example to enable IAA device 3::

     # echo iax3 > /sys/bus/dsa/drivers/idxd/bind

5) Enable the desired workqueues on the device.  For example to
   enable workques 0 and 1 on IAA device 3::

     # echo wq3.0 > /sys/bus/dsa/drivers/crypto/bind
     # echo wq3.1 > /sys/bus/dsa/drivers/crypto/bind”h]”(hŒterm”“”)”}”(hŒFor each device::”h]”hŒFor each device::”…””}”(hj;  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  h³hÇh´MPhj5  ubhŒ
definition”“”)”}”(hhh]”hŒenumerated_list”“”)”}”(hhh]”(jH  )”}”(hŒÒDisable any workqueues enabled on the device.  For example to
disable workques 0 and 1 on IAA device 3::

  # echo wq3.0 > /sys/bus/dsa/drivers/crypto/unbind
  # echo wq3.1 > /sys/bus/dsa/drivers/crypto/unbind
”h]”(hÞ)”}”(hŒhDisable any workqueues enabled on the device.  For example to
disable workques 0 and 1 on IAA device 3::”h]”hŒgDisable any workqueues enabled on the device.  For example to
disable workques 0 and 1 on IAA device 3:”…””}”(hjW  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M4hjS  ubjn  )”}”(hŒc# echo wq3.0 > /sys/bus/dsa/drivers/crypto/unbind
# echo wq3.1 > /sys/bus/dsa/drivers/crypto/unbind”h]”hŒc# echo wq3.0 > /sys/bus/dsa/drivers/crypto/unbind
# echo wq3.1 > /sys/bus/dsa/drivers/crypto/unbind”…””}”hje  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M7hjS  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjP  ubjH  )”}”(hŒlDisable the device. For example to disable IAA device 3::

  # echo iax3 > /sys/bus/dsa/drivers/idxd/unbind
”h]”(hÞ)”}”(hŒ9Disable the device. For example to disable IAA device 3::”h]”hŒ8Disable the device. For example to disable IAA device 3:”…””}”(hj}  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M:hjy  ubjn  )”}”(hŒ.# echo iax3 > /sys/bus/dsa/drivers/idxd/unbind”h]”hŒ.# echo iax3 > /sys/bus/dsa/drivers/idxd/unbind”…””}”hj‹  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´M<hjy  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjP  ubjH  )”}”(hXí  configure the desired workqueues.  For example, to configure
workqueue 3 on IAA device 3::

  # echo dedicated > /sys/bus/dsa/devices/iax3/wq3.3/mode
  # echo 128 > /sys/bus/dsa/devices/iax3/wq3.3/size
  # echo 0 > /sys/bus/dsa/devices/iax3/wq3.3/group_id
  # echo 10 > /sys/bus/dsa/devices/iax3/wq3.3/priority
  # echo "kernel" > /sys/bus/dsa/devices/iax3/wq3.3/type
  # echo "iaa_crypto" > /sys/bus/dsa/devices/iax3/wq3.3/name
  # echo "crypto" > /sys/bus/dsa/devices/iax3/wq3.3/driver_name
”h]”(hÞ)”}”(hŒZconfigure the desired workqueues.  For example, to configure
workqueue 3 on IAA device 3::”h]”hŒYconfigure the desired workqueues.  For example, to configure
workqueue 3 on IAA device 3:”…””}”(hj£  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´M>hjŸ  ubjn  )”}”(hX‚  # echo dedicated > /sys/bus/dsa/devices/iax3/wq3.3/mode
# echo 128 > /sys/bus/dsa/devices/iax3/wq3.3/size
# echo 0 > /sys/bus/dsa/devices/iax3/wq3.3/group_id
# echo 10 > /sys/bus/dsa/devices/iax3/wq3.3/priority
# echo "kernel" > /sys/bus/dsa/devices/iax3/wq3.3/type
# echo "iaa_crypto" > /sys/bus/dsa/devices/iax3/wq3.3/name
# echo "crypto" > /sys/bus/dsa/devices/iax3/wq3.3/driver_name”h]”hX‚  # echo dedicated > /sys/bus/dsa/devices/iax3/wq3.3/mode
# echo 128 > /sys/bus/dsa/devices/iax3/wq3.3/size
# echo 0 > /sys/bus/dsa/devices/iax3/wq3.3/group_id
# echo 10 > /sys/bus/dsa/devices/iax3/wq3.3/priority
# echo "kernel" > /sys/bus/dsa/devices/iax3/wq3.3/type
# echo "iaa_crypto" > /sys/bus/dsa/devices/iax3/wq3.3/name
# echo "crypto" > /sys/bus/dsa/devices/iax3/wq3.3/driver_name”…””}”hj±  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MAhjŸ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjP  ubjH  )”}”(hŒhEnable the device. For example to enable IAA device 3::

  # echo iax3 > /sys/bus/dsa/drivers/idxd/bind
”h]”(hÞ)”}”(hŒ7Enable the device. For example to enable IAA device 3::”h]”hŒ6Enable the device. For example to enable IAA device 3:”…””}”(hjÉ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MIhjÅ  ubjn  )”}”(hŒ,# echo iax3 > /sys/bus/dsa/drivers/idxd/bind”h]”hŒ,# echo iax3 > /sys/bus/dsa/drivers/idxd/bind”…””}”hj×  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MKhjÅ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjP  ubjH  )”}”(hŒËEnable the desired workqueues on the device.  For example to
enable workques 0 and 1 on IAA device 3::

  # echo wq3.0 > /sys/bus/dsa/drivers/crypto/bind
  # echo wq3.1 > /sys/bus/dsa/drivers/crypto/bind”h]”(hÞ)”}”(hŒfEnable the desired workqueues on the device.  For example to
enable workques 0 and 1 on IAA device 3::”h]”hŒeEnable the desired workqueues on the device.  For example to
enable workques 0 and 1 on IAA device 3:”…””}”(hjï  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´MMhjë  ubjn  )”}”(hŒ_# echo wq3.0 > /sys/bus/dsa/drivers/crypto/bind
# echo wq3.1 > /sys/bus/dsa/drivers/crypto/bind”h]”hŒ_# echo wq3.0 > /sys/bus/dsa/drivers/crypto/bind
# echo wq3.1 > /sys/bus/dsa/drivers/crypto/bind”…””}”hjý  sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1jm  h³hÇh´MPhjë  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjP  ubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ)”uh1jN  hjK  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jI  hj5  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j3  h³hÇh´MPhj0  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j.  hjÉ
  h²hh³Nh´Nubeh}”(h]”(Œiaa-sysfs-config-interface”jÈ
  eh ]”h"]”(Œiaa sysfs config interface”Œiaa_sysfs_config”eh$]”h&]”uh1hÈhj­
  h²hh³hÇh´Mjó  }”j4  j¾
  sjõ  }”jÈ
  j¾
  subeh}”(h]”Œappendix”ah ]”h"]”Œappendix”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´Mubeh}”(h]”Œ)iaa-compression-accelerator-crypto-driver”ah ]”h"]”Œ)iaa compression accelerator crypto driver”ah$]”h&]”uh1hÈhhh²hh³hÇh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÇuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hÍNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jl  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÇŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”(jX  ]”jM  aj,
  ]”j"
  ajÈ
  ]”j¾
  auŒnameids”}”(jF  jC  jX  jU  j®  j«  j  j
  jP  jM  jü  jù  jw  jt  j   jý  j^  j[  jð  jX  jï  jì  j…  j‚  jª
  j§
  j2
  j/
  j 
  j,
  jŸ
  jœ
  j>  j;  j4  jÈ
  j3  j0  uŒ	nametypes”}”(jF  ‰jX  ‰j®  ‰j  ‰jP  ‰jü  ‰jw  ‰j   ‰j^  ‰jð  ˆjï  ‰j…  ‰jª
  ‰j2
  ‰j 
  ˆjŸ
  ‰j>  ‰j4  ˆj3  ‰uh}”(jC  hÊjU  j§  j«  jD  j
  j±  jM  j  jù  j[  jt  jl  jý  jz  j[  j  jX  ja  jì  ja  j‚  jÿ  j§
  jˆ  j/
  j™  j,
  j5
  jœ
  j5
  j;  j­
  jÈ
  jÉ
  j0  jÉ
  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”jz  Ks…”R”Œparse_messages”]”hŒsystem_message”“”)”}”(hhh]”hÞ)”}”(hŒ`Blank line missing before literal block (after the "::")? Interpreted as a definition list item.”h]”hŒdBlank line missing before literal block (after the â€œ::â€)? Interpreted as a definition list item.”…””}”(hjÖ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝhjÓ  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œline”MQŒsource”hÇuh1jÑ  hjK  ubaŒtransform_messages”]”(jÒ  )”}”(hhh]”hÞ)”}”(hhh]”hŒ8Hyperlink target "iaa-default-config" is not referenced.”…””}”hjô  sbah}”(h]”h ]”h"]”h$]”h&]”uh1hÝhjñ  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”jì  Œsource”hÇŒline”M%uh1jÑ  ubjÒ  )”}”(hhh]”hÞ)”}”(hhh]”hŒ8Hyperlink target "iaa-disable-script" is not referenced.”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”uh1hÝhj  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”jì  Œsource”hÇŒline”M¥uh1jÑ  ubjÒ  )”}”(hhh]”hÞ)”}”(hhh]”hŒ6Hyperlink target "iaa-sysfs-config" is not referenced.”…””}”hj(  sbah}”(h]”h ]”h"]”h$]”h&]”uh1hÝhj%  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”jì  Œsource”hÇŒline”Muh1jÑ  ubeŒtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.