numam-spdk/doc
Richael Zhuang 201aa63471 sock: introduce SO_INCOMING_CPU to get placement_id
Leverage SO_INCOMING_CPU to get the CPU affinity of connections
(sockets). And allocate the connections to specific poll groups,
which aims to utilize cache locality.

From our test:
6 P4600 NVMe on target,target uses 8 cores, NIC irqs are bound to
these 8 cores, and initiator side uses 24 and 32 cores,
we can get 11%~17% randwrite performance boost for posix, and 8%~12%
for uring.

Change-Id: I011e0a21502c85adcccd4a14fbe9838b43f54976
Signed-off-by: Richael Zhuang <richael.zhuang@arm.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5748
Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Ziye Yang <ziye.yang@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
2021-03-09 08:53:52 +00:00
..
img spdk_top: update spdk_top docs for spdk.io 2021-03-08 10:48:47 +00:00
.gitignore
about.md
accel_fw.md doc/accel_fw: update docs to reflect updated configuration 2021-02-05 21:19:37 +00:00
applications.md
bdev_module.md
bdev_pg.md
bdev.md doc/bdev: Update OCF needed memory formula 2021-02-04 08:42:45 +00:00
bdevperf.md
blob.md Doc/Blob: fix a typo in the document 2020-12-30 07:52:19 +00:00
blobfs.md doc: update blobfs.md gen_nvme routine 2020-12-28 13:18:03 +00:00
ci_tools.md
compression.md
concepts.md
concurrency.md
containers.md
Doxyfile doc: Stop generating latex docs 2021-02-19 11:30:07 +00:00
driver_modules.md
event.md
footer.html
ftl.md
gdb_macros.md
general.md doc: added scheduler framework documentation 2021-01-29 18:21:13 +00:00
getting_started.md
header.html
idxd.md
index.md
intro.md
ioat.md
iscsi.md
jsonrpc_proxy.md
jsonrpc.md sock: introduce SO_INCOMING_CPU to get placement_id 2021-03-09 08:53:52 +00:00
libraries.md
lvol.md
Makefile
memory.md
misc.md
notify.md
nvme_spec.md doc: correct explanation of NVMe SQ command submission 2021-01-25 12:52:08 +00:00
nvme.md
nvmf_tgt_pg.md
nvmf_tracing.md
nvmf.md doc: list methods to convert from legacy config 2021-01-29 15:15:13 +00:00
overview.md
peer_2_peer.md
performance_reports.md doc: add NVMe Bdev 20.10 performance report entry 2021-01-20 08:10:45 +00:00
pkgconfig.md build: generate pkg-config files for SPDK 2021-01-21 09:46:32 +00:00
porting.md
prog_guides.md
README.md
scheduler.md doc: added scheduler framework documentation 2021-01-29 18:21:13 +00:00
shfmt.md
spdk_top.md spdk_top: update spdk_top docs for spdk.io 2021-03-08 10:48:47 +00:00
spdkcli.md
ssd_internals.md
stylesheet.css
system_configuration.md configure: remove --with-igb-uio-driver option 2021-01-22 08:47:48 +00:00
template_pg.md
tools.md test: remove spdk/nvme-cli references 2021-01-04 16:28:01 +00:00
two.min.js
user_guides.md build: generate pkg-config files for SPDK 2021-01-21 09:46:32 +00:00
userspace.md
vagrant.md
vhost_processing.md
vhost.md
virtio.md
vmd.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML run make in the doc directory. The output will be located in doc/output/html. Before running make ensure all pre-requisites are installed. See Installing Prerequisites for more details.