libcfs/include/libcfs/user-tcpip.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef __LIBCFS_USER_TCPIP_H__
  38 #define __LIBCFS_USER_TCPIP_H__
  39
  40 #ifndef __LIBCFS_LIBCFS_H__
  41 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  42 #endif
  43
  44 #ifndef __KERNEL__
  45
  46 #include <sys/uio.h>
  47
  48 /*
  49  * Functions to get network interfaces info
  50  */
  51
  52 int libcfs_sock_ioctl(int cmd, unsigned long arg);
  53 int libcfs_ipif_query (char *name, int *up, __u32 *ip);
  54 void libcfs_ipif_free_enumeration (char **names, int n);
  55 int libcfs_ipif_enumerate (char ***namesp);
  56
  57 /*
  58  * Network function used by user-land lnet acceptor
  59  */
  60
  61 typedef struct cfs_socket {
  62         int s_fd;
  63 } cfs_socket_t;
  64
  65 #define LIBCFS_SOCK2FD(sock) ((sock)->s_fd)
  66
  67 int libcfs_sock_listen(cfs_socket_t **sockp, __u32 ip, int port, int backlog);
  68 int libcfs_sock_accept(cfs_socket_t **newsockp, cfs_socket_t *sock);
  69 int libcfs_sock_read(cfs_socket_t *sock, void *buffer, int nob, int timeout);
  70 int libcfs_sock_write(cfs_socket_t *sock, void *buffer, int nob, int timeout);
  71 void libcfs_sock_abort_accept(cfs_socket_t *sock);
  72 void libcfs_sock_release(cfs_socket_t *sock);
  73 int libcfs_sock_getaddr(cfs_socket_t *sock, int remote, __u32 *ip, int *port);
  74
  75 /*
  76  * Network functions of common use
  77  */
  78
  79 int libcfs_socketpair(cfs_socket_t **sockp);
  80 int libcfs_fcntl_nonblock(cfs_socket_t *sock);
  81 int libcfs_sock_set_nagle(cfs_socket_t *sock, int nagle);
  82 int libcfs_sock_set_bufsiz(cfs_socket_t *sock, int bufsiz);
  83 int libcfs_sock_connect(cfs_socket_t *sock, __u32 ip, __u16 port);
  84 int libcfs_sock_writev(cfs_socket_t *sock,
  85                        const struct iovec *vector, int count);
  86 int libcfs_sock_readv(cfs_socket_t *sock,
  87                       const struct iovec *vector, int count);
  88 int libcfs_sock_create(cfs_socket_t **sockp, int *fatal,
  89                        __u32 local_ip, int local_port);
  90
  91
  92 /*
  93  * Macros for easy printing IP-adresses
  94  */
  95
  96 #define NIPQUAD(addr) \
  97         ((unsigned char *)&addr)[0], \
  98         ((unsigned char *)&addr)[1], \
  99         ((unsigned char *)&addr)[2], \
 100         ((unsigned char *)&addr)[3]
 101
 102 #if defined(__LITTLE_ENDIAN) || defined(_LITTLE_ENDIAN)
 103 #define HIPQUAD(addr)                \
 104         ((unsigned char *)&addr)[3], \
 105         ((unsigned char *)&addr)[2], \
 106         ((unsigned char *)&addr)[1], \
 107         ((unsigned char *)&addr)[0]
 108 #elif defined(__BIG_ENDIAN) || defined(_BIG_ENDIAN)
 109 #define HIPQUAD NIPQUAD
 110 #else
 111 #error "Undefined byteorder??"
 112 #endif /* __LITTLE_ENDIAN */
 113
 114 #endif /* !__KERNEL__ */
 115
 116 #endif