From patchwork Wed Sep 21 22:08:41 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jason Gunthorpe X-Patchwork-Id: 9344315 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 16619601C2 for ; Wed, 21 Sep 2016 22:32:06 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 18AEB2A2F4 for ; Wed, 21 Sep 2016 22:32:06 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id EA77F2A346; Wed, 21 Sep 2016 22:32:05 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2D6CD2A2F4 for ; Wed, 21 Sep 2016 22:32:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934214AbcIUWcE (ORCPT ); Wed, 21 Sep 2016 18:32:04 -0400 Received: from quartz.orcorp.ca ([184.70.90.242]:35481 "EHLO quartz.orcorp.ca" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934051AbcIUWcD (ORCPT ); Wed, 21 Sep 2016 18:32:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=obsidianresearch.com; s=rsa1; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From; bh=K30HUjYTss5ceSx3pc7EZXvIHnF/C0n4zabr2CFUdrY=; b=4rRkTJTwEZcNAdL8BWdEolwSoy1M0T6k8SUA8cT4PYyJozyjeoG2eh+IfHJK3Br69Bp7QSxTOj8jMJVfp7HXnFwcDjSazN6UuRa0vfdCoQqqMyuB0D18F3rbJUY/QbeYhfRvtmqybhIi7TmpYS7emRPZS8Gzex/RgUAsgPweqho=; Received: from [10.0.0.151] (helo=jggl.edm.orcorp.ca) by quartz.orcorp.ca with esmtps (TLS1.2:ECDHE_RSA_AES_128_CBC_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1bmphG-0003vd-GK; Wed, 21 Sep 2016 16:08:54 -0600 From: Jason Gunthorpe To: linux-rdma@vger.kernel.org Cc: Christoph Hellwig , Sean Hefty Subject: [PATCH 15/23] rdmacm: Move documentation to Documentation/ Date: Wed, 21 Sep 2016 16:08:41 -0600 Message-Id: <1474495729-17604-16-git-send-email-jgunthorpe@obsidianresearch.com> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1474495729-17604-1-git-send-email-jgunthorpe@obsidianresearch.com> References: <1474495729-17604-1-git-send-email-jgunthorpe@obsidianresearch.com> X-Broken-Reverse-DNS: no host name found for IP address 10.0.0.151 Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Christoph Hellwig And drop bits that are outdated or replaced by top-level Documentation. Signed-off-by: Christoph Hellwig --- librdmacm/README => Documentation/librdmacm.md | 27 ++++++-------------------- 1 file changed, 6 insertions(+), 21 deletions(-) rename librdmacm/README => Documentation/librdmacm.md (65%) diff --git a/librdmacm/README b/Documentation/librdmacm.md similarity index 65% rename from librdmacm/README rename to Documentation/librdmacm.md index e1f222740144..817383661c06 100644 --- a/librdmacm/README +++ b/Documentation/librdmacm.md @@ -1,19 +1,5 @@ -This README is for userspace RDMA cm library. +# Device files - -Building -======== -To make this directory, run: -./autogen.sh && ./configure && make && make install - -Typically the autogen and configure steps only need be done the first -time unless configure.in or Makefile.am changes. - -Libraries are installed by default at /usr/local/lib. - - -Device files -============ The userspace CMA uses a single device file regardless of the number of adapters or ports present. @@ -31,17 +17,16 @@ or you can create it manually mknod /dev/infiniband/rdma_cm c 231 255 -Common issues -============= +# Common issues Using multiple interfaces - The librdmacm does support multiple interfaces. To make use +: The librdmacm does support multiple interfaces. To make use of multiple interfaces, however, you need to instruct linux to only send ARP reples on the interface targetted in the ARP request. This can be done using a command similar to the following: - sysctl -w net.ipv4.conf.all.arp_ignore=2 + sysctl -w net.ipv4.conf.all.arp_ignore=2 Without this change, it's possible for linux to resopnd to ARP requests on a different interface (IP address) than the IP @@ -50,12 +35,12 @@ Using multiple interfaces device. Using loopback - The librdmacm relies on ARP to resolve IP address to RDMA +: The librdmacm relies on ARP to resolve IP address to RDMA addresses. To support loopback connections between different ports on the same system, ARP must be enabled for local resolution: - sysctl net.ipv4.conf.all.accept_local=1 + sysctl net.ipv4.conf.all.accept_local=1 Without this setting, loopback connections may timeout during address resolution.