aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRoland Dreier <rolandd@cisco.com>2006-02-15 06:08:15 +0000
committerRoland Dreier <rolandd@cisco.com>2006-11-09 11:35:59 -0800
commit4ec38d4943a7ee58544044fed9ca8ee7f52b0acf (patch)
treed38acff0f1384ef9f62ac30b9c69b39a20f63dfa
parent6bb69dce4c299ea86a9fd80af6da85c9fdc8acc2 (diff)
downloadlibibverbs-4ec38d4943a7ee58544044fed9ca8ee7f52b0acf.tar.gz
Add lots more TODO information to the libibverbs README
Signed-off-by: Roland Dreier <rolandd@cisco.com>
-rw-r--r--README47
1 files changed, 45 insertions, 2 deletions
diff --git a/README b/README
index 347612d..95e3660 100644
--- a/README
+++ b/README
@@ -98,5 +98,48 @@ necessary permissions to release your work.
TODO
====
- * Memory windows (MWs) need to be implemented.
- * Some query verbs (query AH, etc) need to be implemented.
+1.0 series
+----------
+
+ * Use the MADV_DONTFORK advice for madvise(2) to make applications
+ that use fork(2) work better.
+
+1.1 series
+----------
+
+The libibverbs API and ABI are frozen for all releases in the 1.0
+series. The following changes that break API or ABI are planned for
+the 1.1 release:
+
+ * Implement memory window (MW) support. This will break the
+ device driver ABI, because new methods will need to be added to
+ struct ibv_context_ops.
+
+ * Implement the reregister memory region (MR) verb. We will add an
+ extension to the IB spec to allow the application to indicate that
+ the region is only being extended, and that operations in progress
+ should _not_ fail (contrary to the IB spec, which states that
+ reregister must be implemented so that it behaves equivalently to a
+ deregister followed by a register). This will break the device
+ driver ABI, because a new method will need to be added to struct
+ ibv_context_ops.
+
+ * Eliminate the dependency on libsysfs by implementing the required
+ sysfs handling directly. This will break the API, because the dev
+ and ibdev members of struct ibv_device will be removed. It will
+ also break the device driver ABI, because the signature of the
+ driver initialization function will change. The driver
+ initialization function will be changed as part of this work; this
+ has the added benefit of allowing us to choose a better name than
+ "openib_driver_init."
+
+Other possibilities
+-------------------
+
+There are no plans to implement the following features, which would be
+needed for completeness but don't seem particularly useful. However,
+if there is demand from application developers or an implementation is
+contributed, then the feature may be added.
+
+ * Implement the query address handle (AH) verb.
+ * Implement the query memory region (MR) verb.