blob: ee249070c380d95a0d023e85ed6cc6dcfbaa9fa8 [file] [log] [blame]
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001/* Socket module */
2
3/*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005This module provides an interface to Berkeley socket IPC.
6
7Limitations:
8
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00009- Only AF_INET, AF_INET6 and AF_UNIX address families are supported in a
Christian Heimes043d6f62008-01-07 17:19:16 +000010 portable manner, though AF_PACKET, AF_NETLINK and AF_TIPC are supported
11 under Linux.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000012- No read/write operations (use sendall/recv or makefile instead).
13- Additional restrictions apply on some non-Unix platforms (compensated
14 for by socket.py).
Guido van Rossum6574b3e1991-06-25 21:36:08 +000015
Guido van Rossum27e177d1995-03-16 15:43:47 +000016Module interface:
Guido van Rossum6574b3e1991-06-25 21:36:08 +000017
Andrew Svetlov0832af62012-12-18 23:10:48 +020018- socket.error: exception raised for socket specific errors, alias for OSError
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000019- socket.gaierror: exception raised for getaddrinfo/getnameinfo errors,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000020 a subclass of socket.error
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000021- socket.herror: exception raised for gethostby* errors,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 a subclass of socket.error
Guido van Rossum30a685f1991-06-27 15:51:29 +000023- socket.gethostbyname(hostname) --> host IP address (string: 'dd.dd.dd.dd')
Guido van Rossum3bbc62e1995-01-02 19:30:30 +000024- socket.gethostbyaddr(IP address) --> (hostname, [alias, ...], [IP addr, ...])
Guido van Rossum27e177d1995-03-16 15:43:47 +000025- socket.gethostname() --> host name (string: 'spam' or 'spam.domain.com')
Guido van Rossum25405c71996-12-19 16:42:52 +000026- socket.getprotobyname(protocolname) --> protocol number
Barry Warsaw11b91a02004-06-28 00:50:43 +000027- socket.getservbyname(servicename[, protocolname]) --> port number
28- socket.getservbyport(portnumber[, protocolname]) --> service name
Guido van Rossum7d0a8262007-05-21 23:13:11 +000029- socket.socket([family[, type [, proto, fileno]]]) --> new socket object
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 (fileno specifies a pre-existing socket file descriptor)
Dave Cole331708b2004-08-09 04:51:41 +000031- socket.socketpair([family[, type [, proto]]]) --> (socket, socket)
Guido van Rossum006bf911996-06-12 04:04:55 +000032- socket.ntohs(16 bit value) --> new int object
33- socket.ntohl(32 bit value) --> new int object
34- socket.htons(16 bit value) --> new int object
35- socket.htonl(32 bit value) --> new int object
Berker Peksaga6ec5ee2014-06-30 11:28:40 +030036- socket.getaddrinfo(host, port [, family, type, proto, flags])
37 --> List of (family, type, proto, canonname, sockaddr)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000038- socket.getnameinfo(sockaddr, flags) --> (host, port)
Guido van Rossum27e177d1995-03-16 15:43:47 +000039- socket.AF_INET, socket.SOCK_STREAM, etc.: constants from <socket.h>
Guido van Rossum47dfa4a2003-04-25 05:48:32 +000040- socket.has_ipv6: boolean value indicating if IPv6 is supported
Guido van Rossum5c9eb211999-08-20 18:21:51 +000041- socket.inet_aton(IP address) -> 32-bit packed IP representation
42- socket.inet_ntoa(packed IP) -> IP address string
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +000043- socket.getdefaulttimeout() -> None | float
44- socket.setdefaulttimeout(None | float)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -070045- socket.if_nameindex() -> list of tuples (if_index, if_name)
46- socket.if_nametoindex(name) -> corresponding interface index
47- socket.if_indextoname(index) -> corresponding interface name
Guido van Rossum6574b3e1991-06-25 21:36:08 +000048- an Internet socket address is a pair (hostname, port)
49 where hostname can be anything recognized by gethostbyname()
50 (including the dd.dd.dd.dd notation) and port is in host byte order
51- where a hostname is returned, the dd.dd.dd.dd notation is used
Guido van Rossum27e177d1995-03-16 15:43:47 +000052- a UNIX domain socket address is a string specifying the pathname
Jeremy Hylton22308652001-02-02 03:23:09 +000053- an AF_PACKET socket address is a tuple containing a string
54 specifying the ethernet interface and an integer specifying
55 the Ethernet protocol number to be received. For example:
Jeremy Hyltondbfb6622001-02-02 19:55:17 +000056 ("eth0",0x1234). Optional 3rd,4th,5th elements in the tuple
Andrew M. Kuchlingb8e17172004-07-10 23:39:35 +000057 specify packet-type and ha-type/addr.
Christian Heimes043d6f62008-01-07 17:19:16 +000058- an AF_TIPC socket address is expressed as
59 (addr_type, v1, v2, v3 [, scope]); where addr_type can be one of:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, and TIPC_ADDR_ID;
Christian Heimes043d6f62008-01-07 17:19:16 +000061 and scope can be one of:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and TIPC_NODE_SCOPE.
Christian Heimes043d6f62008-01-07 17:19:16 +000063 The meaning of v1, v2 and v3 depends on the value of addr_type:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000064 if addr_type is TIPC_ADDR_NAME:
65 v1 is the server type
66 v2 is the port identifier
67 v3 is ignored
68 if addr_type is TIPC_ADDR_NAMESEQ:
69 v1 is the server type
70 v2 is the lower port number
71 v3 is the upper port number
72 if addr_type is TIPC_ADDR_ID:
73 v1 is the node
74 v2 is the ref
75 v3 is ignored
Christian Heimes043d6f62008-01-07 17:19:16 +000076
Guido van Rossum6574b3e1991-06-25 21:36:08 +000077
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000078Local naming conventions:
Guido van Rossum6574b3e1991-06-25 21:36:08 +000079
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000080- names starting with sock_ are socket object methods
81- names starting with socket_ are module-level functions
82- names starting with PySocket are exported through socketmodule.h
Guido van Rossum30a685f1991-06-27 15:51:29 +000083
Guido van Rossum6574b3e1991-06-25 21:36:08 +000084*/
85
Thomas Wouters477c8d52006-05-27 19:21:47 +000086#ifdef __APPLE__
87 /*
88 * inet_aton is not available on OSX 10.3, yet we want to use a binary
89 * that was build on 10.4 or later to work on that release, weak linking
90 * comes to the rescue.
91 */
92# pragma weak inet_aton
93#endif
94
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000095#include "Python.h"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000096#include "structmember.h"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000097
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000098/* Socket object documentation */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000099PyDoc_STRVAR(sock_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +0200100"socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None) -> socket object\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000101\n\
102Open a socket of the given type. The family argument specifies the\n\
103address family; it defaults to AF_INET. The type argument specifies\n\
104whether this is a stream (SOCK_STREAM, this is the default)\n\
105or datagram (SOCK_DGRAM) socket. The protocol argument defaults to 0,\n\
106specifying the default protocol. Keyword arguments are accepted.\n\
Victor Stinnerdaf45552013-08-28 00:53:59 +0200107The socket is created as non-inheritable.\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000108\n\
109A socket object represents one endpoint of a network connection.\n\
110\n\
111Methods of socket objects (keyword arguments not allowed):\n\
112\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000113_accept() -- accept connection, returning new socket fd and client address\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000114bind(addr) -- bind the socket to a local address\n\
115close() -- close the socket\n\
116connect(addr) -- connect the socket to a remote address\n\
117connect_ex(addr) -- connect, return an error code instead of an exception\n\
Victor Stinnerdaf45552013-08-28 00:53:59 +0200118dup() -- return a new socket fd duplicated from fileno()\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000119fileno() -- return underlying file descriptor\n\
120getpeername() -- return remote address [*]\n\
121getsockname() -- return local address\n\
122getsockopt(level, optname[, buflen]) -- get socket options\n\
123gettimeout() -- return timeout or None\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +0100124listen([n]) -- start listening for incoming connections\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000125recv(buflen[, flags]) -- receive data\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000126recv_into(buffer[, nbytes[, flags]]) -- receive data (into a buffer)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000127recvfrom(buflen[, flags]) -- receive data and sender\'s address\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000128recvfrom_into(buffer[, nbytes, [, flags])\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000129 -- receive data and sender\'s address (into a buffer)\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000130sendall(data[, flags]) -- send all data\n\
131send(data[, flags]) -- send data, may not send all of it\n\
132sendto(data[, flags], addr) -- send data to a given address\n\
133setblocking(0 | 1) -- set or clear the blocking I/O flag\n\
134setsockopt(level, optname, value) -- set socket options\n\
135settimeout(None | float) -- set or clear the timeout\n\
136shutdown(how) -- shut down traffic in one or both directions\n\
Gregory P. Smith5ed2e772011-05-15 00:26:45 -0700137if_nameindex() -- return all network interface indices and names\n\
Gregory P. Smithb6471db2011-05-22 22:47:55 -0700138if_nametoindex(name) -- return the corresponding interface index\n\
139if_indextoname(index) -- return the corresponding interface name\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000140\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000141 [*] not available on all platforms!");
Guido van Rossum3baaa131999-03-22 21:44:51 +0000142
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000143/* XXX This is a terrible mess of platform-dependent preprocessor hacks.
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000144 I hope some day someone can clean this up please... */
145
Guido van Rossum9376b741999-09-15 22:01:40 +0000146/* Hacks for gethostbyname_r(). On some non-Linux platforms, the configure
147 script doesn't get this right, so we hardcode some platform checks below.
148 On the other hand, not all Linux versions agree, so there the settings
149 computed by the configure script are needed! */
150
151#ifndef linux
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000152# undef HAVE_GETHOSTBYNAME_R_3_ARG
153# undef HAVE_GETHOSTBYNAME_R_5_ARG
154# undef HAVE_GETHOSTBYNAME_R_6_ARG
Guido van Rossum9376b741999-09-15 22:01:40 +0000155#endif
Guido van Rossume7de2061999-03-24 17:24:33 +0000156
Victor Stinner710d27e2011-08-23 10:57:32 +0200157#if defined(__OpenBSD__)
158# include <sys/uio.h>
159#endif
160
Guido van Rossum7a122991999-04-13 04:07:32 +0000161#ifndef WITH_THREAD
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000162# undef HAVE_GETHOSTBYNAME_R
Guido van Rossum7a122991999-04-13 04:07:32 +0000163#endif
164
Guido van Rossume7de2061999-03-24 17:24:33 +0000165#ifdef HAVE_GETHOSTBYNAME_R
Jesus Cea736e7fc2011-03-14 17:36:54 +0100166# if defined(_AIX)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000167# define HAVE_GETHOSTBYNAME_R_3_ARG
168# elif defined(__sun) || defined(__sgi)
169# define HAVE_GETHOSTBYNAME_R_5_ARG
170# elif defined(linux)
Guido van Rossum9376b741999-09-15 22:01:40 +0000171/* Rely on the configure script */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000172# else
173# undef HAVE_GETHOSTBYNAME_R
174# endif
Guido van Rossume7de2061999-03-24 17:24:33 +0000175#endif
176
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000177#if !defined(HAVE_GETHOSTBYNAME_R) && defined(WITH_THREAD) && \
178 !defined(MS_WINDOWS)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000179# define USE_GETHOSTBYNAME_LOCK
Guido van Rossum3baaa131999-03-22 21:44:51 +0000180#endif
181
Hye-Shik Chang9ceebd52005-09-24 14:58:47 +0000182/* To use __FreeBSD_version */
183#ifdef HAVE_SYS_PARAM_H
184#include <sys/param.h>
185#endif
Just van Rossum1040d2c2003-05-09 07:53:18 +0000186/* On systems on which getaddrinfo() is believed to not be thread-safe,
Just van Rossum09aecd72003-05-09 08:03:44 +0000187 (this includes the getaddrinfo emulation) protect access with a lock. */
Hye-Shik Chang9ceebd52005-09-24 14:58:47 +0000188#if defined(WITH_THREAD) && (defined(__APPLE__) || \
189 (defined(__FreeBSD__) && __FreeBSD_version+0 < 503000) || \
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 defined(__OpenBSD__) || defined(__NetBSD__) || \
Christian Heimesaf01f662013-12-21 16:19:10 +0100191 !defined(HAVE_GETADDRINFO))
Just van Rossum1040d2c2003-05-09 07:53:18 +0000192#define USE_GETADDRINFO_LOCK
193#endif
194
195#ifdef USE_GETADDRINFO_LOCK
196#define ACQUIRE_GETADDRINFO_LOCK PyThread_acquire_lock(netdb_lock, 1);
197#define RELEASE_GETADDRINFO_LOCK PyThread_release_lock(netdb_lock);
198#else
199#define ACQUIRE_GETADDRINFO_LOCK
200#define RELEASE_GETADDRINFO_LOCK
201#endif
202
203#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000204# include "pythread.h"
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000205#endif
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000206
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000207#if defined(PYCC_VACPP)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000208# include <types.h>
209# include <io.h>
210# include <sys/ioctl.h>
211# include <utils.h>
212# include <ctype.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000213#endif
214
Martin v. Löwis9d6c6692012-02-03 17:44:58 +0100215#ifdef __APPLE__
216# include <sys/ioctl.h>
217#endif
218
219
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000220#if defined(__sgi) && _COMPILER_VERSION>700 && !_SGIAPI
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000221/* make sure that the reentrant (gethostbyaddr_r etc)
222 functions are declared correctly if compiling with
223 MIPSPro 7.x in ANSI C mode (default) */
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000224
Thomas Wouters477c8d52006-05-27 19:21:47 +0000225/* XXX Using _SGIAPI is the wrong thing,
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000226 but I don't know what the right thing is. */
Trent Mick8ea5bdf2004-09-13 17:48:41 +0000227#undef _SGIAPI /* to avoid warning */
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000228#define _SGIAPI 1
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000229
Trent Mick8ea5bdf2004-09-13 17:48:41 +0000230#undef _XOPEN_SOURCE
231#include <sys/socket.h>
232#include <sys/types.h>
233#include <netinet/in.h>
234#ifdef _SS_ALIGNSIZE
235#define HAVE_GETADDRINFO 1
236#define HAVE_GETNAMEINFO 1
237#endif
238
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000239#define HAVE_INET_PTON
240#include <netdb.h>
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000241#endif
242
Thomas Wouters477c8d52006-05-27 19:21:47 +0000243/* Irix 6.5 fails to define this variable at all. This is needed
244 for both GCC and SGI's compiler. I'd say that the SGI headers
Georg Brandldbd83392006-02-20 09:42:33 +0000245 are just busted. Same thing for Solaris. */
246#if (defined(__sgi) || defined(sun)) && !defined(INET_ADDRSTRLEN)
Anthony Baxterbab23cf2003-10-04 08:00:49 +0000247#define INET_ADDRSTRLEN 16
248#endif
249
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000250/* Generic includes */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000251#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000252#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000253#endif
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000254
Gregory P. Smith3b1f2c32011-05-15 12:18:23 -0700255#ifdef HAVE_SYS_SOCKET_H
256#include <sys/socket.h>
257#endif
258
259#ifdef HAVE_NET_IF_H
260#include <net/if.h>
261#endif
262
Marc-André Lemburg976ade62002-02-16 18:47:07 +0000263/* Generic socket object definitions and includes */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000264#define PySocket_BUILDING_SOCKET
Marc-André Lemburgbb8b78b2002-02-16 18:44:52 +0000265#include "socketmodule.h"
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000266
267/* Addressing includes */
268
Guido van Rossum6f489d91996-06-28 20:15:15 +0000269#ifndef MS_WINDOWS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000270
271/* Non-MS WINDOWS includes */
272# include <netdb.h>
Nick Coghlan4ecf6cf2011-08-22 15:45:19 +1000273# include <unistd.h>
Guido van Rossum5c9eb211999-08-20 18:21:51 +0000274
Guido van Rossum9376b741999-09-15 22:01:40 +0000275/* Headers needed for inet_ntoa() and inet_addr() */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000276# include <arpa/inet.h>
Guido van Rossum5c9eb211999-08-20 18:21:51 +0000277
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000278# include <fcntl.h>
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000279
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000280#else
Guido van Rossum48a680c2001-03-02 06:34:14 +0000281
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000282/* MS_WINDOWS includes */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000283# ifdef HAVE_FCNTL_H
284# include <fcntl.h>
285# endif
Guido van Rossum48a680c2001-03-02 06:34:14 +0000286
Steve Dower65e4cb12014-11-22 12:54:57 -0800287#if defined(_MSC_VER) && _MSC_VER >= 1800
288/* Provides the IsWindows7SP1OrGreater() function */
289#include <VersionHelpers.h>
290#endif
291
Jeremy Hylton22308652001-02-02 03:23:09 +0000292#endif
293
Skip Montanaro7befb992004-02-10 16:50:21 +0000294#include <stddef.h>
Martin v. Löwisa45ecae2001-06-24 21:28:42 +0000295
Neal Norwitz39d22e52002-11-02 19:55:21 +0000296#ifndef O_NONBLOCK
297# define O_NONBLOCK O_NDELAY
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000298#endif
299
Trent Micka708d6e2004-09-07 17:48:26 +0000300/* include Python's addrinfo.h unless it causes trouble */
301#if defined(__sgi) && _COMPILER_VERSION>700 && defined(_SS_ALIGNSIZE)
302 /* Do not include addinfo.h on some newer IRIX versions.
303 * _SS_ALIGNSIZE is defined in sys/socket.h by 6.5.21,
304 * for example, but not by 6.5.10.
305 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000306#elif defined(_MSC_VER) && _MSC_VER>1201
Trent Micka708d6e2004-09-07 17:48:26 +0000307 /* Do not include addrinfo.h for MSVC7 or greater. 'addrinfo' and
308 * EAI_* constants are defined in (the already included) ws2tcpip.h.
309 */
310#else
311# include "addrinfo.h"
312#endif
Jason Tishlerc246cb72004-08-09 13:25:59 +0000313
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000314#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +0000315#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000316int inet_pton(int af, const char *src, void *dst);
Martin v. Löwisc925b1532001-07-21 09:42:15 +0000317const char *inet_ntop(int af, const void *src, char *dst, socklen_t size);
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000318#endif
Christian Heimesb6150692007-11-15 23:37:07 +0000319#endif
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000320
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000321#ifdef __APPLE__
322/* On OS X, getaddrinfo returns no error indication of lookup
323 failure, so we must use the emulation instead of the libinfo
324 implementation. Unfortunately, performing an autoconf test
325 for this bug would require DNS access for the machine performing
326 the configuration, which is not acceptable. Therefore, we
327 determine the bug just by checking for __APPLE__. If this bug
328 gets ever fixed, perhaps checking for sys/version.h would be
329 appropriate, which is 10/0 on the system with the bug. */
Jack Jansen84262fb2002-07-02 14:40:42 +0000330#ifndef HAVE_GETNAMEINFO
331/* This bug seems to be fixed in Jaguar. Ths easiest way I could
332 Find to check for Jaguar is that it has getnameinfo(), which
333 older releases don't have */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000334#undef HAVE_GETADDRINFO
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000335#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +0000336
337#ifdef HAVE_INET_ATON
338#define USE_INET_ATON_WEAKLINK
339#endif
340
Jack Jansen84262fb2002-07-02 14:40:42 +0000341#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000342
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000343/* I know this is a bad practice, but it is the easiest... */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000344#if !defined(HAVE_GETADDRINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000345/* avoid clashes with the C library definition of the symbol. */
346#define getaddrinfo fake_getaddrinfo
347#define gai_strerror fake_gai_strerror
348#define freeaddrinfo fake_freeaddrinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000349#include "getaddrinfo.c"
350#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000351#if !defined(HAVE_GETNAMEINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000352#define getnameinfo fake_getnameinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000353#include "getnameinfo.c"
354#endif
355
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000356#ifdef MS_WINDOWS
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000357#define SOCKETCLOSE closesocket
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000358#endif
359
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000360#ifdef MS_WIN32
Kristján Valur Jónsson310052c2012-03-31 13:35:00 +0000361#undef EAFNOSUPPORT
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000362#define EAFNOSUPPORT WSAEAFNOSUPPORT
363#define snprintf _snprintf
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000364#endif
Fred Drakea04eaad2000-06-30 02:46:07 +0000365
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000366#ifndef SOCKETCLOSE
367#define SOCKETCLOSE close
368#endif
369
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000370#if (defined(HAVE_BLUETOOTH_H) || defined(HAVE_BLUETOOTH_BLUETOOTH_H)) && !defined(__NetBSD__) && !defined(__DragonFly__)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000371#define USE_BLUETOOTH 1
372#if defined(__FreeBSD__)
373#define BTPROTO_L2CAP BLUETOOTH_PROTO_L2CAP
374#define BTPROTO_RFCOMM BLUETOOTH_PROTO_RFCOMM
Thomas Wouterscf297e42007-02-23 15:07:44 +0000375#define BTPROTO_HCI BLUETOOTH_PROTO_HCI
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000376#define SOL_HCI SOL_HCI_RAW
377#define HCI_FILTER SO_HCI_RAW_FILTER
Hye-Shik Chang81268602004-02-02 06:05:24 +0000378#define sockaddr_l2 sockaddr_l2cap
379#define sockaddr_rc sockaddr_rfcomm
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000380#define hci_dev hci_node
Hye-Shik Chang81268602004-02-02 06:05:24 +0000381#define _BT_L2_MEMB(sa, memb) ((sa)->l2cap_##memb)
382#define _BT_RC_MEMB(sa, memb) ((sa)->rfcomm_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000383#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000384#elif defined(__NetBSD__) || defined(__DragonFly__)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000385#define sockaddr_l2 sockaddr_bt
386#define sockaddr_rc sockaddr_bt
Thomas Wouterscf297e42007-02-23 15:07:44 +0000387#define sockaddr_hci sockaddr_bt
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000388#define sockaddr_sco sockaddr_bt
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000389#define SOL_HCI BTPROTO_HCI
390#define HCI_DATA_DIR SO_HCI_DIRECTION
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000391#define _BT_L2_MEMB(sa, memb) ((sa)->bt_##memb)
392#define _BT_RC_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000393#define _BT_HCI_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000394#define _BT_SCO_MEMB(sa, memb) ((sa)->bt_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000395#else
Hye-Shik Chang81268602004-02-02 06:05:24 +0000396#define _BT_L2_MEMB(sa, memb) ((sa)->l2_##memb)
397#define _BT_RC_MEMB(sa, memb) ((sa)->rc_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000398#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000399#define _BT_SCO_MEMB(sa, memb) ((sa)->sco_##memb)
400#endif
401#endif
402
Charles-François Natali8b759652011-12-23 16:44:51 +0100403/* Convert "sock_addr_t *" to "struct sockaddr *". */
404#define SAS2SA(x) (&((x)->sa))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000405
Martin v. Löwise9416172003-05-03 10:12:45 +0000406/*
407 * Constants for getnameinfo()
408 */
409#if !defined(NI_MAXHOST)
410#define NI_MAXHOST 1025
411#endif
412#if !defined(NI_MAXSERV)
413#define NI_MAXSERV 32
414#endif
415
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000416#ifndef INVALID_SOCKET /* MS defines this */
417#define INVALID_SOCKET (-1)
418#endif
419
Charles-François Natali0cc86852013-09-13 19:53:08 +0200420#ifndef INADDR_NONE
421#define INADDR_NONE (-1)
422#endif
423
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000424/* XXX There's a problem here: *static* functions are not supposed to have
425 a Py prefix (or use CapitalizedWords). Later... */
426
Guido van Rossum30a685f1991-06-27 15:51:29 +0000427/* Global variable holding the exception type for errors detected
428 by this module (but not argument type or memory errors, etc.). */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000429static PyObject *socket_herror;
430static PyObject *socket_gaierror;
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000431static PyObject *socket_timeout;
Guido van Rossum30a685f1991-06-27 15:51:29 +0000432
Tim Peters643a7fc2002-02-17 04:13:21 +0000433/* A forward reference to the socket type object.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000434 The sock_type variable contains pointers to various functions,
435 some of which call new_sockobject(), which uses sock_type, so
Tim Peters643a7fc2002-02-17 04:13:21 +0000436 there has to be a circular reference. */
Jeremy Hylton938ace62002-07-17 16:30:39 +0000437static PyTypeObject sock_type;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000438
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000439#if defined(HAVE_POLL_H)
440#include <poll.h>
441#elif defined(HAVE_SYS_POLL_H)
442#include <sys/poll.h>
443#endif
444
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000445/* Largest value to try to store in a socklen_t (used when handling
446 ancillary data). POSIX requires socklen_t to hold at least
447 (2**31)-1 and recommends against storing larger values, but
448 socklen_t was originally int in the BSD interface, so to be on the
449 safe side we use the smaller of (2**31)-1 and INT_MAX. */
450#if INT_MAX > 0x7fffffff
451#define SOCKLEN_T_LIMIT 0x7fffffff
452#else
453#define SOCKLEN_T_LIMIT INT_MAX
454#endif
455
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200456#ifdef HAVE_POLL
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000457/* Instead of select(), we'll use poll() since poll() works on any fd. */
458#define IS_SELECTABLE(s) 1
459/* Can we call select() with this socket without a buffer overrun? */
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000460#else
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200461/* If there's no timeout left, we don't have to call select, so it's a safe,
462 * little white lie. */
Victor Stinner71694d52015-03-28 01:18:54 +0100463#define IS_SELECTABLE(s) (_PyIsSelectable_fd((s)->sock_fd) || (s)->sock_timeout <= 0)
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000464#endif
Neal Norwitz082b2df2006-02-07 07:04:46 +0000465
466static PyObject*
467select_error(void)
468{
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200469 PyErr_SetString(PyExc_OSError, "unable to select on socket");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 return NULL;
Neal Norwitz082b2df2006-02-07 07:04:46 +0000471}
472
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000473#ifdef MS_WINDOWS
Antoine Pitrouc8f01962010-09-28 22:03:27 +0000474#ifndef WSAEAGAIN
475#define WSAEAGAIN WSAEWOULDBLOCK
476#endif
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000477#define CHECK_ERRNO(expected) \
478 (WSAGetLastError() == WSA ## expected)
479#else
480#define CHECK_ERRNO(expected) \
481 (errno == expected)
482#endif
483
Victor Stinnerdaf45552013-08-28 00:53:59 +0200484#ifdef MS_WINDOWS
Victor Stinner81c41db2015-04-02 11:50:57 +0200485# define GET_SOCK_ERROR WSAGetLastError()
486# define SET_SOCK_ERROR(err) WSASetLastError(err)
487# define SOCK_TIMEOUT_ERR WSAEWOULDBLOCK
488# define SOCK_INPROGRESS_ERR WSAEWOULDBLOCK
489#else
490# define GET_SOCK_ERROR errno
491# define SET_SOCK_ERROR(err) do { errno = err; } while (0)
492# define SOCK_TIMEOUT_ERR EWOULDBLOCK
493# define SOCK_INPROGRESS_ERR EINPROGRESS
494#endif
495
496
497#ifdef MS_WINDOWS
Victor Stinnerdaf45552013-08-28 00:53:59 +0200498/* Does WSASocket() support the WSA_FLAG_NO_HANDLE_INHERIT flag? */
499static int support_wsa_no_inherit = -1;
500#endif
501
Guido van Rossum30a685f1991-06-27 15:51:29 +0000502/* Convenience function to raise an error according to errno
503 and return a NULL pointer from a function. */
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000504
Guido van Rossum73624e91994-10-10 17:59:00 +0000505static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000506set_error(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000507{
Guido van Rossum8d665e61996-06-26 18:22:49 +0000508#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 int err_no = WSAGetLastError();
510 /* PyErr_SetExcFromWindowsErr() invokes FormatMessage() which
511 recognizes the error codes used by both GetLastError() and
512 WSAGetLastError */
513 if (err_no)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200514 return PyErr_SetExcFromWindowsErr(PyExc_OSError, err_no);
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000515#endif
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000516
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200517 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000518}
519
Guido van Rossum30a685f1991-06-27 15:51:29 +0000520
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000521static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000522set_herror(int h_error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000523{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000525
526#ifdef HAVE_HSTRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 v = Py_BuildValue("(is)", h_error, (char *)hstrerror(h_error));
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000528#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 v = Py_BuildValue("(is)", h_error, "host not found");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000530#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (v != NULL) {
532 PyErr_SetObject(socket_herror, v);
533 Py_DECREF(v);
534 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000537}
538
539
540static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000541set_gaierror(int error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000542{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000544
Martin v. Löwis272cb402002-03-01 08:31:07 +0000545#ifdef EAI_SYSTEM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 /* EAI_SYSTEM is not available on Windows XP. */
547 if (error == EAI_SYSTEM)
548 return set_error();
Martin v. Löwis272cb402002-03-01 08:31:07 +0000549#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000550
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000551#ifdef HAVE_GAI_STRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 v = Py_BuildValue("(is)", error, gai_strerror(error));
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000553#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 v = Py_BuildValue("(is)", error, "getaddrinfo failed");
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000555#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 if (v != NULL) {
557 PyErr_SetObject(socket_gaierror, v);
558 Py_DECREF(v);
559 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000562}
563
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000564/* Function to perform the setting of socket blocking mode
565 internally. block = (1 | 0). */
Guido van Rossum67f7a382002-06-06 21:08:16 +0000566static int
567internal_setblocking(PySocketSockObject *s, int block)
568{
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200569#ifdef MS_WINDOWS
570 u_long arg;
571#endif
Victor Stinner9a954832013-12-04 00:41:24 +0100572#if !defined(MS_WINDOWS) \
Christian Heimesaf01f662013-12-21 16:19:10 +0100573 && !((defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO)))
Victor Stinner9a954832013-12-04 00:41:24 +0100574 int delay_flag, new_delay_flag;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000575#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +0000576#ifdef SOCK_NONBLOCK
577 if (block)
578 s->sock_type &= (~SOCK_NONBLOCK);
579 else
580 s->sock_type |= SOCK_NONBLOCK;
581#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 Py_BEGIN_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000584#ifndef MS_WINDOWS
Christian Heimesaf01f662013-12-21 16:19:10 +0100585#if (defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 block = !block;
587 ioctl(s->sock_fd, FIONBIO, (unsigned int *)&block);
Victor Stinner9a954832013-12-04 00:41:24 +0100588#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 delay_flag = fcntl(s->sock_fd, F_GETFL, 0);
590 if (block)
Victor Stinner9a954832013-12-04 00:41:24 +0100591 new_delay_flag = delay_flag & (~O_NONBLOCK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 else
Victor Stinner9a954832013-12-04 00:41:24 +0100593 new_delay_flag = delay_flag | O_NONBLOCK;
594 if (new_delay_flag != delay_flag)
595 fcntl(s->sock_fd, F_SETFL, new_delay_flag);
596#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000597#else /* MS_WINDOWS */
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200598 arg = !block;
599 ioctlsocket(s->sock_fd, FIONBIO, &arg);
Guido van Rossum67f7a382002-06-06 21:08:16 +0000600#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 /* Since these don't return anything */
604 return 1;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000605}
606
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000607static int
Victor Stinner81c41db2015-04-02 11:50:57 +0200608internal_select(PySocketSockObject *s, int writing, _PyTime_t interval,
609 int connect)
Guido van Rossum67f7a382002-06-06 21:08:16 +0000610{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 int n;
Victor Stinner71694d52015-03-28 01:18:54 +0100612#ifdef HAVE_POLL
613 struct pollfd pollfd;
Victor Stinnere6951c62015-03-31 13:50:44 +0200614 _PyTime_t ms;
Victor Stinner71694d52015-03-28 01:18:54 +0100615#else
Victor Stinner416f2e62015-03-31 13:56:29 +0200616 fd_set fds, efds;
Victor Stinnerced11742015-04-09 10:27:25 +0200617 struct timeval tv, *tvp;
Victor Stinner71694d52015-03-28 01:18:54 +0100618#endif
Guido van Rossum11ba0942002-06-13 15:07:44 +0000619
Victor Stinnerb7df3142015-03-27 22:59:32 +0100620#ifdef WITH_THREAD
621 /* must be called with the GIL held */
622 assert(PyGILState_Check());
623#endif
624
Victor Stinner416f2e62015-03-31 13:56:29 +0200625 /* Error condition is for output only */
Victor Stinner81c41db2015-04-02 11:50:57 +0200626 assert(!(connect && !writing));
Guido van Rossum67f7a382002-06-06 21:08:16 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 /* Guard against closed socket */
629 if (s->sock_fd < 0)
630 return 0;
Guido van Rossumad654902002-07-19 12:44:59 +0000631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 /* Prefer poll, if available, since you can poll() any fd
633 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000634#ifdef HAVE_POLL
Victor Stinner71694d52015-03-28 01:18:54 +0100635 pollfd.fd = s->sock_fd;
636 pollfd.events = writing ? POLLOUT : POLLIN;
Victor Stinner81c41db2015-04-02 11:50:57 +0200637 if (connect) {
638 /* On Windows, the socket becomes writable on connection success,
639 but a connection failure is notified as an error. On POSIX, the
640 socket becomes writable on connection success or on connection
641 failure. */
Victor Stinner416f2e62015-03-31 13:56:29 +0200642 pollfd.events |= POLLERR;
Victor Stinner81c41db2015-04-02 11:50:57 +0200643 }
Guido van Rossum67f7a382002-06-06 21:08:16 +0000644
Victor Stinner71694d52015-03-28 01:18:54 +0100645 /* s->sock_timeout is in seconds, timeout in ms */
Victor Stinner10550cd2015-04-03 13:22:27 +0200646 ms = _PyTime_AsMilliseconds(interval, _PyTime_ROUND_CEILING);
Victor Stinnere6951c62015-03-31 13:50:44 +0200647 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000648
Victor Stinner71694d52015-03-28 01:18:54 +0100649 Py_BEGIN_ALLOW_THREADS;
Victor Stinnere6951c62015-03-31 13:50:44 +0200650 n = poll(&pollfd, 1, (int)ms);
Victor Stinner71694d52015-03-28 01:18:54 +0100651 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000652#else
Victor Stinnerced11742015-04-09 10:27:25 +0200653 if (interval >= 0) {
654 _PyTime_AsTimeval_noraise(interval, &tv, _PyTime_ROUND_CEILING);
655 tvp = &tv;
656 }
657 else
658 tvp = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000659
Victor Stinner71694d52015-03-28 01:18:54 +0100660 FD_ZERO(&fds);
661 FD_SET(s->sock_fd, &fds);
Victor Stinner416f2e62015-03-31 13:56:29 +0200662 FD_ZERO(&efds);
Victor Stinner81c41db2015-04-02 11:50:57 +0200663 if (connect) {
664 /* On Windows, the socket becomes writable on connection success,
665 but a connection failure is notified as an error. On POSIX, the
666 socket becomes writable on connection success or on connection
667 failure. */
Victor Stinner416f2e62015-03-31 13:56:29 +0200668 FD_SET(s->sock_fd, &efds);
Victor Stinner81c41db2015-04-02 11:50:57 +0200669 }
Victor Stinner71694d52015-03-28 01:18:54 +0100670
671 /* See if the socket is ready */
672 Py_BEGIN_ALLOW_THREADS;
673 if (writing)
674 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinnerced11742015-04-09 10:27:25 +0200675 NULL, &fds, &efds, tvp);
Victor Stinner71694d52015-03-28 01:18:54 +0100676 else
677 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinnerced11742015-04-09 10:27:25 +0200678 &fds, NULL, &efds, tvp);
Victor Stinner71694d52015-03-28 01:18:54 +0100679 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000680#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 if (n < 0)
683 return -1;
684 if (n == 0)
685 return 1;
686 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000687}
688
Victor Stinner31bf2d52015-04-01 21:57:09 +0200689/* Call a socket function.
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000690
Victor Stinner81c41db2015-04-02 11:50:57 +0200691 On error, raise an exception and return -1 if err is set, or fill err and
692 return -1 otherwise. If a signal was received and the signal handler raised
693 an exception, return -1, and set err to -1 if err is set.
694
695 On success, return 0, and set err to 0 if err is set.
Victor Stinnerb7df3142015-03-27 22:59:32 +0100696
Victor Stinner31bf2d52015-04-01 21:57:09 +0200697 If the socket has a timeout, wait until the socket is ready before calling
698 the function: wait until the socket is writable if writing is nonzero, wait
699 until the socket received data otherwise.
Victor Stinnerb7df3142015-03-27 22:59:32 +0100700
Victor Stinner81c41db2015-04-02 11:50:57 +0200701 If the socket function is interrupted by a signal (failed with EINTR): retry
Victor Stinner31bf2d52015-04-01 21:57:09 +0200702 the function, except if the signal handler raised an exception (PEP 475).
703
704 When the function is retried, recompute the timeout using a monotonic clock.
705
Victor Stinner81c41db2015-04-02 11:50:57 +0200706 sock_call_ex() must be called with the GIL held. The socket function is
707 called with the GIL released. */
Victor Stinner31bf2d52015-04-01 21:57:09 +0200708static int
Victor Stinner81c41db2015-04-02 11:50:57 +0200709sock_call_ex(PySocketSockObject *s,
710 int writing,
711 int (*sock_func) (PySocketSockObject *s, void *data),
712 void *data,
713 int connect,
Victor Stinner8912d142015-04-06 23:16:34 +0200714 int *err,
715 _PyTime_t timeout)
Victor Stinner31bf2d52015-04-01 21:57:09 +0200716{
Victor Stinner8912d142015-04-06 23:16:34 +0200717 int has_timeout = (timeout > 0);
Victor Stinner31bf2d52015-04-01 21:57:09 +0200718 _PyTime_t deadline = 0;
719 int deadline_initialized = 0;
720 int res;
721
722 /* sock_call() must be called with the GIL held. */
723 assert(PyGILState_Check());
724
725 /* outer loop to retry select() when select() is interrupted by a signal
Victor Stinner81c41db2015-04-02 11:50:57 +0200726 or to retry select()+sock_func() on false positive (see above) */
Victor Stinner31bf2d52015-04-01 21:57:09 +0200727 while (1) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200728 /* For connect(), poll even for blocking socket. The connection
729 runs asynchronously. */
730 if (has_timeout || connect) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200731 if (has_timeout) {
Victor Stinner10550cd2015-04-03 13:22:27 +0200732 _PyTime_t interval;
733
Victor Stinner81c41db2015-04-02 11:50:57 +0200734 if (deadline_initialized) {
735 /* recompute the timeout */
736 interval = deadline - _PyTime_GetMonotonicClock();
737 }
738 else {
739 deadline_initialized = 1;
Victor Stinner8912d142015-04-06 23:16:34 +0200740 deadline = _PyTime_GetMonotonicClock() + timeout;
741 interval = timeout;
Victor Stinner81c41db2015-04-02 11:50:57 +0200742 }
Victor Stinner31bf2d52015-04-01 21:57:09 +0200743
Victor Stinner10550cd2015-04-03 13:22:27 +0200744 if (interval >= 0)
745 res = internal_select(s, writing, interval, connect);
746 else
747 res = 1;
748 }
749 else {
Victor Stinner222dfc72015-04-06 22:30:41 +0200750 res = internal_select(s, writing, timeout, connect);
Victor Stinner10550cd2015-04-03 13:22:27 +0200751 }
752
Victor Stinner31bf2d52015-04-01 21:57:09 +0200753 if (res == -1) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200754 if (err)
755 *err = GET_SOCK_ERROR;
756
Victor Stinner31bf2d52015-04-01 21:57:09 +0200757 if (CHECK_ERRNO(EINTR)) {
758 /* select() was interrupted by a signal */
Victor Stinner81c41db2015-04-02 11:50:57 +0200759 if (PyErr_CheckSignals()) {
760 if (err)
761 *err = -1;
Victor Stinner31bf2d52015-04-01 21:57:09 +0200762 return -1;
Victor Stinner81c41db2015-04-02 11:50:57 +0200763 }
Victor Stinner31bf2d52015-04-01 21:57:09 +0200764
765 /* retry select() */
766 continue;
767 }
768
769 /* select() failed */
770 s->errorhandler();
771 return -1;
772 }
773
774 if (res == 1) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200775 if (err)
776 *err = SOCK_TIMEOUT_ERR;
777 else
778 PyErr_SetString(socket_timeout, "timed out");
Victor Stinner31bf2d52015-04-01 21:57:09 +0200779 return -1;
780 }
781
782 /* the socket is ready */
783 }
784
Victor Stinner81c41db2015-04-02 11:50:57 +0200785 /* inner loop to retry sock_func() when sock_func() is interrupted
786 by a signal */
Victor Stinner31bf2d52015-04-01 21:57:09 +0200787 while (1) {
788 Py_BEGIN_ALLOW_THREADS
Victor Stinner81c41db2015-04-02 11:50:57 +0200789 res = sock_func(s, data);
Victor Stinner31bf2d52015-04-01 21:57:09 +0200790 Py_END_ALLOW_THREADS
791
792 if (res) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200793 /* sock_func() succeeded */
794 if (err)
795 *err = 0;
Victor Stinner31bf2d52015-04-01 21:57:09 +0200796 return 0;
797 }
798
Victor Stinner81c41db2015-04-02 11:50:57 +0200799 if (err)
800 *err = GET_SOCK_ERROR;
801
Victor Stinner31bf2d52015-04-01 21:57:09 +0200802 if (!CHECK_ERRNO(EINTR))
803 break;
804
Victor Stinner81c41db2015-04-02 11:50:57 +0200805 /* sock_func() was interrupted by a signal */
806 if (PyErr_CheckSignals()) {
807 if (err)
808 *err = -1;
Victor Stinner31bf2d52015-04-01 21:57:09 +0200809 return -1;
Victor Stinner81c41db2015-04-02 11:50:57 +0200810 }
Victor Stinner31bf2d52015-04-01 21:57:09 +0200811
Victor Stinner81c41db2015-04-02 11:50:57 +0200812 /* retry sock_func() */
Victor Stinner31bf2d52015-04-01 21:57:09 +0200813 }
814
815 if (s->sock_timeout > 0
816 && (CHECK_ERRNO(EWOULDBLOCK) || CHECK_ERRNO(EAGAIN))) {
Victor Stinner81c41db2015-04-02 11:50:57 +0200817 /* False positive: sock_func() failed with EWOULDBLOCK or EAGAIN.
Victor Stinner31bf2d52015-04-01 21:57:09 +0200818
819 For example, select() could indicate a socket is ready for
820 reading, but the data then discarded by the OS because of a
821 wrong checksum.
822
823 Loop on select() to recheck for socket readyness. */
824 continue;
825 }
826
Victor Stinner81c41db2015-04-02 11:50:57 +0200827 /* sock_func() failed */
828 if (!err)
829 s->errorhandler();
830 /* else: err was already set before */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000831 return -1;
832 }
Victor Stinner31bf2d52015-04-01 21:57:09 +0200833}
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000834
Victor Stinner81c41db2015-04-02 11:50:57 +0200835static int
836sock_call(PySocketSockObject *s,
837 int writing,
838 int (*func) (PySocketSockObject *s, void *data),
839 void *data)
840{
Victor Stinner8912d142015-04-06 23:16:34 +0200841 return sock_call_ex(s, writing, func, data, 0, NULL, s->sock_timeout);
Victor Stinner81c41db2015-04-02 11:50:57 +0200842}
843
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000844
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000845/* Initialize a new socket object. */
846
Victor Stinner88ed6402015-04-09 10:23:12 +0200847/* Default timeout for new sockets */
848static _PyTime_t defaulttimeout = _PYTIME_FROMSECONDS(-1);
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000849
Martin v. Löwis1a214512008-06-11 05:26:20 +0000850static void
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000851init_sockobject(PySocketSockObject *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 SOCKET_T fd, int family, int type, int proto)
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000853{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 s->sock_fd = fd;
855 s->sock_family = family;
856 s->sock_type = type;
857 s->sock_proto = proto;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 s->errorhandler = &set_error;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000860#ifdef SOCK_NONBLOCK
861 if (type & SOCK_NONBLOCK)
Victor Stinner71694d52015-03-28 01:18:54 +0100862 s->sock_timeout = 0;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000863 else
864#endif
865 {
866 s->sock_timeout = defaulttimeout;
Victor Stinner71694d52015-03-28 01:18:54 +0100867 if (defaulttimeout >= 0)
Antoine Pitroub1c54962010-10-14 15:05:38 +0000868 internal_setblocking(s, 0);
869 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000870
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000871}
872
873
Guido van Rossum30a685f1991-06-27 15:51:29 +0000874/* Create a new socket object.
875 This just creates the object and initializes it.
876 If the creation fails, return NULL and set an exception (implicit
877 in NEWOBJ()). */
878
Guido van Rossum73624e91994-10-10 17:59:00 +0000879static PySocketSockObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000880new_sockobject(SOCKET_T fd, int family, int type, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000881{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 PySocketSockObject *s;
883 s = (PySocketSockObject *)
884 PyType_GenericNew(&sock_type, NULL, NULL);
885 if (s != NULL)
886 init_sockobject(s, fd, family, type, proto);
887 return s;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000888}
889
Guido van Rossum30a685f1991-06-27 15:51:29 +0000890
Guido van Rossum48a680c2001-03-02 06:34:14 +0000891/* Lock to allow python interpreter to continue, but only allow one
Just van Rossum1040d2c2003-05-09 07:53:18 +0000892 thread to be in gethostbyname or getaddrinfo */
893#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Matthias Klosed182a6c2012-08-14 17:29:04 +0200894static PyThread_type_lock netdb_lock;
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000895#endif
896
897
Guido van Rossum30a685f1991-06-27 15:51:29 +0000898/* Convert a string specifying a host name or one of a few symbolic
899 names to a numeric IP address. This usually calls gethostbyname()
900 to do the work; the names "" and "<broadcast>" are special.
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000901 Return the length (IPv4 should be 4 bytes), or negative if
Guido van Rossum30a685f1991-06-27 15:51:29 +0000902 an error occurred; then an exception is raised. */
903
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000904static int
Martin v. Löwisddc6f472002-07-28 16:10:31 +0000905setipaddr(char *name, struct sockaddr *addr_ret, size_t addr_ret_size, int af)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 struct addrinfo hints, *res;
908 int error;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000909
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000910 memset((void *) addr_ret, '\0', sizeof(*addr_ret));
911 if (name[0] == '\0') {
912 int siz;
913 memset(&hints, 0, sizeof(hints));
914 hints.ai_family = af;
915 hints.ai_socktype = SOCK_DGRAM; /*dummy*/
916 hints.ai_flags = AI_PASSIVE;
917 Py_BEGIN_ALLOW_THREADS
918 ACQUIRE_GETADDRINFO_LOCK
919 error = getaddrinfo(NULL, "0", &hints, &res);
920 Py_END_ALLOW_THREADS
921 /* We assume that those thread-unsafe getaddrinfo() versions
922 *are* safe regarding their return value, ie. that a
923 subsequent call to getaddrinfo() does not destroy the
924 outcome of the first call. */
925 RELEASE_GETADDRINFO_LOCK
926 if (error) {
927 set_gaierror(error);
928 return -1;
929 }
930 switch (res->ai_family) {
931 case AF_INET:
932 siz = 4;
933 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000934#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 case AF_INET6:
936 siz = 16;
937 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000938#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 default:
940 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200941 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 "unsupported address family");
943 return -1;
944 }
945 if (res->ai_next) {
946 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200947 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 "wildcard resolved to multiple address");
949 return -1;
950 }
951 if (res->ai_addrlen < addr_ret_size)
952 addr_ret_size = res->ai_addrlen;
953 memcpy(addr_ret, res->ai_addr, addr_ret_size);
954 freeaddrinfo(res);
955 return siz;
956 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200957 /* special-case broadcast - inet_addr() below can return INADDR_NONE for
Victor Stinnere990c6e2013-11-16 00:18:58 +0100958 * this */
Charles-François Natali0cc86852013-09-13 19:53:08 +0200959 if (strcmp(name, "255.255.255.255") == 0 ||
960 strcmp(name, "<broadcast>") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 struct sockaddr_in *sin;
962 if (af != AF_INET && af != AF_UNSPEC) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200963 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 "address family mismatched");
965 return -1;
966 }
967 sin = (struct sockaddr_in *)addr_ret;
968 memset((void *) sin, '\0', sizeof(*sin));
969 sin->sin_family = AF_INET;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000970#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 sin->sin_len = sizeof(*sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000972#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 sin->sin_addr.s_addr = INADDR_BROADCAST;
974 return sizeof(sin->sin_addr);
975 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200976
977 /* avoid a name resolution in case of numeric address */
978#ifdef HAVE_INET_PTON
979 /* check for an IPv4 address */
980 if (af == AF_UNSPEC || af == AF_INET) {
981 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
982 memset(sin, 0, sizeof(*sin));
983 if (inet_pton(AF_INET, name, &sin->sin_addr) > 0) {
984 sin->sin_family = AF_INET;
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000985#ifdef HAVE_SOCKADDR_SA_LEN
Charles-François Natali0cc86852013-09-13 19:53:08 +0200986 sin->sin_len = sizeof(*sin);
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000987#endif
Charles-François Natali0cc86852013-09-13 19:53:08 +0200988 return 4;
989 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200991#ifdef ENABLE_IPV6
992 /* check for an IPv6 address - if the address contains a scope ID, we
993 * fallback to getaddrinfo(), which can handle translation from interface
994 * name to interface index */
995 if ((af == AF_UNSPEC || af == AF_INET6) && !strchr(name, '%')) {
996 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)addr_ret;
997 memset(sin, 0, sizeof(*sin));
998 if (inet_pton(AF_INET6, name, &sin->sin6_addr) > 0) {
999 sin->sin6_family = AF_INET6;
1000#ifdef HAVE_SOCKADDR_SA_LEN
1001 sin->sin6_len = sizeof(*sin);
1002#endif
1003 return 16;
1004 }
1005 }
1006#endif /* ENABLE_IPV6 */
1007#else /* HAVE_INET_PTON */
1008 /* check for an IPv4 address */
1009 if (af == AF_INET || af == AF_UNSPEC) {
1010 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
1011 memset(sin, 0, sizeof(*sin));
1012 if ((sin->sin_addr.s_addr = inet_addr(name)) != INADDR_NONE) {
1013 sin->sin_family = AF_INET;
1014#ifdef HAVE_SOCKADDR_SA_LEN
1015 sin->sin_len = sizeof(*sin);
1016#endif
1017 return 4;
1018 }
Victor Stinnere990c6e2013-11-16 00:18:58 +01001019 }
Charles-François Natali0cc86852013-09-13 19:53:08 +02001020#endif /* HAVE_INET_PTON */
1021
1022 /* perform a name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 memset(&hints, 0, sizeof(hints));
1024 hints.ai_family = af;
1025 Py_BEGIN_ALLOW_THREADS
1026 ACQUIRE_GETADDRINFO_LOCK
1027 error = getaddrinfo(name, NULL, &hints, &res);
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +00001028#if defined(__digital__) && defined(__unix__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 if (error == EAI_NONAME && af == AF_UNSPEC) {
1030 /* On Tru64 V5.1, numeric-to-addr conversion fails
1031 if no address family is given. Assume IPv4 for now.*/
1032 hints.ai_family = AF_INET;
1033 error = getaddrinfo(name, NULL, &hints, &res);
1034 }
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +00001035#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 Py_END_ALLOW_THREADS
1037 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
1038 if (error) {
1039 set_gaierror(error);
1040 return -1;
1041 }
1042 if (res->ai_addrlen < addr_ret_size)
1043 addr_ret_size = res->ai_addrlen;
1044 memcpy((char *) addr_ret, res->ai_addr, addr_ret_size);
1045 freeaddrinfo(res);
1046 switch (addr_ret->sa_family) {
1047 case AF_INET:
1048 return 4;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001049#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 case AF_INET6:
1051 return 16;
Guido van Rossum955becc1999-03-22 20:14:53 +00001052#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001054 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return -1;
1056 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001057}
1058
Guido van Rossum30a685f1991-06-27 15:51:29 +00001059
Guido van Rossum30a685f1991-06-27 15:51:29 +00001060/* Create a string object representing an IP address.
1061 This is always a string of the form 'dd.dd.dd.dd' (with variable
1062 size numbers). */
1063
Guido van Rossum73624e91994-10-10 17:59:00 +00001064static PyObject *
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001065makeipaddr(struct sockaddr *addr, int addrlen)
Guido van Rossum30a685f1991-06-27 15:51:29 +00001066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 char buf[NI_MAXHOST];
1068 int error;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 error = getnameinfo(addr, addrlen, buf, sizeof(buf), NULL, 0,
1071 NI_NUMERICHOST);
1072 if (error) {
1073 set_gaierror(error);
1074 return NULL;
1075 }
1076 return PyUnicode_FromString(buf);
Guido van Rossum30a685f1991-06-27 15:51:29 +00001077}
1078
1079
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001080#ifdef USE_BLUETOOTH
1081/* Convert a string representation of a Bluetooth address into a numeric
1082 address. Returns the length (6), or raises an exception and returns -1 if
1083 an error occurred. */
1084
1085static int
1086setbdaddr(char *name, bdaddr_t *bdaddr)
1087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 unsigned int b0, b1, b2, b3, b4, b5;
1089 char ch;
1090 int n;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 n = sscanf(name, "%X:%X:%X:%X:%X:%X%c",
1093 &b5, &b4, &b3, &b2, &b1, &b0, &ch);
1094 if (n == 6 && (b0 | b1 | b2 | b3 | b4 | b5) < 256) {
1095 bdaddr->b[0] = b0;
1096 bdaddr->b[1] = b1;
1097 bdaddr->b[2] = b2;
1098 bdaddr->b[3] = b3;
1099 bdaddr->b[4] = b4;
1100 bdaddr->b[5] = b5;
1101 return 6;
1102 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001103 PyErr_SetString(PyExc_OSError, "bad bluetooth address");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 return -1;
1105 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001106}
1107
1108/* Create a string representation of the Bluetooth address. This is always a
1109 string of the form 'XX:XX:XX:XX:XX:XX' where XX is a two digit hexadecimal
1110 value (zero padded if necessary). */
1111
1112static PyObject *
1113makebdaddr(bdaddr_t *bdaddr)
1114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 char buf[(6 * 2) + 5 + 1];
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 sprintf(buf, "%02X:%02X:%02X:%02X:%02X:%02X",
1118 bdaddr->b[5], bdaddr->b[4], bdaddr->b[3],
1119 bdaddr->b[2], bdaddr->b[1], bdaddr->b[0]);
1120 return PyUnicode_FromString(buf);
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001121}
1122#endif
1123
1124
Guido van Rossum30a685f1991-06-27 15:51:29 +00001125/* Create an object representing the given socket address,
1126 suitable for passing it back to bind(), connect() etc.
1127 The family field of the sockaddr structure is inspected
1128 to determine what kind of address it really is. */
1129
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001130/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00001131static PyObject *
Antoine Pitrou19467d22010-08-17 19:33:30 +00001132makesockaddr(SOCKET_T sockfd, struct sockaddr *addr, size_t addrlen, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 if (addrlen == 0) {
1135 /* No address -- may be recvfrom() from known socket */
1136 Py_INCREF(Py_None);
1137 return Py_None;
1138 }
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 switch (addr->sa_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 case AF_INET:
1143 {
1144 struct sockaddr_in *a;
1145 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1146 PyObject *ret = NULL;
1147 if (addrobj) {
1148 a = (struct sockaddr_in *)addr;
1149 ret = Py_BuildValue("Oi", addrobj, ntohs(a->sin_port));
1150 Py_DECREF(addrobj);
1151 }
1152 return ret;
1153 }
Guido van Rossum30a685f1991-06-27 15:51:29 +00001154
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001155#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 case AF_UNIX:
1157 {
1158 struct sockaddr_un *a = (struct sockaddr_un *) addr;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001159#ifdef linux
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 if (a->sun_path[0] == 0) { /* Linux abstract namespace */
1161 addrlen -= offsetof(struct sockaddr_un, sun_path);
Charles-François Natalib10c71d2013-05-21 10:45:46 +02001162 return PyBytes_FromStringAndSize(a->sun_path, addrlen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 }
1164 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001165#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 {
1167 /* regular NULL-terminated string */
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001168 return PyUnicode_DecodeFSDefault(a->sun_path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 }
1170 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001171#endif /* AF_UNIX */
1172
Martin v. Löwis11017b12006-01-14 18:12:57 +00001173#if defined(AF_NETLINK)
1174 case AF_NETLINK:
1175 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 struct sockaddr_nl *a = (struct sockaddr_nl *) addr;
1177 return Py_BuildValue("II", a->nl_pid, a->nl_groups);
Martin v. Löwis11017b12006-01-14 18:12:57 +00001178 }
1179#endif /* AF_NETLINK */
1180
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001181#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 case AF_INET6:
1183 {
1184 struct sockaddr_in6 *a;
1185 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1186 PyObject *ret = NULL;
1187 if (addrobj) {
1188 a = (struct sockaddr_in6 *)addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01001189 ret = Py_BuildValue("OiII",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 addrobj,
1191 ntohs(a->sin6_port),
Charles-François Natali366999a2012-01-02 15:47:29 +01001192 ntohl(a->sin6_flowinfo),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 a->sin6_scope_id);
1194 Py_DECREF(addrobj);
1195 }
1196 return ret;
1197 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001198#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00001199
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001200#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 case AF_BLUETOOTH:
1202 switch (proto) {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 case BTPROTO_L2CAP:
1205 {
1206 struct sockaddr_l2 *a = (struct sockaddr_l2 *) addr;
1207 PyObject *addrobj = makebdaddr(&_BT_L2_MEMB(a, bdaddr));
1208 PyObject *ret = NULL;
1209 if (addrobj) {
1210 ret = Py_BuildValue("Oi",
1211 addrobj,
1212 _BT_L2_MEMB(a, psm));
1213 Py_DECREF(addrobj);
1214 }
1215 return ret;
1216 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 case BTPROTO_RFCOMM:
1219 {
1220 struct sockaddr_rc *a = (struct sockaddr_rc *) addr;
1221 PyObject *addrobj = makebdaddr(&_BT_RC_MEMB(a, bdaddr));
1222 PyObject *ret = NULL;
1223 if (addrobj) {
1224 ret = Py_BuildValue("Oi",
1225 addrobj,
1226 _BT_RC_MEMB(a, channel));
1227 Py_DECREF(addrobj);
1228 }
1229 return ret;
1230 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 case BTPROTO_HCI:
1233 {
1234 struct sockaddr_hci *a = (struct sockaddr_hci *) addr;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001235#if defined(__NetBSD__) || defined(__DragonFly__)
1236 return makebdaddr(&_BT_HCI_MEMB(a, bdaddr));
1237#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 PyObject *ret = NULL;
1239 ret = Py_BuildValue("i", _BT_HCI_MEMB(a, dev));
1240 return ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001241#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 }
Thomas Wouterscf297e42007-02-23 15:07:44 +00001243
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001244#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 case BTPROTO_SCO:
1246 {
1247 struct sockaddr_sco *a = (struct sockaddr_sco *) addr;
1248 return makebdaddr(&_BT_SCO_MEMB(a, bdaddr));
1249 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001250#endif
1251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 default:
1253 PyErr_SetString(PyExc_ValueError,
1254 "Unknown Bluetooth protocol");
1255 return NULL;
1256 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001257#endif
1258
Antoine Pitroub156a462010-10-27 20:13:57 +00001259#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFNAME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 case AF_PACKET:
1261 {
1262 struct sockaddr_ll *a = (struct sockaddr_ll *)addr;
1263 char *ifname = "";
1264 struct ifreq ifr;
1265 /* need to look up interface name give index */
1266 if (a->sll_ifindex) {
1267 ifr.ifr_ifindex = a->sll_ifindex;
1268 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1269 ifname = ifr.ifr_name;
1270 }
1271 return Py_BuildValue("shbhy#",
1272 ifname,
1273 ntohs(a->sll_protocol),
1274 a->sll_pkttype,
1275 a->sll_hatype,
1276 a->sll_addr,
1277 a->sll_halen);
1278 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001279#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001280
Christian Heimes043d6f62008-01-07 17:19:16 +00001281#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 case AF_TIPC:
1283 {
1284 struct sockaddr_tipc *a = (struct sockaddr_tipc *) addr;
1285 if (a->addrtype == TIPC_ADDR_NAMESEQ) {
1286 return Py_BuildValue("IIIII",
1287 a->addrtype,
1288 a->addr.nameseq.type,
1289 a->addr.nameseq.lower,
1290 a->addr.nameseq.upper,
1291 a->scope);
1292 } else if (a->addrtype == TIPC_ADDR_NAME) {
1293 return Py_BuildValue("IIIII",
1294 a->addrtype,
1295 a->addr.name.name.type,
1296 a->addr.name.name.instance,
1297 a->addr.name.name.instance,
1298 a->scope);
1299 } else if (a->addrtype == TIPC_ADDR_ID) {
1300 return Py_BuildValue("IIIII",
1301 a->addrtype,
1302 a->addr.id.node,
1303 a->addr.id.ref,
1304 0,
1305 a->scope);
1306 } else {
1307 PyErr_SetString(PyExc_ValueError,
1308 "Invalid address type");
1309 return NULL;
1310 }
1311 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001312#endif
1313
Vinay Sajipecfc98c2014-03-20 12:42:42 +00001314#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001315 case AF_CAN:
1316 {
1317 struct sockaddr_can *a = (struct sockaddr_can *)addr;
1318 char *ifname = "";
1319 struct ifreq ifr;
1320 /* need to look up interface name given index */
1321 if (a->can_ifindex) {
1322 ifr.ifr_ifindex = a->can_ifindex;
1323 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1324 ifname = ifr.ifr_name;
1325 }
1326
1327 return Py_BuildValue("O&h", PyUnicode_DecodeFSDefault,
1328 ifname,
1329 a->can_family);
1330 }
1331#endif
1332
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001333#ifdef PF_SYSTEM
1334 case PF_SYSTEM:
1335 switch(proto) {
1336#ifdef SYSPROTO_CONTROL
1337 case SYSPROTO_CONTROL:
1338 {
1339 struct sockaddr_ctl *a = (struct sockaddr_ctl *)addr;
1340 return Py_BuildValue("(II)", a->sc_id, a->sc_unit);
1341 }
1342#endif
1343 default:
1344 PyErr_SetString(PyExc_ValueError,
1345 "Invalid address type");
1346 return 0;
1347 }
1348#endif
1349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 default:
1353 /* If we don't know the address family, don't raise an
1354 exception -- return it as an (int, bytes) tuple. */
1355 return Py_BuildValue("iy#",
1356 addr->sa_family,
1357 addr->sa_data,
1358 sizeof(addr->sa_data));
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001361}
1362
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001363/* Helper for getsockaddrarg: bypass IDNA for ASCII-only host names
1364 (in particular, numeric IP addresses). */
1365struct maybe_idna {
1366 PyObject *obj;
1367 char *buf;
1368};
1369
1370static void
1371idna_cleanup(struct maybe_idna *data)
1372{
1373 Py_CLEAR(data->obj);
1374}
1375
1376static int
1377idna_converter(PyObject *obj, struct maybe_idna *data)
1378{
1379 size_t len;
1380 PyObject *obj2, *obj3;
1381 if (obj == NULL) {
1382 idna_cleanup(data);
1383 return 1;
1384 }
1385 data->obj = NULL;
1386 len = -1;
1387 if (PyBytes_Check(obj)) {
1388 data->buf = PyBytes_AsString(obj);
1389 len = PyBytes_Size(obj);
1390 }
1391 else if (PyByteArray_Check(obj)) {
1392 data->buf = PyByteArray_AsString(obj);
1393 len = PyByteArray_Size(obj);
1394 }
1395 else if (PyUnicode_Check(obj) && PyUnicode_READY(obj) == 0 && PyUnicode_IS_COMPACT_ASCII(obj)) {
1396 data->buf = PyUnicode_DATA(obj);
1397 len = PyUnicode_GET_LENGTH(obj);
1398 }
1399 else {
1400 obj2 = PyUnicode_FromObject(obj);
1401 if (!obj2) {
1402 PyErr_Format(PyExc_TypeError, "string or unicode text buffer expected, not %s",
1403 obj->ob_type->tp_name);
1404 return 0;
1405 }
1406 obj3 = PyUnicode_AsEncodedString(obj2, "idna", NULL);
1407 Py_DECREF(obj2);
1408 if (!obj3) {
1409 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed");
1410 return 0;
1411 }
1412 if (!PyBytes_Check(obj3)) {
Martin v. Löwis17fd1e12014-08-05 16:13:50 +02001413 Py_DECREF(obj3);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001414 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed to return bytes");
1415 return 0;
1416 }
1417 data->obj = obj3;
1418 data->buf = PyBytes_AS_STRING(obj3);
1419 len = PyBytes_GET_SIZE(obj3);
1420 }
1421 if (strlen(data->buf) != len) {
1422 Py_CLEAR(data->obj);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001423 PyErr_SetString(PyExc_TypeError, "host name must not contain null character");
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001424 return 0;
1425 }
1426 return Py_CLEANUP_SUPPORTED;
Victor Stinner1a62a682014-08-17 19:33:28 +02001427}
Guido van Rossum30a685f1991-06-27 15:51:29 +00001428
1429/* Parse a socket address argument according to the socket object's
1430 address family. Return 1 if the address was in the proper format,
1431 0 of not. The address is returned through addr_ret, its length
1432 through len_ret. */
1433
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001434static int
Guido van Rossum48a680c2001-03-02 06:34:14 +00001435getsockaddrarg(PySocketSockObject *s, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 struct sockaddr *addr_ret, int *len_ret)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001437{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 switch (s->sock_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001439
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001440#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 case AF_UNIX:
1442 {
1443 struct sockaddr_un* addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001444 Py_buffer path;
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001445 int retval = 0;
1446
1447 /* PEP 383. Not using PyUnicode_FSConverter since we need to
1448 allow embedded nulls on Linux. */
1449 if (PyUnicode_Check(args)) {
1450 if ((args = PyUnicode_EncodeFSDefault(args)) == NULL)
1451 return 0;
1452 }
1453 else
1454 Py_INCREF(args);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001455 if (!PyArg_Parse(args, "y*", &path)) {
1456 Py_DECREF(args);
1457 return retval;
1458 }
1459 assert(path.len >= 0);
Thomas Wouters89f507f2006-12-13 04:49:30 +00001460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 addr = (struct sockaddr_un*)addr_ret;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001462#ifdef linux
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001463 if (path.len > 0 && *(const char *)path.buf == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 /* Linux abstract namespace extension */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001465 if ((size_t)path.len > sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001466 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001468 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 }
1470 }
1471 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001472#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 {
1474 /* regular NULL-terminated string */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001475 if ((size_t)path.len >= sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001476 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001478 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001480 addr->sun_path[path.len] = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 }
1482 addr->sun_family = s->sock_family;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001483 memcpy(addr->sun_path, path.buf, path.len);
1484 *len_ret = path.len + offsetof(struct sockaddr_un, sun_path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001485 retval = 1;
1486 unix_out:
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001487 PyBuffer_Release(&path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001488 Py_DECREF(args);
1489 return retval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001491#endif /* AF_UNIX */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001492
Martin v. Löwis11017b12006-01-14 18:12:57 +00001493#if defined(AF_NETLINK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 case AF_NETLINK:
1495 {
1496 struct sockaddr_nl* addr;
1497 int pid, groups;
1498 addr = (struct sockaddr_nl *)addr_ret;
1499 if (!PyTuple_Check(args)) {
1500 PyErr_Format(
1501 PyExc_TypeError,
1502 "getsockaddrarg: "
1503 "AF_NETLINK address must be tuple, not %.500s",
1504 Py_TYPE(args)->tp_name);
1505 return 0;
1506 }
1507 if (!PyArg_ParseTuple(args, "II:getsockaddrarg", &pid, &groups))
1508 return 0;
1509 addr->nl_family = AF_NETLINK;
1510 addr->nl_pid = pid;
1511 addr->nl_groups = groups;
1512 *len_ret = sizeof(*addr);
1513 return 1;
1514 }
Martin v. Löwis11017b12006-01-14 18:12:57 +00001515#endif
1516
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001517#ifdef AF_RDS
1518 case AF_RDS:
1519 /* RDS sockets use sockaddr_in: fall-through */
1520#endif
1521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 case AF_INET:
1523 {
1524 struct sockaddr_in* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001525 struct maybe_idna host = {NULL, NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 int port, result;
1527 if (!PyTuple_Check(args)) {
1528 PyErr_Format(
1529 PyExc_TypeError,
1530 "getsockaddrarg: "
1531 "AF_INET address must be tuple, not %.500s",
1532 Py_TYPE(args)->tp_name);
1533 return 0;
1534 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001535 if (!PyArg_ParseTuple(args, "O&i:getsockaddrarg",
1536 idna_converter, &host, &port))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 return 0;
1538 addr=(struct sockaddr_in*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001539 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 sizeof(*addr), AF_INET);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001541 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (result < 0)
1543 return 0;
1544 if (port < 0 || port > 0xffff) {
1545 PyErr_SetString(
1546 PyExc_OverflowError,
1547 "getsockaddrarg: port must be 0-65535.");
1548 return 0;
1549 }
1550 addr->sin_family = AF_INET;
1551 addr->sin_port = htons((short)port);
1552 *len_ret = sizeof *addr;
1553 return 1;
1554 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001555
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001556#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 case AF_INET6:
1558 {
1559 struct sockaddr_in6* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001560 struct maybe_idna host = {NULL, NULL};
Charles-François Natali366999a2012-01-02 15:47:29 +01001561 int port, result;
1562 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 flowinfo = scope_id = 0;
1564 if (!PyTuple_Check(args)) {
1565 PyErr_Format(
1566 PyExc_TypeError,
1567 "getsockaddrarg: "
1568 "AF_INET6 address must be tuple, not %.500s",
1569 Py_TYPE(args)->tp_name);
1570 return 0;
1571 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001572 if (!PyArg_ParseTuple(args, "O&i|II",
1573 idna_converter, &host, &port, &flowinfo,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 &scope_id)) {
1575 return 0;
1576 }
1577 addr = (struct sockaddr_in6*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001578 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 sizeof(*addr), AF_INET6);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001580 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 if (result < 0)
1582 return 0;
1583 if (port < 0 || port > 0xffff) {
1584 PyErr_SetString(
1585 PyExc_OverflowError,
1586 "getsockaddrarg: port must be 0-65535.");
1587 return 0;
1588 }
Charles-François Natali9b0c0062012-06-23 10:17:05 +02001589 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01001590 PyErr_SetString(
1591 PyExc_OverflowError,
1592 "getsockaddrarg: flowinfo must be 0-1048575.");
1593 return 0;
1594 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 addr->sin6_family = s->sock_family;
1596 addr->sin6_port = htons((short)port);
Charles-François Natali366999a2012-01-02 15:47:29 +01001597 addr->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 addr->sin6_scope_id = scope_id;
1599 *len_ret = sizeof *addr;
1600 return 1;
1601 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001602#endif
1603
Hye-Shik Chang81268602004-02-02 06:05:24 +00001604#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 case AF_BLUETOOTH:
1606 {
1607 switch (s->sock_proto) {
1608 case BTPROTO_L2CAP:
1609 {
1610 struct sockaddr_l2 *addr;
1611 char *straddr;
Martin v. Löwis12af0482004-01-31 12:34:17 +00001612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 addr = (struct sockaddr_l2 *)addr_ret;
1614 memset(addr, 0, sizeof(struct sockaddr_l2));
1615 _BT_L2_MEMB(addr, family) = AF_BLUETOOTH;
1616 if (!PyArg_ParseTuple(args, "si", &straddr,
1617 &_BT_L2_MEMB(addr, psm))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001618 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 "wrong format");
1620 return 0;
1621 }
1622 if (setbdaddr(straddr, &_BT_L2_MEMB(addr, bdaddr)) < 0)
1623 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 *len_ret = sizeof *addr;
1626 return 1;
1627 }
1628 case BTPROTO_RFCOMM:
1629 {
1630 struct sockaddr_rc *addr;
1631 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 addr = (struct sockaddr_rc *)addr_ret;
1634 _BT_RC_MEMB(addr, family) = AF_BLUETOOTH;
1635 if (!PyArg_ParseTuple(args, "si", &straddr,
1636 &_BT_RC_MEMB(addr, channel))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001637 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 "wrong format");
1639 return 0;
1640 }
1641 if (setbdaddr(straddr, &_BT_RC_MEMB(addr, bdaddr)) < 0)
1642 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 *len_ret = sizeof *addr;
1645 return 1;
1646 }
1647 case BTPROTO_HCI:
1648 {
1649 struct sockaddr_hci *addr = (struct sockaddr_hci *)addr_ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001650#if defined(__NetBSD__) || defined(__DragonFly__)
Alexander Belopolskye239d232010-12-08 23:31:48 +00001651 char *straddr = PyBytes_AS_STRING(args);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001652
Alexander Belopolskye239d232010-12-08 23:31:48 +00001653 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001654 if (straddr == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001655 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001656 "wrong format");
1657 return 0;
1658 }
1659 if (setbdaddr(straddr, &_BT_HCI_MEMB(addr, bdaddr)) < 0)
1660 return 0;
1661#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
1663 if (!PyArg_ParseTuple(args, "i", &_BT_HCI_MEMB(addr, dev))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001664 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 "wrong format");
1666 return 0;
1667 }
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001668#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 *len_ret = sizeof *addr;
1670 return 1;
1671 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001672#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 case BTPROTO_SCO:
1674 {
1675 struct sockaddr_sco *addr;
1676 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 addr = (struct sockaddr_sco *)addr_ret;
1679 _BT_SCO_MEMB(addr, family) = AF_BLUETOOTH;
1680 if (!PyBytes_Check(args)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001681 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 "wrong format");
1683 return 0;
1684 }
1685 straddr = PyBytes_AS_STRING(args);
1686 if (setbdaddr(straddr, &_BT_SCO_MEMB(addr, bdaddr)) < 0)
1687 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 *len_ret = sizeof *addr;
1690 return 1;
1691 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001692#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001694 PyErr_SetString(PyExc_OSError, "getsockaddrarg: unknown Bluetooth protocol");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 return 0;
1696 }
1697 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001698#endif
1699
Antoine Pitroub156a462010-10-27 20:13:57 +00001700#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFINDEX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 case AF_PACKET:
1702 {
1703 struct sockaddr_ll* addr;
1704 struct ifreq ifr;
1705 char *interfaceName;
1706 int protoNumber;
1707 int hatype = 0;
1708 int pkttype = 0;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001709 Py_buffer haddr = {NULL, NULL};
Guido van Rossum48a680c2001-03-02 06:34:14 +00001710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 if (!PyTuple_Check(args)) {
1712 PyErr_Format(
1713 PyExc_TypeError,
1714 "getsockaddrarg: "
1715 "AF_PACKET address must be tuple, not %.500s",
1716 Py_TYPE(args)->tp_name);
1717 return 0;
1718 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001719 if (!PyArg_ParseTuple(args, "si|iiy*", &interfaceName,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 &protoNumber, &pkttype, &hatype,
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001721 &haddr))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 return 0;
1723 strncpy(ifr.ifr_name, interfaceName, sizeof(ifr.ifr_name));
1724 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
1725 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1726 s->errorhandler();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001727 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 return 0;
1729 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001730 if (haddr.buf && haddr.len > 8) {
1731 PyErr_SetString(PyExc_ValueError,
1732 "Hardware address must be 8 bytes or less");
1733 PyBuffer_Release(&haddr);
1734 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 }
1736 if (protoNumber < 0 || protoNumber > 0xffff) {
1737 PyErr_SetString(
1738 PyExc_OverflowError,
1739 "getsockaddrarg: protoNumber must be 0-65535.");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001740 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 return 0;
1742 }
1743 addr = (struct sockaddr_ll*)addr_ret;
1744 addr->sll_family = AF_PACKET;
1745 addr->sll_protocol = htons((short)protoNumber);
1746 addr->sll_ifindex = ifr.ifr_ifindex;
1747 addr->sll_pkttype = pkttype;
1748 addr->sll_hatype = hatype;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001749 if (haddr.buf) {
1750 memcpy(&addr->sll_addr, haddr.buf, haddr.len);
1751 addr->sll_halen = haddr.len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001753 else
1754 addr->sll_halen = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 *len_ret = sizeof *addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001756 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 return 1;
1758 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001759#endif
1760
Christian Heimes043d6f62008-01-07 17:19:16 +00001761#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 case AF_TIPC:
1763 {
1764 unsigned int atype, v1, v2, v3;
1765 unsigned int scope = TIPC_CLUSTER_SCOPE;
1766 struct sockaddr_tipc *addr;
Christian Heimes043d6f62008-01-07 17:19:16 +00001767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 if (!PyTuple_Check(args)) {
1769 PyErr_Format(
1770 PyExc_TypeError,
1771 "getsockaddrarg: "
1772 "AF_TIPC address must be tuple, not %.500s",
1773 Py_TYPE(args)->tp_name);
1774 return 0;
1775 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 if (!PyArg_ParseTuple(args,
1778 "IIII|I;Invalid TIPC address format",
1779 &atype, &v1, &v2, &v3, &scope))
1780 return 0;
Christian Heimes043d6f62008-01-07 17:19:16 +00001781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 addr = (struct sockaddr_tipc *) addr_ret;
1783 memset(addr, 0, sizeof(struct sockaddr_tipc));
Christian Heimes043d6f62008-01-07 17:19:16 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 addr->family = AF_TIPC;
1786 addr->scope = scope;
1787 addr->addrtype = atype;
Christian Heimes043d6f62008-01-07 17:19:16 +00001788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 if (atype == TIPC_ADDR_NAMESEQ) {
1790 addr->addr.nameseq.type = v1;
1791 addr->addr.nameseq.lower = v2;
1792 addr->addr.nameseq.upper = v3;
1793 } else if (atype == TIPC_ADDR_NAME) {
1794 addr->addr.name.name.type = v1;
1795 addr->addr.name.name.instance = v2;
1796 } else if (atype == TIPC_ADDR_ID) {
1797 addr->addr.id.node = v1;
1798 addr->addr.id.ref = v2;
1799 } else {
1800 /* Shouldn't happen */
1801 PyErr_SetString(PyExc_TypeError, "Invalid address type");
1802 return 0;
1803 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 *len_ret = sizeof(*addr);
Christian Heimes043d6f62008-01-07 17:19:16 +00001806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 return 1;
1808 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001809#endif
1810
Vinay Sajiped6783f2014-03-21 11:44:32 +00001811#if defined(AF_CAN) && defined(CAN_RAW) && defined(CAN_BCM)
Charles-François Natali47413c12011-10-06 19:47:44 +02001812 case AF_CAN:
1813 switch (s->sock_proto) {
1814 case CAN_RAW:
Charles-François Natali773e42d2013-02-05 19:42:01 +01001815 /* fall-through */
1816 case CAN_BCM:
Charles-François Natali47413c12011-10-06 19:47:44 +02001817 {
1818 struct sockaddr_can *addr;
1819 PyObject *interfaceName;
1820 struct ifreq ifr;
Charles-François Natali47413c12011-10-06 19:47:44 +02001821 Py_ssize_t len;
1822
Benjamin Peterson18b71912013-05-16 15:29:44 -05001823 addr = (struct sockaddr_can *)addr_ret;
1824
Charles-François Natali47413c12011-10-06 19:47:44 +02001825 if (!PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter,
1826 &interfaceName))
1827 return 0;
1828
1829 len = PyBytes_GET_SIZE(interfaceName);
1830
1831 if (len == 0) {
1832 ifr.ifr_ifindex = 0;
Victor Stinner1a62a682014-08-17 19:33:28 +02001833 } else if ((size_t)len < sizeof(ifr.ifr_name)) {
Christian Heimes15b68852012-09-10 01:25:50 +02001834 strncpy(ifr.ifr_name, PyBytes_AS_STRING(interfaceName), sizeof(ifr.ifr_name));
1835 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
Charles-François Natali47413c12011-10-06 19:47:44 +02001836 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1837 s->errorhandler();
1838 Py_DECREF(interfaceName);
1839 return 0;
1840 }
1841 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001842 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001843 "AF_CAN interface name too long");
1844 Py_DECREF(interfaceName);
1845 return 0;
1846 }
1847
1848 addr->can_family = AF_CAN;
1849 addr->can_ifindex = ifr.ifr_ifindex;
1850
1851 *len_ret = sizeof(*addr);
1852 Py_DECREF(interfaceName);
1853 return 1;
1854 }
1855 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001856 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001857 "getsockaddrarg: unsupported CAN protocol");
1858 return 0;
1859 }
1860#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001861
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001862#ifdef PF_SYSTEM
1863 case PF_SYSTEM:
1864 switch (s->sock_proto) {
1865#ifdef SYSPROTO_CONTROL
1866 case SYSPROTO_CONTROL:
1867 {
1868 struct sockaddr_ctl *addr;
Victor Stinnera534fc42013-06-03 22:07:27 +02001869
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001870 addr = (struct sockaddr_ctl *)addr_ret;
1871 addr->sc_family = AF_SYSTEM;
Victor Stinnera534fc42013-06-03 22:07:27 +02001872 addr->ss_sysaddr = AF_SYS_CONTROL;
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001873
1874 if (PyUnicode_Check(args)) {
1875 struct ctl_info info;
1876 PyObject *ctl_name;
1877
1878 if (!PyArg_Parse(args, "O&",
1879 PyUnicode_FSConverter, &ctl_name)) {
1880 return 0;
1881 }
1882
Victor Stinnerf50e1872015-03-20 11:32:24 +01001883 if (PyBytes_GET_SIZE(ctl_name) > (Py_ssize_t)sizeof(info.ctl_name)) {
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001884 PyErr_SetString(PyExc_ValueError,
1885 "provided string is too long");
1886 Py_DECREF(ctl_name);
1887 return 0;
1888 }
1889 strncpy(info.ctl_name, PyBytes_AS_STRING(ctl_name),
1890 sizeof(info.ctl_name));
1891 Py_DECREF(ctl_name);
1892
1893 if (ioctl(s->sock_fd, CTLIOCGINFO, &info)) {
1894 PyErr_SetString(PyExc_OSError,
1895 "cannot find kernel control with provided name");
1896 return 0;
1897 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001898
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001899 addr->sc_id = info.ctl_id;
1900 addr->sc_unit = 0;
1901 } else if (!PyArg_ParseTuple(args, "II",
1902 &(addr->sc_id), &(addr->sc_unit))) {
1903 PyErr_SetString(PyExc_TypeError, "getsockaddrarg: "
1904 "expected str or tuple of two ints");
Victor Stinnera534fc42013-06-03 22:07:27 +02001905
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001906 return 0;
1907 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001908
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001909 *len_ret = sizeof(*addr);
1910 return 1;
1911 }
1912#endif
1913 default:
1914 PyErr_SetString(PyExc_OSError,
1915 "getsockaddrarg: unsupported PF_SYSTEM protocol");
1916 return 0;
1917 }
1918#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001920 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001923 PyErr_SetString(PyExc_OSError, "getsockaddrarg: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 return 0;
Guido van Rossum30a685f1991-06-27 15:51:29 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001927}
1928
Guido van Rossum30a685f1991-06-27 15:51:29 +00001929
Guido van Rossum48a680c2001-03-02 06:34:14 +00001930/* Get the address length according to the socket object's address family.
Guido van Rossum710e1df1992-06-12 10:39:36 +00001931 Return 1 if the family is known, 0 otherwise. The length is returned
1932 through len_ret. */
1933
1934static int
Peter Schneider-Kamp618e25d2000-07-11 23:00:12 +00001935getsockaddrlen(PySocketSockObject *s, socklen_t *len_ret)
Guido van Rossum710e1df1992-06-12 10:39:36 +00001936{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001937 switch (s->sock_family) {
Guido van Rossum710e1df1992-06-12 10:39:36 +00001938
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001939#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 case AF_UNIX:
1941 {
1942 *len_ret = sizeof (struct sockaddr_un);
1943 return 1;
1944 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001945#endif /* AF_UNIX */
Martin v. Löwis11017b12006-01-14 18:12:57 +00001946#if defined(AF_NETLINK)
1947 case AF_NETLINK:
1948 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 *len_ret = sizeof (struct sockaddr_nl);
1950 return 1;
Martin v. Löwis11017b12006-01-14 18:12:57 +00001951 }
1952#endif
Guido van Rossum710e1df1992-06-12 10:39:36 +00001953
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001954#ifdef AF_RDS
1955 case AF_RDS:
1956 /* RDS sockets use sockaddr_in: fall-through */
1957#endif
1958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 case AF_INET:
1960 {
1961 *len_ret = sizeof (struct sockaddr_in);
1962 return 1;
1963 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001964
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001965#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001966 case AF_INET6:
1967 {
1968 *len_ret = sizeof (struct sockaddr_in6);
1969 return 1;
1970 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001971#endif
1972
Hye-Shik Chang81268602004-02-02 06:05:24 +00001973#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 case AF_BLUETOOTH:
1975 {
1976 switch(s->sock_proto)
1977 {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 case BTPROTO_L2CAP:
1980 *len_ret = sizeof (struct sockaddr_l2);
1981 return 1;
1982 case BTPROTO_RFCOMM:
1983 *len_ret = sizeof (struct sockaddr_rc);
1984 return 1;
1985 case BTPROTO_HCI:
1986 *len_ret = sizeof (struct sockaddr_hci);
1987 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001988#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 case BTPROTO_SCO:
1990 *len_ret = sizeof (struct sockaddr_sco);
1991 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001992#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001994 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 "unknown BT protocol");
1996 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 }
1999 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00002000#endif
2001
Martin v. Löwis1ba3fd52001-08-10 20:29:40 +00002002#ifdef HAVE_NETPACKET_PACKET_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 case AF_PACKET:
2004 {
2005 *len_ret = sizeof (struct sockaddr_ll);
2006 return 1;
2007 }
Jeremy Hylton22308652001-02-02 03:23:09 +00002008#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00002009
Christian Heimes043d6f62008-01-07 17:19:16 +00002010#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002011 case AF_TIPC:
2012 {
2013 *len_ret = sizeof (struct sockaddr_tipc);
2014 return 1;
2015 }
Christian Heimes043d6f62008-01-07 17:19:16 +00002016#endif
2017
Vinay Sajipecfc98c2014-03-20 12:42:42 +00002018#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02002019 case AF_CAN:
2020 {
2021 *len_ret = sizeof (struct sockaddr_can);
2022 return 1;
2023 }
2024#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02002025
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01002026#ifdef PF_SYSTEM
2027 case PF_SYSTEM:
2028 switch(s->sock_proto) {
2029#ifdef SYSPROTO_CONTROL
2030 case SYSPROTO_CONTROL:
2031 *len_ret = sizeof (struct sockaddr_ctl);
2032 return 1;
2033#endif
2034 default:
2035 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
2036 "unknown PF_SYSTEM protocol");
2037 return 0;
2038 }
2039#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02002040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 /* More cases here... */
Guido van Rossum710e1df1992-06-12 10:39:36 +00002042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002044 PyErr_SetString(PyExc_OSError, "getsockaddrlen: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 return 0;
Guido van Rossum710e1df1992-06-12 10:39:36 +00002046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002047 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00002048}
2049
2050
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002051/* Support functions for the sendmsg() and recvmsg[_into]() methods.
2052 Currently, these methods are only compiled if the RFC 2292/3542
2053 CMSG_LEN() macro is available. Older systems seem to have used
2054 sizeof(struct cmsghdr) + (length) where CMSG_LEN() is used now, so
2055 it may be possible to define CMSG_LEN() that way if it's not
2056 provided. Some architectures might need extra padding after the
2057 cmsghdr, however, and CMSG_LEN() would have to take account of
2058 this. */
2059#ifdef CMSG_LEN
2060/* If length is in range, set *result to CMSG_LEN(length) and return
2061 true; otherwise, return false. */
2062static int
2063get_CMSG_LEN(size_t length, size_t *result)
2064{
2065 size_t tmp;
2066
2067 if (length > (SOCKLEN_T_LIMIT - CMSG_LEN(0)))
2068 return 0;
2069 tmp = CMSG_LEN(length);
2070 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
2071 return 0;
2072 *result = tmp;
2073 return 1;
2074}
2075
2076#ifdef CMSG_SPACE
2077/* If length is in range, set *result to CMSG_SPACE(length) and return
2078 true; otherwise, return false. */
2079static int
2080get_CMSG_SPACE(size_t length, size_t *result)
2081{
2082 size_t tmp;
2083
2084 /* Use CMSG_SPACE(1) here in order to take account of the padding
2085 necessary before *and* after the data. */
2086 if (length > (SOCKLEN_T_LIMIT - CMSG_SPACE(1)))
2087 return 0;
2088 tmp = CMSG_SPACE(length);
2089 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
2090 return 0;
2091 *result = tmp;
2092 return 1;
2093}
2094#endif
2095
2096/* Return true iff msg->msg_controllen is valid, cmsgh is a valid
2097 pointer in msg->msg_control with at least "space" bytes after it,
2098 and its cmsg_len member inside the buffer. */
2099static int
2100cmsg_min_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t space)
2101{
2102 size_t cmsg_offset;
2103 static const size_t cmsg_len_end = (offsetof(struct cmsghdr, cmsg_len) +
2104 sizeof(cmsgh->cmsg_len));
2105
Charles-François Natali466517d2011-08-28 18:23:43 +02002106 /* Note that POSIX allows msg_controllen to be of signed type. */
Brett Cannonb05cbe62014-01-07 17:01:01 -05002107 if (cmsgh == NULL || msg->msg_control == NULL)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002108 return 0;
Brett Cannonb05cbe62014-01-07 17:01:01 -05002109 /* Note that POSIX allows msg_controllen to be of a signed type. This is
2110 annoying under OS X as it's unsigned there and so it triggers a
2111 tautological comparison warning under Clang when compared against 0.
2112 Since the check is valid on other platforms, silence the warning under
2113 Clang. */
2114 #ifdef __clang__
2115 #pragma clang diagnostic push
2116 #pragma clang diagnostic ignored "-Wtautological-compare"
2117 #endif
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02002118 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02002119 #pragma GCC diagnostic push
2120 #pragma GCC diagnostic ignored "-Wtype-limits"
2121 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002122 if (msg->msg_controllen < 0)
2123 return 0;
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02002124 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02002125 #pragma GCC diagnostic pop
2126 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002127 #ifdef __clang__
2128 #pragma clang diagnostic pop
2129 #endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002130 if (space < cmsg_len_end)
2131 space = cmsg_len_end;
2132 cmsg_offset = (char *)cmsgh - (char *)msg->msg_control;
2133 return (cmsg_offset <= (size_t)-1 - space &&
2134 cmsg_offset + space <= msg->msg_controllen);
2135}
2136
2137/* If pointer CMSG_DATA(cmsgh) is in buffer msg->msg_control, set
2138 *space to number of bytes following it in the buffer and return
2139 true; otherwise, return false. Assumes cmsgh, msg->msg_control and
2140 msg->msg_controllen are valid. */
2141static int
2142get_cmsg_data_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *space)
2143{
2144 size_t data_offset;
2145 char *data_ptr;
2146
2147 if ((data_ptr = (char *)CMSG_DATA(cmsgh)) == NULL)
2148 return 0;
2149 data_offset = data_ptr - (char *)msg->msg_control;
2150 if (data_offset > msg->msg_controllen)
2151 return 0;
2152 *space = msg->msg_controllen - data_offset;
2153 return 1;
2154}
2155
2156/* If cmsgh is invalid or not contained in the buffer pointed to by
2157 msg->msg_control, return -1. If cmsgh is valid and its associated
2158 data is entirely contained in the buffer, set *data_len to the
2159 length of the associated data and return 0. If only part of the
2160 associated data is contained in the buffer but cmsgh is otherwise
2161 valid, set *data_len to the length contained in the buffer and
2162 return 1. */
2163static int
2164get_cmsg_data_len(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *data_len)
2165{
2166 size_t space, cmsg_data_len;
2167
2168 if (!cmsg_min_space(msg, cmsgh, CMSG_LEN(0)) ||
2169 cmsgh->cmsg_len < CMSG_LEN(0))
2170 return -1;
2171 cmsg_data_len = cmsgh->cmsg_len - CMSG_LEN(0);
2172 if (!get_cmsg_data_space(msg, cmsgh, &space))
2173 return -1;
2174 if (space >= cmsg_data_len) {
2175 *data_len = cmsg_data_len;
2176 return 0;
2177 }
2178 *data_len = space;
2179 return 1;
2180}
2181#endif /* CMSG_LEN */
2182
2183
Victor Stinner31bf2d52015-04-01 21:57:09 +02002184struct sock_accept {
2185 socklen_t *addrlen;
2186 sock_addr_t *addrbuf;
2187 SOCKET_T result;
2188};
2189
2190#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2191/* accept4() is available on Linux 2.6.28+ and glibc 2.10 */
2192static int accept4_works = -1;
2193#endif
2194
2195static int
2196sock_accept_impl(PySocketSockObject *s, void *data)
2197{
2198 struct sock_accept *ctx = data;
2199
2200#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2201 if (accept4_works != 0) {
2202 ctx->result = accept4(s->sock_fd, SAS2SA(ctx->addrbuf), ctx->addrlen,
2203 SOCK_CLOEXEC);
2204 if (ctx->result == INVALID_SOCKET && accept4_works == -1) {
2205 /* On Linux older than 2.6.28, accept4() fails with ENOSYS */
2206 accept4_works = (errno != ENOSYS);
2207 }
2208 }
2209 if (accept4_works == 0)
2210 ctx->result = accept(s->sock_fd, SAS2SA(ctx->addrbuf), ctx->addrlen);
2211#else
2212 ctx->result = accept(s->sock_fd, SAS2SA(ctx->addrbuf), ctx->addrlen);
2213#endif
Victor Stinnerbea232a2015-07-27 23:37:11 +02002214
2215#ifdef MS_WINDOWS
2216 return (ctx->result != INVALID_SOCKET);
2217#else
Victor Stinner31bf2d52015-04-01 21:57:09 +02002218 return (ctx->result >= 0);
Victor Stinnerbea232a2015-07-27 23:37:11 +02002219#endif
Victor Stinner31bf2d52015-04-01 21:57:09 +02002220}
2221
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002222/* s._accept() -> (fd, address) */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002223
Guido van Rossum73624e91994-10-10 17:59:00 +00002224static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002225sock_accept(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 sock_addr_t addrbuf;
Victor Stinner31bf2d52015-04-01 21:57:09 +02002228 SOCKET_T newfd;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 socklen_t addrlen;
2230 PyObject *sock = NULL;
2231 PyObject *addr = NULL;
2232 PyObject *res = NULL;
Victor Stinner31bf2d52015-04-01 21:57:09 +02002233 struct sock_accept ctx;
Victor Stinnerdaf45552013-08-28 00:53:59 +02002234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 if (!getsockaddrlen(s, &addrlen))
2236 return NULL;
2237 memset(&addrbuf, 0, addrlen);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 if (!IS_SELECTABLE(s))
2240 return select_error();
Neal Norwitz082b2df2006-02-07 07:04:46 +00002241
Victor Stinner31bf2d52015-04-01 21:57:09 +02002242 ctx.addrlen = &addrlen;
2243 ctx.addrbuf = &addrbuf;
2244 if (sock_call(s, 0, sock_accept_impl, &ctx) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 return NULL;
Victor Stinner31bf2d52015-04-01 21:57:09 +02002246 newfd = ctx.result;
Barry Warsaw752300b1997-01-03 17:18:10 +00002247
Victor Stinnerdaf45552013-08-28 00:53:59 +02002248#ifdef MS_WINDOWS
2249 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
2250 PyErr_SetFromWindowsErr(0);
2251 SOCKETCLOSE(newfd);
2252 goto finally;
2253 }
2254#else
2255
2256#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2257 if (!accept4_works)
2258#endif
2259 {
2260 if (_Py_set_inheritable(newfd, 0, NULL) < 0) {
2261 SOCKETCLOSE(newfd);
2262 goto finally;
2263 }
2264 }
2265#endif
2266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 sock = PyLong_FromSocket_t(newfd);
2268 if (sock == NULL) {
2269 SOCKETCLOSE(newfd);
2270 goto finally;
2271 }
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2274 addrlen, s->sock_proto);
2275 if (addr == NULL)
2276 goto finally;
Barry Warsaw752300b1997-01-03 17:18:10 +00002277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002278 res = PyTuple_Pack(2, sock, addr);
Barry Warsaw752300b1997-01-03 17:18:10 +00002279
Guido van Rossum67f7a382002-06-06 21:08:16 +00002280finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 Py_XDECREF(sock);
2282 Py_XDECREF(addr);
2283 return res;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002284}
2285
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002286PyDoc_STRVAR(accept_doc,
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002287"_accept() -> (integer, address info)\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002288\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002289Wait for an incoming connection. Return a new socket file descriptor\n\
2290representing the connection, and the address of the client.\n\
2291For IP sockets, the address info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002292
Guido van Rossum11ba0942002-06-13 15:07:44 +00002293/* s.setblocking(flag) method. Argument:
2294 False -- non-blocking mode; same as settimeout(0)
2295 True -- blocking mode; same as settimeout(None)
2296*/
Guido van Rossume4485b01994-09-07 14:32:49 +00002297
Guido van Rossum73624e91994-10-10 17:59:00 +00002298static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002299sock_setblocking(PySocketSockObject *s, PyObject *arg)
Guido van Rossume4485b01994-09-07 14:32:49 +00002300{
Serhiy Storchaka78980432013-01-15 01:12:17 +02002301 long block;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 block = PyLong_AsLong(arg);
2304 if (block == -1 && PyErr_Occurred())
2305 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002306
Victor Stinner9001d802015-04-06 23:06:01 +02002307 s->sock_timeout = _PyTime_FromSeconds(block ? -1 : 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 internal_setblocking(s, block);
Guido van Rossume4485b01994-09-07 14:32:49 +00002309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002310 Py_INCREF(Py_None);
2311 return Py_None;
Guido van Rossume4485b01994-09-07 14:32:49 +00002312}
Guido van Rossume4485b01994-09-07 14:32:49 +00002313
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002314PyDoc_STRVAR(setblocking_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002315"setblocking(flag)\n\
2316\n\
2317Set the socket to blocking (flag is true) or non-blocking (false).\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002318setblocking(True) is equivalent to settimeout(None);\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002319setblocking(False) is equivalent to settimeout(0.0).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002320
Victor Stinner71694d52015-03-28 01:18:54 +01002321static int
2322socket_parse_timeout(_PyTime_t *timeout, PyObject *timeout_obj)
2323{
2324#ifdef MS_WINDOWS
2325 struct timeval tv;
2326#endif
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002327#ifndef HAVE_POLL
2328 _PyTime_t ms;
2329#endif
Victor Stinner71694d52015-03-28 01:18:54 +01002330 int overflow = 0;
2331
2332 if (timeout_obj == Py_None) {
Victor Stinner10550cd2015-04-03 13:22:27 +02002333 *timeout = _PyTime_FromSeconds(-1);
Victor Stinner71694d52015-03-28 01:18:54 +01002334 return 0;
2335 }
2336
Victor Stinner869e1772015-03-30 03:49:14 +02002337 if (_PyTime_FromSecondsObject(timeout,
2338 timeout_obj, _PyTime_ROUND_CEILING) < 0)
Victor Stinner71694d52015-03-28 01:18:54 +01002339 return -1;
2340
2341 if (*timeout < 0) {
2342 PyErr_SetString(PyExc_ValueError, "Timeout value out of range");
2343 return -1;
2344 }
2345
2346#ifdef MS_WINDOWS
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002347 overflow |= (_PyTime_AsTimeval(*timeout, &tv, _PyTime_ROUND_CEILING) < 0);
Victor Stinner71694d52015-03-28 01:18:54 +01002348#endif
2349#ifndef HAVE_POLL
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002350 ms = _PyTime_AsMilliseconds(*timeout, _PyTime_ROUND_CEILING);
2351 overflow |= (ms > INT_MAX);
Victor Stinner71694d52015-03-28 01:18:54 +01002352#endif
2353 if (overflow) {
2354 PyErr_SetString(PyExc_OverflowError,
2355 "timeout doesn't fit into C timeval");
2356 return -1;
2357 }
2358
2359 return 0;
2360}
2361
Guido van Rossum11ba0942002-06-13 15:07:44 +00002362/* s.settimeout(timeout) method. Argument:
2363 None -- no timeout, blocking mode; same as setblocking(True)
2364 0.0 -- non-blocking mode; same as setblocking(False)
2365 > 0 -- timeout mode; operations time out after timeout seconds
2366 < 0 -- illegal; raises an exception
2367*/
Guido van Rossum67f7a382002-06-06 21:08:16 +00002368static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002369sock_settimeout(PySocketSockObject *s, PyObject *arg)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002370{
Victor Stinner71694d52015-03-28 01:18:54 +01002371 _PyTime_t timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002372
Victor Stinner71694d52015-03-28 01:18:54 +01002373 if (socket_parse_timeout(&timeout, arg) < 0)
2374 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 s->sock_timeout = timeout;
Victor Stinner71694d52015-03-28 01:18:54 +01002377 internal_setblocking(s, timeout < 0);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 Py_INCREF(Py_None);
2380 return Py_None;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002381}
2382
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002383PyDoc_STRVAR(settimeout_doc,
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002384"settimeout(timeout)\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002385\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002386Set a timeout on socket operations. 'timeout' can be a float,\n\
2387giving in seconds, or None. Setting a timeout of None disables\n\
2388the timeout feature and is equivalent to setblocking(1).\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002389Setting a timeout of zero is the same as setblocking(0).");
Guido van Rossum67f7a382002-06-06 21:08:16 +00002390
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002391/* s.gettimeout() method.
2392 Returns the timeout associated with a socket. */
Guido van Rossum67f7a382002-06-06 21:08:16 +00002393static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002394sock_gettimeout(PySocketSockObject *s)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002395{
Victor Stinner71694d52015-03-28 01:18:54 +01002396 if (s->sock_timeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 Py_INCREF(Py_None);
2398 return Py_None;
2399 }
Victor Stinner71694d52015-03-28 01:18:54 +01002400 else {
2401 double seconds = _PyTime_AsSecondsDouble(s->sock_timeout);
2402 return PyFloat_FromDouble(seconds);
2403 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002404}
2405
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002406PyDoc_STRVAR(gettimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002407"gettimeout() -> timeout\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002408\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03002409Returns the timeout in seconds (float) associated with socket \n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002410operations. A timeout of None indicates that timeouts on socket \n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002411operations are disabled.");
Guido van Rossume4485b01994-09-07 14:32:49 +00002412
Guido van Rossumaee08791992-09-08 09:05:33 +00002413/* s.setsockopt() method.
2414 With an integer third argument, sets an integer option.
2415 With a string third argument, sets an option from a buffer;
2416 use optional built-in module 'struct' to encode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002417
Guido van Rossum73624e91994-10-10 17:59:00 +00002418static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002419sock_setsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 int level;
2422 int optname;
2423 int res;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002424 Py_buffer optval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 int flag;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 if (PyArg_ParseTuple(args, "iii:setsockopt",
2428 &level, &optname, &flag)) {
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002429 res = setsockopt(s->sock_fd, level, optname,
2430 (char*)&flag, sizeof flag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 }
2432 else {
2433 PyErr_Clear();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002434 if (!PyArg_ParseTuple(args, "iiy*:setsockopt",
2435 &level, &optname, &optval))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 return NULL;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002437 res = setsockopt(s->sock_fd, level, optname, optval.buf, optval.len);
2438 PyBuffer_Release(&optval);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 if (res < 0)
2441 return s->errorhandler();
2442 Py_INCREF(Py_None);
2443 return Py_None;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002444}
2445
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002446PyDoc_STRVAR(setsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002447"setsockopt(level, option, value)\n\
2448\n\
2449Set a socket option. See the Unix manual for level and option.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002450The value argument can either be an integer or a string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002451
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002452
Guido van Rossumaee08791992-09-08 09:05:33 +00002453/* s.getsockopt() method.
2454 With two arguments, retrieves an integer option.
2455 With a third integer argument, retrieves a string buffer of that size;
2456 use optional built-in module 'struct' to decode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002457
Guido van Rossum73624e91994-10-10 17:59:00 +00002458static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002459sock_getsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 int level;
2462 int optname;
2463 int res;
2464 PyObject *buf;
2465 socklen_t buflen = 0;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 if (!PyArg_ParseTuple(args, "ii|i:getsockopt",
2468 &level, &optname, &buflen))
2469 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 if (buflen == 0) {
2472 int flag = 0;
2473 socklen_t flagsize = sizeof flag;
2474 res = getsockopt(s->sock_fd, level, optname,
2475 (void *)&flag, &flagsize);
2476 if (res < 0)
2477 return s->errorhandler();
2478 return PyLong_FromLong(flag);
2479 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 if (buflen <= 0 || buflen > 1024) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002481 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 "getsockopt buflen out of range");
2483 return NULL;
2484 }
2485 buf = PyBytes_FromStringAndSize((char *)NULL, buflen);
2486 if (buf == NULL)
2487 return NULL;
2488 res = getsockopt(s->sock_fd, level, optname,
2489 (void *)PyBytes_AS_STRING(buf), &buflen);
2490 if (res < 0) {
2491 Py_DECREF(buf);
2492 return s->errorhandler();
2493 }
2494 _PyBytes_Resize(&buf, buflen);
2495 return buf;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002496}
2497
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002498PyDoc_STRVAR(getsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002499"getsockopt(level, option[, buffersize]) -> value\n\
2500\n\
2501Get a socket option. See the Unix manual for level and option.\n\
2502If a nonzero buffersize argument is given, the return value is a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002503string of that length; otherwise it is an integer.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002504
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002505
Fred Drake728819a2000-07-01 03:40:12 +00002506/* s.bind(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002507
Guido van Rossum73624e91994-10-10 17:59:00 +00002508static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002509sock_bind(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 sock_addr_t addrbuf;
2512 int addrlen;
2513 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002515 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2516 return NULL;
2517 Py_BEGIN_ALLOW_THREADS
2518 res = bind(s->sock_fd, SAS2SA(&addrbuf), addrlen);
2519 Py_END_ALLOW_THREADS
2520 if (res < 0)
2521 return s->errorhandler();
2522 Py_INCREF(Py_None);
2523 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002524}
2525
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002526PyDoc_STRVAR(bind_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002527"bind(address)\n\
2528\n\
2529Bind the socket to a local address. For IP sockets, the address is a\n\
Jeremy Hylton22308652001-02-02 03:23:09 +00002530pair (host, port); the host must refer to the local host. For raw packet\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002531sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002532
Guido van Rossum30a685f1991-06-27 15:51:29 +00002533
2534/* s.close() method.
2535 Set the file descriptor to -1 so operations tried subsequently
2536 will surely fail. */
2537
Guido van Rossum73624e91994-10-10 17:59:00 +00002538static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002539sock_close(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 SOCKET_T fd;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002542
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002543 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
2544 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
2545 * for more details.
2546 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 if ((fd = s->sock_fd) != -1) {
2548 s->sock_fd = -1;
2549 Py_BEGIN_ALLOW_THREADS
2550 (void) SOCKETCLOSE(fd);
2551 Py_END_ALLOW_THREADS
2552 }
2553 Py_INCREF(Py_None);
2554 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002555}
2556
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002557PyDoc_STRVAR(close_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002558"close()\n\
2559\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002560Close the socket. It cannot be used after this call.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002561
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002562static PyObject *
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002563sock_detach(PySocketSockObject *s)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002564{
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002565 SOCKET_T fd = s->sock_fd;
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002566 s->sock_fd = -1;
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002567 return PyLong_FromSocket_t(fd);
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002568}
2569
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002570PyDoc_STRVAR(detach_doc,
2571"detach()\n\
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002572\n\
Guido van Rossum638aebd2013-12-04 11:50:09 -08002573Close the socket object without closing the underlying file descriptor.\n\
2574The object cannot be used after this call, but the file descriptor\n\
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002575can be reused for other purposes. The file descriptor is returned.");
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002576
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002577static int
Victor Stinner81c41db2015-04-02 11:50:57 +02002578sock_connect_impl(PySocketSockObject *s, void* Py_UNUSED(data))
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002579{
Victor Stinner81c41db2015-04-02 11:50:57 +02002580 int err;
2581 socklen_t size = sizeof err;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002582
Victor Stinner81c41db2015-04-02 11:50:57 +02002583 if (getsockopt(s->sock_fd, SOL_SOCKET, SO_ERROR, (void *)&err, &size)) {
2584 /* getsockopt() failed */
2585 return 0;
2586 }
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002587
Victor Stinner81c41db2015-04-02 11:50:57 +02002588 if (err == EISCONN)
2589 return 1;
Victor Stinner38aec752015-04-02 14:37:20 +02002590 if (err != 0) {
2591 /* sock_call_ex() uses GET_SOCK_ERROR() to get the error code */
2592 SET_SOCK_ERROR(err);
Victor Stinner38aec752015-04-02 14:37:20 +02002593 return 0;
2594 }
2595 return 1;
Victor Stinner81c41db2015-04-02 11:50:57 +02002596}
2597
2598static int
2599internal_connect(PySocketSockObject *s, struct sockaddr *addr, int addrlen,
2600 int raise)
2601{
2602 int res, err, wait_connect;
Victor Stinnerb7df3142015-03-27 22:59:32 +01002603
2604 Py_BEGIN_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 res = connect(s->sock_fd, addr, addrlen);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002606 Py_END_ALLOW_THREADS
2607
Victor Stinner70a46f62015-03-31 22:03:59 +02002608 if (!res) {
2609 /* connect() succeeded, the socket is connected */
2610 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 }
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002612
Victor Stinner81c41db2015-04-02 11:50:57 +02002613 /* connect() failed */
Victor Stinneree699e92015-03-31 21:28:42 +02002614
Victor Stinner81c41db2015-04-02 11:50:57 +02002615 /* save error, PyErr_CheckSignals() can replace it */
2616 err = GET_SOCK_ERROR;
2617 if (CHECK_ERRNO(EINTR)) {
2618 if (PyErr_CheckSignals())
Victor Stinner70a46f62015-03-31 22:03:59 +02002619 return -1;
Victor Stinner81c41db2015-04-02 11:50:57 +02002620
2621 /* Issue #23618: when connect() fails with EINTR, the connection is
2622 running asynchronously.
2623
2624 If the socket is blocking or has a timeout, wait until the
2625 connection completes, fails or timed out using select(), and then
2626 get the connection status using getsockopt(SO_ERROR).
2627
2628 If the socket is non-blocking, raise InterruptedError. The caller is
2629 responsible to wait until the connection completes, fails or timed
2630 out (it's the case in asyncio for example). */
2631 wait_connect = (s->sock_timeout != 0 && IS_SELECTABLE(s));
2632 }
2633 else {
2634 wait_connect = (s->sock_timeout > 0 && err == SOCK_INPROGRESS_ERR
2635 && IS_SELECTABLE(s));
Victor Stinner70a46f62015-03-31 22:03:59 +02002636 }
2637
Victor Stinner81c41db2015-04-02 11:50:57 +02002638 if (!wait_connect) {
2639 if (raise) {
2640 /* restore error, maybe replaced by PyErr_CheckSignals() */
2641 SET_SOCK_ERROR(err);
2642 s->errorhandler();
2643 return -1;
2644 }
2645 else
2646 return err;
Victor Stinner70a46f62015-03-31 22:03:59 +02002647 }
2648
Victor Stinner81c41db2015-04-02 11:50:57 +02002649 if (raise) {
2650 /* socket.connect() raises an exception on error */
Victor Stinner8912d142015-04-06 23:16:34 +02002651 if (sock_call_ex(s, 1, sock_connect_impl, NULL,
2652 1, NULL, s->sock_timeout) < 0)
Victor Stinner81c41db2015-04-02 11:50:57 +02002653 return -1;
Victor Stinner70a46f62015-03-31 22:03:59 +02002654 }
Victor Stinner81c41db2015-04-02 11:50:57 +02002655 else {
2656 /* socket.connect_ex() returns the error code on error */
Victor Stinner8912d142015-04-06 23:16:34 +02002657 if (sock_call_ex(s, 1, sock_connect_impl, NULL,
2658 1, &err, s->sock_timeout) < 0)
Victor Stinner81c41db2015-04-02 11:50:57 +02002659 return err;
2660 }
2661 return 0;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002662}
Guido van Rossum30a685f1991-06-27 15:51:29 +00002663
Fred Drake728819a2000-07-01 03:40:12 +00002664/* s.connect(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002665
Guido van Rossum73624e91994-10-10 17:59:00 +00002666static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002667sock_connect(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002668{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 sock_addr_t addrbuf;
2670 int addrlen;
2671 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002673 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2674 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002675
Victor Stinner81c41db2015-04-02 11:50:57 +02002676 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, 1);
Victor Stinneree699e92015-03-31 21:28:42 +02002677 if (res < 0)
2678 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002679
Victor Stinneree699e92015-03-31 21:28:42 +02002680 Py_RETURN_NONE;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002681}
2682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002683PyDoc_STRVAR(connect_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002684"connect(address)\n\
2685\n\
2686Connect the socket to a remote address. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002687is a pair (host, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002688
Guido van Rossum30a685f1991-06-27 15:51:29 +00002689
Fred Drake728819a2000-07-01 03:40:12 +00002690/* s.connect_ex(sockaddr) method */
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002691
2692static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002693sock_connect_ex(PySocketSockObject *s, PyObject *addro)
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 sock_addr_t addrbuf;
2696 int addrlen;
2697 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2700 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002701
Victor Stinner81c41db2015-04-02 11:50:57 +02002702 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, 0);
Victor Stinner71694d52015-03-28 01:18:54 +01002703 if (res < 0)
2704 return NULL;
2705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 return PyLong_FromLong((long) res);
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002707}
2708
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002709PyDoc_STRVAR(connect_ex_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002710"connect_ex(address) -> errno\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002711\n\
2712This is like connect(address), but returns an error code (the errno value)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002713instead of raising an exception when an error occurs.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002714
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002715
Guido van Rossumed233a51992-06-23 09:07:03 +00002716/* s.fileno() method */
2717
Guido van Rossum73624e91994-10-10 17:59:00 +00002718static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002719sock_fileno(PySocketSockObject *s)
Guido van Rossumed233a51992-06-23 09:07:03 +00002720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 return PyLong_FromSocket_t(s->sock_fd);
Guido van Rossumed233a51992-06-23 09:07:03 +00002722}
2723
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002724PyDoc_STRVAR(fileno_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002725"fileno() -> integer\n\
2726\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002727Return the integer file descriptor of the socket.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002728
Guido van Rossumed233a51992-06-23 09:07:03 +00002729
Guido van Rossumc89705d1992-11-26 08:54:07 +00002730/* s.getsockname() method */
2731
Guido van Rossum73624e91994-10-10 17:59:00 +00002732static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002733sock_getsockname(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 sock_addr_t addrbuf;
2736 int res;
2737 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 if (!getsockaddrlen(s, &addrlen))
2740 return NULL;
2741 memset(&addrbuf, 0, addrlen);
2742 Py_BEGIN_ALLOW_THREADS
2743 res = getsockname(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2744 Py_END_ALLOW_THREADS
2745 if (res < 0)
2746 return s->errorhandler();
2747 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2748 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002749}
2750
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002751PyDoc_STRVAR(getsockname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002752"getsockname() -> address info\n\
2753\n\
2754Return the address of the local endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002755info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002756
Guido van Rossumc89705d1992-11-26 08:54:07 +00002757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002758#ifdef HAVE_GETPEERNAME /* Cray APP doesn't have this :-( */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002759/* s.getpeername() method */
2760
Guido van Rossum73624e91994-10-10 17:59:00 +00002761static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002762sock_getpeername(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002763{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 sock_addr_t addrbuf;
2765 int res;
2766 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 if (!getsockaddrlen(s, &addrlen))
2769 return NULL;
2770 memset(&addrbuf, 0, addrlen);
2771 Py_BEGIN_ALLOW_THREADS
2772 res = getpeername(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2773 Py_END_ALLOW_THREADS
2774 if (res < 0)
2775 return s->errorhandler();
2776 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2777 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002778}
Guido van Rossum82a5c661998-07-07 20:45:43 +00002779
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002780PyDoc_STRVAR(getpeername_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002781"getpeername() -> address info\n\
2782\n\
2783Return the address of the remote endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002784info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002785
Guido van Rossumb6775db1994-08-01 11:34:53 +00002786#endif /* HAVE_GETPEERNAME */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002787
2788
Guido van Rossum30a685f1991-06-27 15:51:29 +00002789/* s.listen(n) method */
2790
Guido van Rossum73624e91994-10-10 17:59:00 +00002791static PyObject *
Charles-François Natali644b8f52014-05-22 19:45:39 +01002792sock_listen(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002793{
Charles-François Natali644b8f52014-05-22 19:45:39 +01002794 /* We try to choose a default backlog high enough to avoid connection drops
2795 * for common workloads, yet not too high to limit resource usage. */
2796 int backlog = Py_MIN(SOMAXCONN, 128);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002797 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002798
Charles-François Natali644b8f52014-05-22 19:45:39 +01002799 if (!PyArg_ParseTuple(args, "|i:listen", &backlog))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 return NULL;
Charles-François Natali644b8f52014-05-22 19:45:39 +01002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002803 /* To avoid problems on systems that don't allow a negative backlog
2804 * (which doesn't make sense anyway) we force a minimum value of 0. */
2805 if (backlog < 0)
2806 backlog = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 res = listen(s->sock_fd, backlog);
2808 Py_END_ALLOW_THREADS
2809 if (res < 0)
2810 return s->errorhandler();
2811 Py_INCREF(Py_None);
2812 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002813}
2814
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002815PyDoc_STRVAR(listen_doc,
Charles-François Natali644b8f52014-05-22 19:45:39 +01002816"listen([backlog])\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002817\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002818Enable a server to accept connections. If backlog is specified, it must be\n\
2819at least 0 (if it is lower, it is set to 0); it specifies the number of\n\
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002820unaccepted connections that the system will allow before refusing new\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002821connections. If not specified, a default reasonable value is chosen.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002822
Victor Stinner31bf2d52015-04-01 21:57:09 +02002823struct sock_recv {
2824 char *cbuf;
2825 Py_ssize_t len;
2826 int flags;
2827 Py_ssize_t result;
2828};
2829
2830static int
2831sock_recv_impl(PySocketSockObject *s, void *data)
2832{
2833 struct sock_recv *ctx = data;
2834
2835#ifdef MS_WINDOWS
2836 if (ctx->len > INT_MAX)
2837 ctx->len = INT_MAX;
2838 ctx->result = recv(s->sock_fd, ctx->cbuf, (int)ctx->len, ctx->flags);
2839#else
2840 ctx->result = recv(s->sock_fd, ctx->cbuf, ctx->len, ctx->flags);
2841#endif
2842 return (ctx->result >= 0);
2843}
2844
Guido van Rossum82a5c661998-07-07 20:45:43 +00002845
Thomas Wouters477c8d52006-05-27 19:21:47 +00002846/*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002847 * This is the guts of the recv() and recv_into() methods, which reads into a
Thomas Wouters902d6eb2007-01-09 23:18:33 +00002848 * char buffer. If you have any inc/dec ref to do to the objects that contain
Thomas Wouters477c8d52006-05-27 19:21:47 +00002849 * the buffer, do it in the caller. This function returns the number of bytes
Ezio Melotti13925002011-03-16 11:05:33 +02002850 * successfully read. If there was an error, it returns -1. Note that it is
Thomas Wouters477c8d52006-05-27 19:21:47 +00002851 * also possible that we return a number of bytes smaller than the request
2852 * bytes.
2853 */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002854
Antoine Pitrou19467d22010-08-17 19:33:30 +00002855static Py_ssize_t
2856sock_recv_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002857{
Victor Stinner31bf2d52015-04-01 21:57:09 +02002858 struct sock_recv ctx;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002860 if (!IS_SELECTABLE(s)) {
2861 select_error();
2862 return -1;
2863 }
2864 if (len == 0) {
2865 /* If 0 bytes were requested, do nothing. */
2866 return 0;
2867 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002868
Victor Stinner31bf2d52015-04-01 21:57:09 +02002869 ctx.cbuf = cbuf;
2870 ctx.len = len;
2871 ctx.flags = flags;
2872 if (sock_call(s, 0, sock_recv_impl, &ctx) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 return -1;
Victor Stinner31bf2d52015-04-01 21:57:09 +02002874
2875 return ctx.result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002876}
2877
Guido van Rossum48a680c2001-03-02 06:34:14 +00002878
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00002879/* s.recv(nbytes [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002880
Guido van Rossum73624e91994-10-10 17:59:00 +00002881static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002882sock_recv(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00002883{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002884 Py_ssize_t recvlen, outlen;
2885 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002886 PyObject *buf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002887
Antoine Pitrou19467d22010-08-17 19:33:30 +00002888 if (!PyArg_ParseTuple(args, "n|i:recv", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002889 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 if (recvlen < 0) {
2892 PyErr_SetString(PyExc_ValueError,
2893 "negative buffersize in recv");
2894 return NULL;
2895 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 /* Allocate a new string. */
2898 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2899 if (buf == NULL)
2900 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002902 /* Call the guts */
2903 outlen = sock_recv_guts(s, PyBytes_AS_STRING(buf), recvlen, flags);
2904 if (outlen < 0) {
2905 /* An error occurred, release the string and return an
2906 error. */
2907 Py_DECREF(buf);
2908 return NULL;
2909 }
2910 if (outlen != recvlen) {
2911 /* We did not read as many bytes as we anticipated, resize the
2912 string if possible and be successful. */
2913 _PyBytes_Resize(&buf, outlen);
2914 }
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00002915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 return buf;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002917}
2918
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002919PyDoc_STRVAR(recv_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002920"recv(buffersize[, flags]) -> data\n\
2921\n\
2922Receive up to buffersize bytes from the socket. For the optional flags\n\
2923argument, see the Unix manual. When no data is available, block until\n\
2924at least one byte is available or until the remote end is closed. When\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002925the remote end is closed and all data is read, return the empty string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002926
Guido van Rossum30a685f1991-06-27 15:51:29 +00002927
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002928/* s.recv_into(buffer, [nbytes [,flags]]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002929
Thomas Wouters477c8d52006-05-27 19:21:47 +00002930static PyObject*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002931sock_recv_into(PySocketSockObject *s, PyObject *args, PyObject *kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002932{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002933 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002934
Antoine Pitrou19467d22010-08-17 19:33:30 +00002935 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002936 Py_buffer pbuf;
2937 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002938 Py_ssize_t buflen, readlen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 /* Get the buffer's memory */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002941 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recv_into", kwlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002942 &pbuf, &recvlen, &flags))
2943 return NULL;
2944 buf = pbuf.buf;
2945 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002947 if (recvlen < 0) {
2948 PyBuffer_Release(&pbuf);
2949 PyErr_SetString(PyExc_ValueError,
2950 "negative buffersize in recv_into");
2951 return NULL;
2952 }
2953 if (recvlen == 0) {
2954 /* If nbytes was not specified, use the buffer's length */
2955 recvlen = buflen;
2956 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 /* Check if the buffer is large enough */
2959 if (buflen < recvlen) {
2960 PyBuffer_Release(&pbuf);
2961 PyErr_SetString(PyExc_ValueError,
2962 "buffer too small for requested bytes");
2963 return NULL;
2964 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 /* Call the guts */
2967 readlen = sock_recv_guts(s, buf, recvlen, flags);
2968 if (readlen < 0) {
2969 /* Return an error. */
2970 PyBuffer_Release(&pbuf);
2971 return NULL;
2972 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002974 PyBuffer_Release(&pbuf);
2975 /* Return the number of bytes read. Note that we do not do anything
2976 special here in the case that readlen < recvlen. */
2977 return PyLong_FromSsize_t(readlen);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002978}
2979
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002980PyDoc_STRVAR(recv_into_doc,
2981"recv_into(buffer, [nbytes[, flags]]) -> nbytes_read\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002982\n\
2983A version of recv() that stores its data into a buffer rather than creating \n\
2984a new string. Receive up to buffersize bytes from the socket. If buffersize \n\
2985is not specified (or 0), receive up to the size available in the given buffer.\n\
2986\n\
2987See recv() for documentation about the flags.");
2988
Victor Stinner31bf2d52015-04-01 21:57:09 +02002989struct sock_recvfrom {
2990 char* cbuf;
2991 Py_ssize_t len;
2992 int flags;
2993 socklen_t *addrlen;
2994 sock_addr_t *addrbuf;
2995 Py_ssize_t result;
2996};
2997
2998static int
2999sock_recvfrom_impl(PySocketSockObject *s, void *data)
3000{
3001 struct sock_recvfrom *ctx = data;
3002
3003 memset(ctx->addrbuf, 0, *ctx->addrlen);
3004
3005#ifdef MS_WINDOWS
3006 if (ctx->len > INT_MAX)
3007 ctx->len = INT_MAX;
3008 ctx->result = recvfrom(s->sock_fd, ctx->cbuf, (int)ctx->len, ctx->flags,
3009 SAS2SA(ctx->addrbuf), ctx->addrlen);
3010#else
3011 ctx->result = recvfrom(s->sock_fd, ctx->cbuf, ctx->len, ctx->flags,
3012 SAS2SA(ctx->addrbuf), ctx->addrlen);
3013#endif
3014 return (ctx->result >= 0);
3015}
3016
Thomas Wouters477c8d52006-05-27 19:21:47 +00003017
3018/*
Christian Heimes99170a52007-12-19 02:07:34 +00003019 * This is the guts of the recvfrom() and recvfrom_into() methods, which reads
3020 * into a char buffer. If you have any inc/def ref to do to the objects that
3021 * contain the buffer, do it in the caller. This function returns the number
Ezio Melotti13925002011-03-16 11:05:33 +02003022 * of bytes successfully read. If there was an error, it returns -1. Note
Christian Heimes99170a52007-12-19 02:07:34 +00003023 * that it is also possible that we return a number of bytes smaller than the
3024 * request bytes.
Thomas Wouters477c8d52006-05-27 19:21:47 +00003025 *
3026 * 'addr' is a return value for the address object. Note that you must decref
3027 * it yourself.
3028 */
Antoine Pitrou19467d22010-08-17 19:33:30 +00003029static Py_ssize_t
3030sock_recvfrom_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 PyObject** addr)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 sock_addr_t addrbuf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 socklen_t addrlen;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003035 struct sock_recvfrom ctx;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 *addr = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003039 if (!getsockaddrlen(s, &addrlen))
3040 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 if (!IS_SELECTABLE(s)) {
3043 select_error();
3044 return -1;
3045 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003046
Victor Stinner31bf2d52015-04-01 21:57:09 +02003047 ctx.cbuf = cbuf;
3048 ctx.len = len;
3049 ctx.flags = flags;
3050 ctx.addrbuf = &addrbuf;
3051 ctx.addrlen = &addrlen;
3052 if (sock_call(s, 0, sock_recvfrom_impl, &ctx) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003054
Victor Stinner31bf2d52015-04-01 21:57:09 +02003055 *addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
3056 s->sock_proto);
3057 if (*addr == NULL)
3058 return -1;
3059
3060 return ctx.result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003061}
3062
3063/* s.recvfrom(nbytes [,flags]) method */
3064
3065static PyObject *
3066sock_recvfrom(PySocketSockObject *s, PyObject *args)
3067{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 PyObject *buf = NULL;
3069 PyObject *addr = NULL;
3070 PyObject *ret = NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003071 int flags = 0;
3072 Py_ssize_t recvlen, outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003073
Antoine Pitrou19467d22010-08-17 19:33:30 +00003074 if (!PyArg_ParseTuple(args, "n|i:recvfrom", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00003076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003077 if (recvlen < 0) {
3078 PyErr_SetString(PyExc_ValueError,
3079 "negative buffersize in recvfrom");
3080 return NULL;
3081 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003083 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
3084 if (buf == NULL)
3085 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 outlen = sock_recvfrom_guts(s, PyBytes_AS_STRING(buf),
3088 recvlen, flags, &addr);
3089 if (outlen < 0) {
3090 goto finally;
3091 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 if (outlen != recvlen) {
3094 /* We did not read as many bytes as we anticipated, resize the
Ezio Melotti13925002011-03-16 11:05:33 +02003095 string if possible and be successful. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003096 if (_PyBytes_Resize(&buf, outlen) < 0)
Ezio Melotti13925002011-03-16 11:05:33 +02003097 /* Oopsy, not so successful after all. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003098 goto finally;
3099 }
Barry Warsaw752300b1997-01-03 17:18:10 +00003100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 ret = PyTuple_Pack(2, buf, addr);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003102
3103finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 Py_XDECREF(buf);
3105 Py_XDECREF(addr);
3106 return ret;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003107}
3108
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003109PyDoc_STRVAR(recvfrom_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003110"recvfrom(buffersize[, flags]) -> (data, address info)\n\
3111\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003112Like recv(buffersize, flags) but also return the sender's address info.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003113
Thomas Wouters477c8d52006-05-27 19:21:47 +00003114
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003115/* s.recvfrom_into(buffer[, nbytes [,flags]]) method */
Thomas Wouters477c8d52006-05-27 19:21:47 +00003116
3117static PyObject *
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003118sock_recvfrom_into(PySocketSockObject *s, PyObject *args, PyObject* kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00003119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00003121
Antoine Pitrou19467d22010-08-17 19:33:30 +00003122 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 Py_buffer pbuf;
3124 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003125 Py_ssize_t readlen, buflen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003127 PyObject *addr = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003128
Antoine Pitrou19467d22010-08-17 19:33:30 +00003129 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recvfrom_into",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 kwlist, &pbuf,
3131 &recvlen, &flags))
3132 return NULL;
3133 buf = pbuf.buf;
3134 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003136 if (recvlen < 0) {
3137 PyBuffer_Release(&pbuf);
3138 PyErr_SetString(PyExc_ValueError,
3139 "negative buffersize in recvfrom_into");
3140 return NULL;
3141 }
3142 if (recvlen == 0) {
3143 /* If nbytes was not specified, use the buffer's length */
3144 recvlen = buflen;
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05003145 } else if (recvlen > buflen) {
3146 PyBuffer_Release(&pbuf);
3147 PyErr_SetString(PyExc_ValueError,
3148 "nbytes is greater than the length of the buffer");
3149 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 readlen = sock_recvfrom_guts(s, buf, recvlen, flags, &addr);
3153 if (readlen < 0) {
3154 PyBuffer_Release(&pbuf);
3155 /* Return an error */
3156 Py_XDECREF(addr);
3157 return NULL;
3158 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 PyBuffer_Release(&pbuf);
3161 /* Return the number of bytes read and the address. Note that we do
3162 not do anything special here in the case that readlen < recvlen. */
Antoine Pitrou19467d22010-08-17 19:33:30 +00003163 return Py_BuildValue("nN", readlen, addr);
Thomas Wouters477c8d52006-05-27 19:21:47 +00003164}
3165
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003166PyDoc_STRVAR(recvfrom_into_doc,
3167"recvfrom_into(buffer[, nbytes[, flags]]) -> (nbytes, address info)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00003168\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003169Like recv_into(buffer[, nbytes[, flags]]) but also return the sender's address info.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00003170
Victor Stinner35bee932015-04-02 12:28:07 +02003171/* The sendmsg() and recvmsg[_into]() methods require a working
3172 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3173#ifdef CMSG_LEN
Victor Stinner31bf2d52015-04-01 21:57:09 +02003174struct sock_recvmsg {
3175 struct msghdr *msg;
3176 int flags;
3177 ssize_t result;
3178};
3179
3180static int
3181sock_recvmsg_impl(PySocketSockObject *s, void *data)
3182{
3183 struct sock_recvmsg *ctx = data;
3184
3185 ctx->result = recvmsg(s->sock_fd, ctx->msg, ctx->flags);
3186 return (ctx->result >= 0);
3187}
3188
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003189/*
3190 * Call recvmsg() with the supplied iovec structures, flags, and
3191 * ancillary data buffer size (controllen). Returns the tuple return
3192 * value for recvmsg() or recvmsg_into(), with the first item provided
3193 * by the supplied makeval() function. makeval() will be called with
3194 * the length read and makeval_data as arguments, and must return a
3195 * new reference (which will be decrefed if there is a subsequent
3196 * error). On error, closes any file descriptors received via
3197 * SCM_RIGHTS.
3198 */
3199static PyObject *
3200sock_recvmsg_guts(PySocketSockObject *s, struct iovec *iov, int iovlen,
3201 int flags, Py_ssize_t controllen,
3202 PyObject *(*makeval)(ssize_t, void *), void *makeval_data)
3203{
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003204 sock_addr_t addrbuf;
3205 socklen_t addrbuflen;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003206 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003207 PyObject *cmsg_list = NULL, *retval = NULL;
3208 void *controlbuf = NULL;
3209 struct cmsghdr *cmsgh;
3210 size_t cmsgdatalen = 0;
3211 int cmsg_status;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003212 struct sock_recvmsg ctx;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003213
3214 /* XXX: POSIX says that msg_name and msg_namelen "shall be
3215 ignored" when the socket is connected (Linux fills them in
3216 anyway for AF_UNIX sockets at least). Normally msg_namelen
3217 seems to be set to 0 if there's no address, but try to
3218 initialize msg_name to something that won't be mistaken for a
3219 real address if that doesn't happen. */
3220 if (!getsockaddrlen(s, &addrbuflen))
3221 return NULL;
3222 memset(&addrbuf, 0, addrbuflen);
3223 SAS2SA(&addrbuf)->sa_family = AF_UNSPEC;
3224
3225 if (controllen < 0 || controllen > SOCKLEN_T_LIMIT) {
3226 PyErr_SetString(PyExc_ValueError,
3227 "invalid ancillary data buffer length");
3228 return NULL;
3229 }
3230 if (controllen > 0 && (controlbuf = PyMem_Malloc(controllen)) == NULL)
3231 return PyErr_NoMemory();
3232
3233 /* Make the system call. */
3234 if (!IS_SELECTABLE(s)) {
3235 select_error();
3236 goto finally;
3237 }
3238
Victor Stinner31bf2d52015-04-01 21:57:09 +02003239 msg.msg_name = SAS2SA(&addrbuf);
3240 msg.msg_namelen = addrbuflen;
3241 msg.msg_iov = iov;
3242 msg.msg_iovlen = iovlen;
3243 msg.msg_control = controlbuf;
3244 msg.msg_controllen = controllen;
Victor Stinnerb7df3142015-03-27 22:59:32 +01003245
Victor Stinner31bf2d52015-04-01 21:57:09 +02003246 ctx.msg = &msg;
3247 ctx.flags = flags;
3248 if (sock_call(s, 0, sock_recvmsg_impl, &ctx) < 0)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003249 goto finally;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003250
3251 /* Make list of (level, type, data) tuples from control messages. */
3252 if ((cmsg_list = PyList_New(0)) == NULL)
3253 goto err_closefds;
3254 /* Check for empty ancillary data as old CMSG_FIRSTHDR()
3255 implementations didn't do so. */
3256 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3257 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3258 PyObject *bytes, *tuple;
3259 int tmp;
3260
3261 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3262 if (cmsg_status != 0) {
3263 if (PyErr_WarnEx(PyExc_RuntimeWarning,
3264 "received malformed or improperly-truncated "
3265 "ancillary data", 1) == -1)
3266 goto err_closefds;
3267 }
3268 if (cmsg_status < 0)
3269 break;
3270 if (cmsgdatalen > PY_SSIZE_T_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003271 PyErr_SetString(PyExc_OSError, "control message too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003272 goto err_closefds;
3273 }
3274
3275 bytes = PyBytes_FromStringAndSize((char *)CMSG_DATA(cmsgh),
3276 cmsgdatalen);
3277 tuple = Py_BuildValue("iiN", (int)cmsgh->cmsg_level,
3278 (int)cmsgh->cmsg_type, bytes);
3279 if (tuple == NULL)
3280 goto err_closefds;
3281 tmp = PyList_Append(cmsg_list, tuple);
3282 Py_DECREF(tuple);
3283 if (tmp != 0)
3284 goto err_closefds;
3285
3286 if (cmsg_status != 0)
3287 break;
3288 }
3289
3290 retval = Py_BuildValue("NOiN",
Victor Stinner31bf2d52015-04-01 21:57:09 +02003291 (*makeval)(ctx.result, makeval_data),
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003292 cmsg_list,
3293 (int)msg.msg_flags,
3294 makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
3295 ((msg.msg_namelen > addrbuflen) ?
3296 addrbuflen : msg.msg_namelen),
3297 s->sock_proto));
3298 if (retval == NULL)
3299 goto err_closefds;
3300
3301finally:
3302 Py_XDECREF(cmsg_list);
3303 PyMem_Free(controlbuf);
3304 return retval;
3305
3306err_closefds:
3307#ifdef SCM_RIGHTS
3308 /* Close all descriptors coming from SCM_RIGHTS, so they don't leak. */
3309 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3310 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3311 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3312 if (cmsg_status < 0)
3313 break;
3314 if (cmsgh->cmsg_level == SOL_SOCKET &&
3315 cmsgh->cmsg_type == SCM_RIGHTS) {
3316 size_t numfds;
3317 int *fdp;
3318
3319 numfds = cmsgdatalen / sizeof(int);
3320 fdp = (int *)CMSG_DATA(cmsgh);
3321 while (numfds-- > 0)
3322 close(*fdp++);
3323 }
3324 if (cmsg_status != 0)
3325 break;
3326 }
3327#endif /* SCM_RIGHTS */
3328 goto finally;
3329}
3330
3331
3332static PyObject *
3333makeval_recvmsg(ssize_t received, void *data)
3334{
3335 PyObject **buf = data;
3336
3337 if (received < PyBytes_GET_SIZE(*buf))
3338 _PyBytes_Resize(buf, received);
3339 Py_XINCREF(*buf);
3340 return *buf;
3341}
3342
3343/* s.recvmsg(bufsize[, ancbufsize[, flags]]) method */
3344
3345static PyObject *
3346sock_recvmsg(PySocketSockObject *s, PyObject *args)
3347{
3348 Py_ssize_t bufsize, ancbufsize = 0;
3349 int flags = 0;
3350 struct iovec iov;
3351 PyObject *buf = NULL, *retval = NULL;
3352
3353 if (!PyArg_ParseTuple(args, "n|ni:recvmsg", &bufsize, &ancbufsize, &flags))
3354 return NULL;
3355
3356 if (bufsize < 0) {
3357 PyErr_SetString(PyExc_ValueError, "negative buffer size in recvmsg()");
3358 return NULL;
3359 }
3360 if ((buf = PyBytes_FromStringAndSize(NULL, bufsize)) == NULL)
3361 return NULL;
3362 iov.iov_base = PyBytes_AS_STRING(buf);
3363 iov.iov_len = bufsize;
3364
3365 /* Note that we're passing a pointer to *our pointer* to the bytes
3366 object here (&buf); makeval_recvmsg() may incref the object, or
3367 deallocate it and set our pointer to NULL. */
3368 retval = sock_recvmsg_guts(s, &iov, 1, flags, ancbufsize,
3369 &makeval_recvmsg, &buf);
3370 Py_XDECREF(buf);
3371 return retval;
3372}
3373
3374PyDoc_STRVAR(recvmsg_doc,
3375"recvmsg(bufsize[, ancbufsize[, flags]]) -> (data, ancdata, msg_flags, address)\n\
3376\n\
3377Receive normal data (up to bufsize bytes) and ancillary data from the\n\
3378socket. The ancbufsize argument sets the size in bytes of the\n\
3379internal buffer used to receive the ancillary data; it defaults to 0,\n\
3380meaning that no ancillary data will be received. Appropriate buffer\n\
3381sizes for ancillary data can be calculated using CMSG_SPACE() or\n\
3382CMSG_LEN(), and items which do not fit into the buffer might be\n\
3383truncated or discarded. The flags argument defaults to 0 and has the\n\
3384same meaning as for recv().\n\
3385\n\
3386The return value is a 4-tuple: (data, ancdata, msg_flags, address).\n\
3387The data item is a bytes object holding the non-ancillary data\n\
3388received. The ancdata item is a list of zero or more tuples\n\
3389(cmsg_level, cmsg_type, cmsg_data) representing the ancillary data\n\
3390(control messages) received: cmsg_level and cmsg_type are integers\n\
3391specifying the protocol level and protocol-specific type respectively,\n\
3392and cmsg_data is a bytes object holding the associated data. The\n\
3393msg_flags item is the bitwise OR of various flags indicating\n\
3394conditions on the received message; see your system documentation for\n\
3395details. If the receiving socket is unconnected, address is the\n\
3396address of the sending socket, if available; otherwise, its value is\n\
3397unspecified.\n\
3398\n\
3399If recvmsg() raises an exception after the system call returns, it\n\
3400will first attempt to close any file descriptors received via the\n\
3401SCM_RIGHTS mechanism.");
3402
3403
3404static PyObject *
3405makeval_recvmsg_into(ssize_t received, void *data)
3406{
3407 return PyLong_FromSsize_t(received);
3408}
3409
3410/* s.recvmsg_into(buffers[, ancbufsize[, flags]]) method */
3411
3412static PyObject *
3413sock_recvmsg_into(PySocketSockObject *s, PyObject *args)
3414{
3415 Py_ssize_t ancbufsize = 0;
3416 int flags = 0;
3417 struct iovec *iovs = NULL;
3418 Py_ssize_t i, nitems, nbufs = 0;
3419 Py_buffer *bufs = NULL;
3420 PyObject *buffers_arg, *fast, *retval = NULL;
3421
3422 if (!PyArg_ParseTuple(args, "O|ni:recvmsg_into",
3423 &buffers_arg, &ancbufsize, &flags))
3424 return NULL;
3425
3426 if ((fast = PySequence_Fast(buffers_arg,
3427 "recvmsg_into() argument 1 must be an "
3428 "iterable")) == NULL)
3429 return NULL;
3430 nitems = PySequence_Fast_GET_SIZE(fast);
3431 if (nitems > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003432 PyErr_SetString(PyExc_OSError, "recvmsg_into() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003433 goto finally;
3434 }
3435
3436 /* Fill in an iovec for each item, and save the Py_buffer
3437 structs to release afterwards. */
3438 if (nitems > 0 && ((iovs = PyMem_New(struct iovec, nitems)) == NULL ||
3439 (bufs = PyMem_New(Py_buffer, nitems)) == NULL)) {
3440 PyErr_NoMemory();
3441 goto finally;
3442 }
3443 for (; nbufs < nitems; nbufs++) {
3444 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(fast, nbufs),
3445 "w*;recvmsg_into() argument 1 must be an iterable "
3446 "of single-segment read-write buffers",
3447 &bufs[nbufs]))
3448 goto finally;
3449 iovs[nbufs].iov_base = bufs[nbufs].buf;
3450 iovs[nbufs].iov_len = bufs[nbufs].len;
3451 }
3452
3453 retval = sock_recvmsg_guts(s, iovs, nitems, flags, ancbufsize,
3454 &makeval_recvmsg_into, NULL);
3455finally:
3456 for (i = 0; i < nbufs; i++)
3457 PyBuffer_Release(&bufs[i]);
3458 PyMem_Free(bufs);
3459 PyMem_Free(iovs);
3460 Py_DECREF(fast);
3461 return retval;
3462}
3463
3464PyDoc_STRVAR(recvmsg_into_doc,
3465"recvmsg_into(buffers[, ancbufsize[, flags]]) -> (nbytes, ancdata, msg_flags, address)\n\
3466\n\
3467Receive normal data and ancillary data from the socket, scattering the\n\
3468non-ancillary data into a series of buffers. The buffers argument\n\
3469must be an iterable of objects that export writable buffers\n\
3470(e.g. bytearray objects); these will be filled with successive chunks\n\
3471of the non-ancillary data until it has all been written or there are\n\
3472no more buffers. The ancbufsize argument sets the size in bytes of\n\
3473the internal buffer used to receive the ancillary data; it defaults to\n\
34740, meaning that no ancillary data will be received. Appropriate\n\
3475buffer sizes for ancillary data can be calculated using CMSG_SPACE()\n\
3476or CMSG_LEN(), and items which do not fit into the buffer might be\n\
3477truncated or discarded. The flags argument defaults to 0 and has the\n\
3478same meaning as for recv().\n\
3479\n\
3480The return value is a 4-tuple: (nbytes, ancdata, msg_flags, address).\n\
3481The nbytes item is the total number of bytes of non-ancillary data\n\
3482written into the buffers. The ancdata item is a list of zero or more\n\
3483tuples (cmsg_level, cmsg_type, cmsg_data) representing the ancillary\n\
3484data (control messages) received: cmsg_level and cmsg_type are\n\
3485integers specifying the protocol level and protocol-specific type\n\
3486respectively, and cmsg_data is a bytes object holding the associated\n\
3487data. The msg_flags item is the bitwise OR of various flags\n\
3488indicating conditions on the received message; see your system\n\
3489documentation for details. If the receiving socket is unconnected,\n\
3490address is the address of the sending socket, if available; otherwise,\n\
3491its value is unspecified.\n\
3492\n\
3493If recvmsg_into() raises an exception after the system call returns,\n\
3494it will first attempt to close any file descriptors received via the\n\
3495SCM_RIGHTS mechanism.");
3496#endif /* CMSG_LEN */
3497
3498
Victor Stinner31bf2d52015-04-01 21:57:09 +02003499struct sock_send {
3500 char *buf;
3501 Py_ssize_t len;
3502 int flags;
3503 Py_ssize_t result;
3504};
3505
3506static int
3507sock_send_impl(PySocketSockObject *s, void *data)
3508{
3509 struct sock_send *ctx = data;
3510
3511#ifdef MS_WINDOWS
3512 if (ctx->len > INT_MAX)
3513 ctx->len = INT_MAX;
3514 ctx->result = send(s->sock_fd, ctx->buf, (int)ctx->len, ctx->flags);
3515#else
3516 ctx->result = send(s->sock_fd, ctx->buf, ctx->len, ctx->flags);
3517#endif
3518 return (ctx->result >= 0);
3519}
3520
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003521/* s.send(data [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003522
Guido van Rossum73624e91994-10-10 17:59:00 +00003523static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003524sock_send(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00003525{
Victor Stinner31bf2d52015-04-01 21:57:09 +02003526 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 Py_buffer pbuf;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003528 struct sock_send ctx;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003530 if (!PyArg_ParseTuple(args, "y*|i:send", &pbuf, &flags))
3531 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 if (!IS_SELECTABLE(s)) {
3534 PyBuffer_Release(&pbuf);
3535 return select_error();
3536 }
Victor Stinner31bf2d52015-04-01 21:57:09 +02003537 ctx.buf = pbuf.buf;
3538 ctx.len = pbuf.len;
3539 ctx.flags = flags;
3540 if (sock_call(s, 1, sock_send_impl, &ctx) < 0) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003541 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003542 return NULL;
3543 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003544 PyBuffer_Release(&pbuf);
Victor Stinner31bf2d52015-04-01 21:57:09 +02003545
3546 return PyLong_FromSsize_t(ctx.result);
Guido van Rossum30a685f1991-06-27 15:51:29 +00003547}
3548
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003549PyDoc_STRVAR(send_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003550"send(data[, flags]) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003551\n\
3552Send a data string to the socket. For the optional flags\n\
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003553argument, see the Unix manual. Return the number of bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003554sent; this may be less than len(data) if the network is busy.");
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003555
3556
3557/* s.sendall(data [,flags]) method */
3558
3559static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003560sock_sendall(PySocketSockObject *s, PyObject *args)
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003562 char *buf;
Victor Stinner02f32ab2015-04-01 22:53:26 +02003563 Py_ssize_t len, n;
3564 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003565 Py_buffer pbuf;
Victor Stinner02f32ab2015-04-01 22:53:26 +02003566 struct sock_send ctx;
Victor Stinner8912d142015-04-06 23:16:34 +02003567 int has_timeout = (s->sock_timeout > 0);
3568 _PyTime_t interval = s->sock_timeout;
3569 _PyTime_t deadline = 0;
3570 int deadline_initialized = 0;
3571 PyObject *res = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 if (!PyArg_ParseTuple(args, "y*|i:sendall", &pbuf, &flags))
3574 return NULL;
3575 buf = pbuf.buf;
3576 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 if (!IS_SELECTABLE(s)) {
3579 PyBuffer_Release(&pbuf);
3580 return select_error();
3581 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 do {
Victor Stinner8912d142015-04-06 23:16:34 +02003584 if (has_timeout) {
3585 if (deadline_initialized) {
3586 /* recompute the timeout */
3587 interval = deadline - _PyTime_GetMonotonicClock();
3588 }
3589 else {
3590 deadline_initialized = 1;
3591 deadline = _PyTime_GetMonotonicClock() + s->sock_timeout;
3592 }
3593
3594 if (interval <= 0) {
3595 PyErr_SetString(socket_timeout, "timed out");
3596 goto done;
3597 }
3598 }
3599
Victor Stinner02f32ab2015-04-01 22:53:26 +02003600 ctx.buf = buf;
3601 ctx.len = len;
3602 ctx.flags = flags;
Victor Stinner8912d142015-04-06 23:16:34 +02003603 if (sock_call_ex(s, 1, sock_send_impl, &ctx, 0, NULL, interval) < 0)
3604 goto done;
Victor Stinner02f32ab2015-04-01 22:53:26 +02003605 n = ctx.result;
3606 assert(n >= 0);
3607
3608 buf += n;
3609 len -= n;
3610
3611 /* We must run our signal handlers before looping again.
3612 send() can return a successful partial write when it is
3613 interrupted, so we can't restrict ourselves to EINTR. */
Victor Stinner8912d142015-04-06 23:16:34 +02003614 if (PyErr_CheckSignals())
3615 goto done;
Victor Stinner02f32ab2015-04-01 22:53:26 +02003616 } while (len > 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003617 PyBuffer_Release(&pbuf);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003618
Victor Stinner8912d142015-04-06 23:16:34 +02003619 Py_INCREF(Py_None);
3620 res = Py_None;
3621
3622done:
3623 PyBuffer_Release(&pbuf);
3624 return res;
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003625}
3626
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003627PyDoc_STRVAR(sendall_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003628"sendall(data[, flags])\n\
3629\n\
3630Send a data string to the socket. For the optional flags\n\
3631argument, see the Unix manual. This calls send() repeatedly\n\
3632until all data is sent. If an error occurs, it's impossible\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003633to tell how much data has been sent.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003634
Guido van Rossum30a685f1991-06-27 15:51:29 +00003635
Victor Stinner31bf2d52015-04-01 21:57:09 +02003636struct sock_sendto {
3637 char *buf;
3638 Py_ssize_t len;
3639 int flags;
3640 int addrlen;
3641 sock_addr_t *addrbuf;
3642 Py_ssize_t result;
3643};
3644
3645static int
3646sock_sendto_impl(PySocketSockObject *s, void *data)
3647{
3648 struct sock_sendto *ctx = data;
3649
3650#ifdef MS_WINDOWS
3651 if (ctx->len > INT_MAX)
3652 ctx->len = INT_MAX;
3653 ctx->result = sendto(s->sock_fd, ctx->buf, (int)ctx->len, ctx->flags,
3654 SAS2SA(ctx->addrbuf), ctx->addrlen);
3655#else
3656 ctx->result = sendto(s->sock_fd, ctx->buf, ctx->len, ctx->flags,
3657 SAS2SA(ctx->addrbuf), ctx->addrlen);
3658#endif
3659 return (ctx->result >= 0);
3660}
3661
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003662/* s.sendto(data, [flags,] sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003663
Guido van Rossum73624e91994-10-10 17:59:00 +00003664static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003665sock_sendto(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003666{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 Py_buffer pbuf;
3668 PyObject *addro;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003669 Py_ssize_t arglen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003670 sock_addr_t addrbuf;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003671 int addrlen, flags;
3672 struct sock_sendto ctx;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 flags = 0;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003675 arglen = PyTuple_Size(args);
3676 switch (arglen) {
3677 case 2:
3678 PyArg_ParseTuple(args, "y*O:sendto", &pbuf, &addro);
3679 break;
3680 case 3:
3681 PyArg_ParseTuple(args, "y*iO:sendto",
3682 &pbuf, &flags, &addro);
3683 break;
3684 default:
3685 PyErr_Format(PyExc_TypeError,
3686 "sendto() takes 2 or 3 arguments (%d given)",
3687 arglen);
Victor Stinner77af1722011-05-26 14:05:59 +02003688 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 }
Antoine Pitrou5e981412011-03-17 22:38:37 +01003690 if (PyErr_Occurred())
3691 return NULL;
3692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 if (!IS_SELECTABLE(s)) {
3694 PyBuffer_Release(&pbuf);
3695 return select_error();
3696 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen)) {
3699 PyBuffer_Release(&pbuf);
3700 return NULL;
3701 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00003702
Victor Stinner31bf2d52015-04-01 21:57:09 +02003703 ctx.buf = pbuf.buf;
3704 ctx.len = pbuf.len;
3705 ctx.flags = flags;
3706 ctx.addrlen = addrlen;
3707 ctx.addrbuf = &addrbuf;
3708 if (sock_call(s, 1, sock_sendto_impl, &ctx) < 0) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003709 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003710 return NULL;
3711 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003712 PyBuffer_Release(&pbuf);
Victor Stinner31bf2d52015-04-01 21:57:09 +02003713
3714 return PyLong_FromSsize_t(ctx.result);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003715}
3716
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003717PyDoc_STRVAR(sendto_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00003718"sendto(data[, flags], address) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003719\n\
3720Like send(data, flags) but allows specifying the destination address.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003721For IP sockets, the address is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003722
Guido van Rossum30a685f1991-06-27 15:51:29 +00003723
Victor Stinner35bee932015-04-02 12:28:07 +02003724/* The sendmsg() and recvmsg[_into]() methods require a working
3725 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3726#ifdef CMSG_LEN
Victor Stinner31bf2d52015-04-01 21:57:09 +02003727struct sock_sendmsg {
3728 struct msghdr *msg;
3729 int flags;
3730 ssize_t result;
3731};
3732
3733static int
3734sock_sendmsg_impl(PySocketSockObject *s, void *data)
3735{
3736 struct sock_sendmsg *ctx = data;
3737
3738 ctx->result = sendmsg(s->sock_fd, ctx->msg, ctx->flags);
3739 return (ctx->result >= 0);
3740}
3741
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003742/* s.sendmsg(buffers[, ancdata[, flags[, address]]]) method */
3743
3744static PyObject *
3745sock_sendmsg(PySocketSockObject *s, PyObject *args)
3746{
3747 Py_ssize_t i, ndataparts, ndatabufs = 0, ncmsgs, ncmsgbufs = 0;
3748 Py_buffer *databufs = NULL;
3749 struct iovec *iovs = NULL;
3750 sock_addr_t addrbuf;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003751 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003752 struct cmsginfo {
3753 int level;
3754 int type;
3755 Py_buffer data;
3756 } *cmsgs = NULL;
3757 void *controlbuf = NULL;
3758 size_t controllen, controllen_last;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003759 int addrlen, flags = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003760 PyObject *data_arg, *cmsg_arg = NULL, *addr_arg = NULL, *data_fast = NULL,
3761 *cmsg_fast = NULL, *retval = NULL;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003762 struct sock_sendmsg ctx;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003763
3764 if (!PyArg_ParseTuple(args, "O|OiO:sendmsg",
3765 &data_arg, &cmsg_arg, &flags, &addr_arg))
3766 return NULL;
3767
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003768 /* Parse destination address. */
3769 if (addr_arg != NULL && addr_arg != Py_None) {
3770 if (!getsockaddrarg(s, addr_arg, SAS2SA(&addrbuf), &addrlen))
3771 goto finally;
3772 msg.msg_name = &addrbuf;
3773 msg.msg_namelen = addrlen;
3774 }
3775
3776 /* Fill in an iovec for each message part, and save the Py_buffer
3777 structs to release afterwards. */
3778 if ((data_fast = PySequence_Fast(data_arg,
3779 "sendmsg() argument 1 must be an "
3780 "iterable")) == NULL)
3781 goto finally;
3782 ndataparts = PySequence_Fast_GET_SIZE(data_fast);
3783 if (ndataparts > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003784 PyErr_SetString(PyExc_OSError, "sendmsg() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003785 goto finally;
3786 }
3787 msg.msg_iovlen = ndataparts;
3788 if (ndataparts > 0 &&
3789 ((msg.msg_iov = iovs = PyMem_New(struct iovec, ndataparts)) == NULL ||
3790 (databufs = PyMem_New(Py_buffer, ndataparts)) == NULL)) {
3791 PyErr_NoMemory();
3792 goto finally;
3793 }
3794 for (; ndatabufs < ndataparts; ndatabufs++) {
3795 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(data_fast, ndatabufs),
3796 "y*;sendmsg() argument 1 must be an iterable of "
Serhiy Storchakab757c832014-12-05 22:25:22 +02003797 "bytes-like objects",
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003798 &databufs[ndatabufs]))
3799 goto finally;
3800 iovs[ndatabufs].iov_base = databufs[ndatabufs].buf;
3801 iovs[ndatabufs].iov_len = databufs[ndatabufs].len;
3802 }
3803
3804 if (cmsg_arg == NULL)
3805 ncmsgs = 0;
3806 else {
3807 if ((cmsg_fast = PySequence_Fast(cmsg_arg,
3808 "sendmsg() argument 2 must be an "
3809 "iterable")) == NULL)
3810 goto finally;
3811 ncmsgs = PySequence_Fast_GET_SIZE(cmsg_fast);
3812 }
3813
3814#ifndef CMSG_SPACE
3815 if (ncmsgs > 1) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003816 PyErr_SetString(PyExc_OSError,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003817 "sending multiple control messages is not supported "
3818 "on this system");
3819 goto finally;
3820 }
3821#endif
3822 /* Save level, type and Py_buffer for each control message,
3823 and calculate total size. */
3824 if (ncmsgs > 0 && (cmsgs = PyMem_New(struct cmsginfo, ncmsgs)) == NULL) {
3825 PyErr_NoMemory();
3826 goto finally;
3827 }
3828 controllen = controllen_last = 0;
3829 while (ncmsgbufs < ncmsgs) {
3830 size_t bufsize, space;
3831
3832 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(cmsg_fast, ncmsgbufs),
3833 "(iiy*):[sendmsg() ancillary data items]",
3834 &cmsgs[ncmsgbufs].level,
3835 &cmsgs[ncmsgbufs].type,
3836 &cmsgs[ncmsgbufs].data))
3837 goto finally;
3838 bufsize = cmsgs[ncmsgbufs++].data.len;
3839
3840#ifdef CMSG_SPACE
3841 if (!get_CMSG_SPACE(bufsize, &space)) {
3842#else
3843 if (!get_CMSG_LEN(bufsize, &space)) {
3844#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003845 PyErr_SetString(PyExc_OSError, "ancillary data item too large");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003846 goto finally;
3847 }
3848 controllen += space;
3849 if (controllen > SOCKLEN_T_LIMIT || controllen < controllen_last) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003850 PyErr_SetString(PyExc_OSError, "too much ancillary data");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003851 goto finally;
3852 }
3853 controllen_last = controllen;
3854 }
3855
3856 /* Construct ancillary data block from control message info. */
3857 if (ncmsgbufs > 0) {
3858 struct cmsghdr *cmsgh = NULL;
3859
3860 if ((msg.msg_control = controlbuf =
3861 PyMem_Malloc(controllen)) == NULL) {
3862 PyErr_NoMemory();
3863 goto finally;
3864 }
3865 msg.msg_controllen = controllen;
3866
3867 /* Need to zero out the buffer as a workaround for glibc's
3868 CMSG_NXTHDR() implementation. After getting the pointer to
3869 the next header, it checks its (uninitialized) cmsg_len
3870 member to see if the "message" fits in the buffer, and
3871 returns NULL if it doesn't. Zero-filling the buffer
Terry Jan Reedy0f847642013-03-11 18:34:00 -04003872 ensures that this doesn't happen. */
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003873 memset(controlbuf, 0, controllen);
3874
3875 for (i = 0; i < ncmsgbufs; i++) {
3876 size_t msg_len, data_len = cmsgs[i].data.len;
3877 int enough_space = 0;
3878
3879 cmsgh = (i == 0) ? CMSG_FIRSTHDR(&msg) : CMSG_NXTHDR(&msg, cmsgh);
3880 if (cmsgh == NULL) {
3881 PyErr_Format(PyExc_RuntimeError,
3882 "unexpected NULL result from %s()",
3883 (i == 0) ? "CMSG_FIRSTHDR" : "CMSG_NXTHDR");
3884 goto finally;
3885 }
3886 if (!get_CMSG_LEN(data_len, &msg_len)) {
3887 PyErr_SetString(PyExc_RuntimeError,
3888 "item size out of range for CMSG_LEN()");
3889 goto finally;
3890 }
3891 if (cmsg_min_space(&msg, cmsgh, msg_len)) {
3892 size_t space;
3893
3894 cmsgh->cmsg_len = msg_len;
3895 if (get_cmsg_data_space(&msg, cmsgh, &space))
3896 enough_space = (space >= data_len);
3897 }
3898 if (!enough_space) {
3899 PyErr_SetString(PyExc_RuntimeError,
3900 "ancillary data does not fit in calculated "
3901 "space");
3902 goto finally;
3903 }
3904 cmsgh->cmsg_level = cmsgs[i].level;
3905 cmsgh->cmsg_type = cmsgs[i].type;
3906 memcpy(CMSG_DATA(cmsgh), cmsgs[i].data.buf, data_len);
3907 }
3908 }
3909
3910 /* Make the system call. */
3911 if (!IS_SELECTABLE(s)) {
3912 select_error();
3913 goto finally;
3914 }
3915
Victor Stinner31bf2d52015-04-01 21:57:09 +02003916 ctx.msg = &msg;
3917 ctx.flags = flags;
3918 if (sock_call(s, 1, sock_sendmsg_impl, &ctx) < 0)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003919 goto finally;
Victor Stinner31bf2d52015-04-01 21:57:09 +02003920
3921 retval = PyLong_FromSsize_t(ctx.result);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003922
3923finally:
3924 PyMem_Free(controlbuf);
3925 for (i = 0; i < ncmsgbufs; i++)
3926 PyBuffer_Release(&cmsgs[i].data);
3927 PyMem_Free(cmsgs);
3928 Py_XDECREF(cmsg_fast);
3929 for (i = 0; i < ndatabufs; i++)
3930 PyBuffer_Release(&databufs[i]);
3931 PyMem_Free(databufs);
3932 PyMem_Free(iovs);
3933 Py_XDECREF(data_fast);
3934 return retval;
3935}
3936
3937PyDoc_STRVAR(sendmsg_doc,
3938"sendmsg(buffers[, ancdata[, flags[, address]]]) -> count\n\
3939\n\
3940Send normal and ancillary data to the socket, gathering the\n\
3941non-ancillary data from a series of buffers and concatenating it into\n\
3942a single message. The buffers argument specifies the non-ancillary\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003943data as an iterable of bytes-like objects (e.g. bytes objects).\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003944The ancdata argument specifies the ancillary data (control messages)\n\
3945as an iterable of zero or more tuples (cmsg_level, cmsg_type,\n\
3946cmsg_data), where cmsg_level and cmsg_type are integers specifying the\n\
3947protocol level and protocol-specific type respectively, and cmsg_data\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003948is a bytes-like object holding the associated data. The flags\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003949argument defaults to 0 and has the same meaning as for send(). If\n\
3950address is supplied and not None, it sets a destination address for\n\
3951the message. The return value is the number of bytes of non-ancillary\n\
3952data sent.");
3953#endif /* CMSG_LEN */
3954
3955
Guido van Rossum30a685f1991-06-27 15:51:29 +00003956/* s.shutdown(how) method */
3957
Guido van Rossum73624e91994-10-10 17:59:00 +00003958static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003959sock_shutdown(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003960{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003961 int how;
3962 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00003963
Serhiy Storchaka78980432013-01-15 01:12:17 +02003964 how = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003965 if (how == -1 && PyErr_Occurred())
3966 return NULL;
3967 Py_BEGIN_ALLOW_THREADS
3968 res = shutdown(s->sock_fd, how);
3969 Py_END_ALLOW_THREADS
3970 if (res < 0)
3971 return s->errorhandler();
3972 Py_INCREF(Py_None);
3973 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003974}
3975
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003976PyDoc_STRVAR(shutdown_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003977"shutdown(flag)\n\
3978\n\
Martin v. Löwis94681fc2003-11-27 19:40:22 +00003979Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
3980of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003981
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003982#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Christian Heimesfaf2f632008-01-06 16:59:19 +00003983static PyObject*
3984sock_ioctl(PySocketSockObject *s, PyObject *arg)
3985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 unsigned long cmd = SIO_RCVALL;
3987 PyObject *argO;
3988 DWORD recv;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 if (!PyArg_ParseTuple(arg, "kO:ioctl", &cmd, &argO))
3991 return NULL;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003993 switch (cmd) {
3994 case SIO_RCVALL: {
3995 unsigned int option = RCVALL_ON;
3996 if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
3997 return NULL;
3998 if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
3999 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
4000 return set_error();
4001 }
4002 return PyLong_FromUnsignedLong(recv); }
4003 case SIO_KEEPALIVE_VALS: {
4004 struct tcp_keepalive ka;
4005 if (!PyArg_ParseTuple(arg, "k(kkk):ioctl", &cmd,
4006 &ka.onoff, &ka.keepalivetime, &ka.keepaliveinterval))
4007 return NULL;
4008 if (WSAIoctl(s->sock_fd, cmd, &ka, sizeof(ka),
4009 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
4010 return set_error();
4011 }
4012 return PyLong_FromUnsignedLong(recv); }
4013 default:
4014 PyErr_Format(PyExc_ValueError, "invalid ioctl command %d", cmd);
4015 return NULL;
4016 }
Christian Heimesfaf2f632008-01-06 16:59:19 +00004017}
4018PyDoc_STRVAR(sock_ioctl_doc,
4019"ioctl(cmd, option) -> long\n\
4020\n\
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00004021Control the socket with WSAIoctl syscall. Currently supported 'cmd' values are\n\
4022SIO_RCVALL: 'option' must be one of the socket.RCVALL_* constants.\n\
4023SIO_KEEPALIVE_VALS: 'option' is a tuple of (onoff, timeout, interval).");
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004024#endif
4025
4026#if defined(MS_WINDOWS)
4027static PyObject*
4028sock_share(PySocketSockObject *s, PyObject *arg)
4029{
4030 WSAPROTOCOL_INFO info;
4031 DWORD processId;
4032 int result;
4033
4034 if (!PyArg_ParseTuple(arg, "I", &processId))
4035 return NULL;
4036
4037 Py_BEGIN_ALLOW_THREADS
4038 result = WSADuplicateSocket(s->sock_fd, processId, &info);
4039 Py_END_ALLOW_THREADS
4040 if (result == SOCKET_ERROR)
4041 return set_error();
4042 return PyBytes_FromStringAndSize((const char*)&info, sizeof(info));
4043}
4044PyDoc_STRVAR(sock_share_doc,
4045"share(process_id) -> bytes\n\
4046\n\
4047Share the socket with another process. The target process id\n\
4048must be provided and the resulting bytes object passed to the target\n\
4049process. There the shared socket can be instantiated by calling\n\
4050socket.fromshare().");
4051
Christian Heimesfaf2f632008-01-06 16:59:19 +00004052
4053#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00004054
4055/* List of methods for socket objects */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004056
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004057static PyMethodDef sock_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 {"_accept", (PyCFunction)sock_accept, METH_NOARGS,
4059 accept_doc},
4060 {"bind", (PyCFunction)sock_bind, METH_O,
4061 bind_doc},
4062 {"close", (PyCFunction)sock_close, METH_NOARGS,
4063 close_doc},
4064 {"connect", (PyCFunction)sock_connect, METH_O,
4065 connect_doc},
4066 {"connect_ex", (PyCFunction)sock_connect_ex, METH_O,
4067 connect_ex_doc},
Antoine Pitrou6e451df2010-08-09 20:39:54 +00004068 {"detach", (PyCFunction)sock_detach, METH_NOARGS,
4069 detach_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004070 {"fileno", (PyCFunction)sock_fileno, METH_NOARGS,
4071 fileno_doc},
Guido van Rossumb6775db1994-08-01 11:34:53 +00004072#ifdef HAVE_GETPEERNAME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004073 {"getpeername", (PyCFunction)sock_getpeername,
4074 METH_NOARGS, getpeername_doc},
Guido van Rossum9575a441993-04-07 14:06:14 +00004075#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004076 {"getsockname", (PyCFunction)sock_getsockname,
4077 METH_NOARGS, getsockname_doc},
4078 {"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
4079 getsockopt_doc},
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00004080#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004081 {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
4082 sock_ioctl_doc},
Christian Heimesfaf2f632008-01-06 16:59:19 +00004083#endif
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004084#if defined(MS_WINDOWS)
4085 {"share", (PyCFunction)sock_share, METH_VARARGS,
4086 sock_share_doc},
4087#endif
Charles-François Natali644b8f52014-05-22 19:45:39 +01004088 {"listen", (PyCFunction)sock_listen, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004089 listen_doc},
4090 {"recv", (PyCFunction)sock_recv, METH_VARARGS,
4091 recv_doc},
4092 {"recv_into", (PyCFunction)sock_recv_into, METH_VARARGS | METH_KEYWORDS,
4093 recv_into_doc},
4094 {"recvfrom", (PyCFunction)sock_recvfrom, METH_VARARGS,
4095 recvfrom_doc},
4096 {"recvfrom_into", (PyCFunction)sock_recvfrom_into, METH_VARARGS | METH_KEYWORDS,
4097 recvfrom_into_doc},
4098 {"send", (PyCFunction)sock_send, METH_VARARGS,
4099 send_doc},
4100 {"sendall", (PyCFunction)sock_sendall, METH_VARARGS,
4101 sendall_doc},
4102 {"sendto", (PyCFunction)sock_sendto, METH_VARARGS,
4103 sendto_doc},
4104 {"setblocking", (PyCFunction)sock_setblocking, METH_O,
4105 setblocking_doc},
4106 {"settimeout", (PyCFunction)sock_settimeout, METH_O,
4107 settimeout_doc},
4108 {"gettimeout", (PyCFunction)sock_gettimeout, METH_NOARGS,
4109 gettimeout_doc},
4110 {"setsockopt", (PyCFunction)sock_setsockopt, METH_VARARGS,
4111 setsockopt_doc},
4112 {"shutdown", (PyCFunction)sock_shutdown, METH_O,
4113 shutdown_doc},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10004114#ifdef CMSG_LEN
4115 {"recvmsg", (PyCFunction)sock_recvmsg, METH_VARARGS,
4116 recvmsg_doc},
4117 {"recvmsg_into", (PyCFunction)sock_recvmsg_into, METH_VARARGS,
4118 recvmsg_into_doc,},
4119 {"sendmsg", (PyCFunction)sock_sendmsg, METH_VARARGS,
4120 sendmsg_doc},
4121#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004122 {NULL, NULL} /* sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004123};
4124
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004125/* SockObject members */
4126static PyMemberDef sock_memberlist[] = {
4127 {"family", T_INT, offsetof(PySocketSockObject, sock_family), READONLY, "the socket family"},
4128 {"type", T_INT, offsetof(PySocketSockObject, sock_type), READONLY, "the socket type"},
4129 {"proto", T_INT, offsetof(PySocketSockObject, sock_proto), READONLY, "the socket protocol"},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004130 {0},
4131};
Guido van Rossum30a685f1991-06-27 15:51:29 +00004132
Victor Stinner71694d52015-03-28 01:18:54 +01004133static PyGetSetDef sock_getsetlist[] = {
4134 {"timeout", (getter)sock_gettimeout, NULL, PyDoc_STR("the socket timeout")},
4135 {NULL} /* sentinel */
4136};
4137
Guido van Rossum73624e91994-10-10 17:59:00 +00004138/* Deallocate a socket object in response to the last Py_DECREF().
Guido van Rossum30a685f1991-06-27 15:51:29 +00004139 First close the file description. */
4140
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004141static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004142sock_dealloc(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004143{
Antoine Pitroue033e062010-10-29 10:38:18 +00004144 if (s->sock_fd != -1) {
4145 PyObject *exc, *val, *tb;
4146 Py_ssize_t old_refcount = Py_REFCNT(s);
4147 ++Py_REFCNT(s);
4148 PyErr_Fetch(&exc, &val, &tb);
4149 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
4150 "unclosed %R", s))
4151 /* Spurious errors can appear at shutdown */
4152 if (PyErr_ExceptionMatches(PyExc_Warning))
4153 PyErr_WriteUnraisable((PyObject *) s);
4154 PyErr_Restore(exc, val, tb);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004155 (void) SOCKETCLOSE(s->sock_fd);
Antoine Pitroue033e062010-10-29 10:38:18 +00004156 Py_REFCNT(s) = old_refcount;
4157 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004158 Py_TYPE(s)->tp_free((PyObject *)s);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004159}
4160
Guido van Rossum30a685f1991-06-27 15:51:29 +00004161
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004162static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004163sock_repr(PySocketSockObject *s)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004164{
Victor Stinnere254e532014-07-26 14:36:55 +02004165 long sock_fd;
4166 /* On Windows, this test is needed because SOCKET_T is unsigned */
4167 if (s->sock_fd == INVALID_SOCKET) {
4168 sock_fd = -1;
4169 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004170#if SIZEOF_SOCKET_T > SIZEOF_LONG
Victor Stinnere254e532014-07-26 14:36:55 +02004171 else if (s->sock_fd > LONG_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004172 /* this can occur on Win64, and actually there is a special
4173 ugly printf formatter for decimal pointer length integer
4174 printing, only bother if necessary*/
4175 PyErr_SetString(PyExc_OverflowError,
4176 "no printf formatter to display "
4177 "the socket descriptor in decimal");
4178 return NULL;
4179 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004180#endif
Victor Stinnere254e532014-07-26 14:36:55 +02004181 else
4182 sock_fd = (long)s->sock_fd;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004183 return PyUnicode_FromFormat(
4184 "<socket object, fd=%ld, family=%d, type=%d, proto=%d>",
Victor Stinnere254e532014-07-26 14:36:55 +02004185 sock_fd, s->sock_family,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004186 s->sock_type,
4187 s->sock_proto);
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004188}
4189
4190
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004191/* Create a new, uninitialized socket object. */
4192
4193static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004194sock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004196 PyObject *new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004198 new = type->tp_alloc(type, 0);
4199 if (new != NULL) {
4200 ((PySocketSockObject *)new)->sock_fd = -1;
Victor Stinner9001d802015-04-06 23:06:01 +02004201 ((PySocketSockObject *)new)->sock_timeout = _PyTime_FromSeconds(-1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004202 ((PySocketSockObject *)new)->errorhandler = &set_error;
4203 }
4204 return new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004205}
4206
4207
4208/* Initialize a new socket object. */
4209
Victor Stinnerdaf45552013-08-28 00:53:59 +02004210#ifdef SOCK_CLOEXEC
4211/* socket() and socketpair() fail with EINVAL on Linux kernel older
4212 * than 2.6.27 if SOCK_CLOEXEC flag is set in the socket type. */
4213static int sock_cloexec_works = -1;
4214#endif
4215
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004216/*ARGSUSED*/
4217static int
Andrew MacIntyre7aec4a22002-06-13 11:53:52 +00004218sock_initobj(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004219{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004220 PySocketSockObject *s = (PySocketSockObject *)self;
4221 PyObject *fdobj = NULL;
4222 SOCKET_T fd = INVALID_SOCKET;
4223 int family = AF_INET, type = SOCK_STREAM, proto = 0;
4224 static char *keywords[] = {"family", "type", "proto", "fileno", 0};
Victor Stinnerdaf45552013-08-28 00:53:59 +02004225#ifndef MS_WINDOWS
4226#ifdef SOCK_CLOEXEC
4227 int *atomic_flag_works = &sock_cloexec_works;
4228#else
4229 int *atomic_flag_works = NULL;
4230#endif
4231#endif
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004233 if (!PyArg_ParseTupleAndKeywords(args, kwds,
4234 "|iiiO:socket", keywords,
4235 &family, &type, &proto, &fdobj))
4236 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004238 if (fdobj != NULL && fdobj != Py_None) {
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004239#ifdef MS_WINDOWS
4240 /* recreate a socket that was duplicated */
4241 if (PyBytes_Check(fdobj)) {
4242 WSAPROTOCOL_INFO info;
4243 if (PyBytes_GET_SIZE(fdobj) != sizeof(info)) {
4244 PyErr_Format(PyExc_ValueError,
4245 "socket descriptor string has wrong size, "
4246 "should be %zu bytes.", sizeof(info));
4247 return -1;
4248 }
4249 memcpy(&info, PyBytes_AS_STRING(fdobj), sizeof(info));
4250 Py_BEGIN_ALLOW_THREADS
4251 fd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4252 FROM_PROTOCOL_INFO, &info, 0, WSA_FLAG_OVERLAPPED);
4253 Py_END_ALLOW_THREADS
4254 if (fd == INVALID_SOCKET) {
4255 set_error();
4256 return -1;
4257 }
4258 family = info.iAddressFamily;
4259 type = info.iSocketType;
4260 proto = info.iProtocol;
4261 }
4262 else
4263#endif
4264 {
4265 fd = PyLong_AsSocket_t(fdobj);
4266 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4267 return -1;
4268 if (fd == INVALID_SOCKET) {
4269 PyErr_SetString(PyExc_ValueError,
4270 "can't use invalid socket value");
4271 return -1;
4272 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004273 }
4274 }
4275 else {
Victor Stinnerdaf45552013-08-28 00:53:59 +02004276#ifdef MS_WINDOWS
4277 /* Windows implementation */
4278#ifndef WSA_FLAG_NO_HANDLE_INHERIT
4279#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
4280#endif
4281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004282 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02004283 if (support_wsa_no_inherit) {
4284 fd = WSASocket(family, type, proto,
4285 NULL, 0,
4286 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
4287 if (fd == INVALID_SOCKET) {
4288 /* Windows 7 or Windows 2008 R2 without SP1 or the hotfix */
4289 support_wsa_no_inherit = 0;
4290 fd = socket(family, type, proto);
4291 }
4292 }
4293 else {
4294 fd = socket(family, type, proto);
4295 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004296 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00004297
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 if (fd == INVALID_SOCKET) {
4299 set_error();
4300 return -1;
4301 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02004302
4303 if (!support_wsa_no_inherit) {
4304 if (!SetHandleInformation((HANDLE)fd, HANDLE_FLAG_INHERIT, 0)) {
4305 closesocket(fd);
4306 PyErr_SetFromWindowsErr(0);
4307 return -1;
4308 }
4309 }
4310#else
4311 /* UNIX */
4312 Py_BEGIN_ALLOW_THREADS
4313#ifdef SOCK_CLOEXEC
4314 if (sock_cloexec_works != 0) {
4315 fd = socket(family, type | SOCK_CLOEXEC, proto);
4316 if (sock_cloexec_works == -1) {
4317 if (fd >= 0) {
4318 sock_cloexec_works = 1;
4319 }
4320 else if (errno == EINVAL) {
4321 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4322 sock_cloexec_works = 0;
4323 fd = socket(family, type, proto);
4324 }
4325 }
4326 }
4327 else
4328#endif
4329 {
4330 fd = socket(family, type, proto);
4331 }
4332 Py_END_ALLOW_THREADS
4333
4334 if (fd == INVALID_SOCKET) {
4335 set_error();
4336 return -1;
4337 }
4338
4339 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
4340 SOCKETCLOSE(fd);
4341 return -1;
4342 }
4343#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004344 }
4345 init_sockobject(s, fd, family, type, proto);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004347 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004348
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004349}
4350
4351
Guido van Rossumb6775db1994-08-01 11:34:53 +00004352/* Type object for socket objects. */
Guido van Rossum30a685f1991-06-27 15:51:29 +00004353
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004354static PyTypeObject sock_type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004355 PyVarObject_HEAD_INIT(0, 0) /* Must fill in type value later */
4356 "_socket.socket", /* tp_name */
4357 sizeof(PySocketSockObject), /* tp_basicsize */
4358 0, /* tp_itemsize */
4359 (destructor)sock_dealloc, /* tp_dealloc */
4360 0, /* tp_print */
4361 0, /* tp_getattr */
4362 0, /* tp_setattr */
4363 0, /* tp_reserved */
4364 (reprfunc)sock_repr, /* tp_repr */
4365 0, /* tp_as_number */
4366 0, /* tp_as_sequence */
4367 0, /* tp_as_mapping */
4368 0, /* tp_hash */
4369 0, /* tp_call */
4370 0, /* tp_str */
4371 PyObject_GenericGetAttr, /* tp_getattro */
4372 0, /* tp_setattro */
4373 0, /* tp_as_buffer */
4374 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4375 sock_doc, /* tp_doc */
4376 0, /* tp_traverse */
4377 0, /* tp_clear */
4378 0, /* tp_richcompare */
4379 0, /* tp_weaklistoffset */
4380 0, /* tp_iter */
4381 0, /* tp_iternext */
4382 sock_methods, /* tp_methods */
4383 sock_memberlist, /* tp_members */
Victor Stinner71694d52015-03-28 01:18:54 +01004384 sock_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004385 0, /* tp_base */
4386 0, /* tp_dict */
4387 0, /* tp_descr_get */
4388 0, /* tp_descr_set */
4389 0, /* tp_dictoffset */
4390 sock_initobj, /* tp_init */
4391 PyType_GenericAlloc, /* tp_alloc */
4392 sock_new, /* tp_new */
4393 PyObject_Del, /* tp_free */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004394};
4395
Guido van Rossum30a685f1991-06-27 15:51:29 +00004396
Guido van Rossum81194471991-07-27 21:42:02 +00004397/* Python interface to gethostname(). */
4398
4399/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004400static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00004401socket_gethostname(PyObject *self, PyObject *unused)
Guido van Rossum81194471991-07-27 21:42:02 +00004402{
Martin v. Löwis72f48422010-10-29 18:20:08 +00004403#ifdef MS_WINDOWS
4404 /* Don't use winsock's gethostname, as this returns the ANSI
4405 version of the hostname, whereas we need a Unicode string.
4406 Otherwise, gethostname apparently also returns the DNS name. */
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004407 wchar_t buf[MAX_COMPUTERNAME_LENGTH + 1];
Victor Stinner63941882011-09-29 00:42:28 +02004408 DWORD size = Py_ARRAY_LENGTH(buf);
Victor Stinner74168972011-11-17 01:11:36 +01004409 wchar_t *name;
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004410 PyObject *result;
Victor Stinner74168972011-11-17 01:11:36 +01004411
4412 if (GetComputerNameExW(ComputerNamePhysicalDnsHostname, buf, &size))
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004413 return PyUnicode_FromWideChar(buf, size);
Victor Stinner74168972011-11-17 01:11:36 +01004414
4415 if (GetLastError() != ERROR_MORE_DATA)
4416 return PyErr_SetFromWindowsErr(0);
4417
4418 if (size == 0)
4419 return PyUnicode_New(0, 0);
4420
4421 /* MSDN says ERROR_MORE_DATA may occur because DNS allows longer
4422 names */
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004423 name = PyMem_New(wchar_t, size);
4424 if (!name) {
4425 PyErr_NoMemory();
Victor Stinner74168972011-11-17 01:11:36 +01004426 return NULL;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004427 }
Victor Stinner74168972011-11-17 01:11:36 +01004428 if (!GetComputerNameExW(ComputerNamePhysicalDnsHostname,
4429 name,
4430 &size))
4431 {
4432 PyMem_Free(name);
4433 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004434 }
Victor Stinner74168972011-11-17 01:11:36 +01004435
4436 result = PyUnicode_FromWideChar(name, size);
4437 PyMem_Free(name);
4438 return result;
Martin v. Löwis72f48422010-10-29 18:20:08 +00004439#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004440 char buf[1024];
4441 int res;
4442 Py_BEGIN_ALLOW_THREADS
4443 res = gethostname(buf, (int) sizeof buf - 1);
4444 Py_END_ALLOW_THREADS
4445 if (res < 0)
4446 return set_error();
4447 buf[sizeof buf - 1] = '\0';
Victor Stinnera534fc42013-06-03 22:07:27 +02004448 return PyUnicode_DecodeFSDefault(buf);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004449#endif
Guido van Rossum81194471991-07-27 21:42:02 +00004450}
Guido van Rossumff4949e1992-08-05 19:58:53 +00004451
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004452PyDoc_STRVAR(gethostname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004453"gethostname() -> string\n\
4454\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004455Return the current host name.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004456
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004457#ifdef HAVE_SETHOSTNAME
4458PyDoc_STRVAR(sethostname_doc,
4459"sethostname(name)\n\n\
4460Sets the hostname to name.");
4461
4462static PyObject *
4463socket_sethostname(PyObject *self, PyObject *args)
4464{
4465 PyObject *hnobj;
4466 Py_buffer buf;
4467 int res, flag = 0;
4468
Christian Heimesd2774c72013-06-19 02:06:29 +02004469#ifdef _AIX
4470/* issue #18259, not declared in any useful header file */
4471extern int sethostname(const char *, size_t);
4472#endif
4473
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004474 if (!PyArg_ParseTuple(args, "S:sethostname", &hnobj)) {
4475 PyErr_Clear();
4476 if (!PyArg_ParseTuple(args, "O&:sethostname",
4477 PyUnicode_FSConverter, &hnobj))
4478 return NULL;
4479 flag = 1;
4480 }
4481 res = PyObject_GetBuffer(hnobj, &buf, PyBUF_SIMPLE);
4482 if (!res) {
4483 res = sethostname(buf.buf, buf.len);
4484 PyBuffer_Release(&buf);
4485 }
4486 if (flag)
4487 Py_DECREF(hnobj);
4488 if (res)
4489 return set_error();
4490 Py_RETURN_NONE;
4491}
4492#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +00004493
Guido van Rossum30a685f1991-06-27 15:51:29 +00004494/* Python interface to gethostbyname(name). */
4495
4496/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004497static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004498socket_gethostbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004500 char *name;
4501 sock_addr_t addrbuf;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004502 PyObject *ret = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004503
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004504 if (!PyArg_ParseTuple(args, "et:gethostbyname", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004505 return NULL;
4506 if (setipaddr(name, SAS2SA(&addrbuf), sizeof(addrbuf), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004507 goto finally;
4508 ret = makeipaddr(SAS2SA(&addrbuf), sizeof(struct sockaddr_in));
4509finally:
4510 PyMem_Free(name);
4511 return ret;
Guido van Rossum30a685f1991-06-27 15:51:29 +00004512}
4513
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004514PyDoc_STRVAR(gethostbyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004515"gethostbyname(host) -> address\n\
4516\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004517Return the IP address (a string of the form '255.255.255.255') for a host.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004518
4519
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004520/* Convenience function common to gethostbyname_ex and gethostbyaddr */
4521
4522static PyObject *
Victor Stinner1a62a682014-08-17 19:33:28 +02004523gethost_common(struct hostent *h, struct sockaddr *addr, size_t alen, int af)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004525 char **pch;
4526 PyObject *rtn_tuple = (PyObject *)NULL;
4527 PyObject *name_list = (PyObject *)NULL;
4528 PyObject *addr_list = (PyObject *)NULL;
4529 PyObject *tmp;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004531 if (h == NULL) {
4532 /* Let's get real error message to return */
4533 set_herror(h_errno);
4534 return NULL;
4535 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004537 if (h->h_addrtype != af) {
4538 /* Let's get real error message to return */
Victor Stinner1f33f2b2011-12-17 04:45:09 +01004539 errno = EAFNOSUPPORT;
4540 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004541 return NULL;
4542 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004544 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004546 case AF_INET:
4547 if (alen < sizeof(struct sockaddr_in))
4548 return NULL;
4549 break;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004550
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004551#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004552 case AF_INET6:
4553 if (alen < sizeof(struct sockaddr_in6))
4554 return NULL;
4555 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004556#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004558 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004560 if ((name_list = PyList_New(0)) == NULL)
4561 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004563 if ((addr_list = PyList_New(0)) == NULL)
4564 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004566 /* SF #1511317: h_aliases can be NULL */
4567 if (h->h_aliases) {
4568 for (pch = h->h_aliases; *pch != NULL; pch++) {
4569 int status;
4570 tmp = PyUnicode_FromString(*pch);
4571 if (tmp == NULL)
4572 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004574 status = PyList_Append(name_list, tmp);
4575 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004577 if (status)
4578 goto err;
4579 }
4580 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004582 for (pch = h->h_addr_list; *pch != NULL; pch++) {
4583 int status;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004585 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004587 case AF_INET:
4588 {
4589 struct sockaddr_in sin;
4590 memset(&sin, 0, sizeof(sin));
4591 sin.sin_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004592#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004593 sin.sin_len = sizeof(sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004594#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004595 memcpy(&sin.sin_addr, *pch, sizeof(sin.sin_addr));
4596 tmp = makeipaddr((struct sockaddr *)&sin, sizeof(sin));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004598 if (pch == h->h_addr_list && alen >= sizeof(sin))
4599 memcpy((char *) addr, &sin, sizeof(sin));
4600 break;
4601 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004602
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004603#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004604 case AF_INET6:
4605 {
4606 struct sockaddr_in6 sin6;
4607 memset(&sin6, 0, sizeof(sin6));
4608 sin6.sin6_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004609#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004610 sin6.sin6_len = sizeof(sin6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004611#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004612 memcpy(&sin6.sin6_addr, *pch, sizeof(sin6.sin6_addr));
4613 tmp = makeipaddr((struct sockaddr *)&sin6,
4614 sizeof(sin6));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004616 if (pch == h->h_addr_list && alen >= sizeof(sin6))
4617 memcpy((char *) addr, &sin6, sizeof(sin6));
4618 break;
4619 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004620#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004622 default: /* can't happen */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004623 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004624 "unsupported address family");
4625 return NULL;
4626 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004628 if (tmp == NULL)
4629 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004631 status = PyList_Append(addr_list, tmp);
4632 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004634 if (status)
4635 goto err;
4636 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004638 rtn_tuple = Py_BuildValue("sOO", h->h_name, name_list, addr_list);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004639
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004640 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004641 Py_XDECREF(name_list);
4642 Py_XDECREF(addr_list);
4643 return rtn_tuple;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004644}
4645
4646
4647/* Python interface to gethostbyname_ex(name). */
4648
4649/*ARGSUSED*/
4650static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004651socket_gethostbyname_ex(PyObject *self, PyObject *args)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004653 char *name;
4654 struct hostent *h;
Charles-François Natali8b759652011-12-23 16:44:51 +01004655 sock_addr_t addr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004656 struct sockaddr *sa;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004657 PyObject *ret = NULL;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004658#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004659 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004660#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004661 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004662#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004663 char buf[16384];
4664 int buf_len = (sizeof buf) - 1;
4665 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004666#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004667#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004668 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004669#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004670#endif /* HAVE_GETHOSTBYNAME_R */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004671
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004672 if (!PyArg_ParseTuple(args, "et:gethostbyname_ex", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004673 return NULL;
Charles-François Natali8b759652011-12-23 16:44:51 +01004674 if (setipaddr(name, SAS2SA(&addr), sizeof(addr), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004675 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004676 Py_BEGIN_ALLOW_THREADS
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004677#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004678#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004679 gethostbyname_r(name, &hp_allocated, buf, buf_len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004680 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004681#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004682 h = gethostbyname_r(name, &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004683#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004684 memset((void *) &data, '\0', sizeof(data));
4685 result = gethostbyname_r(name, &hp_allocated, &data);
4686 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004687#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004688#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004689#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004690 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004691#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004692 h = gethostbyname(name);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004693#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004694 Py_END_ALLOW_THREADS
4695 /* Some C libraries would require addr.__ss_family instead of
4696 addr.ss_family.
4697 Therefore, we cast the sockaddr_storage into sockaddr to
4698 access sa_family. */
Charles-François Natali8b759652011-12-23 16:44:51 +01004699 sa = SAS2SA(&addr);
4700 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004701 sa->sa_family);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004702#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004703 PyThread_release_lock(netdb_lock);
Guido van Rossum955becc1999-03-22 20:14:53 +00004704#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004705finally:
4706 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004707 return ret;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004708}
4709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004710PyDoc_STRVAR(ghbn_ex_doc,
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004711"gethostbyname_ex(host) -> (name, aliaslist, addresslist)\n\
4712\n\
4713Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004714for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004715
4716
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004717/* Python interface to gethostbyaddr(IP). */
4718
4719/*ARGSUSED*/
4720static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004721socket_gethostbyaddr(PyObject *self, PyObject *args)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004722{
Charles-François Natali8b759652011-12-23 16:44:51 +01004723 sock_addr_t addr;
4724 struct sockaddr *sa = SAS2SA(&addr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004725 char *ip_num;
4726 struct hostent *h;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004727 PyObject *ret = NULL;
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004728#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004729 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004730#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004731 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004732#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004733 /* glibcs up to 2.10 assume that the buf argument to
4734 gethostbyaddr_r is 8-byte aligned, which at least llvm-gcc
4735 does not ensure. The attribute below instructs the compiler
4736 to maintain this alignment. */
4737 char buf[16384] Py_ALIGNED(8);
4738 int buf_len = (sizeof buf) - 1;
4739 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004740#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004741#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004742 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004743#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004744#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004745 char *ap;
4746 int al;
4747 int af;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004748
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004749 if (!PyArg_ParseTuple(args, "et:gethostbyaddr", "idna", &ip_num))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004750 return NULL;
4751 af = AF_UNSPEC;
4752 if (setipaddr(ip_num, sa, sizeof(addr), af) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004753 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004754 af = sa->sa_family;
4755 ap = NULL;
Brett Cannonb94767f2011-02-22 20:15:44 +00004756 /* al = 0; */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004757 switch (af) {
4758 case AF_INET:
4759 ap = (char *)&((struct sockaddr_in *)sa)->sin_addr;
4760 al = sizeof(((struct sockaddr_in *)sa)->sin_addr);
4761 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004762#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004763 case AF_INET6:
4764 ap = (char *)&((struct sockaddr_in6 *)sa)->sin6_addr;
4765 al = sizeof(((struct sockaddr_in6 *)sa)->sin6_addr);
4766 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004767#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004768 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004769 PyErr_SetString(PyExc_OSError, "unsupported address family");
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004770 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004771 }
4772 Py_BEGIN_ALLOW_THREADS
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004773#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004774#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004775 gethostbyaddr_r(ap, al, af,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004776 &hp_allocated, buf, buf_len,
4777 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004778#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004779 h = gethostbyaddr_r(ap, al, af,
4780 &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004781#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004782 memset((void *) &data, '\0', sizeof(data));
4783 result = gethostbyaddr_r(ap, al, af, &hp_allocated, &data);
4784 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004785#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004786#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004787#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004788 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004789#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004790 h = gethostbyaddr(ap, al, af);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004791#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004792 Py_END_ALLOW_THREADS
Charles-François Natali8b759652011-12-23 16:44:51 +01004793 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr), af);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004794#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004795 PyThread_release_lock(netdb_lock);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004796#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004797finally:
4798 PyMem_Free(ip_num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004799 return ret;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004800}
4801
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004802PyDoc_STRVAR(gethostbyaddr_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004803"gethostbyaddr(host) -> (name, aliaslist, addresslist)\n\
4804\n\
4805Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004806for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004807
Guido van Rossum30a685f1991-06-27 15:51:29 +00004808
4809/* Python interface to getservbyname(name).
4810 This only returns the port number, since the other info is already
4811 known or not useful (like the list of aliases). */
4812
4813/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004814static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004815socket_getservbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004817 char *name, *proto=NULL;
4818 struct servent *sp;
4819 if (!PyArg_ParseTuple(args, "s|s:getservbyname", &name, &proto))
4820 return NULL;
4821 Py_BEGIN_ALLOW_THREADS
4822 sp = getservbyname(name, proto);
4823 Py_END_ALLOW_THREADS
4824 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004825 PyErr_SetString(PyExc_OSError, "service/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004826 return NULL;
4827 }
4828 return PyLong_FromLong((long) ntohs(sp->s_port));
Guido van Rossum30a685f1991-06-27 15:51:29 +00004829}
4830
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004831PyDoc_STRVAR(getservbyname_doc,
Barry Warsaw11b91a02004-06-28 00:50:43 +00004832"getservbyname(servicename[, protocolname]) -> integer\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00004833\n\
4834Return a port number from a service name and protocol name.\n\
Barry Warsaw11b91a02004-06-28 00:50:43 +00004835The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4836otherwise any protocol will match.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004837
Guido van Rossum30a685f1991-06-27 15:51:29 +00004838
Barry Warsaw11b91a02004-06-28 00:50:43 +00004839/* Python interface to getservbyport(port).
4840 This only returns the service name, since the other info is already
4841 known or not useful (like the list of aliases). */
4842
4843/*ARGSUSED*/
4844static PyObject *
4845socket_getservbyport(PyObject *self, PyObject *args)
4846{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004847 int port;
4848 char *proto=NULL;
4849 struct servent *sp;
4850 if (!PyArg_ParseTuple(args, "i|s:getservbyport", &port, &proto))
4851 return NULL;
4852 if (port < 0 || port > 0xffff) {
4853 PyErr_SetString(
4854 PyExc_OverflowError,
4855 "getservbyport: port must be 0-65535.");
4856 return NULL;
4857 }
4858 Py_BEGIN_ALLOW_THREADS
4859 sp = getservbyport(htons((short)port), proto);
4860 Py_END_ALLOW_THREADS
4861 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004862 PyErr_SetString(PyExc_OSError, "port/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004863 return NULL;
4864 }
4865 return PyUnicode_FromString(sp->s_name);
Barry Warsaw11b91a02004-06-28 00:50:43 +00004866}
4867
4868PyDoc_STRVAR(getservbyport_doc,
4869"getservbyport(port[, protocolname]) -> string\n\
4870\n\
4871Return the service name from a port number and protocol name.\n\
4872The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4873otherwise any protocol will match.");
4874
Guido van Rossum3901d851996-12-19 16:35:04 +00004875/* Python interface to getprotobyname(name).
4876 This only returns the protocol number, since the other info is
4877 already known or not useful (like the list of aliases). */
4878
4879/*ARGSUSED*/
4880static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004881socket_getprotobyname(PyObject *self, PyObject *args)
Guido van Rossum3901d851996-12-19 16:35:04 +00004882{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004883 char *name;
4884 struct protoent *sp;
4885 if (!PyArg_ParseTuple(args, "s:getprotobyname", &name))
4886 return NULL;
4887 Py_BEGIN_ALLOW_THREADS
4888 sp = getprotobyname(name);
4889 Py_END_ALLOW_THREADS
4890 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004891 PyErr_SetString(PyExc_OSError, "protocol not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004892 return NULL;
4893 }
4894 return PyLong_FromLong((long) sp->p_proto);
Guido van Rossum3901d851996-12-19 16:35:04 +00004895}
4896
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004897PyDoc_STRVAR(getprotobyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004898"getprotobyname(name) -> integer\n\
4899\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004900Return the protocol number for the named protocol. (Rarely used.)");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004901
Guido van Rossum3901d851996-12-19 16:35:04 +00004902
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004903#ifndef NO_DUP
4904/* dup() function for socket fds */
4905
4906static PyObject *
4907socket_dup(PyObject *self, PyObject *fdobj)
4908{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004909 SOCKET_T fd, newfd;
4910 PyObject *newfdobj;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004911#ifdef MS_WINDOWS
4912 WSAPROTOCOL_INFO info;
4913#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004915 fd = PyLong_AsSocket_t(fdobj);
4916 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4917 return NULL;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004918
Victor Stinnerdaf45552013-08-28 00:53:59 +02004919#ifdef MS_WINDOWS
4920 if (WSADuplicateSocket(fd, GetCurrentProcessId(), &info))
4921 return set_error();
4922
4923 newfd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4924 FROM_PROTOCOL_INFO,
4925 &info, 0, WSA_FLAG_OVERLAPPED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004926 if (newfd == INVALID_SOCKET)
4927 return set_error();
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004928
Victor Stinnerdaf45552013-08-28 00:53:59 +02004929 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
4930 closesocket(newfd);
4931 PyErr_SetFromWindowsErr(0);
4932 return NULL;
4933 }
4934#else
4935 /* On UNIX, dup can be used to duplicate the file descriptor of a socket */
4936 newfd = _Py_dup(fd);
4937 if (newfd == INVALID_SOCKET)
Victor Stinnere990c6e2013-11-16 00:18:58 +01004938 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004939#endif
4940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004941 newfdobj = PyLong_FromSocket_t(newfd);
4942 if (newfdobj == NULL)
4943 SOCKETCLOSE(newfd);
4944 return newfdobj;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004945}
4946
4947PyDoc_STRVAR(dup_doc,
4948"dup(integer) -> integer\n\
4949\n\
4950Duplicate an integer socket file descriptor. This is like os.dup(), but for\n\
4951sockets; on some platforms os.dup() won't work for socket file descriptors.");
4952#endif
4953
4954
Dave Cole331708b2004-08-09 04:51:41 +00004955#ifdef HAVE_SOCKETPAIR
4956/* Create a pair of sockets using the socketpair() function.
Dave Cole07fda7e2004-08-23 05:16:23 +00004957 Arguments as for socket() except the default family is AF_UNIX if
Dave Colee8bbfe42004-08-26 00:51:16 +00004958 defined on the platform; otherwise, the default is AF_INET. */
Dave Cole331708b2004-08-09 04:51:41 +00004959
4960/*ARGSUSED*/
4961static PyObject *
4962socket_socketpair(PyObject *self, PyObject *args)
4963{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004964 PySocketSockObject *s0 = NULL, *s1 = NULL;
4965 SOCKET_T sv[2];
4966 int family, type = SOCK_STREAM, proto = 0;
4967 PyObject *res = NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004968#ifdef SOCK_CLOEXEC
4969 int *atomic_flag_works = &sock_cloexec_works;
4970#else
4971 int *atomic_flag_works = NULL;
4972#endif
4973 int ret;
Dave Cole331708b2004-08-09 04:51:41 +00004974
4975#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004976 family = AF_UNIX;
Dave Cole331708b2004-08-09 04:51:41 +00004977#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004978 family = AF_INET;
Dave Cole331708b2004-08-09 04:51:41 +00004979#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004980 if (!PyArg_ParseTuple(args, "|iii:socketpair",
4981 &family, &type, &proto))
4982 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004984 /* Create a pair of socket fds */
Victor Stinnerdaf45552013-08-28 00:53:59 +02004985 Py_BEGIN_ALLOW_THREADS
4986#ifdef SOCK_CLOEXEC
4987 if (sock_cloexec_works != 0) {
4988 ret = socketpair(family, type | SOCK_CLOEXEC, proto, sv);
4989 if (sock_cloexec_works == -1) {
4990 if (ret >= 0) {
4991 sock_cloexec_works = 1;
4992 }
4993 else if (errno == EINVAL) {
4994 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4995 sock_cloexec_works = 0;
4996 ret = socketpair(family, type, proto, sv);
4997 }
4998 }
4999 }
5000 else
5001#endif
5002 {
5003 ret = socketpair(family, type, proto, sv);
5004 }
5005 Py_END_ALLOW_THREADS
5006
5007 if (ret < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005008 return set_error();
Victor Stinnerdaf45552013-08-28 00:53:59 +02005009
5010 if (_Py_set_inheritable(sv[0], 0, atomic_flag_works) < 0)
5011 goto finally;
5012 if (_Py_set_inheritable(sv[1], 0, atomic_flag_works) < 0)
5013 goto finally;
5014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005015 s0 = new_sockobject(sv[0], family, type, proto);
5016 if (s0 == NULL)
5017 goto finally;
5018 s1 = new_sockobject(sv[1], family, type, proto);
5019 if (s1 == NULL)
5020 goto finally;
5021 res = PyTuple_Pack(2, s0, s1);
Dave Cole331708b2004-08-09 04:51:41 +00005022
5023finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005024 if (res == NULL) {
5025 if (s0 == NULL)
5026 SOCKETCLOSE(sv[0]);
5027 if (s1 == NULL)
5028 SOCKETCLOSE(sv[1]);
5029 }
5030 Py_XDECREF(s0);
5031 Py_XDECREF(s1);
5032 return res;
Dave Cole331708b2004-08-09 04:51:41 +00005033}
5034
5035PyDoc_STRVAR(socketpair_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +02005036"socketpair([family[, type [, proto]]]) -> (socket object, socket object)\n\
Dave Cole331708b2004-08-09 04:51:41 +00005037\n\
5038Create a pair of socket objects from the sockets returned by the platform\n\
5039socketpair() function.\n\
Dave Cole07fda7e2004-08-23 05:16:23 +00005040The arguments are the same as for socket() except the default family is\n\
Dave Colee8bbfe42004-08-26 00:51:16 +00005041AF_UNIX if defined on the platform; otherwise, the default is AF_INET.");
Dave Cole331708b2004-08-09 04:51:41 +00005042
5043#endif /* HAVE_SOCKETPAIR */
5044
5045
Guido van Rossum006bf911996-06-12 04:04:55 +00005046static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005047socket_ntohs(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00005048{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005049 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00005050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005051 if (!PyArg_ParseTuple(args, "i:ntohs", &x1)) {
5052 return NULL;
5053 }
5054 if (x1 < 0) {
5055 PyErr_SetString(PyExc_OverflowError,
5056 "can't convert negative number to unsigned long");
5057 return NULL;
5058 }
5059 x2 = (unsigned int)ntohs((unsigned short)x1);
5060 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00005061}
5062
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005063PyDoc_STRVAR(ntohs_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005064"ntohs(integer) -> integer\n\
5065\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005066Convert a 16-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005067
5068
Guido van Rossum006bf911996-06-12 04:04:55 +00005069static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005070socket_ntohl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00005071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005072 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00005073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 if (PyLong_Check(arg)) {
5075 x = PyLong_AsUnsignedLong(arg);
5076 if (x == (unsigned long) -1 && PyErr_Occurred())
5077 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005078#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005079 {
5080 unsigned long y;
5081 /* only want the trailing 32 bits */
5082 y = x & 0xFFFFFFFFUL;
5083 if (y ^ x)
5084 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005085 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005086 x = y;
5087 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005088#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005089 }
5090 else
5091 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005092 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005093 Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005094 return PyLong_FromUnsignedLong(ntohl(x));
Guido van Rossum006bf911996-06-12 04:04:55 +00005095}
5096
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005097PyDoc_STRVAR(ntohl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005098"ntohl(integer) -> integer\n\
5099\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005100Convert a 32-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005101
5102
Guido van Rossum006bf911996-06-12 04:04:55 +00005103static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005104socket_htons(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00005105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005106 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00005107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005108 if (!PyArg_ParseTuple(args, "i:htons", &x1)) {
5109 return NULL;
5110 }
5111 if (x1 < 0) {
5112 PyErr_SetString(PyExc_OverflowError,
5113 "can't convert negative number to unsigned long");
5114 return NULL;
5115 }
5116 x2 = (unsigned int)htons((unsigned short)x1);
5117 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00005118}
5119
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005120PyDoc_STRVAR(htons_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005121"htons(integer) -> integer\n\
5122\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005123Convert a 16-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005124
5125
Guido van Rossum006bf911996-06-12 04:04:55 +00005126static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005127socket_htonl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00005128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005129 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00005130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005131 if (PyLong_Check(arg)) {
5132 x = PyLong_AsUnsignedLong(arg);
5133 if (x == (unsigned long) -1 && PyErr_Occurred())
5134 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005135#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005136 {
5137 unsigned long y;
5138 /* only want the trailing 32 bits */
5139 y = x & 0xFFFFFFFFUL;
5140 if (y ^ x)
5141 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005142 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005143 x = y;
5144 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005145#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005146 }
5147 else
5148 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005149 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005150 Py_TYPE(arg)->tp_name);
5151 return PyLong_FromUnsignedLong(htonl((unsigned long)x));
Guido van Rossum006bf911996-06-12 04:04:55 +00005152}
5153
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005154PyDoc_STRVAR(htonl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005155"htonl(integer) -> integer\n\
5156\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005157Convert a 32-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005158
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005159/* socket.inet_aton() and socket.inet_ntoa() functions. */
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005160
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005161PyDoc_STRVAR(inet_aton_doc,
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005162"inet_aton(string) -> bytes giving packed 32-bit IP representation\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005163\n\
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005164Convert an IP address in string format (123.45.67.89) to the 32-bit packed\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005165binary format used in low-level network functions.");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005166
5167static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005168socket_inet_aton(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005169{
Neal Norwitz88f115b2003-02-13 02:15:42 +00005170#ifdef HAVE_INET_ATON
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005171 struct in_addr buf;
Thomas Wouters477c8d52006-05-27 19:21:47 +00005172#endif
5173
5174#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
Benjamin Petersonf91df042009-02-13 02:50:59 +00005175#if (SIZEOF_INT != 4)
5176#error "Not sure if in_addr_t exists and int is not 32-bits."
5177#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005178 /* Have to use inet_addr() instead */
5179 unsigned int packed_addr;
Tim Peters1df9fdd2003-02-13 03:13:40 +00005180#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005181 char *ip_addr;
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005183 if (!PyArg_ParseTuple(args, "s:inet_aton", &ip_addr))
5184 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005185
Tim Peters1df9fdd2003-02-13 03:13:40 +00005186
5187#ifdef HAVE_INET_ATON
Thomas Wouters477c8d52006-05-27 19:21:47 +00005188
5189#ifdef USE_INET_ATON_WEAKLINK
5190 if (inet_aton != NULL) {
5191#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005192 if (inet_aton(ip_addr, &buf))
5193 return PyBytes_FromStringAndSize((char *)(&buf),
5194 sizeof(buf));
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005195
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005196 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005197 "illegal IP address string passed to inet_aton");
5198 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005199
Thomas Wouters477c8d52006-05-27 19:21:47 +00005200#ifdef USE_INET_ATON_WEAKLINK
5201 } else {
5202#endif
5203
5204#endif
5205
5206#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
5207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005208 /* special-case this address as inet_addr might return INADDR_NONE
5209 * for this */
5210 if (strcmp(ip_addr, "255.255.255.255") == 0) {
Charles-François Natali24aa0412013-08-31 14:48:25 +02005211 packed_addr = INADDR_BROADCAST;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005212 } else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00005213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005214 packed_addr = inet_addr(ip_addr);
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005216 if (packed_addr == INADDR_NONE) { /* invalid address */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005217 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005218 "illegal IP address string passed to inet_aton");
5219 return NULL;
5220 }
5221 }
5222 return PyBytes_FromStringAndSize((char *) &packed_addr,
5223 sizeof(packed_addr));
Thomas Wouters477c8d52006-05-27 19:21:47 +00005224
5225#ifdef USE_INET_ATON_WEAKLINK
5226 }
5227#endif
5228
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005229#endif
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005230}
5231
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005232PyDoc_STRVAR(inet_ntoa_doc,
Fred Drakee0661342000-03-07 14:05:16 +00005233"inet_ntoa(packed_ip) -> ip_address_string\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005234\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005235Convert an IP address from 32-bit packed binary format to string format");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005236
5237static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005238socket_inet_ntoa(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005239{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005240 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005241 struct in_addr packed_addr;
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005242
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005243 if (!PyArg_ParseTuple(args, "y*:inet_ntoa", &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005244 return NULL;
5245 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00005246
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005247 if (packed_ip.len != sizeof(packed_addr)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005248 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005249 "packed IP wrong length for inet_ntoa");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005250 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005251 return NULL;
5252 }
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005253
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005254 memcpy(&packed_addr, packed_ip.buf, packed_ip.len);
5255 PyBuffer_Release(&packed_ip);
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005257 return PyUnicode_FromString(inet_ntoa(packed_addr));
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005258}
Guido van Rossum82a5c661998-07-07 20:45:43 +00005259
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005260#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005261
5262PyDoc_STRVAR(inet_pton_doc,
5263"inet_pton(af, ip) -> packed IP address string\n\
5264\n\
5265Convert an IP address from string format to a packed string suitable\n\
5266for use with low-level network functions.");
5267
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005268#endif
5269
5270#ifdef HAVE_INET_PTON
5271
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005272static PyObject *
5273socket_inet_pton(PyObject *self, PyObject *args)
5274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005275 int af;
5276 char* ip;
5277 int retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005278#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005279 char packed[Py_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005280#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005281 char packed[sizeof(struct in_addr)];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005282#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005283 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5284 return NULL;
5285 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005286
Martin v. Löwis04697e82004-06-02 12:35:29 +00005287#if !defined(ENABLE_IPV6) && defined(AF_INET6)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005288 if(af == AF_INET6) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005289 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005290 "can't use AF_INET6, IPv6 is disabled");
5291 return NULL;
5292 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00005293#endif
Martin v. Löwis10649092003-08-05 06:25:06 +00005294
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005295 retval = inet_pton(af, ip, packed);
5296 if (retval < 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005297 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005298 return NULL;
5299 } else if (retval == 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005300 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005301 "illegal IP address string passed to inet_pton");
5302 return NULL;
5303 } else if (af == AF_INET) {
5304 return PyBytes_FromStringAndSize(packed,
5305 sizeof(struct in_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005306#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005307 } else if (af == AF_INET6) {
5308 return PyBytes_FromStringAndSize(packed,
5309 sizeof(struct in6_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005310#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005311 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005312 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005313 return NULL;
5314 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005315}
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005316#elif defined(MS_WINDOWS)
5317
5318static PyObject *
5319socket_inet_pton(PyObject *self, PyObject *args)
5320{
5321 int af;
5322 char* ip;
5323 struct sockaddr_in6 addr;
5324 INT ret, size;
5325
5326 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5327 return NULL;
5328 }
5329
Victor Stinnere990c6e2013-11-16 00:18:58 +01005330 size = sizeof(addr);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005331 ret = WSAStringToAddressA(ip, af, NULL, (LPSOCKADDR)&addr, &size);
5332
5333 if (ret) {
5334 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5335 return NULL;
5336 } else if(af == AF_INET) {
5337 struct sockaddr_in *addr4 = (struct sockaddr_in*)&addr;
Victor Stinnere990c6e2013-11-16 00:18:58 +01005338 return PyBytes_FromStringAndSize((const char *)&(addr4->sin_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005339 sizeof(addr4->sin_addr));
5340 } else if (af == AF_INET6) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01005341 return PyBytes_FromStringAndSize((const char *)&(addr.sin6_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005342 sizeof(addr.sin6_addr));
5343 } else {
5344 PyErr_SetString(PyExc_OSError, "unknown address family");
5345 return NULL;
5346 }
5347}
5348
5349#endif
5350
5351#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Thomas Wouters477c8d52006-05-27 19:21:47 +00005352
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005353PyDoc_STRVAR(inet_ntop_doc,
5354"inet_ntop(af, packed_ip) -> string formatted IP address\n\
5355\n\
5356Convert a packed IP address of the given family to string format.");
5357
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005358#endif
5359
5360
5361#ifdef HAVE_INET_PTON
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005362static PyObject *
5363socket_inet_ntop(PyObject *self, PyObject *args)
5364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005365 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005366 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005367 const char* retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005368#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005369 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005370#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005371 char ip[INET_ADDRSTRLEN + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005372#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00005373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005374 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5375 memset((void *) &ip[0], '\0', sizeof(ip));
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005376
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005377 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005378 return NULL;
5379 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005381 if (af == AF_INET) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005382 if (packed_ip.len != sizeof(struct in_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005383 PyErr_SetString(PyExc_ValueError,
5384 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005385 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005386 return NULL;
5387 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005388#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005389 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005390 if (packed_ip.len != sizeof(struct in6_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005391 PyErr_SetString(PyExc_ValueError,
5392 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005393 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005394 return NULL;
5395 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005396#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005397 } else {
5398 PyErr_Format(PyExc_ValueError,
5399 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005400 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005401 return NULL;
5402 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005403
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005404 retval = inet_ntop(af, packed_ip.buf, ip, sizeof(ip));
5405 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005406 if (!retval) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005407 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005408 return NULL;
5409 } else {
5410 return PyUnicode_FromString(retval);
5411 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005413 /* NOTREACHED */
5414 PyErr_SetString(PyExc_RuntimeError, "invalid handling of inet_ntop");
5415 return NULL;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005416}
5417
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005418#elif defined(MS_WINDOWS)
5419
5420static PyObject *
5421socket_inet_ntop(PyObject *self, PyObject *args)
5422{
5423 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005424 Py_buffer packed_ip;
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005425 struct sockaddr_in6 addr;
5426 DWORD addrlen, ret, retlen;
Jason R. Coombs8ec784c2013-11-10 13:43:22 -05005427#ifdef ENABLE_IPV6
5428 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
5429#else
5430 char ip[INET_ADDRSTRLEN + 1];
5431#endif
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005432
5433 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5434 memset((void *) &ip[0], '\0', sizeof(ip));
5435
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005436 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005437 return NULL;
5438 }
5439
5440 if (af == AF_INET) {
5441 struct sockaddr_in * addr4 = (struct sockaddr_in *)&addr;
5442
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005443 if (packed_ip.len != sizeof(struct in_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005444 PyErr_SetString(PyExc_ValueError,
5445 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005446 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005447 return NULL;
5448 }
5449 memset(addr4, 0, sizeof(struct sockaddr_in));
5450 addr4->sin_family = AF_INET;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005451 memcpy(&(addr4->sin_addr), packed_ip.buf, sizeof(addr4->sin_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005452 addrlen = sizeof(struct sockaddr_in);
5453 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005454 if (packed_ip.len != sizeof(struct in6_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005455 PyErr_SetString(PyExc_ValueError,
5456 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005457 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005458 return NULL;
5459 }
5460
5461 memset(&addr, 0, sizeof(addr));
5462 addr.sin6_family = AF_INET6;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005463 memcpy(&(addr.sin6_addr), packed_ip.buf, sizeof(addr.sin6_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005464 addrlen = sizeof(addr);
5465 } else {
5466 PyErr_Format(PyExc_ValueError,
5467 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005468 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005469 return NULL;
5470 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005471 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005472
5473 retlen = sizeof(ip);
Victor Stinnere990c6e2013-11-16 00:18:58 +01005474 ret = WSAAddressToStringA((struct sockaddr*)&addr, addrlen, NULL,
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005475 ip, &retlen);
5476
5477 if (ret) {
5478 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5479 return NULL;
5480 } else {
5481 return PyUnicode_FromString(ip);
5482 }
5483}
5484
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005485#endif /* HAVE_INET_PTON */
5486
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005487/* Python interface to getaddrinfo(host, port). */
5488
5489/*ARGSUSED*/
5490static PyObject *
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005491socket_getaddrinfo(PyObject *self, PyObject *args, PyObject* kwargs)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005492{
Victor Stinner77af1722011-05-26 14:05:59 +02005493 static char* kwnames[] = {"host", "port", "family", "type", "proto",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005494 "flags", 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005495 struct addrinfo hints, *res;
5496 struct addrinfo *res0 = NULL;
5497 PyObject *hobj = NULL;
5498 PyObject *pobj = (PyObject *)NULL;
5499 char pbuf[30];
5500 char *hptr, *pptr;
5501 int family, socktype, protocol, flags;
5502 int error;
5503 PyObject *all = (PyObject *)NULL;
5504 PyObject *idna = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005505
Georg Brandl6083a4b2013-10-14 06:51:46 +02005506 socktype = protocol = flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005507 family = AF_UNSPEC;
Victor Stinner77af1722011-05-26 14:05:59 +02005508 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|iiii:getaddrinfo",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005509 kwnames, &hobj, &pobj, &family, &socktype,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005510 &protocol, &flags)) {
5511 return NULL;
5512 }
5513 if (hobj == Py_None) {
5514 hptr = NULL;
5515 } else if (PyUnicode_Check(hobj)) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005516 _Py_IDENTIFIER(encode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02005517
5518 idna = _PyObject_CallMethodId(hobj, &PyId_encode, "s", "idna");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005519 if (!idna)
5520 return NULL;
5521 assert(PyBytes_Check(idna));
5522 hptr = PyBytes_AS_STRING(idna);
5523 } else if (PyBytes_Check(hobj)) {
5524 hptr = PyBytes_AsString(hobj);
5525 } else {
5526 PyErr_SetString(PyExc_TypeError,
5527 "getaddrinfo() argument 1 must be string or None");
5528 return NULL;
5529 }
5530 if (PyLong_CheckExact(pobj)) {
5531 long value = PyLong_AsLong(pobj);
5532 if (value == -1 && PyErr_Occurred())
5533 goto err;
5534 PyOS_snprintf(pbuf, sizeof(pbuf), "%ld", value);
5535 pptr = pbuf;
5536 } else if (PyUnicode_Check(pobj)) {
5537 pptr = _PyUnicode_AsString(pobj);
Alexander Belopolskye239d232010-12-08 23:31:48 +00005538 if (pptr == NULL)
5539 goto err;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005540 } else if (PyBytes_Check(pobj)) {
Alexander Belopolskye239d232010-12-08 23:31:48 +00005541 pptr = PyBytes_AS_STRING(pobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005542 } else if (pobj == Py_None) {
5543 pptr = (char *)NULL;
5544 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005545 PyErr_SetString(PyExc_OSError, "Int or String expected");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005546 goto err;
5547 }
Ronald Oussorena822d3662013-06-10 10:36:28 +02005548#if defined(__APPLE__) && defined(AI_NUMERICSERV)
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005549 if ((flags & AI_NUMERICSERV) && (pptr == NULL || (pptr[0] == '0' && pptr[1] == 0))) {
5550 /* On OSX upto at least OSX 10.8 getaddrinfo crashes
Christian Heimesaf01f662013-12-21 16:19:10 +01005551 * if AI_NUMERICSERV is set and the servname is NULL or "0".
5552 * This workaround avoids a segfault in libsystem.
5553 */
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005554 pptr = "00";
5555 }
5556#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005557 memset(&hints, 0, sizeof(hints));
5558 hints.ai_family = family;
5559 hints.ai_socktype = socktype;
5560 hints.ai_protocol = protocol;
5561 hints.ai_flags = flags;
5562 Py_BEGIN_ALLOW_THREADS
5563 ACQUIRE_GETADDRINFO_LOCK
5564 error = getaddrinfo(hptr, pptr, &hints, &res0);
5565 Py_END_ALLOW_THREADS
5566 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5567 if (error) {
5568 set_gaierror(error);
5569 goto err;
5570 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005571
Benjamin Peterson4fd929b2015-04-01 11:16:40 -04005572 all = PyList_New(0);
5573 if (all == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005574 goto err;
5575 for (res = res0; res; res = res->ai_next) {
5576 PyObject *single;
5577 PyObject *addr =
5578 makesockaddr(-1, res->ai_addr, res->ai_addrlen, protocol);
5579 if (addr == NULL)
5580 goto err;
5581 single = Py_BuildValue("iiisO", res->ai_family,
5582 res->ai_socktype, res->ai_protocol,
5583 res->ai_canonname ? res->ai_canonname : "",
5584 addr);
5585 Py_DECREF(addr);
5586 if (single == NULL)
5587 goto err;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005589 if (PyList_Append(all, single))
5590 goto err;
5591 Py_XDECREF(single);
5592 }
5593 Py_XDECREF(idna);
5594 if (res0)
5595 freeaddrinfo(res0);
5596 return all;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005597 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005598 Py_XDECREF(all);
5599 Py_XDECREF(idna);
5600 if (res0)
5601 freeaddrinfo(res0);
5602 return (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005603}
5604
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005605PyDoc_STRVAR(getaddrinfo_doc,
Berker Peksaga6ec5ee2014-06-30 11:28:40 +03005606"getaddrinfo(host, port [, family, type, proto, flags])\n\
5607 -> list of (family, type, proto, canonname, sockaddr)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005608\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005609Resolve host and port into addrinfo struct.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005610
5611/* Python interface to getnameinfo(sa, flags). */
5612
5613/*ARGSUSED*/
5614static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005615socket_getnameinfo(PyObject *self, PyObject *args)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005616{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005617 PyObject *sa = (PyObject *)NULL;
5618 int flags;
5619 char *hostp;
Charles-François Natali366999a2012-01-02 15:47:29 +01005620 int port;
5621 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005622 char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
5623 struct addrinfo hints, *res = NULL;
5624 int error;
5625 PyObject *ret = (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005627 flags = flowinfo = scope_id = 0;
5628 if (!PyArg_ParseTuple(args, "Oi:getnameinfo", &sa, &flags))
5629 return NULL;
5630 if (!PyTuple_Check(sa)) {
5631 PyErr_SetString(PyExc_TypeError,
5632 "getnameinfo() argument 1 must be a tuple");
5633 return NULL;
5634 }
Charles-François Natali366999a2012-01-02 15:47:29 +01005635 if (!PyArg_ParseTuple(sa, "si|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005636 &hostp, &port, &flowinfo, &scope_id))
5637 return NULL;
Charles-François Natali9b0c0062012-06-23 10:17:05 +02005638 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01005639 PyErr_SetString(PyExc_OverflowError,
5640 "getsockaddrarg: flowinfo must be 0-1048575.");
5641 return NULL;
5642 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005643 PyOS_snprintf(pbuf, sizeof(pbuf), "%d", port);
5644 memset(&hints, 0, sizeof(hints));
5645 hints.ai_family = AF_UNSPEC;
5646 hints.ai_socktype = SOCK_DGRAM; /* make numeric port happy */
Martin v. Löwis112c0f32010-08-25 07:38:15 +00005647 hints.ai_flags = AI_NUMERICHOST; /* don't do any name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005648 Py_BEGIN_ALLOW_THREADS
5649 ACQUIRE_GETADDRINFO_LOCK
5650 error = getaddrinfo(hostp, pbuf, &hints, &res);
5651 Py_END_ALLOW_THREADS
5652 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5653 if (error) {
5654 set_gaierror(error);
5655 goto fail;
5656 }
5657 if (res->ai_next) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005658 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005659 "sockaddr resolved to multiple addresses");
5660 goto fail;
5661 }
5662 switch (res->ai_family) {
5663 case AF_INET:
5664 {
5665 if (PyTuple_GET_SIZE(sa) != 2) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005666 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005667 "IPv4 sockaddr must be 2 tuple");
5668 goto fail;
5669 }
5670 break;
5671 }
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00005672#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005673 case AF_INET6:
5674 {
5675 struct sockaddr_in6 *sin6;
5676 sin6 = (struct sockaddr_in6 *)res->ai_addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01005677 sin6->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005678 sin6->sin6_scope_id = scope_id;
5679 break;
5680 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005681#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005682 }
Antoine Pitrou19467d22010-08-17 19:33:30 +00005683 error = getnameinfo(res->ai_addr, (socklen_t) res->ai_addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005684 hbuf, sizeof(hbuf), pbuf, sizeof(pbuf), flags);
5685 if (error) {
5686 set_gaierror(error);
5687 goto fail;
5688 }
5689 ret = Py_BuildValue("ss", hbuf, pbuf);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005690
5691fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005692 if (res)
5693 freeaddrinfo(res);
5694 return ret;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005695}
5696
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005697PyDoc_STRVAR(getnameinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005698"getnameinfo(sockaddr, flags) --> (host, port)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005699\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005700Get host and port for a sockaddr.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005701
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005702
5703/* Python API to getting and setting the default timeout value. */
5704
5705static PyObject *
5706socket_getdefaulttimeout(PyObject *self)
5707{
Victor Stinner71694d52015-03-28 01:18:54 +01005708 if (defaulttimeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005709 Py_INCREF(Py_None);
5710 return Py_None;
5711 }
Victor Stinner71694d52015-03-28 01:18:54 +01005712 else {
5713 double seconds = _PyTime_AsSecondsDouble(defaulttimeout);
5714 return PyFloat_FromDouble(seconds);
5715 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005716}
5717
5718PyDoc_STRVAR(getdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005719"getdefaulttimeout() -> timeout\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005720\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005721Returns the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005722A value of None indicates that new socket objects have no timeout.\n\
5723When the socket module is first imported, the default is None.");
5724
5725static PyObject *
5726socket_setdefaulttimeout(PyObject *self, PyObject *arg)
5727{
Victor Stinner71694d52015-03-28 01:18:54 +01005728 _PyTime_t timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005729
Victor Stinner71694d52015-03-28 01:18:54 +01005730 if (socket_parse_timeout(&timeout, arg) < 0)
5731 return NULL;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005733 defaulttimeout = timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005735 Py_INCREF(Py_None);
5736 return Py_None;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005737}
5738
5739PyDoc_STRVAR(setdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005740"setdefaulttimeout(timeout)\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005741\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005742Set the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005743A value of None indicates that new socket objects have no timeout.\n\
5744When the socket module is first imported, the default is None.");
5745
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005746#ifdef HAVE_IF_NAMEINDEX
5747/* Python API for getting interface indices and names */
5748
5749static PyObject *
5750socket_if_nameindex(PyObject *self, PyObject *arg)
5751{
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005752 PyObject *list;
Charles-François Natali60713592011-05-20 16:55:06 +02005753 int i;
5754 struct if_nameindex *ni;
Victor Stinner77af1722011-05-26 14:05:59 +02005755
Charles-François Natali60713592011-05-20 16:55:06 +02005756 ni = if_nameindex();
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005757 if (ni == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005758 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005759 return NULL;
5760 }
5761
5762 list = PyList_New(0);
5763 if (list == NULL) {
5764 if_freenameindex(ni);
5765 return NULL;
5766 }
5767
Charles-François Natali60713592011-05-20 16:55:06 +02005768 for (i = 0; ni[i].if_index != 0 && i < INT_MAX; i++) {
5769 PyObject *ni_tuple = Py_BuildValue("IO&",
5770 ni[i].if_index, PyUnicode_DecodeFSDefault, ni[i].if_name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005771
5772 if (ni_tuple == NULL || PyList_Append(list, ni_tuple) == -1) {
5773 Py_XDECREF(ni_tuple);
Charles-François Natali60713592011-05-20 16:55:06 +02005774 Py_DECREF(list);
5775 if_freenameindex(ni);
5776 return NULL;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005777 }
5778 Py_DECREF(ni_tuple);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005779 }
5780
5781 if_freenameindex(ni);
5782 return list;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005783}
5784
5785PyDoc_STRVAR(if_nameindex_doc,
5786"if_nameindex()\n\
5787\n\
5788Returns a list of network interface information (index, name) tuples.");
5789
Charles-François Natali60713592011-05-20 16:55:06 +02005790static PyObject *
5791socket_if_nametoindex(PyObject *self, PyObject *args)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005792{
Charles-François Natali60713592011-05-20 16:55:06 +02005793 PyObject *oname;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005794 unsigned long index;
5795
Charles-François Natali60713592011-05-20 16:55:06 +02005796 if (!PyArg_ParseTuple(args, "O&:if_nametoindex",
5797 PyUnicode_FSConverter, &oname))
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005798 return NULL;
5799
Charles-François Natali60713592011-05-20 16:55:06 +02005800 index = if_nametoindex(PyBytes_AS_STRING(oname));
5801 Py_DECREF(oname);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005802 if (index == 0) {
Charles-François Natali60713592011-05-20 16:55:06 +02005803 /* if_nametoindex() doesn't set errno */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005804 PyErr_SetString(PyExc_OSError, "no interface with this name");
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005805 return NULL;
5806 }
5807
5808 return PyLong_FromUnsignedLong(index);
5809}
5810
5811PyDoc_STRVAR(if_nametoindex_doc,
5812"if_nametoindex(if_name)\n\
5813\n\
5814Returns the interface index corresponding to the interface name if_name.");
5815
Charles-François Natali60713592011-05-20 16:55:06 +02005816static PyObject *
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005817socket_if_indextoname(PyObject *self, PyObject *arg)
5818{
Charles-François Natali60713592011-05-20 16:55:06 +02005819 unsigned long index;
5820 char name[IF_NAMESIZE + 1];
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005821
Charles-François Natali60713592011-05-20 16:55:06 +02005822 index = PyLong_AsUnsignedLong(arg);
5823 if (index == (unsigned long) -1)
5824 return NULL;
5825
5826 if (if_indextoname(index, name) == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005827 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005828 return NULL;
5829 }
5830
Charles-François Natali60713592011-05-20 16:55:06 +02005831 return PyUnicode_DecodeFSDefault(name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005832}
5833
5834PyDoc_STRVAR(if_indextoname_doc,
5835"if_indextoname(if_index)\n\
5836\n\
5837Returns the interface name corresponding to the interface index if_index.");
5838
5839#endif /* HAVE_IF_NAMEINDEX */
5840
5841
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005842#ifdef CMSG_LEN
5843/* Python interface to CMSG_LEN(length). */
5844
5845static PyObject *
5846socket_CMSG_LEN(PyObject *self, PyObject *args)
5847{
5848 Py_ssize_t length;
5849 size_t result;
5850
5851 if (!PyArg_ParseTuple(args, "n:CMSG_LEN", &length))
5852 return NULL;
5853 if (length < 0 || !get_CMSG_LEN(length, &result)) {
5854 PyErr_Format(PyExc_OverflowError, "CMSG_LEN() argument out of range");
5855 return NULL;
5856 }
5857 return PyLong_FromSize_t(result);
5858}
5859
5860PyDoc_STRVAR(CMSG_LEN_doc,
5861"CMSG_LEN(length) -> control message length\n\
5862\n\
5863Return the total length, without trailing padding, of an ancillary\n\
5864data item with associated data of the given length. This value can\n\
5865often be used as the buffer size for recvmsg() to receive a single\n\
5866item of ancillary data, but RFC 3542 requires portable applications to\n\
5867use CMSG_SPACE() and thus include space for padding, even when the\n\
5868item will be the last in the buffer. Raises OverflowError if length\n\
5869is outside the permissible range of values.");
5870
5871
5872#ifdef CMSG_SPACE
5873/* Python interface to CMSG_SPACE(length). */
5874
5875static PyObject *
5876socket_CMSG_SPACE(PyObject *self, PyObject *args)
5877{
5878 Py_ssize_t length;
5879 size_t result;
5880
5881 if (!PyArg_ParseTuple(args, "n:CMSG_SPACE", &length))
5882 return NULL;
5883 if (length < 0 || !get_CMSG_SPACE(length, &result)) {
5884 PyErr_SetString(PyExc_OverflowError,
5885 "CMSG_SPACE() argument out of range");
5886 return NULL;
5887 }
5888 return PyLong_FromSize_t(result);
5889}
5890
5891PyDoc_STRVAR(CMSG_SPACE_doc,
5892"CMSG_SPACE(length) -> buffer size\n\
5893\n\
5894Return the buffer size needed for recvmsg() to receive an ancillary\n\
5895data item with associated data of the given length, along with any\n\
5896trailing padding. The buffer space needed to receive multiple items\n\
5897is the sum of the CMSG_SPACE() values for their associated data\n\
5898lengths. Raises OverflowError if length is outside the permissible\n\
5899range of values.");
5900#endif /* CMSG_SPACE */
5901#endif /* CMSG_LEN */
5902
5903
Guido van Rossum30a685f1991-06-27 15:51:29 +00005904/* List of functions exported by this module. */
5905
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005906static PyMethodDef socket_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005907 {"gethostbyname", socket_gethostbyname,
5908 METH_VARARGS, gethostbyname_doc},
5909 {"gethostbyname_ex", socket_gethostbyname_ex,
5910 METH_VARARGS, ghbn_ex_doc},
5911 {"gethostbyaddr", socket_gethostbyaddr,
5912 METH_VARARGS, gethostbyaddr_doc},
5913 {"gethostname", socket_gethostname,
5914 METH_NOARGS, gethostname_doc},
Antoine Pitrou061cfb52011-02-28 22:25:22 +00005915#ifdef HAVE_SETHOSTNAME
5916 {"sethostname", socket_sethostname,
5917 METH_VARARGS, sethostname_doc},
5918#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005919 {"getservbyname", socket_getservbyname,
5920 METH_VARARGS, getservbyname_doc},
5921 {"getservbyport", socket_getservbyport,
5922 METH_VARARGS, getservbyport_doc},
5923 {"getprotobyname", socket_getprotobyname,
5924 METH_VARARGS, getprotobyname_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005925#ifndef NO_DUP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005926 {"dup", socket_dup,
5927 METH_O, dup_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005928#endif
Dave Cole331708b2004-08-09 04:51:41 +00005929#ifdef HAVE_SOCKETPAIR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005930 {"socketpair", socket_socketpair,
5931 METH_VARARGS, socketpair_doc},
Dave Cole331708b2004-08-09 04:51:41 +00005932#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005933 {"ntohs", socket_ntohs,
5934 METH_VARARGS, ntohs_doc},
5935 {"ntohl", socket_ntohl,
5936 METH_O, ntohl_doc},
5937 {"htons", socket_htons,
5938 METH_VARARGS, htons_doc},
5939 {"htonl", socket_htonl,
5940 METH_O, htonl_doc},
5941 {"inet_aton", socket_inet_aton,
5942 METH_VARARGS, inet_aton_doc},
5943 {"inet_ntoa", socket_inet_ntoa,
5944 METH_VARARGS, inet_ntoa_doc},
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005945#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005946 {"inet_pton", socket_inet_pton,
5947 METH_VARARGS, inet_pton_doc},
5948 {"inet_ntop", socket_inet_ntop,
5949 METH_VARARGS, inet_ntop_doc},
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005950#endif
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005951 {"getaddrinfo", (PyCFunction)socket_getaddrinfo,
5952 METH_VARARGS | METH_KEYWORDS, getaddrinfo_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005953 {"getnameinfo", socket_getnameinfo,
5954 METH_VARARGS, getnameinfo_doc},
5955 {"getdefaulttimeout", (PyCFunction)socket_getdefaulttimeout,
5956 METH_NOARGS, getdefaulttimeout_doc},
5957 {"setdefaulttimeout", socket_setdefaulttimeout,
5958 METH_O, setdefaulttimeout_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005959#ifdef HAVE_IF_NAMEINDEX
5960 {"if_nameindex", socket_if_nameindex,
5961 METH_NOARGS, if_nameindex_doc},
5962 {"if_nametoindex", socket_if_nametoindex,
Charles-François Natali60713592011-05-20 16:55:06 +02005963 METH_VARARGS, if_nametoindex_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005964 {"if_indextoname", socket_if_indextoname,
5965 METH_O, if_indextoname_doc},
5966#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005967#ifdef CMSG_LEN
5968 {"CMSG_LEN", socket_CMSG_LEN,
5969 METH_VARARGS, CMSG_LEN_doc},
5970#ifdef CMSG_SPACE
5971 {"CMSG_SPACE", socket_CMSG_SPACE,
5972 METH_VARARGS, CMSG_SPACE_doc},
5973#endif
5974#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005975 {NULL, NULL} /* Sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005976};
5977
Guido van Rossum30a685f1991-06-27 15:51:29 +00005978
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005979#ifdef MS_WINDOWS
5980#define OS_INIT_DEFINED
5981
5982/* Additional initialization and cleanup for Windows */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005983
5984static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005985os_cleanup(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005987 WSACleanup();
Guido van Rossumbe32c891996-06-20 16:25:29 +00005988}
5989
5990static int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005991os_init(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005993 WSADATA WSAData;
5994 int ret;
5995 ret = WSAStartup(0x0101, &WSAData);
5996 switch (ret) {
5997 case 0: /* No error */
5998 Py_AtExit(os_cleanup);
5999 return 1; /* Success */
6000 case WSASYSNOTREADY:
6001 PyErr_SetString(PyExc_ImportError,
6002 "WSAStartup failed: network not ready");
6003 break;
6004 case WSAVERNOTSUPPORTED:
6005 case WSAEINVAL:
6006 PyErr_SetString(
6007 PyExc_ImportError,
6008 "WSAStartup failed: requested version not supported");
6009 break;
6010 default:
6011 PyErr_Format(PyExc_ImportError, "WSAStartup failed: error code %d", ret);
6012 break;
6013 }
6014 return 0; /* Failure */
Guido van Rossumbe32c891996-06-20 16:25:29 +00006015}
6016
Guido van Rossum8d665e61996-06-26 18:22:49 +00006017#endif /* MS_WINDOWS */
Guido van Rossumbe32c891996-06-20 16:25:29 +00006018
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00006019
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006020
6021#ifndef OS_INIT_DEFINED
6022static int
6023os_init(void)
6024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006025 return 1; /* Success */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006026}
6027#endif
6028
6029
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006030/* C API table - always add new things to the end for binary
6031 compatibility. */
6032static
6033PySocketModule_APIObject PySocketModuleAPI =
6034{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006035 &sock_type,
Antoine Pitrouc4df7842010-12-03 19:59:41 +00006036 NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006037 NULL
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006038};
6039
Guido van Rossum3eede5a2002-06-07 02:08:35 +00006040
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006041/* Initialize the _socket module.
Guido van Rossum3eede5a2002-06-07 02:08:35 +00006042
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006043 This module is actually called "_socket", and there's a wrapper
Guido van Rossum7d0a8262007-05-21 23:13:11 +00006044 "socket.py" which implements some additional functionality.
6045 The import of "_socket" may fail with an ImportError exception if
6046 os-specific initialization fails. On Windows, this does WINSOCK
Ezio Melotti13925002011-03-16 11:05:33 +02006047 initialization. When WINSOCK is initialized successfully, a call to
Guido van Rossum7d0a8262007-05-21 23:13:11 +00006048 WSACleanup() is scheduled to be made at exit time.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006049*/
Guido van Rossum3eede5a2002-06-07 02:08:35 +00006050
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006051PyDoc_STRVAR(socket_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00006052"Implementation module for socket operations.\n\
6053\n\
6054See the socket module for documentation.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00006055
Martin v. Löwis1a214512008-06-11 05:26:20 +00006056static struct PyModuleDef socketmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006057 PyModuleDef_HEAD_INIT,
6058 PySocket_MODULE_NAME,
6059 socket_doc,
6060 -1,
6061 socket_methods,
6062 NULL,
6063 NULL,
6064 NULL,
6065 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00006066};
6067
Mark Hammondfe51c6d2002-08-02 02:27:13 +00006068PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00006069PyInit__socket(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00006070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006071 PyObject *m, *has_ipv6;
Fred Drake4baedc12002-04-01 14:53:37 +00006072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006073 if (!os_init())
6074 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006075
Victor Stinnerdaf45552013-08-28 00:53:59 +02006076#ifdef MS_WINDOWS
6077 if (support_wsa_no_inherit == -1) {
Steve Dower65e4cb12014-11-22 12:54:57 -08006078#if defined(_MSC_VER) && _MSC_VER >= 1800
6079 support_wsa_no_inherit = IsWindows7SP1OrGreater();
6080#else
Victor Stinnerdaf45552013-08-28 00:53:59 +02006081 DWORD version = GetVersion();
6082 DWORD major = (DWORD)LOBYTE(LOWORD(version));
6083 DWORD minor = (DWORD)HIBYTE(LOWORD(version));
6084 /* need Windows 7 SP1, 2008 R2 SP1 or later */
Steve Dower65e4cb12014-11-22 12:54:57 -08006085 support_wsa_no_inherit = major > 6 || (major == 6 && minor >= 1);
6086#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02006087 }
6088#endif
6089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006090 Py_TYPE(&sock_type) = &PyType_Type;
6091 m = PyModule_Create(&socketmodule);
6092 if (m == NULL)
6093 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006094
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02006095 Py_INCREF(PyExc_OSError);
6096 PySocketModuleAPI.error = PyExc_OSError;
6097 Py_INCREF(PyExc_OSError);
6098 PyModule_AddObject(m, "error", PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006099 socket_herror = PyErr_NewException("socket.herror",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02006100 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006101 if (socket_herror == NULL)
6102 return NULL;
6103 Py_INCREF(socket_herror);
6104 PyModule_AddObject(m, "herror", socket_herror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02006105 socket_gaierror = PyErr_NewException("socket.gaierror", PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006106 NULL);
6107 if (socket_gaierror == NULL)
6108 return NULL;
6109 Py_INCREF(socket_gaierror);
6110 PyModule_AddObject(m, "gaierror", socket_gaierror);
6111 socket_timeout = PyErr_NewException("socket.timeout",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02006112 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006113 if (socket_timeout == NULL)
6114 return NULL;
Antoine Pitrouc4df7842010-12-03 19:59:41 +00006115 PySocketModuleAPI.timeout_error = socket_timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006116 Py_INCREF(socket_timeout);
6117 PyModule_AddObject(m, "timeout", socket_timeout);
6118 Py_INCREF((PyObject *)&sock_type);
6119 if (PyModule_AddObject(m, "SocketType",
6120 (PyObject *)&sock_type) != 0)
6121 return NULL;
6122 Py_INCREF((PyObject *)&sock_type);
6123 if (PyModule_AddObject(m, "socket",
6124 (PyObject *)&sock_type) != 0)
6125 return NULL;
Guido van Rossum09be4091999-08-09 14:40:40 +00006126
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00006127#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006128 has_ipv6 = Py_True;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00006129#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006130 has_ipv6 = Py_False;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00006131#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006132 Py_INCREF(has_ipv6);
6133 PyModule_AddObject(m, "has_ipv6", has_ipv6);
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00006134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006135 /* Export C API */
6136 if (PyModule_AddObject(m, PySocket_CAPI_NAME,
6137 PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
6138 ) != 0)
6139 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006141 /* Address families (we only support AF_INET and AF_UNIX) */
Guido van Rossum09be4091999-08-09 14:40:40 +00006142#ifdef AF_UNSPEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006143 PyModule_AddIntMacro(m, AF_UNSPEC);
Guido van Rossum09be4091999-08-09 14:40:40 +00006144#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006145 PyModule_AddIntMacro(m, AF_INET);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006146#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006147 PyModule_AddIntMacro(m, AF_INET6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006148#endif /* AF_INET6 */
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00006149#if defined(AF_UNIX)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006150 PyModule_AddIntMacro(m, AF_UNIX);
Guido van Rossumb6775db1994-08-01 11:34:53 +00006151#endif /* AF_UNIX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006152#ifdef AF_AX25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006153 /* Amateur Radio AX.25 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006154 PyModule_AddIntMacro(m, AF_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006155#endif
6156#ifdef AF_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006157 PyModule_AddIntMacro(m, AF_IPX); /* Novell IPX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006158#endif
6159#ifdef AF_APPLETALK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006160 /* Appletalk DDP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006161 PyModule_AddIntMacro(m, AF_APPLETALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006162#endif
6163#ifdef AF_NETROM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006164 /* Amateur radio NetROM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006165 PyModule_AddIntMacro(m, AF_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006166#endif
6167#ifdef AF_BRIDGE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006168 /* Multiprotocol bridge */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006169 PyModule_AddIntMacro(m, AF_BRIDGE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006170#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006171#ifdef AF_ATMPVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006172 /* ATM PVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006173 PyModule_AddIntMacro(m, AF_ATMPVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006174#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006175#ifdef AF_AAL5
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006176 /* Reserved for Werner's ATM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006177 PyModule_AddIntMacro(m, AF_AAL5);
Guido van Rossum09be4091999-08-09 14:40:40 +00006178#endif
6179#ifdef AF_X25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006180 /* Reserved for X.25 project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006181 PyModule_AddIntMacro(m, AF_X25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006182#endif
6183#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006184 PyModule_AddIntMacro(m, AF_INET6); /* IP version 6 */
Guido van Rossum09be4091999-08-09 14:40:40 +00006185#endif
6186#ifdef AF_ROSE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006187 /* Amateur Radio X.25 PLP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006188 PyModule_AddIntMacro(m, AF_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006189#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006190#ifdef AF_DECnet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006191 /* Reserved for DECnet project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006192 PyModule_AddIntMacro(m, AF_DECnet);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006193#endif
6194#ifdef AF_NETBEUI
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006195 /* Reserved for 802.2LLC project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006196 PyModule_AddIntMacro(m, AF_NETBEUI);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006197#endif
6198#ifdef AF_SECURITY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006199 /* Security callback pseudo AF */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006200 PyModule_AddIntMacro(m, AF_SECURITY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006201#endif
6202#ifdef AF_KEY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006203 /* PF_KEY key management API */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006204 PyModule_AddIntMacro(m, AF_KEY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006205#endif
6206#ifdef AF_NETLINK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006207 /* */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006208 PyModule_AddIntMacro(m, AF_NETLINK);
6209 PyModule_AddIntMacro(m, NETLINK_ROUTE);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006210#ifdef NETLINK_SKIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006211 PyModule_AddIntMacro(m, NETLINK_SKIP);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006212#endif
6213#ifdef NETLINK_W1
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006214 PyModule_AddIntMacro(m, NETLINK_W1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006215#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006216 PyModule_AddIntMacro(m, NETLINK_USERSOCK);
6217 PyModule_AddIntMacro(m, NETLINK_FIREWALL);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006218#ifdef NETLINK_TCPDIAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006219 PyModule_AddIntMacro(m, NETLINK_TCPDIAG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006220#endif
6221#ifdef NETLINK_NFLOG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006222 PyModule_AddIntMacro(m, NETLINK_NFLOG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006223#endif
Neal Norwitz65851662006-01-16 04:31:40 +00006224#ifdef NETLINK_XFRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006225 PyModule_AddIntMacro(m, NETLINK_XFRM);
Neal Norwitz65851662006-01-16 04:31:40 +00006226#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006227#ifdef NETLINK_ARPD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006228 PyModule_AddIntMacro(m, NETLINK_ARPD);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006229#endif
6230#ifdef NETLINK_ROUTE6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006231 PyModule_AddIntMacro(m, NETLINK_ROUTE6);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006232#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006233 PyModule_AddIntMacro(m, NETLINK_IP6_FW);
Thomas Wouterscf297e42007-02-23 15:07:44 +00006234#ifdef NETLINK_DNRTMSG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006235 PyModule_AddIntMacro(m, NETLINK_DNRTMSG);
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00006236#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006237#ifdef NETLINK_TAPBASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006238 PyModule_AddIntMacro(m, NETLINK_TAPBASE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006239#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006240#endif /* AF_NETLINK */
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006241#ifdef AF_ROUTE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006242 /* Alias to emulate 4.4BSD */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006243 PyModule_AddIntMacro(m, AF_ROUTE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006244#endif
Giampaolo Rodola'80e1c432013-05-21 21:02:04 +02006245#ifdef AF_LINK
6246 PyModule_AddIntMacro(m, AF_LINK);
6247#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006248#ifdef AF_ASH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006249 /* Ash */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006250 PyModule_AddIntMacro(m, AF_ASH);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006251#endif
6252#ifdef AF_ECONET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006253 /* Acorn Econet */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006254 PyModule_AddIntMacro(m, AF_ECONET);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006255#endif
6256#ifdef AF_ATMSVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006257 /* ATM SVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006258 PyModule_AddIntMacro(m, AF_ATMSVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006259#endif
6260#ifdef AF_SNA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006261 /* Linux SNA Project (nutters!) */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006262 PyModule_AddIntMacro(m, AF_SNA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006263#endif
6264#ifdef AF_IRDA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006265 /* IRDA sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006266 PyModule_AddIntMacro(m, AF_IRDA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006267#endif
6268#ifdef AF_PPPOX
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006269 /* PPPoX sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006270 PyModule_AddIntMacro(m, AF_PPPOX);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006271#endif
6272#ifdef AF_WANPIPE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006273 /* Wanpipe API Sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006274 PyModule_AddIntMacro(m, AF_WANPIPE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006275#endif
6276#ifdef AF_LLC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006277 /* Linux LLC */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006278 PyModule_AddIntMacro(m, AF_LLC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006279#endif
Martin v. Löwis12af0482004-01-31 12:34:17 +00006280
Hye-Shik Chang81268602004-02-02 06:05:24 +00006281#ifdef USE_BLUETOOTH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006282 PyModule_AddIntMacro(m, AF_BLUETOOTH);
6283 PyModule_AddIntMacro(m, BTPROTO_L2CAP);
6284 PyModule_AddIntMacro(m, BTPROTO_HCI);
6285 PyModule_AddIntMacro(m, SOL_HCI);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006286#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006287 PyModule_AddIntMacro(m, HCI_FILTER);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006288#endif
Hye-Shik Chang81268602004-02-02 06:05:24 +00006289#if !defined(__FreeBSD__)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006290#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006291 PyModule_AddIntMacro(m, HCI_TIME_STAMP);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006292#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006293 PyModule_AddIntMacro(m, HCI_DATA_DIR);
6294 PyModule_AddIntMacro(m, BTPROTO_SCO);
Hye-Shik Chang81268602004-02-02 06:05:24 +00006295#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006296 PyModule_AddIntMacro(m, BTPROTO_RFCOMM);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006297 PyModule_AddStringConstant(m, "BDADDR_ANY", "00:00:00:00:00:00");
6298 PyModule_AddStringConstant(m, "BDADDR_LOCAL", "00:00:00:FF:FF:FF");
Martin v. Löwis12af0482004-01-31 12:34:17 +00006299#endif
6300
Charles-François Natali47413c12011-10-06 19:47:44 +02006301#ifdef AF_CAN
6302 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006303 PyModule_AddIntMacro(m, AF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006304#endif
6305#ifdef PF_CAN
6306 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006307 PyModule_AddIntMacro(m, PF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006308#endif
6309
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006310/* Reliable Datagram Sockets */
6311#ifdef AF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006312 PyModule_AddIntMacro(m, AF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006313#endif
6314#ifdef PF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006315 PyModule_AddIntMacro(m, PF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006316#endif
6317
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006318/* Kernel event messages */
6319#ifdef PF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006320 PyModule_AddIntMacro(m, PF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006321#endif
6322#ifdef AF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006323 PyModule_AddIntMacro(m, AF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006324#endif
6325
Antoine Pitroub156a462010-10-27 20:13:57 +00006326#ifdef AF_PACKET
6327 PyModule_AddIntMacro(m, AF_PACKET);
6328#endif
6329#ifdef PF_PACKET
6330 PyModule_AddIntMacro(m, PF_PACKET);
6331#endif
6332#ifdef PACKET_HOST
6333 PyModule_AddIntMacro(m, PACKET_HOST);
6334#endif
6335#ifdef PACKET_BROADCAST
6336 PyModule_AddIntMacro(m, PACKET_BROADCAST);
6337#endif
6338#ifdef PACKET_MULTICAST
6339 PyModule_AddIntMacro(m, PACKET_MULTICAST);
6340#endif
6341#ifdef PACKET_OTHERHOST
6342 PyModule_AddIntMacro(m, PACKET_OTHERHOST);
6343#endif
6344#ifdef PACKET_OUTGOING
6345 PyModule_AddIntMacro(m, PACKET_OUTGOING);
6346#endif
6347#ifdef PACKET_LOOPBACK
6348 PyModule_AddIntMacro(m, PACKET_LOOPBACK);
6349#endif
6350#ifdef PACKET_FASTROUTE
6351 PyModule_AddIntMacro(m, PACKET_FASTROUTE);
Guido van Rossum48a680c2001-03-02 06:34:14 +00006352#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006353
Christian Heimes043d6f62008-01-07 17:19:16 +00006354#ifdef HAVE_LINUX_TIPC_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006355 PyModule_AddIntMacro(m, AF_TIPC);
Christian Heimes043d6f62008-01-07 17:19:16 +00006356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006357 /* for addresses */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006358 PyModule_AddIntMacro(m, TIPC_ADDR_NAMESEQ);
6359 PyModule_AddIntMacro(m, TIPC_ADDR_NAME);
6360 PyModule_AddIntMacro(m, TIPC_ADDR_ID);
Christian Heimes043d6f62008-01-07 17:19:16 +00006361
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006362 PyModule_AddIntMacro(m, TIPC_ZONE_SCOPE);
6363 PyModule_AddIntMacro(m, TIPC_CLUSTER_SCOPE);
6364 PyModule_AddIntMacro(m, TIPC_NODE_SCOPE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006366 /* for setsockopt() */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006367 PyModule_AddIntMacro(m, SOL_TIPC);
6368 PyModule_AddIntMacro(m, TIPC_IMPORTANCE);
6369 PyModule_AddIntMacro(m, TIPC_SRC_DROPPABLE);
6370 PyModule_AddIntMacro(m, TIPC_DEST_DROPPABLE);
6371 PyModule_AddIntMacro(m, TIPC_CONN_TIMEOUT);
Christian Heimes043d6f62008-01-07 17:19:16 +00006372
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006373 PyModule_AddIntMacro(m, TIPC_LOW_IMPORTANCE);
6374 PyModule_AddIntMacro(m, TIPC_MEDIUM_IMPORTANCE);
6375 PyModule_AddIntMacro(m, TIPC_HIGH_IMPORTANCE);
6376 PyModule_AddIntMacro(m, TIPC_CRITICAL_IMPORTANCE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006378 /* for subscriptions */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006379 PyModule_AddIntMacro(m, TIPC_SUB_PORTS);
6380 PyModule_AddIntMacro(m, TIPC_SUB_SERVICE);
Christian Heimes25bb7832008-01-11 16:17:00 +00006381#ifdef TIPC_SUB_CANCEL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006382 /* doesn't seem to be available everywhere */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006383 PyModule_AddIntMacro(m, TIPC_SUB_CANCEL);
Christian Heimes25bb7832008-01-11 16:17:00 +00006384#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006385 PyModule_AddIntMacro(m, TIPC_WAIT_FOREVER);
6386 PyModule_AddIntMacro(m, TIPC_PUBLISHED);
6387 PyModule_AddIntMacro(m, TIPC_WITHDRAWN);
6388 PyModule_AddIntMacro(m, TIPC_SUBSCR_TIMEOUT);
6389 PyModule_AddIntMacro(m, TIPC_CFG_SRV);
6390 PyModule_AddIntMacro(m, TIPC_TOP_SRV);
Christian Heimes043d6f62008-01-07 17:19:16 +00006391#endif
6392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006393 /* Socket types */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006394 PyModule_AddIntMacro(m, SOCK_STREAM);
6395 PyModule_AddIntMacro(m, SOCK_DGRAM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006396/* We have incomplete socket support. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006397 PyModule_AddIntMacro(m, SOCK_RAW);
6398 PyModule_AddIntMacro(m, SOCK_SEQPACKET);
Martin v. Löwiscf8f47e2002-12-11 13:10:57 +00006399#if defined(SOCK_RDM)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006400 PyModule_AddIntMacro(m, SOCK_RDM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006401#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00006402#ifdef SOCK_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006403 PyModule_AddIntMacro(m, SOCK_CLOEXEC);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006404#endif
6405#ifdef SOCK_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006406 PyModule_AddIntMacro(m, SOCK_NONBLOCK);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006407#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006409#ifdef SO_DEBUG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006410 PyModule_AddIntMacro(m, SO_DEBUG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006411#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006412#ifdef SO_ACCEPTCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006413 PyModule_AddIntMacro(m, SO_ACCEPTCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006414#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006415#ifdef SO_REUSEADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006416 PyModule_AddIntMacro(m, SO_REUSEADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006417#endif
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006418#ifdef SO_EXCLUSIVEADDRUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006419 PyModule_AddIntMacro(m, SO_EXCLUSIVEADDRUSE);
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006420#endif
6421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006422#ifdef SO_KEEPALIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006423 PyModule_AddIntMacro(m, SO_KEEPALIVE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006424#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006425#ifdef SO_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006426 PyModule_AddIntMacro(m, SO_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006427#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006428#ifdef SO_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006429 PyModule_AddIntMacro(m, SO_BROADCAST);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006430#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006431#ifdef SO_USELOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006432 PyModule_AddIntMacro(m, SO_USELOOPBACK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006433#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006434#ifdef SO_LINGER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006435 PyModule_AddIntMacro(m, SO_LINGER);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006436#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006437#ifdef SO_OOBINLINE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006438 PyModule_AddIntMacro(m, SO_OOBINLINE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006439#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006440#ifdef SO_REUSEPORT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006441 PyModule_AddIntMacro(m, SO_REUSEPORT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006442#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006443#ifdef SO_SNDBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006444 PyModule_AddIntMacro(m, SO_SNDBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006445#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006446#ifdef SO_RCVBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006447 PyModule_AddIntMacro(m, SO_RCVBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006448#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006449#ifdef SO_SNDLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006450 PyModule_AddIntMacro(m, SO_SNDLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006451#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006452#ifdef SO_RCVLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006453 PyModule_AddIntMacro(m, SO_RCVLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006454#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006455#ifdef SO_SNDTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006456 PyModule_AddIntMacro(m, SO_SNDTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006457#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006458#ifdef SO_RCVTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006459 PyModule_AddIntMacro(m, SO_RCVTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006460#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006461#ifdef SO_ERROR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006462 PyModule_AddIntMacro(m, SO_ERROR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006463#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006464#ifdef SO_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006465 PyModule_AddIntMacro(m, SO_TYPE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006466#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006467#ifdef SO_SETFIB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006468 PyModule_AddIntMacro(m, SO_SETFIB);
Larry Hastingsf0f37952010-04-02 11:47:10 +00006469#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006470#ifdef SO_PASSCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006471 PyModule_AddIntMacro(m, SO_PASSCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006472#endif
6473#ifdef SO_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006474 PyModule_AddIntMacro(m, SO_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006475#endif
6476#ifdef LOCAL_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006477 PyModule_AddIntMacro(m, LOCAL_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006478#endif
Victor Stinnercb98bed2011-10-25 13:45:48 +02006479#ifdef SO_BINDTODEVICE
6480 PyModule_AddIntMacro(m, SO_BINDTODEVICE);
6481#endif
Benjamin Peterson1314ef72013-11-27 09:18:54 -06006482#ifdef SO_PRIORITY
6483 PyModule_AddIntMacro(m, SO_PRIORITY);
6484#endif
Charles-François Nataliea07eb92014-09-18 23:18:46 +01006485#ifdef SO_MARK
6486 PyModule_AddIntMacro(m, SO_MARK);
6487#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006489 /* Maximum number of connections for "listen" */
6490#ifdef SOMAXCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006491 PyModule_AddIntMacro(m, SOMAXCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006492#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006493 PyModule_AddIntConstant(m, "SOMAXCONN", 5); /* Common value */
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006494#endif
6495
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006496 /* Ancilliary message types */
6497#ifdef SCM_RIGHTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006498 PyModule_AddIntMacro(m, SCM_RIGHTS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006499#endif
6500#ifdef SCM_CREDENTIALS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006501 PyModule_AddIntMacro(m, SCM_CREDENTIALS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006502#endif
6503#ifdef SCM_CREDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006504 PyModule_AddIntMacro(m, SCM_CREDS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006505#endif
6506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006507 /* Flags for send, recv */
6508#ifdef MSG_OOB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006509 PyModule_AddIntMacro(m, MSG_OOB);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006510#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006511#ifdef MSG_PEEK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006512 PyModule_AddIntMacro(m, MSG_PEEK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006513#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006514#ifdef MSG_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006515 PyModule_AddIntMacro(m, MSG_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006516#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006517#ifdef MSG_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006518 PyModule_AddIntMacro(m, MSG_DONTWAIT);
Guido van Rossum2c8bcb82000-04-25 21:34:53 +00006519#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006520#ifdef MSG_EOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006521 PyModule_AddIntMacro(m, MSG_EOR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006522#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006523#ifdef MSG_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006524 PyModule_AddIntMacro(m, MSG_TRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006525#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006526#ifdef MSG_CTRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006527 PyModule_AddIntMacro(m, MSG_CTRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006528#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006529#ifdef MSG_WAITALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006530 PyModule_AddIntMacro(m, MSG_WAITALL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006531#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006532#ifdef MSG_BTAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006533 PyModule_AddIntMacro(m, MSG_BTAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006534#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006535#ifdef MSG_ETAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006536 PyModule_AddIntMacro(m, MSG_ETAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006537#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006538#ifdef MSG_NOSIGNAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006539 PyModule_AddIntMacro(m, MSG_NOSIGNAL);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006540#endif
6541#ifdef MSG_NOTIFICATION
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006542 PyModule_AddIntMacro(m, MSG_NOTIFICATION);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006543#endif
6544#ifdef MSG_CMSG_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006545 PyModule_AddIntMacro(m, MSG_CMSG_CLOEXEC);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006546#endif
6547#ifdef MSG_ERRQUEUE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006548 PyModule_AddIntMacro(m, MSG_ERRQUEUE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006549#endif
6550#ifdef MSG_CONFIRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006551 PyModule_AddIntMacro(m, MSG_CONFIRM);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006552#endif
6553#ifdef MSG_MORE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006554 PyModule_AddIntMacro(m, MSG_MORE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006555#endif
6556#ifdef MSG_EOF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006557 PyModule_AddIntMacro(m, MSG_EOF);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006558#endif
6559#ifdef MSG_BCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006560 PyModule_AddIntMacro(m, MSG_BCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006561#endif
6562#ifdef MSG_MCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006563 PyModule_AddIntMacro(m, MSG_MCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006564#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006565#ifdef MSG_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006566 PyModule_AddIntMacro(m, MSG_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006567#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006569 /* Protocol level and numbers, usable for [gs]etsockopt */
6570#ifdef SOL_SOCKET
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006571 PyModule_AddIntMacro(m, SOL_SOCKET);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006572#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006573#ifdef SOL_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006574 PyModule_AddIntMacro(m, SOL_IP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006575#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006576 PyModule_AddIntConstant(m, "SOL_IP", 0);
Guido van Rossum09be4091999-08-09 14:40:40 +00006577#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006578#ifdef SOL_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006579 PyModule_AddIntMacro(m, SOL_IPX);
Guido van Rossum09be4091999-08-09 14:40:40 +00006580#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006581#ifdef SOL_AX25
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006582 PyModule_AddIntMacro(m, SOL_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006583#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006584#ifdef SOL_ATALK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006585 PyModule_AddIntMacro(m, SOL_ATALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006586#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006587#ifdef SOL_NETROM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006588 PyModule_AddIntMacro(m, SOL_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006589#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006590#ifdef SOL_ROSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006591 PyModule_AddIntMacro(m, SOL_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006592#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006593#ifdef SOL_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006594 PyModule_AddIntMacro(m, SOL_TCP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006595#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006596 PyModule_AddIntConstant(m, "SOL_TCP", 6);
Guido van Rossum09be4091999-08-09 14:40:40 +00006597#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006598#ifdef SOL_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006599 PyModule_AddIntMacro(m, SOL_UDP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006600#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006601 PyModule_AddIntConstant(m, "SOL_UDP", 17);
Guido van Rossum09be4091999-08-09 14:40:40 +00006602#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02006603#ifdef SOL_CAN_BASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006604 PyModule_AddIntMacro(m, SOL_CAN_BASE);
Charles-François Natali47413c12011-10-06 19:47:44 +02006605#endif
6606#ifdef SOL_CAN_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006607 PyModule_AddIntMacro(m, SOL_CAN_RAW);
6608 PyModule_AddIntMacro(m, CAN_RAW);
Charles-François Natali47413c12011-10-06 19:47:44 +02006609#endif
6610#ifdef HAVE_LINUX_CAN_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006611 PyModule_AddIntMacro(m, CAN_EFF_FLAG);
6612 PyModule_AddIntMacro(m, CAN_RTR_FLAG);
6613 PyModule_AddIntMacro(m, CAN_ERR_FLAG);
Charles-François Natali47413c12011-10-06 19:47:44 +02006614
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006615 PyModule_AddIntMacro(m, CAN_SFF_MASK);
6616 PyModule_AddIntMacro(m, CAN_EFF_MASK);
6617 PyModule_AddIntMacro(m, CAN_ERR_MASK);
Charles-François Natali47413c12011-10-06 19:47:44 +02006618#endif
6619#ifdef HAVE_LINUX_CAN_RAW_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006620 PyModule_AddIntMacro(m, CAN_RAW_FILTER);
6621 PyModule_AddIntMacro(m, CAN_RAW_ERR_FILTER);
6622 PyModule_AddIntMacro(m, CAN_RAW_LOOPBACK);
6623 PyModule_AddIntMacro(m, CAN_RAW_RECV_OWN_MSGS);
Charles-François Natali47413c12011-10-06 19:47:44 +02006624#endif
Larry Hastingsa6cc5512015-04-13 17:48:40 -04006625#ifdef HAVE_LINUX_CAN_RAW_FD_FRAMES
6626 PyModule_AddIntMacro(m, CAN_RAW_FD_FRAMES);
6627#endif
Charles-François Natali773e42d2013-02-05 19:42:01 +01006628#ifdef HAVE_LINUX_CAN_BCM_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006629 PyModule_AddIntMacro(m, CAN_BCM);
Charles-François Natali773e42d2013-02-05 19:42:01 +01006630 PyModule_AddIntConstant(m, "CAN_BCM_TX_SETUP", TX_SETUP);
6631 PyModule_AddIntConstant(m, "CAN_BCM_TX_DELETE", TX_DELETE);
6632 PyModule_AddIntConstant(m, "CAN_BCM_TX_READ", TX_READ);
6633 PyModule_AddIntConstant(m, "CAN_BCM_TX_SEND", TX_SEND);
6634 PyModule_AddIntConstant(m, "CAN_BCM_RX_SETUP", RX_SETUP);
6635 PyModule_AddIntConstant(m, "CAN_BCM_RX_DELETE", RX_DELETE);
6636 PyModule_AddIntConstant(m, "CAN_BCM_RX_READ", RX_READ);
6637 PyModule_AddIntConstant(m, "CAN_BCM_TX_STATUS", TX_STATUS);
6638 PyModule_AddIntConstant(m, "CAN_BCM_TX_EXPIRED", TX_EXPIRED);
6639 PyModule_AddIntConstant(m, "CAN_BCM_RX_STATUS", RX_STATUS);
6640 PyModule_AddIntConstant(m, "CAN_BCM_RX_TIMEOUT", RX_TIMEOUT);
6641 PyModule_AddIntConstant(m, "CAN_BCM_RX_CHANGED", RX_CHANGED);
6642#endif
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006643#ifdef SOL_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006644 PyModule_AddIntMacro(m, SOL_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006645#endif
6646#ifdef RDS_CANCEL_SENT_TO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006647 PyModule_AddIntMacro(m, RDS_CANCEL_SENT_TO);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006648#endif
6649#ifdef RDS_GET_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006650 PyModule_AddIntMacro(m, RDS_GET_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006651#endif
6652#ifdef RDS_FREE_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006653 PyModule_AddIntMacro(m, RDS_FREE_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006654#endif
6655#ifdef RDS_RECVERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006656 PyModule_AddIntMacro(m, RDS_RECVERR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006657#endif
6658#ifdef RDS_CONG_MONITOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006659 PyModule_AddIntMacro(m, RDS_CONG_MONITOR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006660#endif
6661#ifdef RDS_GET_MR_FOR_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006662 PyModule_AddIntMacro(m, RDS_GET_MR_FOR_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006663#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006664#ifdef IPPROTO_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006665 PyModule_AddIntMacro(m, IPPROTO_IP);
Guido van Rossum578de301998-05-28 20:18:18 +00006666#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006667 PyModule_AddIntConstant(m, "IPPROTO_IP", 0);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006668#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006669#ifdef IPPROTO_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006670 PyModule_AddIntMacro(m, IPPROTO_HOPOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006671#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006672#ifdef IPPROTO_ICMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006673 PyModule_AddIntMacro(m, IPPROTO_ICMP);
Guido van Rossum578de301998-05-28 20:18:18 +00006674#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006675 PyModule_AddIntConstant(m, "IPPROTO_ICMP", 1);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006676#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006677#ifdef IPPROTO_IGMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006678 PyModule_AddIntMacro(m, IPPROTO_IGMP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006679#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006680#ifdef IPPROTO_GGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006681 PyModule_AddIntMacro(m, IPPROTO_GGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006682#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006683#ifdef IPPROTO_IPV4
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006684 PyModule_AddIntMacro(m, IPPROTO_IPV4);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006685#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006686#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006687 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisa0f17342003-10-03 13:56:20 +00006688#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006689#ifdef IPPROTO_IPIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006690 PyModule_AddIntMacro(m, IPPROTO_IPIP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006691#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006692#ifdef IPPROTO_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006693 PyModule_AddIntMacro(m, IPPROTO_TCP);
Guido van Rossum578de301998-05-28 20:18:18 +00006694#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006695 PyModule_AddIntConstant(m, "IPPROTO_TCP", 6);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006696#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006697#ifdef IPPROTO_EGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006698 PyModule_AddIntMacro(m, IPPROTO_EGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006699#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006700#ifdef IPPROTO_PUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006701 PyModule_AddIntMacro(m, IPPROTO_PUP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006702#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006703#ifdef IPPROTO_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006704 PyModule_AddIntMacro(m, IPPROTO_UDP);
Guido van Rossum578de301998-05-28 20:18:18 +00006705#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006706 PyModule_AddIntConstant(m, "IPPROTO_UDP", 17);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006707#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006708#ifdef IPPROTO_IDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006709 PyModule_AddIntMacro(m, IPPROTO_IDP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006710#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006711#ifdef IPPROTO_HELLO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006712 PyModule_AddIntMacro(m, IPPROTO_HELLO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006713#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006714#ifdef IPPROTO_ND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006715 PyModule_AddIntMacro(m, IPPROTO_ND);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006716#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006717#ifdef IPPROTO_TP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006718 PyModule_AddIntMacro(m, IPPROTO_TP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006719#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006720#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006721 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006722#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006723#ifdef IPPROTO_ROUTING
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006724 PyModule_AddIntMacro(m, IPPROTO_ROUTING);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006725#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006726#ifdef IPPROTO_FRAGMENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006727 PyModule_AddIntMacro(m, IPPROTO_FRAGMENT);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006728#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006729#ifdef IPPROTO_RSVP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006730 PyModule_AddIntMacro(m, IPPROTO_RSVP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006731#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006732#ifdef IPPROTO_GRE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006733 PyModule_AddIntMacro(m, IPPROTO_GRE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006734#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006735#ifdef IPPROTO_ESP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006736 PyModule_AddIntMacro(m, IPPROTO_ESP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006737#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006738#ifdef IPPROTO_AH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006739 PyModule_AddIntMacro(m, IPPROTO_AH);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006740#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006741#ifdef IPPROTO_MOBILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006742 PyModule_AddIntMacro(m, IPPROTO_MOBILE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006743#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006744#ifdef IPPROTO_ICMPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006745 PyModule_AddIntMacro(m, IPPROTO_ICMPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006746#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006747#ifdef IPPROTO_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006748 PyModule_AddIntMacro(m, IPPROTO_NONE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006749#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006750#ifdef IPPROTO_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006751 PyModule_AddIntMacro(m, IPPROTO_DSTOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006752#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006753#ifdef IPPROTO_XTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006754 PyModule_AddIntMacro(m, IPPROTO_XTP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006755#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006756#ifdef IPPROTO_EON
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006757 PyModule_AddIntMacro(m, IPPROTO_EON);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006758#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006759#ifdef IPPROTO_PIM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006760 PyModule_AddIntMacro(m, IPPROTO_PIM);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006761#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006762#ifdef IPPROTO_IPCOMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006763 PyModule_AddIntMacro(m, IPPROTO_IPCOMP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006764#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006765#ifdef IPPROTO_VRRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006766 PyModule_AddIntMacro(m, IPPROTO_VRRP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006767#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006768#ifdef IPPROTO_SCTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006769 PyModule_AddIntMacro(m, IPPROTO_SCTP);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006770#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006771#ifdef IPPROTO_BIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006772 PyModule_AddIntMacro(m, IPPROTO_BIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006773#endif
6774/**/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006775#ifdef IPPROTO_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006776 PyModule_AddIntMacro(m, IPPROTO_RAW);
Guido van Rossum578de301998-05-28 20:18:18 +00006777#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006778 PyModule_AddIntConstant(m, "IPPROTO_RAW", 255);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006779#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006780#ifdef IPPROTO_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006781 PyModule_AddIntMacro(m, IPPROTO_MAX);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006782#endif
6783
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006784#ifdef SYSPROTO_CONTROL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006785 PyModule_AddIntMacro(m, SYSPROTO_CONTROL);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006786#endif
6787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006788 /* Some port configuration */
6789#ifdef IPPORT_RESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006790 PyModule_AddIntMacro(m, IPPORT_RESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006791#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006792 PyModule_AddIntConstant(m, "IPPORT_RESERVED", 1024);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006793#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006794#ifdef IPPORT_USERRESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006795 PyModule_AddIntMacro(m, IPPORT_USERRESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006796#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006797 PyModule_AddIntConstant(m, "IPPORT_USERRESERVED", 5000);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006798#endif
6799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006800 /* Some reserved IP v.4 addresses */
6801#ifdef INADDR_ANY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006802 PyModule_AddIntMacro(m, INADDR_ANY);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006803#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006804 PyModule_AddIntConstant(m, "INADDR_ANY", 0x00000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006805#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006806#ifdef INADDR_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006807 PyModule_AddIntMacro(m, INADDR_BROADCAST);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006808#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006809 PyModule_AddIntConstant(m, "INADDR_BROADCAST", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006810#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006811#ifdef INADDR_LOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006812 PyModule_AddIntMacro(m, INADDR_LOOPBACK);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006813#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006814 PyModule_AddIntConstant(m, "INADDR_LOOPBACK", 0x7F000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006815#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006816#ifdef INADDR_UNSPEC_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006817 PyModule_AddIntMacro(m, INADDR_UNSPEC_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006818#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006819 PyModule_AddIntConstant(m, "INADDR_UNSPEC_GROUP", 0xe0000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006820#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006821#ifdef INADDR_ALLHOSTS_GROUP
6822 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP",
6823 INADDR_ALLHOSTS_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006824#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006825 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP", 0xe0000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006826#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006827#ifdef INADDR_MAX_LOCAL_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006828 PyModule_AddIntMacro(m, INADDR_MAX_LOCAL_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006829#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006830 PyModule_AddIntConstant(m, "INADDR_MAX_LOCAL_GROUP", 0xe00000ff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006831#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006832#ifdef INADDR_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006833 PyModule_AddIntMacro(m, INADDR_NONE);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006834#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006835 PyModule_AddIntConstant(m, "INADDR_NONE", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006836#endif
6837
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006838 /* IPv4 [gs]etsockopt options */
6839#ifdef IP_OPTIONS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006840 PyModule_AddIntMacro(m, IP_OPTIONS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006841#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006842#ifdef IP_HDRINCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006843 PyModule_AddIntMacro(m, IP_HDRINCL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006844#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006845#ifdef IP_TOS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006846 PyModule_AddIntMacro(m, IP_TOS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006847#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006848#ifdef IP_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006849 PyModule_AddIntMacro(m, IP_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006850#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006851#ifdef IP_RECVOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006852 PyModule_AddIntMacro(m, IP_RECVOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006853#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006854#ifdef IP_RECVRETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006855 PyModule_AddIntMacro(m, IP_RECVRETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006856#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006857#ifdef IP_RECVDSTADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006858 PyModule_AddIntMacro(m, IP_RECVDSTADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006859#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006860#ifdef IP_RETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006861 PyModule_AddIntMacro(m, IP_RETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006862#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006863#ifdef IP_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006864 PyModule_AddIntMacro(m, IP_MULTICAST_IF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006865#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006866#ifdef IP_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006867 PyModule_AddIntMacro(m, IP_MULTICAST_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006868#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006869#ifdef IP_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006870 PyModule_AddIntMacro(m, IP_MULTICAST_LOOP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006871#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006872#ifdef IP_ADD_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006873 PyModule_AddIntMacro(m, IP_ADD_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006874#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006875#ifdef IP_DROP_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006876 PyModule_AddIntMacro(m, IP_DROP_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006877#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006878#ifdef IP_DEFAULT_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006879 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_TTL);
Guido van Rossum09be4091999-08-09 14:40:40 +00006880#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006881#ifdef IP_DEFAULT_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006882 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_LOOP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006883#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006884#ifdef IP_MAX_MEMBERSHIPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006885 PyModule_AddIntMacro(m, IP_MAX_MEMBERSHIPS);
Guido van Rossum09be4091999-08-09 14:40:40 +00006886#endif
Charles-François Natali564a42c2011-12-17 14:59:56 +01006887#ifdef IP_TRANSPARENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006888 PyModule_AddIntMacro(m, IP_TRANSPARENT);
Charles-François Natali564a42c2011-12-17 14:59:56 +01006889#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006891 /* IPv6 [gs]etsockopt options, defined in RFC2553 */
6892#ifdef IPV6_JOIN_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006893 PyModule_AddIntMacro(m, IPV6_JOIN_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006894#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006895#ifdef IPV6_LEAVE_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006896 PyModule_AddIntMacro(m, IPV6_LEAVE_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006897#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006898#ifdef IPV6_MULTICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006899 PyModule_AddIntMacro(m, IPV6_MULTICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006900#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006901#ifdef IPV6_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006902 PyModule_AddIntMacro(m, IPV6_MULTICAST_IF);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006903#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006904#ifdef IPV6_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006905 PyModule_AddIntMacro(m, IPV6_MULTICAST_LOOP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006906#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006907#ifdef IPV6_UNICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006908 PyModule_AddIntMacro(m, IPV6_UNICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006909#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006910 /* Additional IPV6 socket options, defined in RFC 3493 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006911#ifdef IPV6_V6ONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006912 PyModule_AddIntMacro(m, IPV6_V6ONLY);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006913#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006914 /* Advanced IPV6 socket options, from RFC 3542 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006915#ifdef IPV6_CHECKSUM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006916 PyModule_AddIntMacro(m, IPV6_CHECKSUM);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006917#endif
6918#ifdef IPV6_DONTFRAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006919 PyModule_AddIntMacro(m, IPV6_DONTFRAG);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006920#endif
6921#ifdef IPV6_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006922 PyModule_AddIntMacro(m, IPV6_DSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006923#endif
6924#ifdef IPV6_HOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006925 PyModule_AddIntMacro(m, IPV6_HOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006926#endif
6927#ifdef IPV6_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006928 PyModule_AddIntMacro(m, IPV6_HOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006929#endif
6930#ifdef IPV6_NEXTHOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006931 PyModule_AddIntMacro(m, IPV6_NEXTHOP);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006932#endif
6933#ifdef IPV6_PATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006934 PyModule_AddIntMacro(m, IPV6_PATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006935#endif
6936#ifdef IPV6_PKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006937 PyModule_AddIntMacro(m, IPV6_PKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006938#endif
6939#ifdef IPV6_RECVDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006940 PyModule_AddIntMacro(m, IPV6_RECVDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006941#endif
6942#ifdef IPV6_RECVHOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006943 PyModule_AddIntMacro(m, IPV6_RECVHOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006944#endif
6945#ifdef IPV6_RECVHOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006946 PyModule_AddIntMacro(m, IPV6_RECVHOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006947#endif
6948#ifdef IPV6_RECVPKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006949 PyModule_AddIntMacro(m, IPV6_RECVPKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006950#endif
6951#ifdef IPV6_RECVRTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006952 PyModule_AddIntMacro(m, IPV6_RECVRTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006953#endif
6954#ifdef IPV6_RECVTCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006955 PyModule_AddIntMacro(m, IPV6_RECVTCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006956#endif
6957#ifdef IPV6_RTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006958 PyModule_AddIntMacro(m, IPV6_RTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006959#endif
6960#ifdef IPV6_RTHDRDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006961 PyModule_AddIntMacro(m, IPV6_RTHDRDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006962#endif
6963#ifdef IPV6_RTHDR_TYPE_0
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006964 PyModule_AddIntMacro(m, IPV6_RTHDR_TYPE_0);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006965#endif
6966#ifdef IPV6_RECVPATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006967 PyModule_AddIntMacro(m, IPV6_RECVPATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006968#endif
6969#ifdef IPV6_TCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006970 PyModule_AddIntMacro(m, IPV6_TCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006971#endif
6972#ifdef IPV6_USE_MIN_MTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006973 PyModule_AddIntMacro(m, IPV6_USE_MIN_MTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006974#endif
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006976 /* TCP options */
6977#ifdef TCP_NODELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006978 PyModule_AddIntMacro(m, TCP_NODELAY);
Guido van Rossum09be4091999-08-09 14:40:40 +00006979#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006980#ifdef TCP_MAXSEG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006981 PyModule_AddIntMacro(m, TCP_MAXSEG);
Guido van Rossum09be4091999-08-09 14:40:40 +00006982#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006983#ifdef TCP_CORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006984 PyModule_AddIntMacro(m, TCP_CORK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006985#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006986#ifdef TCP_KEEPIDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006987 PyModule_AddIntMacro(m, TCP_KEEPIDLE);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006988#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006989#ifdef TCP_KEEPINTVL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006990 PyModule_AddIntMacro(m, TCP_KEEPINTVL);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006991#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006992#ifdef TCP_KEEPCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006993 PyModule_AddIntMacro(m, TCP_KEEPCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006994#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006995#ifdef TCP_SYNCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006996 PyModule_AddIntMacro(m, TCP_SYNCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006997#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006998#ifdef TCP_LINGER2
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006999 PyModule_AddIntMacro(m, TCP_LINGER2);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00007000#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007001#ifdef TCP_DEFER_ACCEPT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007002 PyModule_AddIntMacro(m, TCP_DEFER_ACCEPT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00007003#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007004#ifdef TCP_WINDOW_CLAMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007005 PyModule_AddIntMacro(m, TCP_WINDOW_CLAMP);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00007006#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007007#ifdef TCP_INFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007008 PyModule_AddIntMacro(m, TCP_INFO);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00007009#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007010#ifdef TCP_QUICKACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007011 PyModule_AddIntMacro(m, TCP_QUICKACK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00007012#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05007013#ifdef TCP_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007014 PyModule_AddIntMacro(m, TCP_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05007015#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00007016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007017 /* IPX options */
7018#ifdef IPX_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007019 PyModule_AddIntMacro(m, IPX_TYPE);
Guido van Rossum09be4091999-08-09 14:40:40 +00007020#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00007021
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007022/* Reliable Datagram Sockets */
7023#ifdef RDS_CMSG_RDMA_ARGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007024 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_ARGS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007025#endif
7026#ifdef RDS_CMSG_RDMA_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007027 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007028#endif
7029#ifdef RDS_CMSG_RDMA_MAP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007030 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_MAP);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007031#endif
7032#ifdef RDS_CMSG_RDMA_STATUS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007033 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_STATUS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007034#endif
7035#ifdef RDS_CMSG_RDMA_UPDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007036 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_UPDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007037#endif
7038#ifdef RDS_RDMA_READWRITE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007039 PyModule_AddIntMacro(m, RDS_RDMA_READWRITE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007040#endif
7041#ifdef RDS_RDMA_FENCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007042 PyModule_AddIntMacro(m, RDS_RDMA_FENCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007043#endif
7044#ifdef RDS_RDMA_INVALIDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007045 PyModule_AddIntMacro(m, RDS_RDMA_INVALIDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007046#endif
7047#ifdef RDS_RDMA_USE_ONCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007048 PyModule_AddIntMacro(m, RDS_RDMA_USE_ONCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007049#endif
7050#ifdef RDS_RDMA_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007051 PyModule_AddIntMacro(m, RDS_RDMA_DONTWAIT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007052#endif
7053#ifdef RDS_RDMA_NOTIFY_ME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007054 PyModule_AddIntMacro(m, RDS_RDMA_NOTIFY_ME);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007055#endif
7056#ifdef RDS_RDMA_SILENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007057 PyModule_AddIntMacro(m, RDS_RDMA_SILENT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01007058#endif
7059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007060 /* get{addr,name}info parameters */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007061#ifdef EAI_ADDRFAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007062 PyModule_AddIntMacro(m, EAI_ADDRFAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007063#endif
7064#ifdef EAI_AGAIN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007065 PyModule_AddIntMacro(m, EAI_AGAIN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007066#endif
7067#ifdef EAI_BADFLAGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007068 PyModule_AddIntMacro(m, EAI_BADFLAGS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007069#endif
7070#ifdef EAI_FAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007071 PyModule_AddIntMacro(m, EAI_FAIL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007072#endif
7073#ifdef EAI_FAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007074 PyModule_AddIntMacro(m, EAI_FAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007075#endif
7076#ifdef EAI_MEMORY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007077 PyModule_AddIntMacro(m, EAI_MEMORY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007078#endif
7079#ifdef EAI_NODATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007080 PyModule_AddIntMacro(m, EAI_NODATA);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007081#endif
7082#ifdef EAI_NONAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007083 PyModule_AddIntMacro(m, EAI_NONAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007084#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00007085#ifdef EAI_OVERFLOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007086 PyModule_AddIntMacro(m, EAI_OVERFLOW);
Martin v. Löwisda91d022003-12-30 11:14:01 +00007087#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007088#ifdef EAI_SERVICE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007089 PyModule_AddIntMacro(m, EAI_SERVICE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007090#endif
7091#ifdef EAI_SOCKTYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007092 PyModule_AddIntMacro(m, EAI_SOCKTYPE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007093#endif
7094#ifdef EAI_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007095 PyModule_AddIntMacro(m, EAI_SYSTEM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007096#endif
7097#ifdef EAI_BADHINTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007098 PyModule_AddIntMacro(m, EAI_BADHINTS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007099#endif
7100#ifdef EAI_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007101 PyModule_AddIntMacro(m, EAI_PROTOCOL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007102#endif
7103#ifdef EAI_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007104 PyModule_AddIntMacro(m, EAI_MAX);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007105#endif
7106#ifdef AI_PASSIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007107 PyModule_AddIntMacro(m, AI_PASSIVE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007108#endif
7109#ifdef AI_CANONNAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007110 PyModule_AddIntMacro(m, AI_CANONNAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007111#endif
7112#ifdef AI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007113 PyModule_AddIntMacro(m, AI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007114#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00007115#ifdef AI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007116 PyModule_AddIntMacro(m, AI_NUMERICSERV);
Martin v. Löwisda91d022003-12-30 11:14:01 +00007117#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007118#ifdef AI_MASK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007119 PyModule_AddIntMacro(m, AI_MASK);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007120#endif
7121#ifdef AI_ALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007122 PyModule_AddIntMacro(m, AI_ALL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007123#endif
7124#ifdef AI_V4MAPPED_CFG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007125 PyModule_AddIntMacro(m, AI_V4MAPPED_CFG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007126#endif
7127#ifdef AI_ADDRCONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007128 PyModule_AddIntMacro(m, AI_ADDRCONFIG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007129#endif
7130#ifdef AI_V4MAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007131 PyModule_AddIntMacro(m, AI_V4MAPPED);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007132#endif
7133#ifdef AI_DEFAULT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007134 PyModule_AddIntMacro(m, AI_DEFAULT);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007135#endif
7136#ifdef NI_MAXHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007137 PyModule_AddIntMacro(m, NI_MAXHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007138#endif
7139#ifdef NI_MAXSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007140 PyModule_AddIntMacro(m, NI_MAXSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007141#endif
7142#ifdef NI_NOFQDN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007143 PyModule_AddIntMacro(m, NI_NOFQDN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007144#endif
7145#ifdef NI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007146 PyModule_AddIntMacro(m, NI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007147#endif
7148#ifdef NI_NAMEREQD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007149 PyModule_AddIntMacro(m, NI_NAMEREQD);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007150#endif
7151#ifdef NI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007152 PyModule_AddIntMacro(m, NI_NUMERICSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007153#endif
7154#ifdef NI_DGRAM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007155 PyModule_AddIntMacro(m, NI_DGRAM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007156#endif
7157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007158 /* shutdown() parameters */
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007159#ifdef SHUT_RD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007160 PyModule_AddIntMacro(m, SHUT_RD);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007161#elif defined(SD_RECEIVE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007162 PyModule_AddIntConstant(m, "SHUT_RD", SD_RECEIVE);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007163#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007164 PyModule_AddIntConstant(m, "SHUT_RD", 0);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007165#endif
7166#ifdef SHUT_WR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007167 PyModule_AddIntMacro(m, SHUT_WR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007168#elif defined(SD_SEND)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007169 PyModule_AddIntConstant(m, "SHUT_WR", SD_SEND);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007170#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007171 PyModule_AddIntConstant(m, "SHUT_WR", 1);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007172#endif
7173#ifdef SHUT_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007174 PyModule_AddIntMacro(m, SHUT_RDWR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007175#elif defined(SD_BOTH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007176 PyModule_AddIntConstant(m, "SHUT_RDWR", SD_BOTH);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007177#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007178 PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007179#endif
7180
Christian Heimesfaf2f632008-01-06 16:59:19 +00007181#ifdef SIO_RCVALL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007182 {
7183 DWORD codes[] = {SIO_RCVALL, SIO_KEEPALIVE_VALS};
7184 const char *names[] = {"SIO_RCVALL", "SIO_KEEPALIVE_VALS"};
7185 int i;
Victor Stinner63941882011-09-29 00:42:28 +02007186 for(i = 0; i<Py_ARRAY_LENGTH(codes); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007187 PyObject *tmp;
7188 tmp = PyLong_FromUnsignedLong(codes[i]);
7189 if (tmp == NULL)
7190 return NULL;
7191 PyModule_AddObject(m, names[i], tmp);
7192 }
7193 }
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007194 PyModule_AddIntMacro(m, RCVALL_OFF);
7195 PyModule_AddIntMacro(m, RCVALL_ON);
7196 PyModule_AddIntMacro(m, RCVALL_SOCKETLEVELONLY);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007197#ifdef RCVALL_IPLEVEL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007198 PyModule_AddIntMacro(m, RCVALL_IPLEVEL);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007199#endif
7200#ifdef RCVALL_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007201 PyModule_AddIntMacro(m, RCVALL_MAX);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007202#endif
Christian Heimesfaf2f632008-01-06 16:59:19 +00007203#endif /* _MSTCPIP_ */
7204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007205 /* Initialize gethostbyname lock */
Just van Rossum1040d2c2003-05-09 07:53:18 +00007206#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007207 netdb_lock = PyThread_allocate_lock();
Guido van Rossum4f199ea1998-04-09 20:56:35 +00007208#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007209 return m;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00007210}
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007211
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007212
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007213#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +00007214#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007215
7216/* Simplistic emulation code for inet_pton that only works for IPv4 */
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00007217/* These are not exposed because they do not set errno properly */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007218
Guido van Rossum3eede5a2002-06-07 02:08:35 +00007219int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007220inet_pton(int af, const char *src, void *dst)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007222 if (af == AF_INET) {
Benjamin Petersonf91df042009-02-13 02:50:59 +00007223#if (SIZEOF_INT != 4)
7224#error "Not sure if in_addr_t exists and int is not 32-bits."
7225#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007226 unsigned int packed_addr;
7227 packed_addr = inet_addr(src);
7228 if (packed_addr == INADDR_NONE)
7229 return 0;
7230 memcpy(dst, &packed_addr, 4);
7231 return 1;
7232 }
7233 /* Should set errno to EAFNOSUPPORT */
7234 return -1;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007235}
7236
Martin v. Löwisc925b1532001-07-21 09:42:15 +00007237const char *
7238inet_ntop(int af, const void *src, char *dst, socklen_t size)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007240 if (af == AF_INET) {
7241 struct in_addr packed_addr;
7242 if (size < 16)
7243 /* Should set errno to ENOSPC. */
7244 return NULL;
7245 memcpy(&packed_addr, src, sizeof(packed_addr));
7246 return strncpy(dst, inet_ntoa(packed_addr), size);
7247 }
7248 /* Should set errno to EAFNOSUPPORT */
7249 return NULL;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007250}
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007251
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007252#endif
Christian Heimesb6150692007-11-15 23:37:07 +00007253#endif