zswap

もともと、Linux Kernelのソースコードの一部なので、GPLv2扱いになる（はずの認識）。

> https://www.kernel.org/doc/html/latest/index.html
> 
> Licensing documentation
> 
> The following describes the license of the Linux kernel source code (GPLv2), how to properly mark the license of individual files in the source tree, as well as links to the full license text.
> 
> https://www.kernel.org/doc/html/latest/process/license-rules.html#kernel-licensing

https://www.kernel.org/doc/html/latest/_sources/vm/zswap.rst.txt

# zswap:


# Overview

> Zswap is a lightweight compressed cache for swap pages. It takes pages that are in the process of being swapped out and attempts to compress them into a dynamically allocated RAM-based memory pool.  zswap basically trades CPU cycles for potentially reduced swap I/O.  This trade-off can also result in a significant performance improvement if reads from the compressed cache are faster than reads from a swap device.

Zswapはswap pagesに対する軽量の圧縮キャッシュです。これは、processがswapped outしたときに、動的に確保されるRAM based memory poolに圧縮して保持します。zswapは基本的にはswap I/Oを潜在的に減らし、CPUcyclesとのtれーどになります。このトレードオフにより、圧縮キャッシュからの読み取りがスワップデバイスからの読み取りよりも高速である場合、パフォーマンスが大幅に向上することもありえます。

## note::

Zswap is a new feature as of v3.11 and interacts heavily with memory reclaim. This interaction has not been fully explored on the large set of potential configurations and workloads that exist.  For this reason, zswap is a work in progress and should be considered experimental.

Zswapはv3.11からの新しい機能であり、メモリ再利用と大きく相互作用します。この相互作用は、潜在的な設定とその結果の負荷の多数の組み合わせに対して、完全に暴露されているものではない。この理由から、zswapはまだ作業中であり、実験中と考えるべきである。

---

> Some potential benefits:

いくつかの潜在的な利益があります。

> * Desktop/laptop users with limited RAM capacities can mitigate the performance impact of swapping.
* Overcommitted guests that share a common I/O resource can   dramatically reduce their swap I/O pressure, avoiding heavy handed I/O throttling by the hypervisor. This allows more work to get done with less impact to the guest workload and guests sharing the I/O subsystem
* Users with SSDs as swap devices can extend the life of the device by drastically reducing life-shortening writes.

* デスクトップ/ラップトップのユーザーは、RAM搭載量の限界があるが、swappingによる性能影響を和らげることができる。
* 共通のI/O resourceを共有するovercommitするguestは、swap I/O 圧力を大幅に減少させ、ハイパーバイザーによるI/O スロットリングの過負荷を無くすことができる。これにより、guest 負荷とI/O subsytemを共有しているguestへの影響を抑え、より多く作業が実行できるようになる。
* SSDをswapとして利用しているユーザーにとっては、デバイス寿命を短くするような書き込みを大幅に減らし、デバイスの寿命を延ばすことができる。

> Zswap evicts pages from compressed cache on an LRU basis to the backing swap device when the compressed pool reaches its size limit.  This requirement had been identified in prior community discussions.

Zswapは、LRUベースでbacking swap deviceへページを圧縮キャッシュから立ち退かせます。この要件は、以前、コミュニティディスカッションで見出されていました。

> Whether Zswap is enabled at the boot time depends on whether the ``CONFIG_ZSWAP_DEFAULT_ON`` Kconfig option is enabled or  not. 

Zswapを起動時典で有効にするかどうかは、Kconfig optionの``CONFIG_ZSWAP_DEFAULT_ON`が有効であるか、無効であるか次第です。

> This setting can then be overridden by providing the kernel command line ``zswap.enabled=`` option, for example ``zswap.enabled=0``.

この設定は、カーネルコマンドラインで、`zswap.enabled=` optionを与えることで上書きできます。例えば、 `zswap.enabled=0`。

> Zswap can also be enabled and disabled at runtime using the sysfs interface. 

Zswapはまた、sysfs interfaceを用いて動作中に有効化/無効化することもできます。

> An example command to enable zswap at runtime, assuming sysfs is mounted at ``/sys``, is::

sysfsが`/sys`にマウントされている前提で、zswapを動作中に有効にするコマンドの例は以下です。

`echo 1 > /sys/module/zswap/parameters/enabled `

> When zswap is disabled at runtime it will stop storing pages that are being swapped out.  However, it will _not_ immediately write out or fault back into memory all of the pages stored in the compressed pool.  The pages stored in zswap will remain in the compressed pool until they are either invalidated or faulted back into memory.  In order to force all pages out of the compressed pool, a swapoff on the swap device(s) will fault back into memory all swapped out pages, including those in the compressed pool. 

Zswapを動作中に停止した場合、スワップアウトされたページの保存が停止されます。しかし、それは即座に圧縮プール内のページが書き出されたり、メモリにフォールトバックしたりするわけではありません。zswapにほぞんされているページは、invalidateされるかメモリにフォールトバックするまでは圧縮プール内に保持されます。圧縮プール内すべてのページを強制的にページアウトするには、swap deviceをswapoffし、圧縮プールにも含まれる、全てのswapped out pagesをメモリにfauldbackさせる必要があります。

# Design

> Zswap receives pages for compression through the Frontswap API and is able to evict pages from its own compressed pool on an LRU basis and write them back to the backing swap device in the case that the compressed pool is full.

Zswapは、frontswap APIを通して圧縮用のページを受け取り、LRU基準で自身の圧縮プールからページを追い出し、圧縮プールがフルになったらそれらをbacking swap deviceに書き出します。

> Zswap makes use of zpool for the managing the compressed memory pool.  Each allocation in zpool is not directly accessible by address.  Rather, a handle is returned by the allocation routine and that handle must be mapped before being accessed.  The compressed memory pool grows on demand and shrinks as compressed pages are freed.  The pool is not preallocated.  By default, a zpool of type selected in ``CONFIG_ZSWAP_ZPOOL_DEFAULT`` Kconfig option is created, but it can be overridden at boot time by setting the ``zpool`` 
 attribute,　e.g. ``zswap.zpool=zbud``.

Zswapは、zpoolを圧縮メモリプールの管理に用います。それぞれのzpoolの割り当てには、アドレスから直接アクセスすることはできません。むしろ、ハンドルは確保ルーチンによって返却され、アクセスされる前にマッピングする必要があります。圧縮メモリプールは要望に応じて拡張し、圧縮プールが解放されると縮小します。デフォルトでは、`CONFIG_ZSWAP_ZPOOL_DEFAULT` Kconfig option で選択されたzpoolの種別で作られますが、`zpool`属性の設定によって起動時に上書きすることもできます。例えば、`zswap.zpool=zbud`.

> It can also be changed at runtime using the sysfs　``zpool`` attribute, e.g.::

`zpool*属性のsysfsを利用して動作中に変更する事もできます。

`echo zbud > /sys/module/zswap/parameters/zpool`

> The zbud type zpool allocates exactly 1 page to store 2 compressed pages, which means the compression ratio will always be 2:1 or worse (because of half-full zbud pages).  The zsmalloc type zpool has a more complex compressed page storage method, and it can achieve greater storage densities.  However, zsmalloc does not implement compressed page eviction, so once zswap fills it cannot evict the oldest page, it can only reject new pages.

zbud type zpool は、厳密に1ページを2圧縮ページに割り当てます、つまり、圧縮比率は常に2:1かそれよりも悪くなります（なぜならば、zbud ぺ＾字が半分だけいっぱいになるため）。zsmalloc type zpoolは、更に複雑な圧縮ページ保持方法になっており、それはストレージ密度を高めることができます。ただし、zsmallocは圧縮されたページの排除を実装していないため、zswapがいっぱいになると、最も古いページが排除できなくなり、新しいページのみを拒絶します。

> When a swap page is passed from frontswap to zswap, zswap maintains a mapping of the swap entry, a combination of the swap type and swap offset, to the zpool handle that references that compressed swap page.  This mapping is achieved with a red-black tree per swap type.  The swap offset is the search key for the tree nodes.

swap pageがfrontswapからzswapを通過するとき、zswapはswap entryのマッピング、swap種別とswapのオフセットの組み合わせを、圧縮されたswap pageを参照するzpool handleに保持します。このマッピングは、swap type事に赤-黒木によって保持されます。swap offsetは、木nodeの検索キーになります。

> During a page fault on a PTE that is a swap entry, frontswap calls the zswap load function to decompress the page into the page allocated by the page fault handler.

swap entryのPTEでpage faultが起きている間、frontswapは、page fault handlerによって確保されたページ内にページを展開するために、zswap load functionを呼び出します。

> Once there are no PTEs referencing a swap page stored in zswap (i.e. the count in the swap_map goes to 0) the swap code calls the zswap invalidate function, via frontswap, to free the compressed entry.

zswap内に保持しているスワップページを参照するPTEが亡くなったら（つまり、swap_mapのカウンターが０に到達する）swap codeは、ftontswapを介して、zswap invalidate関数を呼び出し、圧縮されたエントリーを開放します。

> Zswap seeks to be simple in its policies.  Sysfs attributes allow for one user controlled policy:

zswapは、ポリシーをシンプルにすることを目指していまsう。sysfs属性は、１つのユーザー制御ポリシーを実現しています。

> * max_pool_percent - The maximum percentage of memory that the compressed pool can occupy.

* max_pool_percent - 圧縮プールが占有できるメモリの最大パーセンテージ
 

----

> The default compressor is selected in ``CONFIG_ZSWAP_COMPRESSOR_DEFAULT`` Kconfig option, but it can be overridden at boot time by setting the ``compressor`` attribute, e.g. ``zswap.compressor=lzo``. It can also be changed at runtime using the sysfs "compressor" attribute, e.g.::

デフォルトの圧縮機は、`CONFIG_ZSWAP_COMPRESSOR_DEFAULT` Kconfig option によって選択され、起動時に`compressor` attributeによって上書きすることもできる。例えば、`zswap.compressor=lzo`。また、`compressor`のsysfs属性を用いることで動作中にも変更することができる。

`echo lzo > /sys/module/zswap/parameters/compressor`

> When the zpool and/or compressor parameter is changed at runtime, any existing compressed pages are not modified; they are left in their own zpool.  When a request is made for a page in an old zpool, it is uncompressed using its original compressor.  Once all pages are removed from an old zpool, the zpool and its compressor are freed.

zpool および/または compressor parameterが実行時に変更されても、既存の圧縮ページは変更されず、それぞれのzpoolないに保持されたままです。old zpoolからページの生成が呼ばれたら、オリジナルcompressorを用いて展開がなされます。すべてのページがold zpoolから削除されたら、zpoolとそのcompressorは解放されます。

Some of the pages in zswap are same-value filled pages (i.e. contents of the page have same value or repetitive pattern). These pages include zero-filled pages and they are handled differently. During store operation, a page is checked if it is a same-value filled page before compressing it. If true, the
compressed length of the page is set to zero and the pattern or same-filled value is stored.

zswapの一部のページは、同じ値で埋められたページです（つまり、ページのコンテンツは同じ値または繰り返しのパターンを持っています）。 これらのページには、ゼロで埋められたページが含まれており、処理方法が異なります。 ストア操作中、ページは、圧縮する前に、同じ値のページであるかどうかがチェックされます。 trueの場合、ページの圧縮長はゼロに設定され、パターンまたは同じ塗りつぶしの値が保存されます。

Same-value filled pages identification feature is enabled by default and can be disabled at boot time by setting the ``same_filled_pages_enabled`` attribute to 0, e.g. ``zswap.same_filled_pages_enabled=0``. It can also be enabled and disabled at runtime using the sysfs ``same_filled_pages_enabled`` attribute, e.g.::

同じ値で埋められたページの識別機能はデフォルトで有効になっており、ブートjいに`same_filled_pages_enable*属性を0に設定する事で無効化できます、つまり、`zswap.same_filled_pages_enabled=0`。また、sysfs 属性 `same_filled_pages_enabled*を用いて、実行時に有効化・無効化する事もできます。

`echo 1 > /sys/module/zswap/parameters/same_filled_pages_enabled`

> When zswap same-filled page identification is disabled at runtime, it will stop checking for the same-value filled pages during store operation. However, the existing pages which are marked as same-value filled pages remain stored unchanged in zswap until they are either loaded or invalidated.

実行時にzswapの同じ値で埋められたページの識別が無効になっていると、ストア操作中に同じ値で埋められたページのチェックが停止します。 ただし、同じ値が入力されたページとしてマークされている既存のページは、ロードまたは無効化されるまで、zswapに変更されずに保存されます。

> To prevent zswap from shrinking pool when zswap is full and there's a high pressure on swap (this will result in flipping pages in and out zswap pool without any real benefit but with a performance drop for the system), a special parameter has been introduced to implement a sort of hysteresis to refuse taking pages into zswap pool until it has sufficient space if the limit has been hit. 

zswapがフルで、高いswapへの圧力がかかっているときに、poolを小さくしないように（つまり、zswap プールでページをめくったり出したりすることで、実際のメリットはないが、システムのパフォーマンスが低下する）、特別なパラメータが導入されました。zswap poolに含まれるページに対して、limitに到達した場合に十分なスペースが確保されるまで取り込みを行わない、一種のヒステリシスを実現する。

> To set the threshold at which zswap would start accepting pages again after it became full, use the sysfs ``accept_threhsold_percent`` attribute, e. g.::

zswapが一杯になった後にページの受け入れを再開するしきい値を設定するには、sysfsの「accept_threhsold_percent」属性を使用します。例えば

`echo 80 > /sys/module/zswap/parameters/accept_threhsold_percent`

> Setting this parameter to 100 will disable the hysteresis.

この設定を100%とすることで、ヒステリシスを無効化することができます。

> A debugfs interface is provided for various statistic about pool size, number of pages stored, same-value filled pages and various counters for the reasons pages are rejected.

debugfs interfaceには、プールサイズ、保存されているページ数、同じ値が満たされたページ、およびページが拒否される理由のためのさまざまなカウンターに関するさまざまな統計情報が提供されています。