README

Last updated [ Thu Jun  9 15:12:52 PDT 2016 ]

kfi - kernel fabric interface

kfi is based, in spirit, on the usermode OFI (Open Fabric Interface) API.

Currently the build is known to be working for
	linux-3.12.35,	RHEL 6.6
	linux-3.10.*,	RHEL 7.0

kfi/	base kfi (fi_*) entry points and kfi provider registration.
	kfabric.ko is loaded 1st, then provider(s).

include/
	header files for providers plus kfi clients.

prov/
  ibverbs/  Infiniband kernel verbs provider: (under development)

tests/
    getinfo/	fi_getinfo() test
    ibverbs/
	simple	full API test.
	mm2 - 	fi_send() / fi_recv messages between client & server.

Authors:
	Stan C. Smith <stan.smith@intel.com>
	Jay E. Sternberg <jay.e.sternberg@intel.com>
	Frank Yang <Frank.Yang@netapp.com>
	Chen Zhao <Chen.Zhao@netapp.com>

===============================================================================
Building modules:
  $PWD == <...>/kfabric
  make

Loading modules: (simple test works if provider works, curent <NULL> provider.
  KFI framework:	insmod kfabric.ko
  KFI null provider:	insmod kfi_verbs.ko
  KFI test (API):	insmod kfi_test_simple.ko

===============================================================================
Points where KFI and OFI APIs differ plus KFI provider implementation notes.

KFI API definition
------------------
1) kfi_getinfo()
	removed node, portnum and flags call argument.
	info.connreq field not used, info.handle replaces until corrected.

2) kfi_mr_reg(..., uint64_t *dma_address)
	dma_address of registered memory returned.


KFI using the ibverbs (OFED/InfiniBand) provider
------------------------------------

Things to do, please see ./TODO file.