Release: Prepare v1.1.0

Signed-off-by: Stefan Raspl <raspl@linux.ibm.com>

Author: Stefan Raspl

Makefile

@@ -1,15 +1,15 @@
 #
 # SMC Tools - Shared Memory Communication Tools
 #
-# Copyright IBM Corp. 2016, 2017
+# Copyright IBM Corp. 2016, 2018
 #
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License v1.0
 # which accompanies this distribution, and is available at
 # http://www.eclipse.org/legal/epl-v10.html
 #
 
-SMC_TOOLS_RELEASE = 1.0.1
+SMC_TOOLS_RELEASE = 1.1.0
 VER_MAJOR         = $(shell echo $(SMC_TOOLS_RELEASE) | cut -d '.' -f 1)
 
 ARCHTYPE = $(shell uname -m)
@@ -32,6 +32,7 @@ OWNER		  = $(shell id -un)
 GROUP		  = $(shell id -gn)
 INSTALL_FLAGS_BIN = -g $(GROUP) -o $(OWNER) -m755
 INSTALL_FLAGS_MAN = -g $(GROUP) -o $(OWNER) -m644
+INSTALL_FLAGS_LIB = -g $(GROUP) -o $(OWNER) -m4755
 
 STUFF_32BIT	  = 0
 #
@@ -47,7 +48,7 @@ else
 LIBDIR		= ${PREFIX}/lib
 endif
 
-all: ld_pre_smc.so ld_pre_smc32.so smcss smc_pnet smc_run
+all: libsmc-preload.so libsmc-preload32.so smcss smc_pnet
 
 CFLAGS ?= -Wall -O3 -g
 ALL_CFLAGS = -DSMC_TOOLS_RELEASE=$(SMC_TOOLS_RELEASE) $(CFLAGS)
@@ -58,21 +59,19 @@ else
 	MACHINE_OPT32="-m32"
 endif
 
-smc_run: smc_run.in
-	my_installdir=${PREFIX} $(GEN) -e "s#@install_dir@#$$my_installdir#g" < $< > $@
-	chmod a+x $@
+smc-preload.o: smc-preload.c
+	${CCC} ${CFLAGS} -fPIC -c smc-preload.c
 
-ld_pre_smc.o: ld_pre_smc.c
-	${CCC} ${CFLAGS} -fPIC -c ld_pre_smc.c
+libsmc-preload.so: smc-preload.o
+	${LINK} ${LDFLAGS} -shared smc-preload.o -ldl -Wl,-z,defs,-soname,$@.$(VER_MAJOR) -o $@
+	chmod u+s $@
 
-ld_pre_smc.so: ld_pre_smc.o
-	${LINK} ${LDFLAGS} -shared ld_pre_smc.o -ldl -Wl,-z,defs,-soname,$@.$(VER_MAJOR) -o $@
-
-ld_pre_smc32.so: ld_pre_smc.c
+libsmc-preload32.so: smc-preload.c
 ifeq ($(ARCH),64)
 ifeq ($(STUFF_32BIT),1)
-	${CCC} ${CFLAGS} -fPIC -c ${MACHINE_OPT32} $< -o ld_pre_smc32.o
-	${LINK} ${LDFLAGS} -shared ld_pre_smc32.o ${MACHINE_OPT32} -ldl -Wl,-soname,$@.$(VER_MAJOR) -o $@
+	${CCC} ${CFLAGS} -fPIC -c ${MACHINE_OPT32} $< -o smc-preload32.o
+	${LINK} ${LDFLAGS} -shared smc-preload32.o ${MACHINE_OPT32} -ldl -Wl,-soname,$@.$(VER_MAJOR) -o $@
+	chmod u+s $@
 else
 	$(warning "Warning: Skipping 31/32-bit library build because 31/32-bit build tools")
 	$(warning "         are unavailable. SMC will not support 31/32 bit applications")
@@ -107,19 +106,19 @@ smcss: smcss.c smc_diag.h smctools_common.h
 install: all
 	echo "  INSTALL"
 	install -d -m755 $(DESTDIR)$(LIBDIR) $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man7 $(DESTDIR)$(MANDIR)/man8
-	install $(INSTALL_FLAGS_BIN) ld_pre_smc.so $(DESTDIR)$(LIBDIR)
+	install $(INSTALL_FLAGS_LIB) libsmc-preload.so $(DESTDIR)$(LIBDIR)
 ifeq ($(STUFF_32BIT),1)
 	install -d -m755 $(DESTDIR)$(LIBDIR32)
-	install $(INSTALL_FLAGS_BIN) ld_pre_smc32.so $(DESTDIR)$(LIBDIR32)/ld_pre_smc.so
+	install $(INSTALL_FLAGS_LIB) libsmc-preload32.so $(DESTDIR)$(LIBDIR32)/libsmc-preload.so
 endif
 	install $(INSTALL_FLAGS_BIN) smc_run $(DESTDIR)$(BINDIR)
 	install $(INSTALL_FLAGS_BIN) smcss $(DESTDIR)$(BINDIR)
 	install $(INSTALL_FLAGS_BIN) smc_pnet $(DESTDIR)$(BINDIR)
-	install $(INSTALL_FLAGS_MAN) $(DESTDIR)$(MANDIR)/man7
+	install $(INSTALL_FLAGS_MAN) af_smc.7 $(DESTDIR)$(MANDIR)/man7
 	install $(INSTALL_FLAGS_MAN) smc_run.8 $(DESTDIR)$(MANDIR)/man8
 	install $(INSTALL_FLAGS_MAN) smc_pnet.8 $(DESTDIR)$(MANDIR)/man8
 	install $(INSTALL_FLAGS_MAN) smcss.8 $(DESTDIR)$(MANDIR)/man8
 
 clean:
 	echo "  CLEAN"
-	rm -f *.o *.so smc_run smcss smc_pnet
+	rm -f *.o *.so smcss smc_pnet

README.smctools

@@ -1,4 +1,4 @@
-SMC Tools (1.0.1)
+SMC Tools (1.1.0)
 ===================
 
 The SMC Tools provided in this package allow execution of existing TCP
@@ -7,16 +7,16 @@ In addition tools are provided to display SMC socket information.
 
 This package consists of the tools:
 
-- ld_preload_smc.so : preload library.
+- libsmc-preload.so : preload library.
 - smc_run           : preload library environment setup script.
 - smc_pnet          : C program for PNET Table handling
 - smcss             : C program for displaying the information about active
                       SMC sockets.
 
-The preload shared library ld_pre_smc.so provides mapping of TCP socket
+The preload shared library libsmc-preload.so provides mapping of TCP socket
 operations to SMC sockets.
 The environment setup script smc_run sets up the preload environment
-for the ld_pre_smc.so shared library before starting application.
+for the libsmc-preload.so shared library before starting application.
 The smcss program is used to gather and display information about the
 SMC sockets.
 The smc_pnet program is used to create, destroy, and change the SMC-R PNET
@@ -45,19 +45,26 @@ For enhancements, please describe the proposed change and its benefits.
 Release History:
 ================
 
-1.0.1 (2018-01-12)
+1.1.0 (2018-06-29)
     Changes:
+    - smcss:    Add IPv6 support
+    - preload:  Add IPv6 support
+    - smcss:    Output format changed
+    - preload:  Rename preload library into libsmc-preload.so
     - Makefile: Improve distro compatibility
     - Makefile: Add SONAME to shared libraries
     - Makefile: Do not strip binaries on install
     - Makefile: Use LDFLAGS to allow addition of externally set link flags
-    - ld_pre..: Remove hardcoded reference to libc
+    - libsmc..: Remove hardcoded reference to libc
     - Manpages: Formatting changes
 
     Bug fixes:
     - Makefile: Fix target 'install' dependencies
     - smcss:    Fix "--version" output
     - smc_pnet: Fix "--version" output
+    - smc_run:	Append preload library to LD_PRELOAD instead of potentially
+                overwriting pre-set values
+    - preload:  Set suid flag to work with suid executables
 
 1.0.0 (2017-02-13)
     The initial version
@@ -69,7 +76,7 @@ Parts:
 The SMC Tools package includes the following files:
 
 Makefile		smctools Makefile
-ld_pre_smc.c		ld_pre_smc.so, SMC preload library source code
+smc-preload.c		libsmc-preload.so, SMC preload library source code
 smc_run			SMC preload library environment setup script
 smc_pnet.c		PNET Table handling source code
 smcss.c			SMC socket display source code

af_smc.7

@@ -1,7 +1,5 @@
-.\" af_smc.7
 .\"
-.\"
-.\" Copyright IBM Corp. 2016, 2017
+.\" Copyright IBM Corp. 2016, 2018
 .\" Author(s):	Ursula Braun <ubraun@linux.vnet.ibm.com>
 .\"		Thomas Richter <tmricht@linux.vnet.ibm.com>
 .\" ----------------------------------------------------------------------
@@ -10,10 +8,16 @@
 AF_SMC - Sockets for SMC communication
 .SH SYNOPSIS
 .B #include <sys/socket.h>
-.br
+.sp
 .B "#define AF_SMC 43"
+.sp
+.B "#define SMCPROTO_SMC  0"
+.sp
+.B "#define SMCPROTO_SMC6 1"
 .PP
-.I "tcp_socket = socket(AF_SMC, SOCK_STREAM, 0);"
+.IB tcp_sockfd " = socket(" AF_SMC ", " SOCK_STREAM ", " SMCPROTO_SMC );
+.sp
+.IB tcp_sockfd " = socket(" AF_SMC ", " SOCK_STREAM ", " SMCPROTO_SMC6 );
 .SH DESCRIPTION
 .I Shared Memory Communication via RDMA
 (SMC) is a socket over the RDMA
@@ -27,23 +31,45 @@ host-to-host direct memory access without traditional TCP/IP
 processing overhead.
 SMC offers preservation of existing IP topology and IP security, and
 introduces minimal administrative and operational changes.
-The exploitation of SMC is transparent to TCP sockets applications.
+The exploitation of SMC is transparent to TCP socket applications.
 .PP
 The new address family
 .B AF_SMC
 supports the SMC protocol on Linux.
-It keeps the address format of AF_INET sockets and supports streaming
-socket types only.
+It keeps the address format of
+.B AF_INET
+and
+.B AF_INET6
+sockets and supports streaming socket types only.
 .SS Usage modes
 Two usage modes are possible:
 .IP "AF_SMC native usage"
-exploits the socket domain AF_SMC instead of
-AF_INET.
-.IP "usage of AF_INET socket applications with SMC preload library"
-converts AF_INET sockets to AF_SMC sockets.
+uses the socket domain
+.B AF_SMC
+instead of
+.B AF_INET
+and
+.BR AF_INET6 .
+Specify
+.B SMCPROTO_SMC
+for
+.B AF_INET
+compatible socket semantics, and
+.B SMC_PROTO_SMC6
+for
+.B AF_INET6
+respectively.
+.IP "Usage of AF_INET socket applications with SMC preload library"
+converts
+.B AF_INET
+and
+.B AF_INET6
+sockets to
+.B AF_SMC
+sockets.
 The SMC preload library is part of the SMC tools package.
 .PP
-SMC capability of sockets is negotiated during connection setup. If
+SMC socket capabilities are negotiated at connection setup. If
 one peer is not SMC capable, further socket processing falls
 back to TCP usage automatically.
 .SS Implementation details: Links and Link Groups
@@ -53,44 +79,47 @@ is established between
 a local RoCE card and a remote RoCE card. To enhance availability, you can
 configure alternate links with automatic fail over.
 Primary and backup links to a certain peer are combined in a so-called
-.I link group.
-To guarantee untroubled RDMA traffic, the number of connections
-per link group and the number of send requests in flight per link are limited.
-.SS Enabling SMC
-To enable SMC, smc-code must be active: If smc is not part of the
-kernel image, load the separate smc module (use "modprobe smc").
+.I link
+.IR group .
 .SS RoCE adapter mapping: Creation of a pnet table
 The SMC protocol requires grouping of multiple physical networks -
 standard Ethernet and RoCE networks. Such groups are called
 .I Physical Networks
-(PNets). For SMC, RoCE Adapter mapping is configured within a table called
+(PNets). For SMC, RoCE adapter mapping is configured within a table called
 .BR "pnet table" .
 Any available Ethernet interface can be combined with available
 .I RDMA-capable network interface cards
 (RNICs),
 if they belong to the same Converged Ethernet fabric.
 To configure RoCE Adapter mapping, you must create a pnet table.
 Modify the table with the smc-tools command
-.I smc_pnet.
+.IR smc_pnet .
 .PP
-For details call "man smc_pnet".
-.SS Important sysctl settings
-SMC-R supports IPv4 only. Use this sysctl setting:
-.IR  net.ipv6.bindv6only=1
+For details see
+.BR  smc_pnet (8).
 .SS Displaying SMC socket state information
 SMC socket state information can be obtained with the smc-tools command
-.I smcss.
-For details call "man smcss".
-.SS Starting a TCP application to work over SMC
-To start an existing TCP application to work through SMC, use the SMC
+.IR smcss .
+For details see
+.BR smcss (8).
+.SS Starting a TCP application to work with SMC
+To use an existing TCP application to work with SMC, use the SMC
 preload library.
-The SMC Tools package provides a script called "smc_run"
-to convert AF_INET socket calls to AF_SMC socket calls by means of the preload
-technique.
+The SMC Tools package provides the command
+.I smc_run
+to convert
+.B AF_INET
+and
+.B AF_INET6
+socket calls to
+.B AF_SMC
+socket calls by means of the preload technique.
+For more information about the preload mechanism, see also
+.BR ld.so (8).
 .PP
 Example:
 .IP
-smc_run ftp
+.B smc_run ftp
 .PP
 This command-line example starts an FTP client over SMC.
 .PP
@@ -102,7 +131,7 @@ the minimum MTU size of both peers.
 
 .SH "AUTHOR"
 .nf
-Copyright IBM Corp. 2016, 2017
+Copyright IBM Corp. 2016, 2018
 
 Published under the terms and conditions of the EPL
 (Eclipse Public License).
@@ -112,13 +141,13 @@ Published under the terms and conditions of the EPL
 .BR socket (2),
 .BR ip (7),
 .BR tcp (7),
-.BR socket (7)
-.BR smc_run (8)
-.BR smcss (8)
+.BR socket (7),
+.BR smc_run (8),
+.BR smcss (8),
 .BR smc_pnet (8)
 .SH "HISTORY"
 .TP
-.B AF_SMC, version 1.0.1
+.B AF_SMC, version 1.0.0
 .RS 4
 .IP "\bu" 2
 Initial version.

ld_pre_smc.c smc-preload.cld_pre_smc.c renamed to smc-preload.c

@@ -1,7 +1,7 @@
 /*
  * SMC Tools - Shared Memory Communication Tools
  *
- * Copyright (c) IBM Corp. 2016, 2017
+ * Copyright (c) IBM Corp. 2016, 2018
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
@@ -28,6 +28,11 @@
 #define AF_SMC 43
 #endif
 
+#ifndef SMCPROTO_SMC
+#define SMCPROTO_SMC		0	/* SMC protocol, IPv4 */
+#define SMCPROTO_SMC6		1	/* SMC protocol, IPv6 */
+#endif
+
 int (*orig_socket)(int domain, int type, int protocol);
 static void *dl_handle = NULL;
 
@@ -72,14 +77,21 @@ int socket(int domain, int type, int protocol)
 	if (!dl_handle)
 		initialize();
 
-	if ((domain == AF_INET) && (type == SOCK_STREAM)) {
-		dbg_msg(stderr, "ld_pre_smc: map sock AF_INET/SOCK_STREAM ");
-		dbg_msg(stderr, "to AF_SMC\n");
+	/* check if socket is eligible for AF_SMC */
+	if ((domain == AF_INET || domain == AF_INET6) &&
+	    type == SOCK_STREAM &&
+	    (protocol == IPPROTO_IP || protocol == IPPROTO_TCP)) {
+		dbg_msg(stderr, "libsmc-preload: map sock to AF_SMC\n");
+		if (domain == AF_INET)
+			protocol = SMCPROTO_SMC;
+		else /* AF_INET6 */
+			protocol = SMCPROTO_SMC6;
+
 		domain = AF_SMC;
-		rc = (*orig_socket)(domain, type, protocol);
-	} else {
-		rc = (*orig_socket)(domain, type, protocol);
 	}
+
+	rc = (*orig_socket)(domain, type, protocol);
+
 	return rc;
 }