1 '\" te

     2 .TH libsdp 3LIB " Sep 20, 2010"

     3 .SH "NAME"

     4 libsdp - Sockets Direct Protocol library 

     5 .PP

     6 .SH DESCRIPTION

     7 .PP

     8 

     9 libsdp is a LD_PRELOAD-able library that can be used to migrate existing

    10 applications use InfiniBand Sockets Direct Protocol (SDP) instead of

    11 TCP sockets, transparently and without recompilations. To setup libsdp

    12 please follow the instructions below.

    13 

    14 .PP

    15 .SS SETUP

    16 libsdp.so isn't setup automatically. it can be used in one of 2 ways:

    17 

    18 .TP

    19 \fB\1)

    20 LD_PRELOAD environment variable. Setting this to the name of the library you

    21 want to use will cause it to be preloaded.

    22 .TP

    23 \fB\2)

    24 Adding the name of the library  using crle(1).

    25 .PP

    26 

    27 The library should be installed in a directory in which the dynamic loader

    28 searches for shared libraries (as specified by LD_LIBRARY_PATH, crle(1) , etc). Alternatively, you can specify the full path to the library that you want to

    29 use in LD_PRELOAD or crle(1) described above.

    30 

    31 If you have multiple library versions (e.g. 64/32 bit) and want the linker to

    32 select between them automatically. This done for eample using LD_LIBRARY_PATH

    33 to point to both the lib (the 32 bit version) and lib/64 directories and

    34 LD_RELOAD the libsdp.so. This way the correct 32/64bit libsdp.so will be

    35 selected. For example using bash this can be written:

    36 .PP

    37 LD_LIBRARY_PATH=/usr/lib/secure/64/:/usr/lib/secure LD_PRELOAD=libsdp.so ssh

    38 .RE

    39 .PP

    40 .SS CONFIGURATION

    41 libsdp supports two modes of configuration:

    42 .TP

    43 \fB\1)

    44 simple operation where it converts all calls to socket(2) with a family

    45 of AF_INET(6) and a type of SOCK_STREAM into family of AF_INET_SDP.

    46 .TP

    47 \fB\2)

    48 selective mode where it uses a configuration file to select which sockets

    49 will be using SDP and which will not.

    50 .PP

    51  

    52 Note: both of these modes are designed to work with both IPv4 qand IPv6.

    53 But only IPv4 works currently, because Solaris SDP with IPv6,

    54 does not use AF_INET_SDP. (Note in Linux, the underlying SDP kernel

    55 implementation does not support IPv6.)

    56 .PP

    57 

    58 For real world applications where communication with X, authentication,

    59 DNS and other servers connected through TCP is required the selective mode

    60 is required. Simple mode will be selected in one of the following conditions: 

    61 .PP

    62 .TP

    63 \fB\1)

    64 The environment variable SIMPLE_LIBSDP to a non-empty value

    65 .TP

    66 \fB\2)

    67 No configuration file is defined or is un-readble

    68 .TP

    69 \fB\3)

    70 The configuration file does not include any address family rule

    71 For information on how to configure libsdp, see libsdp.conf(4), installed

    72 in /etc/libsdp.conf  The user can further control the file to be used for

    73 configuration by setting the environment variable: LIBSDP_CONFIG_FILE

    74 .SH FILES

    75 .sp

    76 .ne 2

    77 .mk

    78 .na

    79 \fB\fB/usr/lib/secure/libsdp.so\fR\fR

    80 .ad

    81 .RS 30n

    82 .rt

    83 shared object

    84 .RE

    85 .ne 2

    86 .mk

    87 .na

    88 \fB\fB/usr/lib/secure/64/libsdp.so\fR\fR

    89 .ad

    90 .RS 30n

    91 .rt

    92 64 bit shared object

    93 .RE

    94 

    95 .SH SEE ALSO

    96 .sp

    97 .LP

    98 \fBsocket(3SOCKET), \fBcrel(1), \fBattributes\fR(5), \fBlibsdp.conf(4)

    99 .SH NOTES

   100 .sp

   101 .LP

   102 Non-blocking connect in "both" mode defaults to SDP. Specific rules might be

   103 needed for applications to operate properly.