pintos-os.org Git - openvswitch/blob - lib/socket-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef SOCKET_UTIL_H
  18 #define SOCKET_UTIL_H 1
  19
  20 #include <sys/types.h>
  21 #include <sys/socket.h>
  22 #include <sys/time.h>
  23 #include <netinet/in.h>
  24 #include <stdbool.h>
  25 #include "openvswitch/types.h"
  26 #include <netinet/ip.h>
  27
  28 int set_nonblocking(int fd);
  29 void xset_nonblocking(int fd);
  30 int set_dscp(int fd, uint8_t dscp);
  31
  32 int get_max_fds(void);
  33
  34 int lookup_ip(const char *host_name, struct in_addr *address);
  35 int lookup_ipv6(const char *host_name, struct in6_addr *address);
  36
  37 int lookup_hostname(const char *host_name, struct in_addr *);
  38
  39 int get_socket_error(int sock);
  40 int get_socket_rcvbuf(int sock);
  41 int check_connection_completion(int fd);
  42 int drain_rcvbuf(int fd);
  43 void drain_fd(int fd, size_t n_packets);
  44 int make_unix_socket(int style, bool nonblock,
  45                      const char *bind_path, const char *connect_path);
  46 int get_unix_name_len(socklen_t sun_len);
  47 ovs_be32 guess_netmask(ovs_be32 ip);
  48 int get_null_fd(void);
  49
  50 bool inet_parse_active(const char *target, uint16_t default_port,
  51                        struct sockaddr_in *sinp);
  52 int inet_open_active(int style, const char *target, uint16_t default_port,
  53                      struct sockaddr_in *sinp, int *fdp, uint8_t dscp);
  54
  55 bool inet_parse_passive(const char *target, int default_port,
  56                         struct sockaddr_in *sinp);
  57 int inet_open_passive(int style, const char *target, int default_port,
  58                       struct sockaddr_in *sinp, uint8_t dscp);
  59
  60 int read_fully(int fd, void *, size_t, size_t *bytes_read);
  61 int write_fully(int fd, const void *, size_t, size_t *bytes_written);
  62
  63 int fsync_parent_dir(const char *file_name);
  64 int get_mtime(const char *file_name, struct timespec *mtime);
  65
  66 void xpipe(int fds[2]);
  67 void xpipe_nonblocking(int fds[2]);
  68
  69 char *describe_fd(int fd);
  70
  71 /* Default value of dscp bits for connection between controller and manager.
  72  * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
  73  * in <netinet/ip.h> is used. */
  74 #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
  75
  76 /* Maximum number of fds that we support sending or receiving at one time
  77  * across a Unix domain socket. */
  78 #define SOUTIL_MAX_FDS 8
  79
  80 /* Iovecs. */
  81 size_t iovec_len(const struct iovec *iovs, size_t n_iovs);
  82 bool iovec_is_empty(const struct iovec *iovs, size_t n_iovs);
  83
  84 /* Functions particularly useful for Unix domain sockets. */
  85 void xsocketpair(int domain, int type, int protocol, int fds[2]);
  86 int send_iovec_and_fds(int sock,
  87                        const struct iovec *iovs, size_t n_iovs,
  88                        const int fds[], size_t n_fds);
  89 int send_iovec_and_fds_fully(int sock,
  90                              const struct iovec *iovs, size_t n_iovs,
  91                              const int fds[], size_t n_fds,
  92                              size_t skip_bytes, size_t *bytes_sent);
  93 int send_iovec_and_fds_fully_block(int sock,
  94                                    const struct iovec *iovs, size_t n_iovs,
  95                                    const int fds[], size_t n_fds);
  96 int recv_data_and_fds(int sock,
  97                       void *data, size_t size,
  98                       int fds[SOUTIL_MAX_FDS], size_t *n_fdsp);
  99
 100 #endif /* socket-util.h */