blob: 65651874a24f8ad41da2cf678835dc42b6117d9a [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
485/* Does WSASocket() support the WSA_FLAG_NO_HANDLE_INHERIT flag? */
486static int support_wsa_no_inherit = -1;
487#endif
488
Guido van Rossum30a685f1991-06-27 15:51:29 +0000489/* Convenience function to raise an error according to errno
490 and return a NULL pointer from a function. */
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000491
Guido van Rossum73624e91994-10-10 17:59:00 +0000492static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000493set_error(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000494{
Guido van Rossum8d665e61996-06-26 18:22:49 +0000495#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 int err_no = WSAGetLastError();
497 /* PyErr_SetExcFromWindowsErr() invokes FormatMessage() which
498 recognizes the error codes used by both GetLastError() and
499 WSAGetLastError */
500 if (err_no)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200501 return PyErr_SetExcFromWindowsErr(PyExc_OSError, err_no);
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000502#endif
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000503
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200504 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000505}
506
Guido van Rossum30a685f1991-06-27 15:51:29 +0000507
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000508static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000509set_herror(int h_error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000512
513#ifdef HAVE_HSTRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 v = Py_BuildValue("(is)", h_error, (char *)hstrerror(h_error));
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000515#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 v = Py_BuildValue("(is)", h_error, "host not found");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000517#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 if (v != NULL) {
519 PyErr_SetObject(socket_herror, v);
520 Py_DECREF(v);
521 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000523 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000524}
525
526
527static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000528set_gaierror(int error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000531
Martin v. Löwis272cb402002-03-01 08:31:07 +0000532#ifdef EAI_SYSTEM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 /* EAI_SYSTEM is not available on Windows XP. */
534 if (error == EAI_SYSTEM)
535 return set_error();
Martin v. Löwis272cb402002-03-01 08:31:07 +0000536#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000537
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000538#ifdef HAVE_GAI_STRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 v = Py_BuildValue("(is)", error, gai_strerror(error));
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000540#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 v = Py_BuildValue("(is)", error, "getaddrinfo failed");
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 if (v != NULL) {
544 PyErr_SetObject(socket_gaierror, v);
545 Py_DECREF(v);
546 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000549}
550
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000551/* Function to perform the setting of socket blocking mode
552 internally. block = (1 | 0). */
Guido van Rossum67f7a382002-06-06 21:08:16 +0000553static int
554internal_setblocking(PySocketSockObject *s, int block)
555{
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200556#ifdef MS_WINDOWS
557 u_long arg;
558#endif
Victor Stinner9a954832013-12-04 00:41:24 +0100559#if !defined(MS_WINDOWS) \
Christian Heimesaf01f662013-12-21 16:19:10 +0100560 && !((defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO)))
Victor Stinner9a954832013-12-04 00:41:24 +0100561 int delay_flag, new_delay_flag;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000562#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +0000563#ifdef SOCK_NONBLOCK
564 if (block)
565 s->sock_type &= (~SOCK_NONBLOCK);
566 else
567 s->sock_type |= SOCK_NONBLOCK;
568#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000570 Py_BEGIN_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000571#ifndef MS_WINDOWS
Christian Heimesaf01f662013-12-21 16:19:10 +0100572#if (defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 block = !block;
574 ioctl(s->sock_fd, FIONBIO, (unsigned int *)&block);
Victor Stinner9a954832013-12-04 00:41:24 +0100575#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 delay_flag = fcntl(s->sock_fd, F_GETFL, 0);
577 if (block)
Victor Stinner9a954832013-12-04 00:41:24 +0100578 new_delay_flag = delay_flag & (~O_NONBLOCK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 else
Victor Stinner9a954832013-12-04 00:41:24 +0100580 new_delay_flag = delay_flag | O_NONBLOCK;
581 if (new_delay_flag != delay_flag)
582 fcntl(s->sock_fd, F_SETFL, new_delay_flag);
583#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000584#else /* MS_WINDOWS */
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200585 arg = !block;
586 ioctlsocket(s->sock_fd, FIONBIO, &arg);
Guido van Rossum67f7a382002-06-06 21:08:16 +0000587#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 /* Since these don't return anything */
591 return 1;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000592}
593
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000594static int
Victor Stinner416f2e62015-03-31 13:56:29 +0200595internal_select_impl(PySocketSockObject *s, int writing, _PyTime_t interval,
596 int error)
Guido van Rossum67f7a382002-06-06 21:08:16 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 int n;
Victor Stinner71694d52015-03-28 01:18:54 +0100599#ifdef HAVE_POLL
600 struct pollfd pollfd;
Victor Stinnere6951c62015-03-31 13:50:44 +0200601 _PyTime_t ms;
Victor Stinner71694d52015-03-28 01:18:54 +0100602#else
Victor Stinner416f2e62015-03-31 13:56:29 +0200603 fd_set fds, efds;
Victor Stinner71694d52015-03-28 01:18:54 +0100604 struct timeval tv;
605#endif
Guido van Rossum11ba0942002-06-13 15:07:44 +0000606
Victor Stinnerb7df3142015-03-27 22:59:32 +0100607#ifdef WITH_THREAD
608 /* must be called with the GIL held */
609 assert(PyGILState_Check());
610#endif
611
Victor Stinner416f2e62015-03-31 13:56:29 +0200612 /* Error condition is for output only */
613 assert(!(error && !writing));
614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner71694d52015-03-28 01:18:54 +0100616 if (s->sock_timeout <= 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 /* Guard against closed socket */
620 if (s->sock_fd < 0)
621 return 0;
Guido van Rossumad654902002-07-19 12:44:59 +0000622
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000623 /* Handling this condition here simplifies the select loops */
Victor Stinner71694d52015-03-28 01:18:54 +0100624 if (interval < 0)
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000625 return 1;
626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 /* Prefer poll, if available, since you can poll() any fd
628 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629#ifdef HAVE_POLL
Victor Stinner71694d52015-03-28 01:18:54 +0100630 pollfd.fd = s->sock_fd;
631 pollfd.events = writing ? POLLOUT : POLLIN;
Victor Stinner416f2e62015-03-31 13:56:29 +0200632 if (error)
633 pollfd.events |= POLLERR;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000634
Victor Stinner71694d52015-03-28 01:18:54 +0100635 /* s->sock_timeout is in seconds, timeout in ms */
Victor Stinnere6951c62015-03-31 13:50:44 +0200636 ms = _PyTime_AsMilliseconds(interval, _PyTime_ROUND_CEILING);
637 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000638
Victor Stinner71694d52015-03-28 01:18:54 +0100639 Py_BEGIN_ALLOW_THREADS;
Victor Stinnere6951c62015-03-31 13:50:44 +0200640 n = poll(&pollfd, 1, (int)ms);
Victor Stinner71694d52015-03-28 01:18:54 +0100641 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000642#else
Victor Stinner869e1772015-03-30 03:49:14 +0200643 _PyTime_AsTimeval_noraise(interval, &tv, _PyTime_ROUND_CEILING);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644
Victor Stinner71694d52015-03-28 01:18:54 +0100645 FD_ZERO(&fds);
646 FD_SET(s->sock_fd, &fds);
Victor Stinner416f2e62015-03-31 13:56:29 +0200647 FD_ZERO(&efds);
648 if (error)
649 FD_SET(s->sock_fd, &efds);
Victor Stinner71694d52015-03-28 01:18:54 +0100650
651 /* See if the socket is ready */
652 Py_BEGIN_ALLOW_THREADS;
653 if (writing)
654 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinner416f2e62015-03-31 13:56:29 +0200655 NULL, &fds, &efds, &tv);
Victor Stinner71694d52015-03-28 01:18:54 +0100656 else
657 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinner416f2e62015-03-31 13:56:29 +0200658 &fds, NULL, &efds, &tv);
Victor Stinner71694d52015-03-28 01:18:54 +0100659 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000660#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 if (n < 0)
663 return -1;
664 if (n == 0)
665 return 1;
666 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000667}
668
Victor Stinnere6951c62015-03-31 13:50:44 +0200669/* Do a select()/poll() on the socket, if necessary (sock_timeout > 0).
670 The argument writing indicates the direction.
671 This does not raise an exception; we'll let our caller do that
672 after they've reacquired the interpreter lock.
673 Returns 1 on timeout, -1 on error, 0 otherwise. */
674static int
675internal_select(PySocketSockObject *s, int writing, _PyTime_t interval)
676{
Victor Stinner416f2e62015-03-31 13:56:29 +0200677 return internal_select_impl(s, writing, interval, 0);
Victor Stinnere6951c62015-03-31 13:50:44 +0200678}
679
680static int
681internal_connect_select(PySocketSockObject *s)
682{
Victor Stinnerdd83bd22015-03-31 14:24:47 +0200683 return internal_select_impl(s, 1, s->sock_timeout, 1);
Victor Stinnere6951c62015-03-31 13:50:44 +0200684}
685
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000686/*
687 Two macros for automatic retry of select() in case of false positives
688 (for example, select() could indicate a socket is ready for reading
689 but the data then discarded by the OS because of a wrong checksum).
690 Here is an example of use:
691
692 BEGIN_SELECT_LOOP(s)
Victor Stinnerb7df3142015-03-27 22:59:32 +0100693
Victor Stinner391fa712015-03-31 13:15:31 +0200694 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +0100695
696 if (!timeout) {
697 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000698 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinnerb7df3142015-03-27 22:59:32 +0100699 Py_END_ALLOW_THREADS
700 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000701 if (timeout == 1) {
702 PyErr_SetString(socket_timeout, "timed out");
703 return -1;
704 }
705 END_SELECT_LOOP(s)
706*/
707
708#define BEGIN_SELECT_LOOP(s) \
709 { \
Victor Stinner71694d52015-03-28 01:18:54 +0100710 _PyTime_t deadline = 0; \
711 _PyTime_t interval = s->sock_timeout; \
712 int has_timeout = (s->sock_timeout > 0); \
713 if (has_timeout) \
714 deadline = _PyTime_GetMonotonicClock() + interval; \
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000715 while (1) { \
716 errno = 0; \
717
718#define END_SELECT_LOOP(s) \
719 if (!has_timeout || \
720 (!CHECK_ERRNO(EWOULDBLOCK) && !CHECK_ERRNO(EAGAIN))) \
721 break; \
Victor Stinner71694d52015-03-28 01:18:54 +0100722 interval = deadline - _PyTime_GetMonotonicClock(); \
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000723 } \
724 } \
725
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000726/* Initialize a new socket object. */
727
Victor Stinner71694d52015-03-28 01:18:54 +0100728static _PyTime_t defaulttimeout = -1; /* Default timeout for new sockets */
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000729
Martin v. Löwis1a214512008-06-11 05:26:20 +0000730static void
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000731init_sockobject(PySocketSockObject *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 SOCKET_T fd, int family, int type, int proto)
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000733{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 s->sock_fd = fd;
735 s->sock_family = family;
736 s->sock_type = type;
737 s->sock_proto = proto;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 s->errorhandler = &set_error;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000740#ifdef SOCK_NONBLOCK
741 if (type & SOCK_NONBLOCK)
Victor Stinner71694d52015-03-28 01:18:54 +0100742 s->sock_timeout = 0;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000743 else
744#endif
745 {
746 s->sock_timeout = defaulttimeout;
Victor Stinner71694d52015-03-28 01:18:54 +0100747 if (defaulttimeout >= 0)
Antoine Pitroub1c54962010-10-14 15:05:38 +0000748 internal_setblocking(s, 0);
749 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000750
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000751}
752
753
Guido van Rossum30a685f1991-06-27 15:51:29 +0000754/* Create a new socket object.
755 This just creates the object and initializes it.
756 If the creation fails, return NULL and set an exception (implicit
757 in NEWOBJ()). */
758
Guido van Rossum73624e91994-10-10 17:59:00 +0000759static PySocketSockObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000760new_sockobject(SOCKET_T fd, int family, int type, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 PySocketSockObject *s;
763 s = (PySocketSockObject *)
764 PyType_GenericNew(&sock_type, NULL, NULL);
765 if (s != NULL)
766 init_sockobject(s, fd, family, type, proto);
767 return s;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000768}
769
Guido van Rossum30a685f1991-06-27 15:51:29 +0000770
Guido van Rossum48a680c2001-03-02 06:34:14 +0000771/* Lock to allow python interpreter to continue, but only allow one
Just van Rossum1040d2c2003-05-09 07:53:18 +0000772 thread to be in gethostbyname or getaddrinfo */
773#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Matthias Klosed182a6c2012-08-14 17:29:04 +0200774static PyThread_type_lock netdb_lock;
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000775#endif
776
777
Guido van Rossum30a685f1991-06-27 15:51:29 +0000778/* Convert a string specifying a host name or one of a few symbolic
779 names to a numeric IP address. This usually calls gethostbyname()
780 to do the work; the names "" and "<broadcast>" are special.
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000781 Return the length (IPv4 should be 4 bytes), or negative if
Guido van Rossum30a685f1991-06-27 15:51:29 +0000782 an error occurred; then an exception is raised. */
783
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000784static int
Martin v. Löwisddc6f472002-07-28 16:10:31 +0000785setipaddr(char *name, struct sockaddr *addr_ret, size_t addr_ret_size, int af)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 struct addrinfo hints, *res;
788 int error;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 memset((void *) addr_ret, '\0', sizeof(*addr_ret));
791 if (name[0] == '\0') {
792 int siz;
793 memset(&hints, 0, sizeof(hints));
794 hints.ai_family = af;
795 hints.ai_socktype = SOCK_DGRAM; /*dummy*/
796 hints.ai_flags = AI_PASSIVE;
797 Py_BEGIN_ALLOW_THREADS
798 ACQUIRE_GETADDRINFO_LOCK
799 error = getaddrinfo(NULL, "0", &hints, &res);
800 Py_END_ALLOW_THREADS
801 /* We assume that those thread-unsafe getaddrinfo() versions
802 *are* safe regarding their return value, ie. that a
803 subsequent call to getaddrinfo() does not destroy the
804 outcome of the first call. */
805 RELEASE_GETADDRINFO_LOCK
806 if (error) {
807 set_gaierror(error);
808 return -1;
809 }
810 switch (res->ai_family) {
811 case AF_INET:
812 siz = 4;
813 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000814#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 case AF_INET6:
816 siz = 16;
817 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000818#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 default:
820 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200821 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 "unsupported address family");
823 return -1;
824 }
825 if (res->ai_next) {
826 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200827 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 "wildcard resolved to multiple address");
829 return -1;
830 }
831 if (res->ai_addrlen < addr_ret_size)
832 addr_ret_size = res->ai_addrlen;
833 memcpy(addr_ret, res->ai_addr, addr_ret_size);
834 freeaddrinfo(res);
835 return siz;
836 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200837 /* special-case broadcast - inet_addr() below can return INADDR_NONE for
Victor Stinnere990c6e2013-11-16 00:18:58 +0100838 * this */
Charles-François Natali0cc86852013-09-13 19:53:08 +0200839 if (strcmp(name, "255.255.255.255") == 0 ||
840 strcmp(name, "<broadcast>") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 struct sockaddr_in *sin;
842 if (af != AF_INET && af != AF_UNSPEC) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200843 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 "address family mismatched");
845 return -1;
846 }
847 sin = (struct sockaddr_in *)addr_ret;
848 memset((void *) sin, '\0', sizeof(*sin));
849 sin->sin_family = AF_INET;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000850#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 sin->sin_len = sizeof(*sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000852#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 sin->sin_addr.s_addr = INADDR_BROADCAST;
854 return sizeof(sin->sin_addr);
855 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200856
857 /* avoid a name resolution in case of numeric address */
858#ifdef HAVE_INET_PTON
859 /* check for an IPv4 address */
860 if (af == AF_UNSPEC || af == AF_INET) {
861 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
862 memset(sin, 0, sizeof(*sin));
863 if (inet_pton(AF_INET, name, &sin->sin_addr) > 0) {
864 sin->sin_family = AF_INET;
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000865#ifdef HAVE_SOCKADDR_SA_LEN
Charles-François Natali0cc86852013-09-13 19:53:08 +0200866 sin->sin_len = sizeof(*sin);
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000867#endif
Charles-François Natali0cc86852013-09-13 19:53:08 +0200868 return 4;
869 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200871#ifdef ENABLE_IPV6
872 /* check for an IPv6 address - if the address contains a scope ID, we
873 * fallback to getaddrinfo(), which can handle translation from interface
874 * name to interface index */
875 if ((af == AF_UNSPEC || af == AF_INET6) && !strchr(name, '%')) {
876 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)addr_ret;
877 memset(sin, 0, sizeof(*sin));
878 if (inet_pton(AF_INET6, name, &sin->sin6_addr) > 0) {
879 sin->sin6_family = AF_INET6;
880#ifdef HAVE_SOCKADDR_SA_LEN
881 sin->sin6_len = sizeof(*sin);
882#endif
883 return 16;
884 }
885 }
886#endif /* ENABLE_IPV6 */
887#else /* HAVE_INET_PTON */
888 /* check for an IPv4 address */
889 if (af == AF_INET || af == AF_UNSPEC) {
890 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
891 memset(sin, 0, sizeof(*sin));
892 if ((sin->sin_addr.s_addr = inet_addr(name)) != INADDR_NONE) {
893 sin->sin_family = AF_INET;
894#ifdef HAVE_SOCKADDR_SA_LEN
895 sin->sin_len = sizeof(*sin);
896#endif
897 return 4;
898 }
Victor Stinnere990c6e2013-11-16 00:18:58 +0100899 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200900#endif /* HAVE_INET_PTON */
901
902 /* perform a name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 memset(&hints, 0, sizeof(hints));
904 hints.ai_family = af;
905 Py_BEGIN_ALLOW_THREADS
906 ACQUIRE_GETADDRINFO_LOCK
907 error = getaddrinfo(name, NULL, &hints, &res);
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000908#if defined(__digital__) && defined(__unix__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 if (error == EAI_NONAME && af == AF_UNSPEC) {
910 /* On Tru64 V5.1, numeric-to-addr conversion fails
911 if no address family is given. Assume IPv4 for now.*/
912 hints.ai_family = AF_INET;
913 error = getaddrinfo(name, NULL, &hints, &res);
914 }
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000915#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 Py_END_ALLOW_THREADS
917 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
918 if (error) {
919 set_gaierror(error);
920 return -1;
921 }
922 if (res->ai_addrlen < addr_ret_size)
923 addr_ret_size = res->ai_addrlen;
924 memcpy((char *) addr_ret, res->ai_addr, addr_ret_size);
925 freeaddrinfo(res);
926 switch (addr_ret->sa_family) {
927 case AF_INET:
928 return 4;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000929#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 case AF_INET6:
931 return 16;
Guido van Rossum955becc1999-03-22 20:14:53 +0000932#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200934 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 return -1;
936 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000937}
938
Guido van Rossum30a685f1991-06-27 15:51:29 +0000939
Guido van Rossum30a685f1991-06-27 15:51:29 +0000940/* Create a string object representing an IP address.
941 This is always a string of the form 'dd.dd.dd.dd' (with variable
942 size numbers). */
943
Guido van Rossum73624e91994-10-10 17:59:00 +0000944static PyObject *
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000945makeipaddr(struct sockaddr *addr, int addrlen)
Guido van Rossum30a685f1991-06-27 15:51:29 +0000946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 char buf[NI_MAXHOST];
948 int error;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 error = getnameinfo(addr, addrlen, buf, sizeof(buf), NULL, 0,
951 NI_NUMERICHOST);
952 if (error) {
953 set_gaierror(error);
954 return NULL;
955 }
956 return PyUnicode_FromString(buf);
Guido van Rossum30a685f1991-06-27 15:51:29 +0000957}
958
959
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000960#ifdef USE_BLUETOOTH
961/* Convert a string representation of a Bluetooth address into a numeric
962 address. Returns the length (6), or raises an exception and returns -1 if
963 an error occurred. */
964
965static int
966setbdaddr(char *name, bdaddr_t *bdaddr)
967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 unsigned int b0, b1, b2, b3, b4, b5;
969 char ch;
970 int n;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 n = sscanf(name, "%X:%X:%X:%X:%X:%X%c",
973 &b5, &b4, &b3, &b2, &b1, &b0, &ch);
974 if (n == 6 && (b0 | b1 | b2 | b3 | b4 | b5) < 256) {
975 bdaddr->b[0] = b0;
976 bdaddr->b[1] = b1;
977 bdaddr->b[2] = b2;
978 bdaddr->b[3] = b3;
979 bdaddr->b[4] = b4;
980 bdaddr->b[5] = b5;
981 return 6;
982 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200983 PyErr_SetString(PyExc_OSError, "bad bluetooth address");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 return -1;
985 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000986}
987
988/* Create a string representation of the Bluetooth address. This is always a
989 string of the form 'XX:XX:XX:XX:XX:XX' where XX is a two digit hexadecimal
990 value (zero padded if necessary). */
991
992static PyObject *
993makebdaddr(bdaddr_t *bdaddr)
994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 char buf[(6 * 2) + 5 + 1];
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 sprintf(buf, "%02X:%02X:%02X:%02X:%02X:%02X",
998 bdaddr->b[5], bdaddr->b[4], bdaddr->b[3],
999 bdaddr->b[2], bdaddr->b[1], bdaddr->b[0]);
1000 return PyUnicode_FromString(buf);
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001001}
1002#endif
1003
1004
Guido van Rossum30a685f1991-06-27 15:51:29 +00001005/* Create an object representing the given socket address,
1006 suitable for passing it back to bind(), connect() etc.
1007 The family field of the sockaddr structure is inspected
1008 to determine what kind of address it really is. */
1009
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001010/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00001011static PyObject *
Antoine Pitrou19467d22010-08-17 19:33:30 +00001012makesockaddr(SOCKET_T sockfd, struct sockaddr *addr, size_t addrlen, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (addrlen == 0) {
1015 /* No address -- may be recvfrom() from known socket */
1016 Py_INCREF(Py_None);
1017 return Py_None;
1018 }
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 switch (addr->sa_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 case AF_INET:
1023 {
1024 struct sockaddr_in *a;
1025 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1026 PyObject *ret = NULL;
1027 if (addrobj) {
1028 a = (struct sockaddr_in *)addr;
1029 ret = Py_BuildValue("Oi", addrobj, ntohs(a->sin_port));
1030 Py_DECREF(addrobj);
1031 }
1032 return ret;
1033 }
Guido van Rossum30a685f1991-06-27 15:51:29 +00001034
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001035#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 case AF_UNIX:
1037 {
1038 struct sockaddr_un *a = (struct sockaddr_un *) addr;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001039#ifdef linux
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 if (a->sun_path[0] == 0) { /* Linux abstract namespace */
1041 addrlen -= offsetof(struct sockaddr_un, sun_path);
Charles-François Natalib10c71d2013-05-21 10:45:46 +02001042 return PyBytes_FromStringAndSize(a->sun_path, addrlen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 }
1044 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001045#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 {
1047 /* regular NULL-terminated string */
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001048 return PyUnicode_DecodeFSDefault(a->sun_path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 }
1050 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001051#endif /* AF_UNIX */
1052
Martin v. Löwis11017b12006-01-14 18:12:57 +00001053#if defined(AF_NETLINK)
1054 case AF_NETLINK:
1055 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 struct sockaddr_nl *a = (struct sockaddr_nl *) addr;
1057 return Py_BuildValue("II", a->nl_pid, a->nl_groups);
Martin v. Löwis11017b12006-01-14 18:12:57 +00001058 }
1059#endif /* AF_NETLINK */
1060
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001061#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 case AF_INET6:
1063 {
1064 struct sockaddr_in6 *a;
1065 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1066 PyObject *ret = NULL;
1067 if (addrobj) {
1068 a = (struct sockaddr_in6 *)addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01001069 ret = Py_BuildValue("OiII",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 addrobj,
1071 ntohs(a->sin6_port),
Charles-François Natali366999a2012-01-02 15:47:29 +01001072 ntohl(a->sin6_flowinfo),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 a->sin6_scope_id);
1074 Py_DECREF(addrobj);
1075 }
1076 return ret;
1077 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001078#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00001079
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001080#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 case AF_BLUETOOTH:
1082 switch (proto) {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 case BTPROTO_L2CAP:
1085 {
1086 struct sockaddr_l2 *a = (struct sockaddr_l2 *) addr;
1087 PyObject *addrobj = makebdaddr(&_BT_L2_MEMB(a, bdaddr));
1088 PyObject *ret = NULL;
1089 if (addrobj) {
1090 ret = Py_BuildValue("Oi",
1091 addrobj,
1092 _BT_L2_MEMB(a, psm));
1093 Py_DECREF(addrobj);
1094 }
1095 return ret;
1096 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 case BTPROTO_RFCOMM:
1099 {
1100 struct sockaddr_rc *a = (struct sockaddr_rc *) addr;
1101 PyObject *addrobj = makebdaddr(&_BT_RC_MEMB(a, bdaddr));
1102 PyObject *ret = NULL;
1103 if (addrobj) {
1104 ret = Py_BuildValue("Oi",
1105 addrobj,
1106 _BT_RC_MEMB(a, channel));
1107 Py_DECREF(addrobj);
1108 }
1109 return ret;
1110 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 case BTPROTO_HCI:
1113 {
1114 struct sockaddr_hci *a = (struct sockaddr_hci *) addr;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001115#if defined(__NetBSD__) || defined(__DragonFly__)
1116 return makebdaddr(&_BT_HCI_MEMB(a, bdaddr));
1117#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 PyObject *ret = NULL;
1119 ret = Py_BuildValue("i", _BT_HCI_MEMB(a, dev));
1120 return ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001121#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 }
Thomas Wouterscf297e42007-02-23 15:07:44 +00001123
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001124#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 case BTPROTO_SCO:
1126 {
1127 struct sockaddr_sco *a = (struct sockaddr_sco *) addr;
1128 return makebdaddr(&_BT_SCO_MEMB(a, bdaddr));
1129 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001130#endif
1131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 default:
1133 PyErr_SetString(PyExc_ValueError,
1134 "Unknown Bluetooth protocol");
1135 return NULL;
1136 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001137#endif
1138
Antoine Pitroub156a462010-10-27 20:13:57 +00001139#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFNAME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 case AF_PACKET:
1141 {
1142 struct sockaddr_ll *a = (struct sockaddr_ll *)addr;
1143 char *ifname = "";
1144 struct ifreq ifr;
1145 /* need to look up interface name give index */
1146 if (a->sll_ifindex) {
1147 ifr.ifr_ifindex = a->sll_ifindex;
1148 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1149 ifname = ifr.ifr_name;
1150 }
1151 return Py_BuildValue("shbhy#",
1152 ifname,
1153 ntohs(a->sll_protocol),
1154 a->sll_pkttype,
1155 a->sll_hatype,
1156 a->sll_addr,
1157 a->sll_halen);
1158 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001159#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001160
Christian Heimes043d6f62008-01-07 17:19:16 +00001161#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 case AF_TIPC:
1163 {
1164 struct sockaddr_tipc *a = (struct sockaddr_tipc *) addr;
1165 if (a->addrtype == TIPC_ADDR_NAMESEQ) {
1166 return Py_BuildValue("IIIII",
1167 a->addrtype,
1168 a->addr.nameseq.type,
1169 a->addr.nameseq.lower,
1170 a->addr.nameseq.upper,
1171 a->scope);
1172 } else if (a->addrtype == TIPC_ADDR_NAME) {
1173 return Py_BuildValue("IIIII",
1174 a->addrtype,
1175 a->addr.name.name.type,
1176 a->addr.name.name.instance,
1177 a->addr.name.name.instance,
1178 a->scope);
1179 } else if (a->addrtype == TIPC_ADDR_ID) {
1180 return Py_BuildValue("IIIII",
1181 a->addrtype,
1182 a->addr.id.node,
1183 a->addr.id.ref,
1184 0,
1185 a->scope);
1186 } else {
1187 PyErr_SetString(PyExc_ValueError,
1188 "Invalid address type");
1189 return NULL;
1190 }
1191 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001192#endif
1193
Vinay Sajipecfc98c2014-03-20 12:42:42 +00001194#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001195 case AF_CAN:
1196 {
1197 struct sockaddr_can *a = (struct sockaddr_can *)addr;
1198 char *ifname = "";
1199 struct ifreq ifr;
1200 /* need to look up interface name given index */
1201 if (a->can_ifindex) {
1202 ifr.ifr_ifindex = a->can_ifindex;
1203 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1204 ifname = ifr.ifr_name;
1205 }
1206
1207 return Py_BuildValue("O&h", PyUnicode_DecodeFSDefault,
1208 ifname,
1209 a->can_family);
1210 }
1211#endif
1212
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001213#ifdef PF_SYSTEM
1214 case PF_SYSTEM:
1215 switch(proto) {
1216#ifdef SYSPROTO_CONTROL
1217 case SYSPROTO_CONTROL:
1218 {
1219 struct sockaddr_ctl *a = (struct sockaddr_ctl *)addr;
1220 return Py_BuildValue("(II)", a->sc_id, a->sc_unit);
1221 }
1222#endif
1223 default:
1224 PyErr_SetString(PyExc_ValueError,
1225 "Invalid address type");
1226 return 0;
1227 }
1228#endif
1229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 default:
1233 /* If we don't know the address family, don't raise an
1234 exception -- return it as an (int, bytes) tuple. */
1235 return Py_BuildValue("iy#",
1236 addr->sa_family,
1237 addr->sa_data,
1238 sizeof(addr->sa_data));
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001241}
1242
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001243/* Helper for getsockaddrarg: bypass IDNA for ASCII-only host names
1244 (in particular, numeric IP addresses). */
1245struct maybe_idna {
1246 PyObject *obj;
1247 char *buf;
1248};
1249
1250static void
1251idna_cleanup(struct maybe_idna *data)
1252{
1253 Py_CLEAR(data->obj);
1254}
1255
1256static int
1257idna_converter(PyObject *obj, struct maybe_idna *data)
1258{
1259 size_t len;
1260 PyObject *obj2, *obj3;
1261 if (obj == NULL) {
1262 idna_cleanup(data);
1263 return 1;
1264 }
1265 data->obj = NULL;
1266 len = -1;
1267 if (PyBytes_Check(obj)) {
1268 data->buf = PyBytes_AsString(obj);
1269 len = PyBytes_Size(obj);
1270 }
1271 else if (PyByteArray_Check(obj)) {
1272 data->buf = PyByteArray_AsString(obj);
1273 len = PyByteArray_Size(obj);
1274 }
1275 else if (PyUnicode_Check(obj) && PyUnicode_READY(obj) == 0 && PyUnicode_IS_COMPACT_ASCII(obj)) {
1276 data->buf = PyUnicode_DATA(obj);
1277 len = PyUnicode_GET_LENGTH(obj);
1278 }
1279 else {
1280 obj2 = PyUnicode_FromObject(obj);
1281 if (!obj2) {
1282 PyErr_Format(PyExc_TypeError, "string or unicode text buffer expected, not %s",
1283 obj->ob_type->tp_name);
1284 return 0;
1285 }
1286 obj3 = PyUnicode_AsEncodedString(obj2, "idna", NULL);
1287 Py_DECREF(obj2);
1288 if (!obj3) {
1289 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed");
1290 return 0;
1291 }
1292 if (!PyBytes_Check(obj3)) {
Martin v. Löwis17fd1e12014-08-05 16:13:50 +02001293 Py_DECREF(obj3);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001294 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed to return bytes");
1295 return 0;
1296 }
1297 data->obj = obj3;
1298 data->buf = PyBytes_AS_STRING(obj3);
1299 len = PyBytes_GET_SIZE(obj3);
1300 }
1301 if (strlen(data->buf) != len) {
1302 Py_CLEAR(data->obj);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001303 PyErr_SetString(PyExc_TypeError, "host name must not contain null character");
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001304 return 0;
1305 }
1306 return Py_CLEANUP_SUPPORTED;
Victor Stinner1a62a682014-08-17 19:33:28 +02001307}
Guido van Rossum30a685f1991-06-27 15:51:29 +00001308
1309/* Parse a socket address argument according to the socket object's
1310 address family. Return 1 if the address was in the proper format,
1311 0 of not. The address is returned through addr_ret, its length
1312 through len_ret. */
1313
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001314static int
Guido van Rossum48a680c2001-03-02 06:34:14 +00001315getsockaddrarg(PySocketSockObject *s, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 struct sockaddr *addr_ret, int *len_ret)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 switch (s->sock_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001319
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001320#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 case AF_UNIX:
1322 {
1323 struct sockaddr_un* addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001324 Py_buffer path;
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001325 int retval = 0;
1326
1327 /* PEP 383. Not using PyUnicode_FSConverter since we need to
1328 allow embedded nulls on Linux. */
1329 if (PyUnicode_Check(args)) {
1330 if ((args = PyUnicode_EncodeFSDefault(args)) == NULL)
1331 return 0;
1332 }
1333 else
1334 Py_INCREF(args);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001335 if (!PyArg_Parse(args, "y*", &path)) {
1336 Py_DECREF(args);
1337 return retval;
1338 }
1339 assert(path.len >= 0);
Thomas Wouters89f507f2006-12-13 04:49:30 +00001340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 addr = (struct sockaddr_un*)addr_ret;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001342#ifdef linux
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001343 if (path.len > 0 && *(const char *)path.buf == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 /* Linux abstract namespace extension */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001345 if ((size_t)path.len > sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001346 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001348 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 }
1350 }
1351 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001352#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 {
1354 /* regular NULL-terminated string */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001355 if ((size_t)path.len >= sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001356 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001358 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001360 addr->sun_path[path.len] = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 }
1362 addr->sun_family = s->sock_family;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001363 memcpy(addr->sun_path, path.buf, path.len);
1364 *len_ret = path.len + offsetof(struct sockaddr_un, sun_path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001365 retval = 1;
1366 unix_out:
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001367 PyBuffer_Release(&path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001368 Py_DECREF(args);
1369 return retval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001371#endif /* AF_UNIX */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001372
Martin v. Löwis11017b12006-01-14 18:12:57 +00001373#if defined(AF_NETLINK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 case AF_NETLINK:
1375 {
1376 struct sockaddr_nl* addr;
1377 int pid, groups;
1378 addr = (struct sockaddr_nl *)addr_ret;
1379 if (!PyTuple_Check(args)) {
1380 PyErr_Format(
1381 PyExc_TypeError,
1382 "getsockaddrarg: "
1383 "AF_NETLINK address must be tuple, not %.500s",
1384 Py_TYPE(args)->tp_name);
1385 return 0;
1386 }
1387 if (!PyArg_ParseTuple(args, "II:getsockaddrarg", &pid, &groups))
1388 return 0;
1389 addr->nl_family = AF_NETLINK;
1390 addr->nl_pid = pid;
1391 addr->nl_groups = groups;
1392 *len_ret = sizeof(*addr);
1393 return 1;
1394 }
Martin v. Löwis11017b12006-01-14 18:12:57 +00001395#endif
1396
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001397#ifdef AF_RDS
1398 case AF_RDS:
1399 /* RDS sockets use sockaddr_in: fall-through */
1400#endif
1401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 case AF_INET:
1403 {
1404 struct sockaddr_in* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001405 struct maybe_idna host = {NULL, NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 int port, result;
1407 if (!PyTuple_Check(args)) {
1408 PyErr_Format(
1409 PyExc_TypeError,
1410 "getsockaddrarg: "
1411 "AF_INET address must be tuple, not %.500s",
1412 Py_TYPE(args)->tp_name);
1413 return 0;
1414 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001415 if (!PyArg_ParseTuple(args, "O&i:getsockaddrarg",
1416 idna_converter, &host, &port))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 return 0;
1418 addr=(struct sockaddr_in*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001419 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 sizeof(*addr), AF_INET);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001421 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (result < 0)
1423 return 0;
1424 if (port < 0 || port > 0xffff) {
1425 PyErr_SetString(
1426 PyExc_OverflowError,
1427 "getsockaddrarg: port must be 0-65535.");
1428 return 0;
1429 }
1430 addr->sin_family = AF_INET;
1431 addr->sin_port = htons((short)port);
1432 *len_ret = sizeof *addr;
1433 return 1;
1434 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001435
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001436#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 case AF_INET6:
1438 {
1439 struct sockaddr_in6* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001440 struct maybe_idna host = {NULL, NULL};
Charles-François Natali366999a2012-01-02 15:47:29 +01001441 int port, result;
1442 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 flowinfo = scope_id = 0;
1444 if (!PyTuple_Check(args)) {
1445 PyErr_Format(
1446 PyExc_TypeError,
1447 "getsockaddrarg: "
1448 "AF_INET6 address must be tuple, not %.500s",
1449 Py_TYPE(args)->tp_name);
1450 return 0;
1451 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001452 if (!PyArg_ParseTuple(args, "O&i|II",
1453 idna_converter, &host, &port, &flowinfo,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 &scope_id)) {
1455 return 0;
1456 }
1457 addr = (struct sockaddr_in6*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001458 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 sizeof(*addr), AF_INET6);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001460 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 if (result < 0)
1462 return 0;
1463 if (port < 0 || port > 0xffff) {
1464 PyErr_SetString(
1465 PyExc_OverflowError,
1466 "getsockaddrarg: port must be 0-65535.");
1467 return 0;
1468 }
Charles-François Natali9b0c0062012-06-23 10:17:05 +02001469 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01001470 PyErr_SetString(
1471 PyExc_OverflowError,
1472 "getsockaddrarg: flowinfo must be 0-1048575.");
1473 return 0;
1474 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 addr->sin6_family = s->sock_family;
1476 addr->sin6_port = htons((short)port);
Charles-François Natali366999a2012-01-02 15:47:29 +01001477 addr->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 addr->sin6_scope_id = scope_id;
1479 *len_ret = sizeof *addr;
1480 return 1;
1481 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001482#endif
1483
Hye-Shik Chang81268602004-02-02 06:05:24 +00001484#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 case AF_BLUETOOTH:
1486 {
1487 switch (s->sock_proto) {
1488 case BTPROTO_L2CAP:
1489 {
1490 struct sockaddr_l2 *addr;
1491 char *straddr;
Martin v. Löwis12af0482004-01-31 12:34:17 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 addr = (struct sockaddr_l2 *)addr_ret;
1494 memset(addr, 0, sizeof(struct sockaddr_l2));
1495 _BT_L2_MEMB(addr, family) = AF_BLUETOOTH;
1496 if (!PyArg_ParseTuple(args, "si", &straddr,
1497 &_BT_L2_MEMB(addr, psm))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001498 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 "wrong format");
1500 return 0;
1501 }
1502 if (setbdaddr(straddr, &_BT_L2_MEMB(addr, bdaddr)) < 0)
1503 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 *len_ret = sizeof *addr;
1506 return 1;
1507 }
1508 case BTPROTO_RFCOMM:
1509 {
1510 struct sockaddr_rc *addr;
1511 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 addr = (struct sockaddr_rc *)addr_ret;
1514 _BT_RC_MEMB(addr, family) = AF_BLUETOOTH;
1515 if (!PyArg_ParseTuple(args, "si", &straddr,
1516 &_BT_RC_MEMB(addr, channel))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001517 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 "wrong format");
1519 return 0;
1520 }
1521 if (setbdaddr(straddr, &_BT_RC_MEMB(addr, bdaddr)) < 0)
1522 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 *len_ret = sizeof *addr;
1525 return 1;
1526 }
1527 case BTPROTO_HCI:
1528 {
1529 struct sockaddr_hci *addr = (struct sockaddr_hci *)addr_ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001530#if defined(__NetBSD__) || defined(__DragonFly__)
Alexander Belopolskye239d232010-12-08 23:31:48 +00001531 char *straddr = PyBytes_AS_STRING(args);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001532
Alexander Belopolskye239d232010-12-08 23:31:48 +00001533 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001534 if (straddr == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001535 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001536 "wrong format");
1537 return 0;
1538 }
1539 if (setbdaddr(straddr, &_BT_HCI_MEMB(addr, bdaddr)) < 0)
1540 return 0;
1541#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
1543 if (!PyArg_ParseTuple(args, "i", &_BT_HCI_MEMB(addr, dev))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001544 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 "wrong format");
1546 return 0;
1547 }
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001548#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 *len_ret = sizeof *addr;
1550 return 1;
1551 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001552#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 case BTPROTO_SCO:
1554 {
1555 struct sockaddr_sco *addr;
1556 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 addr = (struct sockaddr_sco *)addr_ret;
1559 _BT_SCO_MEMB(addr, family) = AF_BLUETOOTH;
1560 if (!PyBytes_Check(args)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001561 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 "wrong format");
1563 return 0;
1564 }
1565 straddr = PyBytes_AS_STRING(args);
1566 if (setbdaddr(straddr, &_BT_SCO_MEMB(addr, bdaddr)) < 0)
1567 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 *len_ret = sizeof *addr;
1570 return 1;
1571 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001572#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001574 PyErr_SetString(PyExc_OSError, "getsockaddrarg: unknown Bluetooth protocol");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 return 0;
1576 }
1577 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001578#endif
1579
Antoine Pitroub156a462010-10-27 20:13:57 +00001580#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFINDEX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 case AF_PACKET:
1582 {
1583 struct sockaddr_ll* addr;
1584 struct ifreq ifr;
1585 char *interfaceName;
1586 int protoNumber;
1587 int hatype = 0;
1588 int pkttype = 0;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001589 Py_buffer haddr = {NULL, NULL};
Guido van Rossum48a680c2001-03-02 06:34:14 +00001590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (!PyTuple_Check(args)) {
1592 PyErr_Format(
1593 PyExc_TypeError,
1594 "getsockaddrarg: "
1595 "AF_PACKET address must be tuple, not %.500s",
1596 Py_TYPE(args)->tp_name);
1597 return 0;
1598 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001599 if (!PyArg_ParseTuple(args, "si|iiy*", &interfaceName,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 &protoNumber, &pkttype, &hatype,
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001601 &haddr))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 return 0;
1603 strncpy(ifr.ifr_name, interfaceName, sizeof(ifr.ifr_name));
1604 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
1605 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1606 s->errorhandler();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001607 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 return 0;
1609 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001610 if (haddr.buf && haddr.len > 8) {
1611 PyErr_SetString(PyExc_ValueError,
1612 "Hardware address must be 8 bytes or less");
1613 PyBuffer_Release(&haddr);
1614 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 }
1616 if (protoNumber < 0 || protoNumber > 0xffff) {
1617 PyErr_SetString(
1618 PyExc_OverflowError,
1619 "getsockaddrarg: protoNumber must be 0-65535.");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001620 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 return 0;
1622 }
1623 addr = (struct sockaddr_ll*)addr_ret;
1624 addr->sll_family = AF_PACKET;
1625 addr->sll_protocol = htons((short)protoNumber);
1626 addr->sll_ifindex = ifr.ifr_ifindex;
1627 addr->sll_pkttype = pkttype;
1628 addr->sll_hatype = hatype;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001629 if (haddr.buf) {
1630 memcpy(&addr->sll_addr, haddr.buf, haddr.len);
1631 addr->sll_halen = haddr.len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001633 else
1634 addr->sll_halen = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 *len_ret = sizeof *addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001636 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 return 1;
1638 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001639#endif
1640
Christian Heimes043d6f62008-01-07 17:19:16 +00001641#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 case AF_TIPC:
1643 {
1644 unsigned int atype, v1, v2, v3;
1645 unsigned int scope = TIPC_CLUSTER_SCOPE;
1646 struct sockaddr_tipc *addr;
Christian Heimes043d6f62008-01-07 17:19:16 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 if (!PyTuple_Check(args)) {
1649 PyErr_Format(
1650 PyExc_TypeError,
1651 "getsockaddrarg: "
1652 "AF_TIPC address must be tuple, not %.500s",
1653 Py_TYPE(args)->tp_name);
1654 return 0;
1655 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 if (!PyArg_ParseTuple(args,
1658 "IIII|I;Invalid TIPC address format",
1659 &atype, &v1, &v2, &v3, &scope))
1660 return 0;
Christian Heimes043d6f62008-01-07 17:19:16 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 addr = (struct sockaddr_tipc *) addr_ret;
1663 memset(addr, 0, sizeof(struct sockaddr_tipc));
Christian Heimes043d6f62008-01-07 17:19:16 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 addr->family = AF_TIPC;
1666 addr->scope = scope;
1667 addr->addrtype = atype;
Christian Heimes043d6f62008-01-07 17:19:16 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 if (atype == TIPC_ADDR_NAMESEQ) {
1670 addr->addr.nameseq.type = v1;
1671 addr->addr.nameseq.lower = v2;
1672 addr->addr.nameseq.upper = v3;
1673 } else if (atype == TIPC_ADDR_NAME) {
1674 addr->addr.name.name.type = v1;
1675 addr->addr.name.name.instance = v2;
1676 } else if (atype == TIPC_ADDR_ID) {
1677 addr->addr.id.node = v1;
1678 addr->addr.id.ref = v2;
1679 } else {
1680 /* Shouldn't happen */
1681 PyErr_SetString(PyExc_TypeError, "Invalid address type");
1682 return 0;
1683 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 *len_ret = sizeof(*addr);
Christian Heimes043d6f62008-01-07 17:19:16 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 return 1;
1688 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001689#endif
1690
Vinay Sajiped6783f2014-03-21 11:44:32 +00001691#if defined(AF_CAN) && defined(CAN_RAW) && defined(CAN_BCM)
Charles-François Natali47413c12011-10-06 19:47:44 +02001692 case AF_CAN:
1693 switch (s->sock_proto) {
1694 case CAN_RAW:
Charles-François Natali773e42d2013-02-05 19:42:01 +01001695 /* fall-through */
1696 case CAN_BCM:
Charles-François Natali47413c12011-10-06 19:47:44 +02001697 {
1698 struct sockaddr_can *addr;
1699 PyObject *interfaceName;
1700 struct ifreq ifr;
Charles-François Natali47413c12011-10-06 19:47:44 +02001701 Py_ssize_t len;
1702
Benjamin Peterson18b71912013-05-16 15:29:44 -05001703 addr = (struct sockaddr_can *)addr_ret;
1704
Charles-François Natali47413c12011-10-06 19:47:44 +02001705 if (!PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter,
1706 &interfaceName))
1707 return 0;
1708
1709 len = PyBytes_GET_SIZE(interfaceName);
1710
1711 if (len == 0) {
1712 ifr.ifr_ifindex = 0;
Victor Stinner1a62a682014-08-17 19:33:28 +02001713 } else if ((size_t)len < sizeof(ifr.ifr_name)) {
Christian Heimes15b68852012-09-10 01:25:50 +02001714 strncpy(ifr.ifr_name, PyBytes_AS_STRING(interfaceName), sizeof(ifr.ifr_name));
1715 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
Charles-François Natali47413c12011-10-06 19:47:44 +02001716 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1717 s->errorhandler();
1718 Py_DECREF(interfaceName);
1719 return 0;
1720 }
1721 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001722 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001723 "AF_CAN interface name too long");
1724 Py_DECREF(interfaceName);
1725 return 0;
1726 }
1727
1728 addr->can_family = AF_CAN;
1729 addr->can_ifindex = ifr.ifr_ifindex;
1730
1731 *len_ret = sizeof(*addr);
1732 Py_DECREF(interfaceName);
1733 return 1;
1734 }
1735 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001736 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001737 "getsockaddrarg: unsupported CAN protocol");
1738 return 0;
1739 }
1740#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001741
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001742#ifdef PF_SYSTEM
1743 case PF_SYSTEM:
1744 switch (s->sock_proto) {
1745#ifdef SYSPROTO_CONTROL
1746 case SYSPROTO_CONTROL:
1747 {
1748 struct sockaddr_ctl *addr;
Victor Stinnera534fc42013-06-03 22:07:27 +02001749
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001750 addr = (struct sockaddr_ctl *)addr_ret;
1751 addr->sc_family = AF_SYSTEM;
Victor Stinnera534fc42013-06-03 22:07:27 +02001752 addr->ss_sysaddr = AF_SYS_CONTROL;
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001753
1754 if (PyUnicode_Check(args)) {
1755 struct ctl_info info;
1756 PyObject *ctl_name;
1757
1758 if (!PyArg_Parse(args, "O&",
1759 PyUnicode_FSConverter, &ctl_name)) {
1760 return 0;
1761 }
1762
Victor Stinnerf50e1872015-03-20 11:32:24 +01001763 if (PyBytes_GET_SIZE(ctl_name) > (Py_ssize_t)sizeof(info.ctl_name)) {
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001764 PyErr_SetString(PyExc_ValueError,
1765 "provided string is too long");
1766 Py_DECREF(ctl_name);
1767 return 0;
1768 }
1769 strncpy(info.ctl_name, PyBytes_AS_STRING(ctl_name),
1770 sizeof(info.ctl_name));
1771 Py_DECREF(ctl_name);
1772
1773 if (ioctl(s->sock_fd, CTLIOCGINFO, &info)) {
1774 PyErr_SetString(PyExc_OSError,
1775 "cannot find kernel control with provided name");
1776 return 0;
1777 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001778
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001779 addr->sc_id = info.ctl_id;
1780 addr->sc_unit = 0;
1781 } else if (!PyArg_ParseTuple(args, "II",
1782 &(addr->sc_id), &(addr->sc_unit))) {
1783 PyErr_SetString(PyExc_TypeError, "getsockaddrarg: "
1784 "expected str or tuple of two ints");
Victor Stinnera534fc42013-06-03 22:07:27 +02001785
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001786 return 0;
1787 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001788
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001789 *len_ret = sizeof(*addr);
1790 return 1;
1791 }
1792#endif
1793 default:
1794 PyErr_SetString(PyExc_OSError,
1795 "getsockaddrarg: unsupported PF_SYSTEM protocol");
1796 return 0;
1797 }
1798#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001803 PyErr_SetString(PyExc_OSError, "getsockaddrarg: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 return 0;
Guido van Rossum30a685f1991-06-27 15:51:29 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001807}
1808
Guido van Rossum30a685f1991-06-27 15:51:29 +00001809
Guido van Rossum48a680c2001-03-02 06:34:14 +00001810/* Get the address length according to the socket object's address family.
Guido van Rossum710e1df1992-06-12 10:39:36 +00001811 Return 1 if the family is known, 0 otherwise. The length is returned
1812 through len_ret. */
1813
1814static int
Peter Schneider-Kamp618e25d2000-07-11 23:00:12 +00001815getsockaddrlen(PySocketSockObject *s, socklen_t *len_ret)
Guido van Rossum710e1df1992-06-12 10:39:36 +00001816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 switch (s->sock_family) {
Guido van Rossum710e1df1992-06-12 10:39:36 +00001818
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001819#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 case AF_UNIX:
1821 {
1822 *len_ret = sizeof (struct sockaddr_un);
1823 return 1;
1824 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001825#endif /* AF_UNIX */
Martin v. Löwis11017b12006-01-14 18:12:57 +00001826#if defined(AF_NETLINK)
1827 case AF_NETLINK:
1828 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 *len_ret = sizeof (struct sockaddr_nl);
1830 return 1;
Martin v. Löwis11017b12006-01-14 18:12:57 +00001831 }
1832#endif
Guido van Rossum710e1df1992-06-12 10:39:36 +00001833
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001834#ifdef AF_RDS
1835 case AF_RDS:
1836 /* RDS sockets use sockaddr_in: fall-through */
1837#endif
1838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 case AF_INET:
1840 {
1841 *len_ret = sizeof (struct sockaddr_in);
1842 return 1;
1843 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001844
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001845#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 case AF_INET6:
1847 {
1848 *len_ret = sizeof (struct sockaddr_in6);
1849 return 1;
1850 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001851#endif
1852
Hye-Shik Chang81268602004-02-02 06:05:24 +00001853#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 case AF_BLUETOOTH:
1855 {
1856 switch(s->sock_proto)
1857 {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 case BTPROTO_L2CAP:
1860 *len_ret = sizeof (struct sockaddr_l2);
1861 return 1;
1862 case BTPROTO_RFCOMM:
1863 *len_ret = sizeof (struct sockaddr_rc);
1864 return 1;
1865 case BTPROTO_HCI:
1866 *len_ret = sizeof (struct sockaddr_hci);
1867 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001868#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 case BTPROTO_SCO:
1870 *len_ret = sizeof (struct sockaddr_sco);
1871 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001872#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001874 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 "unknown BT protocol");
1876 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 }
1879 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001880#endif
1881
Martin v. Löwis1ba3fd52001-08-10 20:29:40 +00001882#ifdef HAVE_NETPACKET_PACKET_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 case AF_PACKET:
1884 {
1885 *len_ret = sizeof (struct sockaddr_ll);
1886 return 1;
1887 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001888#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001889
Christian Heimes043d6f62008-01-07 17:19:16 +00001890#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 case AF_TIPC:
1892 {
1893 *len_ret = sizeof (struct sockaddr_tipc);
1894 return 1;
1895 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001896#endif
1897
Vinay Sajipecfc98c2014-03-20 12:42:42 +00001898#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001899 case AF_CAN:
1900 {
1901 *len_ret = sizeof (struct sockaddr_can);
1902 return 1;
1903 }
1904#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001905
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001906#ifdef PF_SYSTEM
1907 case PF_SYSTEM:
1908 switch(s->sock_proto) {
1909#ifdef SYSPROTO_CONTROL
1910 case SYSPROTO_CONTROL:
1911 *len_ret = sizeof (struct sockaddr_ctl);
1912 return 1;
1913#endif
1914 default:
1915 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
1916 "unknown PF_SYSTEM protocol");
1917 return 0;
1918 }
1919#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 /* More cases here... */
Guido van Rossum710e1df1992-06-12 10:39:36 +00001922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001924 PyErr_SetString(PyExc_OSError, "getsockaddrlen: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 return 0;
Guido van Rossum710e1df1992-06-12 10:39:36 +00001926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001928}
1929
1930
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001931/* Support functions for the sendmsg() and recvmsg[_into]() methods.
1932 Currently, these methods are only compiled if the RFC 2292/3542
1933 CMSG_LEN() macro is available. Older systems seem to have used
1934 sizeof(struct cmsghdr) + (length) where CMSG_LEN() is used now, so
1935 it may be possible to define CMSG_LEN() that way if it's not
1936 provided. Some architectures might need extra padding after the
1937 cmsghdr, however, and CMSG_LEN() would have to take account of
1938 this. */
1939#ifdef CMSG_LEN
1940/* If length is in range, set *result to CMSG_LEN(length) and return
1941 true; otherwise, return false. */
1942static int
1943get_CMSG_LEN(size_t length, size_t *result)
1944{
1945 size_t tmp;
1946
1947 if (length > (SOCKLEN_T_LIMIT - CMSG_LEN(0)))
1948 return 0;
1949 tmp = CMSG_LEN(length);
1950 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1951 return 0;
1952 *result = tmp;
1953 return 1;
1954}
1955
1956#ifdef CMSG_SPACE
1957/* If length is in range, set *result to CMSG_SPACE(length) and return
1958 true; otherwise, return false. */
1959static int
1960get_CMSG_SPACE(size_t length, size_t *result)
1961{
1962 size_t tmp;
1963
1964 /* Use CMSG_SPACE(1) here in order to take account of the padding
1965 necessary before *and* after the data. */
1966 if (length > (SOCKLEN_T_LIMIT - CMSG_SPACE(1)))
1967 return 0;
1968 tmp = CMSG_SPACE(length);
1969 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1970 return 0;
1971 *result = tmp;
1972 return 1;
1973}
1974#endif
1975
1976/* Return true iff msg->msg_controllen is valid, cmsgh is a valid
1977 pointer in msg->msg_control with at least "space" bytes after it,
1978 and its cmsg_len member inside the buffer. */
1979static int
1980cmsg_min_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t space)
1981{
1982 size_t cmsg_offset;
1983 static const size_t cmsg_len_end = (offsetof(struct cmsghdr, cmsg_len) +
1984 sizeof(cmsgh->cmsg_len));
1985
Charles-François Natali466517d2011-08-28 18:23:43 +02001986 /* Note that POSIX allows msg_controllen to be of signed type. */
Brett Cannonb05cbe62014-01-07 17:01:01 -05001987 if (cmsgh == NULL || msg->msg_control == NULL)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001988 return 0;
Brett Cannonb05cbe62014-01-07 17:01:01 -05001989 /* Note that POSIX allows msg_controllen to be of a signed type. This is
1990 annoying under OS X as it's unsigned there and so it triggers a
1991 tautological comparison warning under Clang when compared against 0.
1992 Since the check is valid on other platforms, silence the warning under
1993 Clang. */
1994 #ifdef __clang__
1995 #pragma clang diagnostic push
1996 #pragma clang diagnostic ignored "-Wtautological-compare"
1997 #endif
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02001998 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02001999 #pragma GCC diagnostic push
2000 #pragma GCC diagnostic ignored "-Wtype-limits"
2001 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002002 if (msg->msg_controllen < 0)
2003 return 0;
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02002004 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02002005 #pragma GCC diagnostic pop
2006 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002007 #ifdef __clang__
2008 #pragma clang diagnostic pop
2009 #endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002010 if (space < cmsg_len_end)
2011 space = cmsg_len_end;
2012 cmsg_offset = (char *)cmsgh - (char *)msg->msg_control;
2013 return (cmsg_offset <= (size_t)-1 - space &&
2014 cmsg_offset + space <= msg->msg_controllen);
2015}
2016
2017/* If pointer CMSG_DATA(cmsgh) is in buffer msg->msg_control, set
2018 *space to number of bytes following it in the buffer and return
2019 true; otherwise, return false. Assumes cmsgh, msg->msg_control and
2020 msg->msg_controllen are valid. */
2021static int
2022get_cmsg_data_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *space)
2023{
2024 size_t data_offset;
2025 char *data_ptr;
2026
2027 if ((data_ptr = (char *)CMSG_DATA(cmsgh)) == NULL)
2028 return 0;
2029 data_offset = data_ptr - (char *)msg->msg_control;
2030 if (data_offset > msg->msg_controllen)
2031 return 0;
2032 *space = msg->msg_controllen - data_offset;
2033 return 1;
2034}
2035
2036/* If cmsgh is invalid or not contained in the buffer pointed to by
2037 msg->msg_control, return -1. If cmsgh is valid and its associated
2038 data is entirely contained in the buffer, set *data_len to the
2039 length of the associated data and return 0. If only part of the
2040 associated data is contained in the buffer but cmsgh is otherwise
2041 valid, set *data_len to the length contained in the buffer and
2042 return 1. */
2043static int
2044get_cmsg_data_len(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *data_len)
2045{
2046 size_t space, cmsg_data_len;
2047
2048 if (!cmsg_min_space(msg, cmsgh, CMSG_LEN(0)) ||
2049 cmsgh->cmsg_len < CMSG_LEN(0))
2050 return -1;
2051 cmsg_data_len = cmsgh->cmsg_len - CMSG_LEN(0);
2052 if (!get_cmsg_data_space(msg, cmsgh, &space))
2053 return -1;
2054 if (space >= cmsg_data_len) {
2055 *data_len = cmsg_data_len;
2056 return 0;
2057 }
2058 *data_len = space;
2059 return 1;
2060}
2061#endif /* CMSG_LEN */
2062
2063
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002064/* s._accept() -> (fd, address) */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002065
Guido van Rossum73624e91994-10-10 17:59:00 +00002066static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002067sock_accept(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002068{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002069 sock_addr_t addrbuf;
2070 SOCKET_T newfd = INVALID_SOCKET;
2071 socklen_t addrlen;
2072 PyObject *sock = NULL;
2073 PyObject *addr = NULL;
2074 PyObject *res = NULL;
2075 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002076 int async_err = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02002077#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2078 /* accept4() is available on Linux 2.6.28+ and glibc 2.10 */
2079 static int accept4_works = -1;
2080#endif
2081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 if (!getsockaddrlen(s, &addrlen))
2083 return NULL;
2084 memset(&addrbuf, 0, addrlen);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 if (!IS_SELECTABLE(s))
2087 return select_error();
Neal Norwitz082b2df2006-02-07 07:04:46 +00002088
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002089 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002090 do {
Victor Stinner391fa712015-03-31 13:15:31 +02002091 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002092
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002093 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002094 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02002095#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002096 if (accept4_works != 0) {
2097 newfd = accept4(s->sock_fd, SAS2SA(&addrbuf), &addrlen,
2098 SOCK_CLOEXEC);
2099 if (newfd == INVALID_SOCKET && accept4_works == -1) {
2100 /* On Linux older than 2.6.28, accept4() fails with ENOSYS */
2101 accept4_works = (errno != ENOSYS);
2102 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02002103 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002104 if (accept4_works == 0)
2105 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
Victor Stinnerdaf45552013-08-28 00:53:59 +02002106#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002107 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
Victor Stinnerdaf45552013-08-28 00:53:59 +02002108#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002109 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002110 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002111 } while (newfd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002112 if (timeout == 1) {
2113 PyErr_SetString(socket_timeout, "timed out");
2114 return NULL;
2115 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002116 END_SELECT_LOOP(s)
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 if (newfd == INVALID_SOCKET)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002119 return (!async_err) ? s->errorhandler() : NULL;
Barry Warsaw752300b1997-01-03 17:18:10 +00002120
Victor Stinnerdaf45552013-08-28 00:53:59 +02002121#ifdef MS_WINDOWS
2122 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
2123 PyErr_SetFromWindowsErr(0);
2124 SOCKETCLOSE(newfd);
2125 goto finally;
2126 }
2127#else
2128
2129#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2130 if (!accept4_works)
2131#endif
2132 {
2133 if (_Py_set_inheritable(newfd, 0, NULL) < 0) {
2134 SOCKETCLOSE(newfd);
2135 goto finally;
2136 }
2137 }
2138#endif
2139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 sock = PyLong_FromSocket_t(newfd);
2141 if (sock == NULL) {
2142 SOCKETCLOSE(newfd);
2143 goto finally;
2144 }
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2147 addrlen, s->sock_proto);
2148 if (addr == NULL)
2149 goto finally;
Barry Warsaw752300b1997-01-03 17:18:10 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 res = PyTuple_Pack(2, sock, addr);
Barry Warsaw752300b1997-01-03 17:18:10 +00002152
Guido van Rossum67f7a382002-06-06 21:08:16 +00002153finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 Py_XDECREF(sock);
2155 Py_XDECREF(addr);
2156 return res;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002157}
2158
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002159PyDoc_STRVAR(accept_doc,
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002160"_accept() -> (integer, address info)\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002161\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002162Wait for an incoming connection. Return a new socket file descriptor\n\
2163representing the connection, and the address of the client.\n\
2164For IP sockets, the address info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002165
Guido van Rossum11ba0942002-06-13 15:07:44 +00002166/* s.setblocking(flag) method. Argument:
2167 False -- non-blocking mode; same as settimeout(0)
2168 True -- blocking mode; same as settimeout(None)
2169*/
Guido van Rossume4485b01994-09-07 14:32:49 +00002170
Guido van Rossum73624e91994-10-10 17:59:00 +00002171static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002172sock_setblocking(PySocketSockObject *s, PyObject *arg)
Guido van Rossume4485b01994-09-07 14:32:49 +00002173{
Serhiy Storchaka78980432013-01-15 01:12:17 +02002174 long block;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 block = PyLong_AsLong(arg);
2177 if (block == -1 && PyErr_Occurred())
2178 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002179
Victor Stinner71694d52015-03-28 01:18:54 +01002180 s->sock_timeout = block ? -1 : 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 internal_setblocking(s, block);
Guido van Rossume4485b01994-09-07 14:32:49 +00002182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 Py_INCREF(Py_None);
2184 return Py_None;
Guido van Rossume4485b01994-09-07 14:32:49 +00002185}
Guido van Rossume4485b01994-09-07 14:32:49 +00002186
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002187PyDoc_STRVAR(setblocking_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002188"setblocking(flag)\n\
2189\n\
2190Set the socket to blocking (flag is true) or non-blocking (false).\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002191setblocking(True) is equivalent to settimeout(None);\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002192setblocking(False) is equivalent to settimeout(0.0).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002193
Victor Stinner71694d52015-03-28 01:18:54 +01002194static int
2195socket_parse_timeout(_PyTime_t *timeout, PyObject *timeout_obj)
2196{
2197#ifdef MS_WINDOWS
2198 struct timeval tv;
2199#endif
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002200#ifndef HAVE_POLL
2201 _PyTime_t ms;
2202#endif
Victor Stinner71694d52015-03-28 01:18:54 +01002203 int overflow = 0;
2204
2205 if (timeout_obj == Py_None) {
2206 *timeout = -1;
2207 return 0;
2208 }
2209
Victor Stinner869e1772015-03-30 03:49:14 +02002210 if (_PyTime_FromSecondsObject(timeout,
2211 timeout_obj, _PyTime_ROUND_CEILING) < 0)
Victor Stinner71694d52015-03-28 01:18:54 +01002212 return -1;
2213
2214 if (*timeout < 0) {
2215 PyErr_SetString(PyExc_ValueError, "Timeout value out of range");
2216 return -1;
2217 }
2218
2219#ifdef MS_WINDOWS
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002220 overflow |= (_PyTime_AsTimeval(*timeout, &tv, _PyTime_ROUND_CEILING) < 0);
Victor Stinner71694d52015-03-28 01:18:54 +01002221#endif
2222#ifndef HAVE_POLL
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002223 ms = _PyTime_AsMilliseconds(*timeout, _PyTime_ROUND_CEILING);
2224 overflow |= (ms > INT_MAX);
Victor Stinner71694d52015-03-28 01:18:54 +01002225#endif
2226 if (overflow) {
2227 PyErr_SetString(PyExc_OverflowError,
2228 "timeout doesn't fit into C timeval");
2229 return -1;
2230 }
2231
2232 return 0;
2233}
2234
Guido van Rossum11ba0942002-06-13 15:07:44 +00002235/* s.settimeout(timeout) method. Argument:
2236 None -- no timeout, blocking mode; same as setblocking(True)
2237 0.0 -- non-blocking mode; same as setblocking(False)
2238 > 0 -- timeout mode; operations time out after timeout seconds
2239 < 0 -- illegal; raises an exception
2240*/
Guido van Rossum67f7a382002-06-06 21:08:16 +00002241static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002242sock_settimeout(PySocketSockObject *s, PyObject *arg)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002243{
Victor Stinner71694d52015-03-28 01:18:54 +01002244 _PyTime_t timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002245
Victor Stinner71694d52015-03-28 01:18:54 +01002246 if (socket_parse_timeout(&timeout, arg) < 0)
2247 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 s->sock_timeout = timeout;
Victor Stinner71694d52015-03-28 01:18:54 +01002250 internal_setblocking(s, timeout < 0);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 Py_INCREF(Py_None);
2253 return Py_None;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002254}
2255
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002256PyDoc_STRVAR(settimeout_doc,
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002257"settimeout(timeout)\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002258\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002259Set a timeout on socket operations. 'timeout' can be a float,\n\
2260giving in seconds, or None. Setting a timeout of None disables\n\
2261the timeout feature and is equivalent to setblocking(1).\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002262Setting a timeout of zero is the same as setblocking(0).");
Guido van Rossum67f7a382002-06-06 21:08:16 +00002263
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002264/* s.gettimeout() method.
2265 Returns the timeout associated with a socket. */
Guido van Rossum67f7a382002-06-06 21:08:16 +00002266static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002267sock_gettimeout(PySocketSockObject *s)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002268{
Victor Stinner71694d52015-03-28 01:18:54 +01002269 if (s->sock_timeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 Py_INCREF(Py_None);
2271 return Py_None;
2272 }
Victor Stinner71694d52015-03-28 01:18:54 +01002273 else {
2274 double seconds = _PyTime_AsSecondsDouble(s->sock_timeout);
2275 return PyFloat_FromDouble(seconds);
2276 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002277}
2278
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002279PyDoc_STRVAR(gettimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002280"gettimeout() -> timeout\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002281\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03002282Returns the timeout in seconds (float) associated with socket \n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002283operations. A timeout of None indicates that timeouts on socket \n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002284operations are disabled.");
Guido van Rossume4485b01994-09-07 14:32:49 +00002285
Guido van Rossumaee08791992-09-08 09:05:33 +00002286/* s.setsockopt() method.
2287 With an integer third argument, sets an integer option.
2288 With a string third argument, sets an option from a buffer;
2289 use optional built-in module 'struct' to encode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002290
Guido van Rossum73624e91994-10-10 17:59:00 +00002291static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002292sock_setsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 int level;
2295 int optname;
2296 int res;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002297 Py_buffer optval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 int flag;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 if (PyArg_ParseTuple(args, "iii:setsockopt",
2301 &level, &optname, &flag)) {
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002302 res = setsockopt(s->sock_fd, level, optname,
2303 (char*)&flag, sizeof flag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002304 }
2305 else {
2306 PyErr_Clear();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002307 if (!PyArg_ParseTuple(args, "iiy*:setsockopt",
2308 &level, &optname, &optval))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 return NULL;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002310 res = setsockopt(s->sock_fd, level, optname, optval.buf, optval.len);
2311 PyBuffer_Release(&optval);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002312 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 if (res < 0)
2314 return s->errorhandler();
2315 Py_INCREF(Py_None);
2316 return Py_None;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002317}
2318
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002319PyDoc_STRVAR(setsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002320"setsockopt(level, option, value)\n\
2321\n\
2322Set a socket option. See the Unix manual for level and option.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002323The value argument can either be an integer or a string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002324
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002325
Guido van Rossumaee08791992-09-08 09:05:33 +00002326/* s.getsockopt() method.
2327 With two arguments, retrieves an integer option.
2328 With a third integer argument, retrieves a string buffer of that size;
2329 use optional built-in module 'struct' to decode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002330
Guido van Rossum73624e91994-10-10 17:59:00 +00002331static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002332sock_getsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002333{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 int level;
2335 int optname;
2336 int res;
2337 PyObject *buf;
2338 socklen_t buflen = 0;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 if (!PyArg_ParseTuple(args, "ii|i:getsockopt",
2341 &level, &optname, &buflen))
2342 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 if (buflen == 0) {
2345 int flag = 0;
2346 socklen_t flagsize = sizeof flag;
2347 res = getsockopt(s->sock_fd, level, optname,
2348 (void *)&flag, &flagsize);
2349 if (res < 0)
2350 return s->errorhandler();
2351 return PyLong_FromLong(flag);
2352 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 if (buflen <= 0 || buflen > 1024) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002354 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 "getsockopt buflen out of range");
2356 return NULL;
2357 }
2358 buf = PyBytes_FromStringAndSize((char *)NULL, buflen);
2359 if (buf == NULL)
2360 return NULL;
2361 res = getsockopt(s->sock_fd, level, optname,
2362 (void *)PyBytes_AS_STRING(buf), &buflen);
2363 if (res < 0) {
2364 Py_DECREF(buf);
2365 return s->errorhandler();
2366 }
2367 _PyBytes_Resize(&buf, buflen);
2368 return buf;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002369}
2370
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002371PyDoc_STRVAR(getsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002372"getsockopt(level, option[, buffersize]) -> value\n\
2373\n\
2374Get a socket option. See the Unix manual for level and option.\n\
2375If a nonzero buffersize argument is given, the return value is a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002376string of that length; otherwise it is an integer.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002377
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002378
Fred Drake728819a2000-07-01 03:40:12 +00002379/* s.bind(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002380
Guido van Rossum73624e91994-10-10 17:59:00 +00002381static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002382sock_bind(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 sock_addr_t addrbuf;
2385 int addrlen;
2386 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2389 return NULL;
2390 Py_BEGIN_ALLOW_THREADS
2391 res = bind(s->sock_fd, SAS2SA(&addrbuf), addrlen);
2392 Py_END_ALLOW_THREADS
2393 if (res < 0)
2394 return s->errorhandler();
2395 Py_INCREF(Py_None);
2396 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002397}
2398
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002399PyDoc_STRVAR(bind_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002400"bind(address)\n\
2401\n\
2402Bind the socket to a local address. For IP sockets, the address is a\n\
Jeremy Hylton22308652001-02-02 03:23:09 +00002403pair (host, port); the host must refer to the local host. For raw packet\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002404sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002405
Guido van Rossum30a685f1991-06-27 15:51:29 +00002406
2407/* s.close() method.
2408 Set the file descriptor to -1 so operations tried subsequently
2409 will surely fail. */
2410
Guido van Rossum73624e91994-10-10 17:59:00 +00002411static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002412sock_close(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 SOCKET_T fd;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002415
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002416 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
2417 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
2418 * for more details.
2419 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 if ((fd = s->sock_fd) != -1) {
2421 s->sock_fd = -1;
2422 Py_BEGIN_ALLOW_THREADS
2423 (void) SOCKETCLOSE(fd);
2424 Py_END_ALLOW_THREADS
2425 }
2426 Py_INCREF(Py_None);
2427 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002428}
2429
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002430PyDoc_STRVAR(close_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002431"close()\n\
2432\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002433Close the socket. It cannot be used after this call.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002434
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002435static PyObject *
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002436sock_detach(PySocketSockObject *s)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002437{
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002438 SOCKET_T fd = s->sock_fd;
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002439 s->sock_fd = -1;
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002440 return PyLong_FromSocket_t(fd);
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002441}
2442
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002443PyDoc_STRVAR(detach_doc,
2444"detach()\n\
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002445\n\
Guido van Rossum638aebd2013-12-04 11:50:09 -08002446Close the socket object without closing the underlying file descriptor.\n\
2447The object cannot be used after this call, but the file descriptor\n\
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002448can be reused for other purposes. The file descriptor is returned.");
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002449
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002450static int
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002451internal_connect(PySocketSockObject *s, struct sockaddr *addr, int addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 int *timeoutp)
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002453{
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002454#ifdef MS_WINDOWS
2455# define GET_ERROR WSAGetLastError()
2456# define IN_PROGRESS_ERR WSAEWOULDBLOCK
2457# define TIMEOUT_ERR WSAEWOULDBLOCK
2458#else
2459# define GET_ERROR errno
2460# define IN_PROGRESS_ERR EINPROGRESS
2461# define TIMEOUT_ERR EWOULDBLOCK
2462#endif
2463
2464 int res, err, in_progress, timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 timeout = 0;
Victor Stinnerb7df3142015-03-27 22:59:32 +01002467
2468 Py_BEGIN_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 res = connect(s->sock_fd, addr, addrlen);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002470 Py_END_ALLOW_THREADS
2471
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002472 if (res < 0)
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002473 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002474 else
2475 err = res;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002476 in_progress = (err == IN_PROGRESS_ERR);
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002477
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002478 if (s->sock_timeout > 0 && in_progress && IS_SELECTABLE(s)) {
Victor Stinnere6951c62015-03-31 13:50:44 +02002479 timeout = internal_connect_select(s);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002480
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002481 if (timeout == 1) {
2482 /* timed out */
2483 err = TIMEOUT_ERR;
2484 }
2485 else if (timeout == 0) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002486 socklen_t res_size = sizeof res;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002487 if (!getsockopt(s->sock_fd, SOL_SOCKET, SO_ERROR,
Victor Stinnerc4e819a2015-03-31 21:23:10 +02002488 (void *)&res, &res_size)) {
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002489 if (res == EISCONN)
2490 res = 0;
2491 err = res;
2492 }
2493 else {
2494 /* getsockopt() failed */
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002495 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002496 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 }
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002498 else {
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002499 /* select() failed */
2500 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002501 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 *timeoutp = timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002504
Victor Stinneree699e92015-03-31 21:28:42 +02002505 if (err == EINTR && PyErr_CheckSignals())
2506 return -1;
2507
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002508 assert(err >= 0);
2509 return err;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002510
2511#undef GET_ERROR
2512#undef IN_PROGRESS_ERR
2513#undef TIMEOUT_ERR
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002514}
Guido van Rossum30a685f1991-06-27 15:51:29 +00002515
Fred Drake728819a2000-07-01 03:40:12 +00002516/* s.connect(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002517
Guido van Rossum73624e91994-10-10 17:59:00 +00002518static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002519sock_connect(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002520{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 sock_addr_t addrbuf;
2522 int addrlen;
2523 int res;
2524 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2527 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Victor Stinneree699e92015-03-31 21:28:42 +02002530 if (res < 0)
2531 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 if (timeout == 1) {
2534 PyErr_SetString(socket_timeout, "timed out");
2535 return NULL;
2536 }
Victor Stinneree699e92015-03-31 21:28:42 +02002537
Victor Stinner71694d52015-03-28 01:18:54 +01002538 if (res != 0) {
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002539#ifdef MS_WINDOWS
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002540 WSASetLastError(res);
2541#else
2542 errno = res;
2543#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 return s->errorhandler();
Victor Stinner71694d52015-03-28 01:18:54 +01002545 }
Victor Stinneree699e92015-03-31 21:28:42 +02002546
2547 Py_RETURN_NONE;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002548}
2549
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002550PyDoc_STRVAR(connect_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002551"connect(address)\n\
2552\n\
2553Connect the socket to a remote address. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002554is a pair (host, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002555
Guido van Rossum30a685f1991-06-27 15:51:29 +00002556
Fred Drake728819a2000-07-01 03:40:12 +00002557/* s.connect_ex(sockaddr) method */
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002558
2559static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002560sock_connect_ex(PySocketSockObject *s, PyObject *addro)
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 sock_addr_t addrbuf;
2563 int addrlen;
2564 int res;
2565 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2568 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Victor Stinner71694d52015-03-28 01:18:54 +01002571 if (res < 0)
2572 return NULL;
2573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 return PyLong_FromLong((long) res);
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002575}
2576
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002577PyDoc_STRVAR(connect_ex_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002578"connect_ex(address) -> errno\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002579\n\
2580This is like connect(address), but returns an error code (the errno value)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002581instead of raising an exception when an error occurs.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002582
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002583
Guido van Rossumed233a51992-06-23 09:07:03 +00002584/* s.fileno() method */
2585
Guido van Rossum73624e91994-10-10 17:59:00 +00002586static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002587sock_fileno(PySocketSockObject *s)
Guido van Rossumed233a51992-06-23 09:07:03 +00002588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 return PyLong_FromSocket_t(s->sock_fd);
Guido van Rossumed233a51992-06-23 09:07:03 +00002590}
2591
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002592PyDoc_STRVAR(fileno_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002593"fileno() -> integer\n\
2594\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002595Return the integer file descriptor of the socket.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002596
Guido van Rossumed233a51992-06-23 09:07:03 +00002597
Guido van Rossumc89705d1992-11-26 08:54:07 +00002598/* s.getsockname() method */
2599
Guido van Rossum73624e91994-10-10 17:59:00 +00002600static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002601sock_getsockname(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 sock_addr_t addrbuf;
2604 int res;
2605 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 if (!getsockaddrlen(s, &addrlen))
2608 return NULL;
2609 memset(&addrbuf, 0, addrlen);
2610 Py_BEGIN_ALLOW_THREADS
2611 res = getsockname(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2612 Py_END_ALLOW_THREADS
2613 if (res < 0)
2614 return s->errorhandler();
2615 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2616 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002617}
2618
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002619PyDoc_STRVAR(getsockname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002620"getsockname() -> address info\n\
2621\n\
2622Return the address of the local endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002623info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002624
Guido van Rossumc89705d1992-11-26 08:54:07 +00002625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626#ifdef HAVE_GETPEERNAME /* Cray APP doesn't have this :-( */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002627/* s.getpeername() method */
2628
Guido van Rossum73624e91994-10-10 17:59:00 +00002629static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002630sock_getpeername(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002631{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 sock_addr_t addrbuf;
2633 int res;
2634 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 if (!getsockaddrlen(s, &addrlen))
2637 return NULL;
2638 memset(&addrbuf, 0, addrlen);
2639 Py_BEGIN_ALLOW_THREADS
2640 res = getpeername(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2641 Py_END_ALLOW_THREADS
2642 if (res < 0)
2643 return s->errorhandler();
2644 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2645 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002646}
Guido van Rossum82a5c661998-07-07 20:45:43 +00002647
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002648PyDoc_STRVAR(getpeername_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002649"getpeername() -> address info\n\
2650\n\
2651Return the address of the remote endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002652info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002653
Guido van Rossumb6775db1994-08-01 11:34:53 +00002654#endif /* HAVE_GETPEERNAME */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002655
2656
Guido van Rossum30a685f1991-06-27 15:51:29 +00002657/* s.listen(n) method */
2658
Guido van Rossum73624e91994-10-10 17:59:00 +00002659static PyObject *
Charles-François Natali644b8f52014-05-22 19:45:39 +01002660sock_listen(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002661{
Charles-François Natali644b8f52014-05-22 19:45:39 +01002662 /* We try to choose a default backlog high enough to avoid connection drops
2663 * for common workloads, yet not too high to limit resource usage. */
2664 int backlog = Py_MIN(SOMAXCONN, 128);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002665 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002666
Charles-François Natali644b8f52014-05-22 19:45:39 +01002667 if (!PyArg_ParseTuple(args, "|i:listen", &backlog))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 return NULL;
Charles-François Natali644b8f52014-05-22 19:45:39 +01002669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002671 /* To avoid problems on systems that don't allow a negative backlog
2672 * (which doesn't make sense anyway) we force a minimum value of 0. */
2673 if (backlog < 0)
2674 backlog = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 res = listen(s->sock_fd, backlog);
2676 Py_END_ALLOW_THREADS
2677 if (res < 0)
2678 return s->errorhandler();
2679 Py_INCREF(Py_None);
2680 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002681}
2682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002683PyDoc_STRVAR(listen_doc,
Charles-François Natali644b8f52014-05-22 19:45:39 +01002684"listen([backlog])\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002685\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002686Enable a server to accept connections. If backlog is specified, it must be\n\
2687at least 0 (if it is lower, it is set to 0); it specifies the number of\n\
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002688unaccepted connections that the system will allow before refusing new\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002689connections. If not specified, a default reasonable value is chosen.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002690
2691
Thomas Wouters477c8d52006-05-27 19:21:47 +00002692/*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002693 * This is the guts of the recv() and recv_into() methods, which reads into a
Thomas Wouters902d6eb2007-01-09 23:18:33 +00002694 * char buffer. If you have any inc/dec ref to do to the objects that contain
Thomas Wouters477c8d52006-05-27 19:21:47 +00002695 * the buffer, do it in the caller. This function returns the number of bytes
Ezio Melotti13925002011-03-16 11:05:33 +02002696 * successfully read. If there was an error, it returns -1. Note that it is
Thomas Wouters477c8d52006-05-27 19:21:47 +00002697 * also possible that we return a number of bytes smaller than the request
2698 * bytes.
2699 */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002700
Antoine Pitrou19467d22010-08-17 19:33:30 +00002701static Py_ssize_t
2702sock_recv_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002703{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002704 Py_ssize_t outlen = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002706 int async_err = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 if (!IS_SELECTABLE(s)) {
2709 select_error();
2710 return -1;
2711 }
2712 if (len == 0) {
2713 /* If 0 bytes were requested, do nothing. */
2714 return 0;
2715 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002716
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002717 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002718 do {
Victor Stinner391fa712015-03-31 13:15:31 +02002719 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002720
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002721 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002722 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02002723#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002724 if (len > INT_MAX)
2725 len = INT_MAX;
2726 outlen = recv(s->sock_fd, cbuf, (int)len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002727#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002728 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002729#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002730 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002731 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002732 } while (outlen < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Thomas Wouters477c8d52006-05-27 19:21:47 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 if (timeout == 1) {
2735 PyErr_SetString(socket_timeout, "timed out");
2736 return -1;
2737 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002738 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 if (outlen < 0) {
2740 /* Note: the call to errorhandler() ALWAYS indirectly returned
2741 NULL, so ignore its return value */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002742 if (!async_err)
2743 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002744 return -1;
2745 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 return outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002747}
2748
Guido van Rossum48a680c2001-03-02 06:34:14 +00002749
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00002750/* s.recv(nbytes [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002751
Guido van Rossum73624e91994-10-10 17:59:00 +00002752static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002753sock_recv(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00002754{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002755 Py_ssize_t recvlen, outlen;
2756 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 PyObject *buf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002758
Antoine Pitrou19467d22010-08-17 19:33:30 +00002759 if (!PyArg_ParseTuple(args, "n|i:recv", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 if (recvlen < 0) {
2763 PyErr_SetString(PyExc_ValueError,
2764 "negative buffersize in recv");
2765 return NULL;
2766 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 /* Allocate a new string. */
2769 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2770 if (buf == NULL)
2771 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 /* Call the guts */
2774 outlen = sock_recv_guts(s, PyBytes_AS_STRING(buf), recvlen, flags);
2775 if (outlen < 0) {
2776 /* An error occurred, release the string and return an
2777 error. */
2778 Py_DECREF(buf);
2779 return NULL;
2780 }
2781 if (outlen != recvlen) {
2782 /* We did not read as many bytes as we anticipated, resize the
2783 string if possible and be successful. */
2784 _PyBytes_Resize(&buf, outlen);
2785 }
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00002786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 return buf;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002788}
2789
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002790PyDoc_STRVAR(recv_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002791"recv(buffersize[, flags]) -> data\n\
2792\n\
2793Receive up to buffersize bytes from the socket. For the optional flags\n\
2794argument, see the Unix manual. When no data is available, block until\n\
2795at least one byte is available or until the remote end is closed. When\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002796the remote end is closed and all data is read, return the empty string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002797
Guido van Rossum30a685f1991-06-27 15:51:29 +00002798
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002799/* s.recv_into(buffer, [nbytes [,flags]]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002800
Thomas Wouters477c8d52006-05-27 19:21:47 +00002801static PyObject*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002802sock_recv_into(PySocketSockObject *s, PyObject *args, PyObject *kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002803{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002805
Antoine Pitrou19467d22010-08-17 19:33:30 +00002806 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 Py_buffer pbuf;
2808 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002809 Py_ssize_t buflen, readlen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002810
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 /* Get the buffer's memory */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002812 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recv_into", kwlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 &pbuf, &recvlen, &flags))
2814 return NULL;
2815 buf = pbuf.buf;
2816 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 if (recvlen < 0) {
2819 PyBuffer_Release(&pbuf);
2820 PyErr_SetString(PyExc_ValueError,
2821 "negative buffersize in recv_into");
2822 return NULL;
2823 }
2824 if (recvlen == 0) {
2825 /* If nbytes was not specified, use the buffer's length */
2826 recvlen = buflen;
2827 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002829 /* Check if the buffer is large enough */
2830 if (buflen < recvlen) {
2831 PyBuffer_Release(&pbuf);
2832 PyErr_SetString(PyExc_ValueError,
2833 "buffer too small for requested bytes");
2834 return NULL;
2835 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002837 /* Call the guts */
2838 readlen = sock_recv_guts(s, buf, recvlen, flags);
2839 if (readlen < 0) {
2840 /* Return an error. */
2841 PyBuffer_Release(&pbuf);
2842 return NULL;
2843 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 PyBuffer_Release(&pbuf);
2846 /* Return the number of bytes read. Note that we do not do anything
2847 special here in the case that readlen < recvlen. */
2848 return PyLong_FromSsize_t(readlen);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002849}
2850
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002851PyDoc_STRVAR(recv_into_doc,
2852"recv_into(buffer, [nbytes[, flags]]) -> nbytes_read\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002853\n\
2854A version of recv() that stores its data into a buffer rather than creating \n\
2855a new string. Receive up to buffersize bytes from the socket. If buffersize \n\
2856is not specified (or 0), receive up to the size available in the given buffer.\n\
2857\n\
2858See recv() for documentation about the flags.");
2859
2860
2861/*
Christian Heimes99170a52007-12-19 02:07:34 +00002862 * This is the guts of the recvfrom() and recvfrom_into() methods, which reads
2863 * into a char buffer. If you have any inc/def ref to do to the objects that
2864 * contain the buffer, do it in the caller. This function returns the number
Ezio Melotti13925002011-03-16 11:05:33 +02002865 * of bytes successfully read. If there was an error, it returns -1. Note
Christian Heimes99170a52007-12-19 02:07:34 +00002866 * that it is also possible that we return a number of bytes smaller than the
2867 * request bytes.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002868 *
2869 * 'addr' is a return value for the address object. Note that you must decref
2870 * it yourself.
2871 */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002872static Py_ssize_t
2873sock_recvfrom_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 PyObject** addr)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 sock_addr_t addrbuf;
2877 int timeout;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002878 Py_ssize_t n = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002879 socklen_t addrlen;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002880 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002881
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002882 *addr = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 if (!getsockaddrlen(s, &addrlen))
2885 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 if (!IS_SELECTABLE(s)) {
2888 select_error();
2889 return -1;
2890 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00002891
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002892 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002893 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002894 memset(&addrbuf, 0, addrlen);
Victor Stinner391fa712015-03-31 13:15:31 +02002895 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002896
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002897 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002898 Py_BEGIN_ALLOW_THREADS
Victor Stinnere990c6e2013-11-16 00:18:58 +01002899#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002900 if (len > INT_MAX)
2901 len = INT_MAX;
2902 n = recvfrom(s->sock_fd, cbuf, (int)len, flags,
2903 (void *) &addrbuf, &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002904#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002905 n = recvfrom(s->sock_fd, cbuf, len, flags,
2906 SAS2SA(&addrbuf), &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002907#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002908 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002909 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002910 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00002911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002912 if (timeout == 1) {
2913 PyErr_SetString(socket_timeout, "timed out");
2914 return -1;
2915 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002916 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002918 if (!async_err)
2919 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 return -1;
2921 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 if (!(*addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2924 addrlen, s->sock_proto)))
2925 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 return n;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002928}
2929
2930/* s.recvfrom(nbytes [,flags]) method */
2931
2932static PyObject *
2933sock_recvfrom(PySocketSockObject *s, PyObject *args)
2934{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 PyObject *buf = NULL;
2936 PyObject *addr = NULL;
2937 PyObject *ret = NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002938 int flags = 0;
2939 Py_ssize_t recvlen, outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002940
Antoine Pitrou19467d22010-08-17 19:33:30 +00002941 if (!PyArg_ParseTuple(args, "n|i:recvfrom", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002942 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 if (recvlen < 0) {
2945 PyErr_SetString(PyExc_ValueError,
2946 "negative buffersize in recvfrom");
2947 return NULL;
2948 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2951 if (buf == NULL)
2952 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 outlen = sock_recvfrom_guts(s, PyBytes_AS_STRING(buf),
2955 recvlen, flags, &addr);
2956 if (outlen < 0) {
2957 goto finally;
2958 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 if (outlen != recvlen) {
2961 /* We did not read as many bytes as we anticipated, resize the
Ezio Melotti13925002011-03-16 11:05:33 +02002962 string if possible and be successful. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 if (_PyBytes_Resize(&buf, outlen) < 0)
Ezio Melotti13925002011-03-16 11:05:33 +02002964 /* Oopsy, not so successful after all. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002965 goto finally;
2966 }
Barry Warsaw752300b1997-01-03 17:18:10 +00002967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 ret = PyTuple_Pack(2, buf, addr);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002969
2970finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002971 Py_XDECREF(buf);
2972 Py_XDECREF(addr);
2973 return ret;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002974}
2975
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002976PyDoc_STRVAR(recvfrom_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002977"recvfrom(buffersize[, flags]) -> (data, address info)\n\
2978\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002979Like recv(buffersize, flags) but also return the sender's address info.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002980
Thomas Wouters477c8d52006-05-27 19:21:47 +00002981
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002982/* s.recvfrom_into(buffer[, nbytes [,flags]]) method */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002983
2984static PyObject *
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002985sock_recvfrom_into(PySocketSockObject *s, PyObject *args, PyObject* kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002988
Antoine Pitrou19467d22010-08-17 19:33:30 +00002989 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002990 Py_buffer pbuf;
2991 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002992 Py_ssize_t readlen, buflen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 PyObject *addr = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002995
Antoine Pitrou19467d22010-08-17 19:33:30 +00002996 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recvfrom_into",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 kwlist, &pbuf,
2998 &recvlen, &flags))
2999 return NULL;
3000 buf = pbuf.buf;
3001 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 if (recvlen < 0) {
3004 PyBuffer_Release(&pbuf);
3005 PyErr_SetString(PyExc_ValueError,
3006 "negative buffersize in recvfrom_into");
3007 return NULL;
3008 }
3009 if (recvlen == 0) {
3010 /* If nbytes was not specified, use the buffer's length */
3011 recvlen = buflen;
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05003012 } else if (recvlen > buflen) {
3013 PyBuffer_Release(&pbuf);
3014 PyErr_SetString(PyExc_ValueError,
3015 "nbytes is greater than the length of the buffer");
3016 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 readlen = sock_recvfrom_guts(s, buf, recvlen, flags, &addr);
3020 if (readlen < 0) {
3021 PyBuffer_Release(&pbuf);
3022 /* Return an error */
3023 Py_XDECREF(addr);
3024 return NULL;
3025 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 PyBuffer_Release(&pbuf);
3028 /* Return the number of bytes read and the address. Note that we do
3029 not do anything special here in the case that readlen < recvlen. */
Antoine Pitrou19467d22010-08-17 19:33:30 +00003030 return Py_BuildValue("nN", readlen, addr);
Thomas Wouters477c8d52006-05-27 19:21:47 +00003031}
3032
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003033PyDoc_STRVAR(recvfrom_into_doc,
3034"recvfrom_into(buffer[, nbytes[, flags]]) -> (nbytes, address info)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00003035\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003036Like recv_into(buffer[, nbytes[, flags]]) but also return the sender's address info.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00003037
3038
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003039/* The sendmsg() and recvmsg[_into]() methods require a working
3040 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3041#ifdef CMSG_LEN
3042/*
3043 * Call recvmsg() with the supplied iovec structures, flags, and
3044 * ancillary data buffer size (controllen). Returns the tuple return
3045 * value for recvmsg() or recvmsg_into(), with the first item provided
3046 * by the supplied makeval() function. makeval() will be called with
3047 * the length read and makeval_data as arguments, and must return a
3048 * new reference (which will be decrefed if there is a subsequent
3049 * error). On error, closes any file descriptors received via
3050 * SCM_RIGHTS.
3051 */
3052static PyObject *
3053sock_recvmsg_guts(PySocketSockObject *s, struct iovec *iov, int iovlen,
3054 int flags, Py_ssize_t controllen,
3055 PyObject *(*makeval)(ssize_t, void *), void *makeval_data)
3056{
3057 ssize_t bytes_received = -1;
3058 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003059 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003060 sock_addr_t addrbuf;
3061 socklen_t addrbuflen;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003062 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003063 PyObject *cmsg_list = NULL, *retval = NULL;
3064 void *controlbuf = NULL;
3065 struct cmsghdr *cmsgh;
3066 size_t cmsgdatalen = 0;
3067 int cmsg_status;
3068
3069 /* XXX: POSIX says that msg_name and msg_namelen "shall be
3070 ignored" when the socket is connected (Linux fills them in
3071 anyway for AF_UNIX sockets at least). Normally msg_namelen
3072 seems to be set to 0 if there's no address, but try to
3073 initialize msg_name to something that won't be mistaken for a
3074 real address if that doesn't happen. */
3075 if (!getsockaddrlen(s, &addrbuflen))
3076 return NULL;
3077 memset(&addrbuf, 0, addrbuflen);
3078 SAS2SA(&addrbuf)->sa_family = AF_UNSPEC;
3079
3080 if (controllen < 0 || controllen > SOCKLEN_T_LIMIT) {
3081 PyErr_SetString(PyExc_ValueError,
3082 "invalid ancillary data buffer length");
3083 return NULL;
3084 }
3085 if (controllen > 0 && (controlbuf = PyMem_Malloc(controllen)) == NULL)
3086 return PyErr_NoMemory();
3087
3088 /* Make the system call. */
3089 if (!IS_SELECTABLE(s)) {
3090 select_error();
3091 goto finally;
3092 }
3093
3094 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003095 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003096 msg.msg_name = SAS2SA(&addrbuf);
3097 msg.msg_namelen = addrbuflen;
3098 msg.msg_iov = iov;
3099 msg.msg_iovlen = iovlen;
3100 msg.msg_control = controlbuf;
3101 msg.msg_controllen = controllen;
Victor Stinner391fa712015-03-31 13:15:31 +02003102 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003103
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003104 if (timeout == 1) {
3105 PyErr_SetString(socket_timeout, "timed out");
3106 goto finally;
3107 }
Victor Stinnerb7df3142015-03-27 22:59:32 +01003108
3109 if (!timeout) {
3110 Py_BEGIN_ALLOW_THREADS;
3111 bytes_received = recvmsg(s->sock_fd, &msg, flags);
3112 Py_END_ALLOW_THREADS;
3113 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003114 } while (bytes_received < 0 && errno == EINTR &&
3115 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003116 END_SELECT_LOOP(s)
3117
3118 if (bytes_received < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003119 if (!async_err)
3120 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003121 goto finally;
3122 }
3123
3124 /* Make list of (level, type, data) tuples from control messages. */
3125 if ((cmsg_list = PyList_New(0)) == NULL)
3126 goto err_closefds;
3127 /* Check for empty ancillary data as old CMSG_FIRSTHDR()
3128 implementations didn't do so. */
3129 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3130 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3131 PyObject *bytes, *tuple;
3132 int tmp;
3133
3134 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3135 if (cmsg_status != 0) {
3136 if (PyErr_WarnEx(PyExc_RuntimeWarning,
3137 "received malformed or improperly-truncated "
3138 "ancillary data", 1) == -1)
3139 goto err_closefds;
3140 }
3141 if (cmsg_status < 0)
3142 break;
3143 if (cmsgdatalen > PY_SSIZE_T_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003144 PyErr_SetString(PyExc_OSError, "control message too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003145 goto err_closefds;
3146 }
3147
3148 bytes = PyBytes_FromStringAndSize((char *)CMSG_DATA(cmsgh),
3149 cmsgdatalen);
3150 tuple = Py_BuildValue("iiN", (int)cmsgh->cmsg_level,
3151 (int)cmsgh->cmsg_type, bytes);
3152 if (tuple == NULL)
3153 goto err_closefds;
3154 tmp = PyList_Append(cmsg_list, tuple);
3155 Py_DECREF(tuple);
3156 if (tmp != 0)
3157 goto err_closefds;
3158
3159 if (cmsg_status != 0)
3160 break;
3161 }
3162
3163 retval = Py_BuildValue("NOiN",
3164 (*makeval)(bytes_received, makeval_data),
3165 cmsg_list,
3166 (int)msg.msg_flags,
3167 makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
3168 ((msg.msg_namelen > addrbuflen) ?
3169 addrbuflen : msg.msg_namelen),
3170 s->sock_proto));
3171 if (retval == NULL)
3172 goto err_closefds;
3173
3174finally:
3175 Py_XDECREF(cmsg_list);
3176 PyMem_Free(controlbuf);
3177 return retval;
3178
3179err_closefds:
3180#ifdef SCM_RIGHTS
3181 /* Close all descriptors coming from SCM_RIGHTS, so they don't leak. */
3182 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3183 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3184 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3185 if (cmsg_status < 0)
3186 break;
3187 if (cmsgh->cmsg_level == SOL_SOCKET &&
3188 cmsgh->cmsg_type == SCM_RIGHTS) {
3189 size_t numfds;
3190 int *fdp;
3191
3192 numfds = cmsgdatalen / sizeof(int);
3193 fdp = (int *)CMSG_DATA(cmsgh);
3194 while (numfds-- > 0)
3195 close(*fdp++);
3196 }
3197 if (cmsg_status != 0)
3198 break;
3199 }
3200#endif /* SCM_RIGHTS */
3201 goto finally;
3202}
3203
3204
3205static PyObject *
3206makeval_recvmsg(ssize_t received, void *data)
3207{
3208 PyObject **buf = data;
3209
3210 if (received < PyBytes_GET_SIZE(*buf))
3211 _PyBytes_Resize(buf, received);
3212 Py_XINCREF(*buf);
3213 return *buf;
3214}
3215
3216/* s.recvmsg(bufsize[, ancbufsize[, flags]]) method */
3217
3218static PyObject *
3219sock_recvmsg(PySocketSockObject *s, PyObject *args)
3220{
3221 Py_ssize_t bufsize, ancbufsize = 0;
3222 int flags = 0;
3223 struct iovec iov;
3224 PyObject *buf = NULL, *retval = NULL;
3225
3226 if (!PyArg_ParseTuple(args, "n|ni:recvmsg", &bufsize, &ancbufsize, &flags))
3227 return NULL;
3228
3229 if (bufsize < 0) {
3230 PyErr_SetString(PyExc_ValueError, "negative buffer size in recvmsg()");
3231 return NULL;
3232 }
3233 if ((buf = PyBytes_FromStringAndSize(NULL, bufsize)) == NULL)
3234 return NULL;
3235 iov.iov_base = PyBytes_AS_STRING(buf);
3236 iov.iov_len = bufsize;
3237
3238 /* Note that we're passing a pointer to *our pointer* to the bytes
3239 object here (&buf); makeval_recvmsg() may incref the object, or
3240 deallocate it and set our pointer to NULL. */
3241 retval = sock_recvmsg_guts(s, &iov, 1, flags, ancbufsize,
3242 &makeval_recvmsg, &buf);
3243 Py_XDECREF(buf);
3244 return retval;
3245}
3246
3247PyDoc_STRVAR(recvmsg_doc,
3248"recvmsg(bufsize[, ancbufsize[, flags]]) -> (data, ancdata, msg_flags, address)\n\
3249\n\
3250Receive normal data (up to bufsize bytes) and ancillary data from the\n\
3251socket. The ancbufsize argument sets the size in bytes of the\n\
3252internal buffer used to receive the ancillary data; it defaults to 0,\n\
3253meaning that no ancillary data will be received. Appropriate buffer\n\
3254sizes for ancillary data can be calculated using CMSG_SPACE() or\n\
3255CMSG_LEN(), and items which do not fit into the buffer might be\n\
3256truncated or discarded. The flags argument defaults to 0 and has the\n\
3257same meaning as for recv().\n\
3258\n\
3259The return value is a 4-tuple: (data, ancdata, msg_flags, address).\n\
3260The data item is a bytes object holding the non-ancillary data\n\
3261received. The ancdata item is a list of zero or more tuples\n\
3262(cmsg_level, cmsg_type, cmsg_data) representing the ancillary data\n\
3263(control messages) received: cmsg_level and cmsg_type are integers\n\
3264specifying the protocol level and protocol-specific type respectively,\n\
3265and cmsg_data is a bytes object holding the associated data. The\n\
3266msg_flags item is the bitwise OR of various flags indicating\n\
3267conditions on the received message; see your system documentation for\n\
3268details. If the receiving socket is unconnected, address is the\n\
3269address of the sending socket, if available; otherwise, its value is\n\
3270unspecified.\n\
3271\n\
3272If recvmsg() raises an exception after the system call returns, it\n\
3273will first attempt to close any file descriptors received via the\n\
3274SCM_RIGHTS mechanism.");
3275
3276
3277static PyObject *
3278makeval_recvmsg_into(ssize_t received, void *data)
3279{
3280 return PyLong_FromSsize_t(received);
3281}
3282
3283/* s.recvmsg_into(buffers[, ancbufsize[, flags]]) method */
3284
3285static PyObject *
3286sock_recvmsg_into(PySocketSockObject *s, PyObject *args)
3287{
3288 Py_ssize_t ancbufsize = 0;
3289 int flags = 0;
3290 struct iovec *iovs = NULL;
3291 Py_ssize_t i, nitems, nbufs = 0;
3292 Py_buffer *bufs = NULL;
3293 PyObject *buffers_arg, *fast, *retval = NULL;
3294
3295 if (!PyArg_ParseTuple(args, "O|ni:recvmsg_into",
3296 &buffers_arg, &ancbufsize, &flags))
3297 return NULL;
3298
3299 if ((fast = PySequence_Fast(buffers_arg,
3300 "recvmsg_into() argument 1 must be an "
3301 "iterable")) == NULL)
3302 return NULL;
3303 nitems = PySequence_Fast_GET_SIZE(fast);
3304 if (nitems > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003305 PyErr_SetString(PyExc_OSError, "recvmsg_into() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003306 goto finally;
3307 }
3308
3309 /* Fill in an iovec for each item, and save the Py_buffer
3310 structs to release afterwards. */
3311 if (nitems > 0 && ((iovs = PyMem_New(struct iovec, nitems)) == NULL ||
3312 (bufs = PyMem_New(Py_buffer, nitems)) == NULL)) {
3313 PyErr_NoMemory();
3314 goto finally;
3315 }
3316 for (; nbufs < nitems; nbufs++) {
3317 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(fast, nbufs),
3318 "w*;recvmsg_into() argument 1 must be an iterable "
3319 "of single-segment read-write buffers",
3320 &bufs[nbufs]))
3321 goto finally;
3322 iovs[nbufs].iov_base = bufs[nbufs].buf;
3323 iovs[nbufs].iov_len = bufs[nbufs].len;
3324 }
3325
3326 retval = sock_recvmsg_guts(s, iovs, nitems, flags, ancbufsize,
3327 &makeval_recvmsg_into, NULL);
3328finally:
3329 for (i = 0; i < nbufs; i++)
3330 PyBuffer_Release(&bufs[i]);
3331 PyMem_Free(bufs);
3332 PyMem_Free(iovs);
3333 Py_DECREF(fast);
3334 return retval;
3335}
3336
3337PyDoc_STRVAR(recvmsg_into_doc,
3338"recvmsg_into(buffers[, ancbufsize[, flags]]) -> (nbytes, ancdata, msg_flags, address)\n\
3339\n\
3340Receive normal data and ancillary data from the socket, scattering the\n\
3341non-ancillary data into a series of buffers. The buffers argument\n\
3342must be an iterable of objects that export writable buffers\n\
3343(e.g. bytearray objects); these will be filled with successive chunks\n\
3344of the non-ancillary data until it has all been written or there are\n\
3345no more buffers. The ancbufsize argument sets the size in bytes of\n\
3346the internal buffer used to receive the ancillary data; it defaults to\n\
33470, meaning that no ancillary data will be received. Appropriate\n\
3348buffer sizes for ancillary data can be calculated using CMSG_SPACE()\n\
3349or CMSG_LEN(), and items which do not fit into the buffer might be\n\
3350truncated or discarded. The flags argument defaults to 0 and has the\n\
3351same meaning as for recv().\n\
3352\n\
3353The return value is a 4-tuple: (nbytes, ancdata, msg_flags, address).\n\
3354The nbytes item is the total number of bytes of non-ancillary data\n\
3355written into the buffers. The ancdata item is a list of zero or more\n\
3356tuples (cmsg_level, cmsg_type, cmsg_data) representing the ancillary\n\
3357data (control messages) received: cmsg_level and cmsg_type are\n\
3358integers specifying the protocol level and protocol-specific type\n\
3359respectively, and cmsg_data is a bytes object holding the associated\n\
3360data. The msg_flags item is the bitwise OR of various flags\n\
3361indicating conditions on the received message; see your system\n\
3362documentation for details. If the receiving socket is unconnected,\n\
3363address is the address of the sending socket, if available; otherwise,\n\
3364its value is unspecified.\n\
3365\n\
3366If recvmsg_into() raises an exception after the system call returns,\n\
3367it will first attempt to close any file descriptors received via the\n\
3368SCM_RIGHTS mechanism.");
3369#endif /* CMSG_LEN */
3370
3371
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003372/* s.send(data [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003373
Guido van Rossum73624e91994-10-10 17:59:00 +00003374static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003375sock_send(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00003376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003377 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003378 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003379 int async_err = 0;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003380 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 if (!PyArg_ParseTuple(args, "y*|i:send", &pbuf, &flags))
3384 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 if (!IS_SELECTABLE(s)) {
3387 PyBuffer_Release(&pbuf);
3388 return select_error();
3389 }
3390 buf = pbuf.buf;
3391 len = pbuf.len;
Neal Norwitz082b2df2006-02-07 07:04:46 +00003392
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003393 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003394 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003395 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003396
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003397 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003398 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003399#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003400 if (len > INT_MAX)
3401 len = INT_MAX;
3402 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003403#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003404 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003405#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003406 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003407 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003408 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003410 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 PyErr_SetString(socket_timeout, "timed out");
3412 return NULL;
3413 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003414 END_SELECT_LOOP(s)
3415
3416 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003418 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003419 return PyLong_FromSsize_t(n);
Guido van Rossum30a685f1991-06-27 15:51:29 +00003420}
3421
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003422PyDoc_STRVAR(send_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003423"send(data[, flags]) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003424\n\
3425Send a data string to the socket. For the optional flags\n\
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003426argument, see the Unix manual. Return the number of bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003427sent; this may be less than len(data) if the network is busy.");
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003428
3429
3430/* s.sendall(data [,flags]) method */
3431
3432static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003433sock_sendall(PySocketSockObject *s, PyObject *args)
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003436 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003437 int async_err = 0;
3438 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 if (!PyArg_ParseTuple(args, "y*|i:sendall", &pbuf, &flags))
3442 return NULL;
3443 buf = pbuf.buf;
3444 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 if (!IS_SELECTABLE(s)) {
3447 PyBuffer_Release(&pbuf);
3448 return select_error();
3449 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003452 timeout = internal_select(s, 1, s->sock_timeout);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 n = -1;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003455 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003456 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003457#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003458 if (len > INT_MAX)
3459 len = INT_MAX;
3460 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003461#else
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003462 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003463#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003464 Py_END_ALLOW_THREADS
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003465 }
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003466 if (timeout == 1) {
3467 PyBuffer_Release(&pbuf);
3468 PyErr_SetString(socket_timeout, "timed out");
3469 return NULL;
3470 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003471 if (n >= 0) {
3472 buf += n;
3473 len -= n;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003474 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003475 } while (len > 0 && (n >= 0 || errno == EINTR) &&
3476 !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 PyBuffer_Release(&pbuf);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003478
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003479 if (n < 0 || async_err)
3480 return (!async_err) ? s->errorhandler() : NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 Py_INCREF(Py_None);
3483 return Py_None;
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003484}
3485
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003486PyDoc_STRVAR(sendall_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003487"sendall(data[, flags])\n\
3488\n\
3489Send a data string to the socket. For the optional flags\n\
3490argument, see the Unix manual. This calls send() repeatedly\n\
3491until all data is sent. If an error occurs, it's impossible\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003492to tell how much data has been sent.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003493
Guido van Rossum30a685f1991-06-27 15:51:29 +00003494
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003495/* s.sendto(data, [flags,] sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003496
Guido van Rossum73624e91994-10-10 17:59:00 +00003497static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003498sock_sendto(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 Py_buffer pbuf;
3501 PyObject *addro;
3502 char *buf;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003503 Py_ssize_t len, arglen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 sock_addr_t addrbuf;
3505 int addrlen, n = -1, flags, timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003506 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 flags = 0;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003509 arglen = PyTuple_Size(args);
3510 switch (arglen) {
3511 case 2:
3512 PyArg_ParseTuple(args, "y*O:sendto", &pbuf, &addro);
3513 break;
3514 case 3:
3515 PyArg_ParseTuple(args, "y*iO:sendto",
3516 &pbuf, &flags, &addro);
3517 break;
3518 default:
3519 PyErr_Format(PyExc_TypeError,
3520 "sendto() takes 2 or 3 arguments (%d given)",
3521 arglen);
Victor Stinner77af1722011-05-26 14:05:59 +02003522 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 }
Antoine Pitrou5e981412011-03-17 22:38:37 +01003524 if (PyErr_Occurred())
3525 return NULL;
3526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 buf = pbuf.buf;
3528 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003530 if (!IS_SELECTABLE(s)) {
3531 PyBuffer_Release(&pbuf);
3532 return select_error();
3533 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003535 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen)) {
3536 PyBuffer_Release(&pbuf);
3537 return NULL;
3538 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00003539
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003540 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003541 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003542 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003543
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003544 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003545 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02003546#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003547 if (len > INT_MAX)
3548 len = INT_MAX;
3549 n = sendto(s->sock_fd, buf, (int)len, flags,
3550 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003551#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003552 n = sendto(s->sock_fd, buf, len, flags,
3553 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003554#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003555 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003556 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003557 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00003558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003559 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003560 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 PyErr_SetString(socket_timeout, "timed out");
3562 return NULL;
3563 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003564 END_SELECT_LOOP(s)
3565 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003567 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003568 return PyLong_FromSsize_t(n);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003569}
3570
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003571PyDoc_STRVAR(sendto_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00003572"sendto(data[, flags], address) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003573\n\
3574Like send(data, flags) but allows specifying the destination address.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003575For IP sockets, the address is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003576
Guido van Rossum30a685f1991-06-27 15:51:29 +00003577
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003578/* The sendmsg() and recvmsg[_into]() methods require a working
3579 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3580#ifdef CMSG_LEN
3581/* s.sendmsg(buffers[, ancdata[, flags[, address]]]) method */
3582
3583static PyObject *
3584sock_sendmsg(PySocketSockObject *s, PyObject *args)
3585{
3586 Py_ssize_t i, ndataparts, ndatabufs = 0, ncmsgs, ncmsgbufs = 0;
3587 Py_buffer *databufs = NULL;
3588 struct iovec *iovs = NULL;
3589 sock_addr_t addrbuf;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003590 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003591 struct cmsginfo {
3592 int level;
3593 int type;
3594 Py_buffer data;
3595 } *cmsgs = NULL;
3596 void *controlbuf = NULL;
3597 size_t controllen, controllen_last;
3598 ssize_t bytes_sent = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003599 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003600 int addrlen, timeout, flags = 0;
3601 PyObject *data_arg, *cmsg_arg = NULL, *addr_arg = NULL, *data_fast = NULL,
3602 *cmsg_fast = NULL, *retval = NULL;
3603
3604 if (!PyArg_ParseTuple(args, "O|OiO:sendmsg",
3605 &data_arg, &cmsg_arg, &flags, &addr_arg))
3606 return NULL;
3607
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003608 /* Parse destination address. */
3609 if (addr_arg != NULL && addr_arg != Py_None) {
3610 if (!getsockaddrarg(s, addr_arg, SAS2SA(&addrbuf), &addrlen))
3611 goto finally;
3612 msg.msg_name = &addrbuf;
3613 msg.msg_namelen = addrlen;
3614 }
3615
3616 /* Fill in an iovec for each message part, and save the Py_buffer
3617 structs to release afterwards. */
3618 if ((data_fast = PySequence_Fast(data_arg,
3619 "sendmsg() argument 1 must be an "
3620 "iterable")) == NULL)
3621 goto finally;
3622 ndataparts = PySequence_Fast_GET_SIZE(data_fast);
3623 if (ndataparts > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003624 PyErr_SetString(PyExc_OSError, "sendmsg() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003625 goto finally;
3626 }
3627 msg.msg_iovlen = ndataparts;
3628 if (ndataparts > 0 &&
3629 ((msg.msg_iov = iovs = PyMem_New(struct iovec, ndataparts)) == NULL ||
3630 (databufs = PyMem_New(Py_buffer, ndataparts)) == NULL)) {
3631 PyErr_NoMemory();
3632 goto finally;
3633 }
3634 for (; ndatabufs < ndataparts; ndatabufs++) {
3635 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(data_fast, ndatabufs),
3636 "y*;sendmsg() argument 1 must be an iterable of "
Serhiy Storchakab757c832014-12-05 22:25:22 +02003637 "bytes-like objects",
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003638 &databufs[ndatabufs]))
3639 goto finally;
3640 iovs[ndatabufs].iov_base = databufs[ndatabufs].buf;
3641 iovs[ndatabufs].iov_len = databufs[ndatabufs].len;
3642 }
3643
3644 if (cmsg_arg == NULL)
3645 ncmsgs = 0;
3646 else {
3647 if ((cmsg_fast = PySequence_Fast(cmsg_arg,
3648 "sendmsg() argument 2 must be an "
3649 "iterable")) == NULL)
3650 goto finally;
3651 ncmsgs = PySequence_Fast_GET_SIZE(cmsg_fast);
3652 }
3653
3654#ifndef CMSG_SPACE
3655 if (ncmsgs > 1) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003656 PyErr_SetString(PyExc_OSError,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003657 "sending multiple control messages is not supported "
3658 "on this system");
3659 goto finally;
3660 }
3661#endif
3662 /* Save level, type and Py_buffer for each control message,
3663 and calculate total size. */
3664 if (ncmsgs > 0 && (cmsgs = PyMem_New(struct cmsginfo, ncmsgs)) == NULL) {
3665 PyErr_NoMemory();
3666 goto finally;
3667 }
3668 controllen = controllen_last = 0;
3669 while (ncmsgbufs < ncmsgs) {
3670 size_t bufsize, space;
3671
3672 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(cmsg_fast, ncmsgbufs),
3673 "(iiy*):[sendmsg() ancillary data items]",
3674 &cmsgs[ncmsgbufs].level,
3675 &cmsgs[ncmsgbufs].type,
3676 &cmsgs[ncmsgbufs].data))
3677 goto finally;
3678 bufsize = cmsgs[ncmsgbufs++].data.len;
3679
3680#ifdef CMSG_SPACE
3681 if (!get_CMSG_SPACE(bufsize, &space)) {
3682#else
3683 if (!get_CMSG_LEN(bufsize, &space)) {
3684#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003685 PyErr_SetString(PyExc_OSError, "ancillary data item too large");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003686 goto finally;
3687 }
3688 controllen += space;
3689 if (controllen > SOCKLEN_T_LIMIT || controllen < controllen_last) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003690 PyErr_SetString(PyExc_OSError, "too much ancillary data");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003691 goto finally;
3692 }
3693 controllen_last = controllen;
3694 }
3695
3696 /* Construct ancillary data block from control message info. */
3697 if (ncmsgbufs > 0) {
3698 struct cmsghdr *cmsgh = NULL;
3699
3700 if ((msg.msg_control = controlbuf =
3701 PyMem_Malloc(controllen)) == NULL) {
3702 PyErr_NoMemory();
3703 goto finally;
3704 }
3705 msg.msg_controllen = controllen;
3706
3707 /* Need to zero out the buffer as a workaround for glibc's
3708 CMSG_NXTHDR() implementation. After getting the pointer to
3709 the next header, it checks its (uninitialized) cmsg_len
3710 member to see if the "message" fits in the buffer, and
3711 returns NULL if it doesn't. Zero-filling the buffer
Terry Jan Reedy0f847642013-03-11 18:34:00 -04003712 ensures that this doesn't happen. */
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003713 memset(controlbuf, 0, controllen);
3714
3715 for (i = 0; i < ncmsgbufs; i++) {
3716 size_t msg_len, data_len = cmsgs[i].data.len;
3717 int enough_space = 0;
3718
3719 cmsgh = (i == 0) ? CMSG_FIRSTHDR(&msg) : CMSG_NXTHDR(&msg, cmsgh);
3720 if (cmsgh == NULL) {
3721 PyErr_Format(PyExc_RuntimeError,
3722 "unexpected NULL result from %s()",
3723 (i == 0) ? "CMSG_FIRSTHDR" : "CMSG_NXTHDR");
3724 goto finally;
3725 }
3726 if (!get_CMSG_LEN(data_len, &msg_len)) {
3727 PyErr_SetString(PyExc_RuntimeError,
3728 "item size out of range for CMSG_LEN()");
3729 goto finally;
3730 }
3731 if (cmsg_min_space(&msg, cmsgh, msg_len)) {
3732 size_t space;
3733
3734 cmsgh->cmsg_len = msg_len;
3735 if (get_cmsg_data_space(&msg, cmsgh, &space))
3736 enough_space = (space >= data_len);
3737 }
3738 if (!enough_space) {
3739 PyErr_SetString(PyExc_RuntimeError,
3740 "ancillary data does not fit in calculated "
3741 "space");
3742 goto finally;
3743 }
3744 cmsgh->cmsg_level = cmsgs[i].level;
3745 cmsgh->cmsg_type = cmsgs[i].type;
3746 memcpy(CMSG_DATA(cmsgh), cmsgs[i].data.buf, data_len);
3747 }
3748 }
3749
3750 /* Make the system call. */
3751 if (!IS_SELECTABLE(s)) {
3752 select_error();
3753 goto finally;
3754 }
3755
3756 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003757 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003758 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003759
3760 if (!timeout) {
3761 Py_BEGIN_ALLOW_THREADS;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003762 bytes_sent = sendmsg(s->sock_fd, &msg, flags);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003763 Py_END_ALLOW_THREADS;
3764 }
3765
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003766 if (timeout == 1) {
3767 PyErr_SetString(socket_timeout, "timed out");
3768 goto finally;
3769 }
3770 } while (bytes_sent < 0 && errno == EINTR &&
3771 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003772 END_SELECT_LOOP(s)
3773
3774 if (bytes_sent < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003775 if (!async_err)
3776 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003777 goto finally;
3778 }
3779 retval = PyLong_FromSsize_t(bytes_sent);
3780
3781finally:
3782 PyMem_Free(controlbuf);
3783 for (i = 0; i < ncmsgbufs; i++)
3784 PyBuffer_Release(&cmsgs[i].data);
3785 PyMem_Free(cmsgs);
3786 Py_XDECREF(cmsg_fast);
3787 for (i = 0; i < ndatabufs; i++)
3788 PyBuffer_Release(&databufs[i]);
3789 PyMem_Free(databufs);
3790 PyMem_Free(iovs);
3791 Py_XDECREF(data_fast);
3792 return retval;
3793}
3794
3795PyDoc_STRVAR(sendmsg_doc,
3796"sendmsg(buffers[, ancdata[, flags[, address]]]) -> count\n\
3797\n\
3798Send normal and ancillary data to the socket, gathering the\n\
3799non-ancillary data from a series of buffers and concatenating it into\n\
3800a single message. The buffers argument specifies the non-ancillary\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003801data as an iterable of bytes-like objects (e.g. bytes objects).\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003802The ancdata argument specifies the ancillary data (control messages)\n\
3803as an iterable of zero or more tuples (cmsg_level, cmsg_type,\n\
3804cmsg_data), where cmsg_level and cmsg_type are integers specifying the\n\
3805protocol level and protocol-specific type respectively, and cmsg_data\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003806is a bytes-like object holding the associated data. The flags\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003807argument defaults to 0 and has the same meaning as for send(). If\n\
3808address is supplied and not None, it sets a destination address for\n\
3809the message. The return value is the number of bytes of non-ancillary\n\
3810data sent.");
3811#endif /* CMSG_LEN */
3812
3813
Guido van Rossum30a685f1991-06-27 15:51:29 +00003814/* s.shutdown(how) method */
3815
Guido van Rossum73624e91994-10-10 17:59:00 +00003816static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003817sock_shutdown(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003818{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003819 int how;
3820 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00003821
Serhiy Storchaka78980432013-01-15 01:12:17 +02003822 how = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 if (how == -1 && PyErr_Occurred())
3824 return NULL;
3825 Py_BEGIN_ALLOW_THREADS
3826 res = shutdown(s->sock_fd, how);
3827 Py_END_ALLOW_THREADS
3828 if (res < 0)
3829 return s->errorhandler();
3830 Py_INCREF(Py_None);
3831 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003832}
3833
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003834PyDoc_STRVAR(shutdown_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003835"shutdown(flag)\n\
3836\n\
Martin v. Löwis94681fc2003-11-27 19:40:22 +00003837Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
3838of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003839
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003840#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Christian Heimesfaf2f632008-01-06 16:59:19 +00003841static PyObject*
3842sock_ioctl(PySocketSockObject *s, PyObject *arg)
3843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003844 unsigned long cmd = SIO_RCVALL;
3845 PyObject *argO;
3846 DWORD recv;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 if (!PyArg_ParseTuple(arg, "kO:ioctl", &cmd, &argO))
3849 return NULL;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003850
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003851 switch (cmd) {
3852 case SIO_RCVALL: {
3853 unsigned int option = RCVALL_ON;
3854 if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
3855 return NULL;
3856 if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
3857 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3858 return set_error();
3859 }
3860 return PyLong_FromUnsignedLong(recv); }
3861 case SIO_KEEPALIVE_VALS: {
3862 struct tcp_keepalive ka;
3863 if (!PyArg_ParseTuple(arg, "k(kkk):ioctl", &cmd,
3864 &ka.onoff, &ka.keepalivetime, &ka.keepaliveinterval))
3865 return NULL;
3866 if (WSAIoctl(s->sock_fd, cmd, &ka, sizeof(ka),
3867 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3868 return set_error();
3869 }
3870 return PyLong_FromUnsignedLong(recv); }
3871 default:
3872 PyErr_Format(PyExc_ValueError, "invalid ioctl command %d", cmd);
3873 return NULL;
3874 }
Christian Heimesfaf2f632008-01-06 16:59:19 +00003875}
3876PyDoc_STRVAR(sock_ioctl_doc,
3877"ioctl(cmd, option) -> long\n\
3878\n\
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00003879Control the socket with WSAIoctl syscall. Currently supported 'cmd' values are\n\
3880SIO_RCVALL: 'option' must be one of the socket.RCVALL_* constants.\n\
3881SIO_KEEPALIVE_VALS: 'option' is a tuple of (onoff, timeout, interval).");
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003882#endif
3883
3884#if defined(MS_WINDOWS)
3885static PyObject*
3886sock_share(PySocketSockObject *s, PyObject *arg)
3887{
3888 WSAPROTOCOL_INFO info;
3889 DWORD processId;
3890 int result;
3891
3892 if (!PyArg_ParseTuple(arg, "I", &processId))
3893 return NULL;
3894
3895 Py_BEGIN_ALLOW_THREADS
3896 result = WSADuplicateSocket(s->sock_fd, processId, &info);
3897 Py_END_ALLOW_THREADS
3898 if (result == SOCKET_ERROR)
3899 return set_error();
3900 return PyBytes_FromStringAndSize((const char*)&info, sizeof(info));
3901}
3902PyDoc_STRVAR(sock_share_doc,
3903"share(process_id) -> bytes\n\
3904\n\
3905Share the socket with another process. The target process id\n\
3906must be provided and the resulting bytes object passed to the target\n\
3907process. There the shared socket can be instantiated by calling\n\
3908socket.fromshare().");
3909
Christian Heimesfaf2f632008-01-06 16:59:19 +00003910
3911#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00003912
3913/* List of methods for socket objects */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003914
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003915static PyMethodDef sock_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003916 {"_accept", (PyCFunction)sock_accept, METH_NOARGS,
3917 accept_doc},
3918 {"bind", (PyCFunction)sock_bind, METH_O,
3919 bind_doc},
3920 {"close", (PyCFunction)sock_close, METH_NOARGS,
3921 close_doc},
3922 {"connect", (PyCFunction)sock_connect, METH_O,
3923 connect_doc},
3924 {"connect_ex", (PyCFunction)sock_connect_ex, METH_O,
3925 connect_ex_doc},
Antoine Pitrou6e451df2010-08-09 20:39:54 +00003926 {"detach", (PyCFunction)sock_detach, METH_NOARGS,
3927 detach_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003928 {"fileno", (PyCFunction)sock_fileno, METH_NOARGS,
3929 fileno_doc},
Guido van Rossumb6775db1994-08-01 11:34:53 +00003930#ifdef HAVE_GETPEERNAME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 {"getpeername", (PyCFunction)sock_getpeername,
3932 METH_NOARGS, getpeername_doc},
Guido van Rossum9575a441993-04-07 14:06:14 +00003933#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003934 {"getsockname", (PyCFunction)sock_getsockname,
3935 METH_NOARGS, getsockname_doc},
3936 {"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
3937 getsockopt_doc},
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003938#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003939 {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
3940 sock_ioctl_doc},
Christian Heimesfaf2f632008-01-06 16:59:19 +00003941#endif
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003942#if defined(MS_WINDOWS)
3943 {"share", (PyCFunction)sock_share, METH_VARARGS,
3944 sock_share_doc},
3945#endif
Charles-François Natali644b8f52014-05-22 19:45:39 +01003946 {"listen", (PyCFunction)sock_listen, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003947 listen_doc},
3948 {"recv", (PyCFunction)sock_recv, METH_VARARGS,
3949 recv_doc},
3950 {"recv_into", (PyCFunction)sock_recv_into, METH_VARARGS | METH_KEYWORDS,
3951 recv_into_doc},
3952 {"recvfrom", (PyCFunction)sock_recvfrom, METH_VARARGS,
3953 recvfrom_doc},
3954 {"recvfrom_into", (PyCFunction)sock_recvfrom_into, METH_VARARGS | METH_KEYWORDS,
3955 recvfrom_into_doc},
3956 {"send", (PyCFunction)sock_send, METH_VARARGS,
3957 send_doc},
3958 {"sendall", (PyCFunction)sock_sendall, METH_VARARGS,
3959 sendall_doc},
3960 {"sendto", (PyCFunction)sock_sendto, METH_VARARGS,
3961 sendto_doc},
3962 {"setblocking", (PyCFunction)sock_setblocking, METH_O,
3963 setblocking_doc},
3964 {"settimeout", (PyCFunction)sock_settimeout, METH_O,
3965 settimeout_doc},
3966 {"gettimeout", (PyCFunction)sock_gettimeout, METH_NOARGS,
3967 gettimeout_doc},
3968 {"setsockopt", (PyCFunction)sock_setsockopt, METH_VARARGS,
3969 setsockopt_doc},
3970 {"shutdown", (PyCFunction)sock_shutdown, METH_O,
3971 shutdown_doc},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003972#ifdef CMSG_LEN
3973 {"recvmsg", (PyCFunction)sock_recvmsg, METH_VARARGS,
3974 recvmsg_doc},
3975 {"recvmsg_into", (PyCFunction)sock_recvmsg_into, METH_VARARGS,
3976 recvmsg_into_doc,},
3977 {"sendmsg", (PyCFunction)sock_sendmsg, METH_VARARGS,
3978 sendmsg_doc},
3979#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003980 {NULL, NULL} /* sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003981};
3982
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003983/* SockObject members */
3984static PyMemberDef sock_memberlist[] = {
3985 {"family", T_INT, offsetof(PySocketSockObject, sock_family), READONLY, "the socket family"},
3986 {"type", T_INT, offsetof(PySocketSockObject, sock_type), READONLY, "the socket type"},
3987 {"proto", T_INT, offsetof(PySocketSockObject, sock_proto), READONLY, "the socket protocol"},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003988 {0},
3989};
Guido van Rossum30a685f1991-06-27 15:51:29 +00003990
Victor Stinner71694d52015-03-28 01:18:54 +01003991static PyGetSetDef sock_getsetlist[] = {
3992 {"timeout", (getter)sock_gettimeout, NULL, PyDoc_STR("the socket timeout")},
3993 {NULL} /* sentinel */
3994};
3995
Guido van Rossum73624e91994-10-10 17:59:00 +00003996/* Deallocate a socket object in response to the last Py_DECREF().
Guido van Rossum30a685f1991-06-27 15:51:29 +00003997 First close the file description. */
3998
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003999static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004000sock_dealloc(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004001{
Antoine Pitroue033e062010-10-29 10:38:18 +00004002 if (s->sock_fd != -1) {
4003 PyObject *exc, *val, *tb;
4004 Py_ssize_t old_refcount = Py_REFCNT(s);
4005 ++Py_REFCNT(s);
4006 PyErr_Fetch(&exc, &val, &tb);
4007 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
4008 "unclosed %R", s))
4009 /* Spurious errors can appear at shutdown */
4010 if (PyErr_ExceptionMatches(PyExc_Warning))
4011 PyErr_WriteUnraisable((PyObject *) s);
4012 PyErr_Restore(exc, val, tb);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004013 (void) SOCKETCLOSE(s->sock_fd);
Antoine Pitroue033e062010-10-29 10:38:18 +00004014 Py_REFCNT(s) = old_refcount;
4015 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004016 Py_TYPE(s)->tp_free((PyObject *)s);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004017}
4018
Guido van Rossum30a685f1991-06-27 15:51:29 +00004019
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004020static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004021sock_repr(PySocketSockObject *s)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004022{
Victor Stinnere254e532014-07-26 14:36:55 +02004023 long sock_fd;
4024 /* On Windows, this test is needed because SOCKET_T is unsigned */
4025 if (s->sock_fd == INVALID_SOCKET) {
4026 sock_fd = -1;
4027 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004028#if SIZEOF_SOCKET_T > SIZEOF_LONG
Victor Stinnere254e532014-07-26 14:36:55 +02004029 else if (s->sock_fd > LONG_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004030 /* this can occur on Win64, and actually there is a special
4031 ugly printf formatter for decimal pointer length integer
4032 printing, only bother if necessary*/
4033 PyErr_SetString(PyExc_OverflowError,
4034 "no printf formatter to display "
4035 "the socket descriptor in decimal");
4036 return NULL;
4037 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004038#endif
Victor Stinnere254e532014-07-26 14:36:55 +02004039 else
4040 sock_fd = (long)s->sock_fd;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004041 return PyUnicode_FromFormat(
4042 "<socket object, fd=%ld, family=%d, type=%d, proto=%d>",
Victor Stinnere254e532014-07-26 14:36:55 +02004043 sock_fd, s->sock_family,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004044 s->sock_type,
4045 s->sock_proto);
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004046}
4047
4048
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004049/* Create a new, uninitialized socket object. */
4050
4051static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004052sock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004053{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004054 PyObject *new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004056 new = type->tp_alloc(type, 0);
4057 if (new != NULL) {
4058 ((PySocketSockObject *)new)->sock_fd = -1;
Victor Stinner71694d52015-03-28 01:18:54 +01004059 ((PySocketSockObject *)new)->sock_timeout = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 ((PySocketSockObject *)new)->errorhandler = &set_error;
4061 }
4062 return new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004063}
4064
4065
4066/* Initialize a new socket object. */
4067
Victor Stinnerdaf45552013-08-28 00:53:59 +02004068#ifdef SOCK_CLOEXEC
4069/* socket() and socketpair() fail with EINVAL on Linux kernel older
4070 * than 2.6.27 if SOCK_CLOEXEC flag is set in the socket type. */
4071static int sock_cloexec_works = -1;
4072#endif
4073
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004074/*ARGSUSED*/
4075static int
Andrew MacIntyre7aec4a22002-06-13 11:53:52 +00004076sock_initobj(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004077{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004078 PySocketSockObject *s = (PySocketSockObject *)self;
4079 PyObject *fdobj = NULL;
4080 SOCKET_T fd = INVALID_SOCKET;
4081 int family = AF_INET, type = SOCK_STREAM, proto = 0;
4082 static char *keywords[] = {"family", "type", "proto", "fileno", 0};
Victor Stinnerdaf45552013-08-28 00:53:59 +02004083#ifndef MS_WINDOWS
4084#ifdef SOCK_CLOEXEC
4085 int *atomic_flag_works = &sock_cloexec_works;
4086#else
4087 int *atomic_flag_works = NULL;
4088#endif
4089#endif
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 if (!PyArg_ParseTupleAndKeywords(args, kwds,
4092 "|iiiO:socket", keywords,
4093 &family, &type, &proto, &fdobj))
4094 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004096 if (fdobj != NULL && fdobj != Py_None) {
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004097#ifdef MS_WINDOWS
4098 /* recreate a socket that was duplicated */
4099 if (PyBytes_Check(fdobj)) {
4100 WSAPROTOCOL_INFO info;
4101 if (PyBytes_GET_SIZE(fdobj) != sizeof(info)) {
4102 PyErr_Format(PyExc_ValueError,
4103 "socket descriptor string has wrong size, "
4104 "should be %zu bytes.", sizeof(info));
4105 return -1;
4106 }
4107 memcpy(&info, PyBytes_AS_STRING(fdobj), sizeof(info));
4108 Py_BEGIN_ALLOW_THREADS
4109 fd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4110 FROM_PROTOCOL_INFO, &info, 0, WSA_FLAG_OVERLAPPED);
4111 Py_END_ALLOW_THREADS
4112 if (fd == INVALID_SOCKET) {
4113 set_error();
4114 return -1;
4115 }
4116 family = info.iAddressFamily;
4117 type = info.iSocketType;
4118 proto = info.iProtocol;
4119 }
4120 else
4121#endif
4122 {
4123 fd = PyLong_AsSocket_t(fdobj);
4124 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4125 return -1;
4126 if (fd == INVALID_SOCKET) {
4127 PyErr_SetString(PyExc_ValueError,
4128 "can't use invalid socket value");
4129 return -1;
4130 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004131 }
4132 }
4133 else {
Victor Stinnerdaf45552013-08-28 00:53:59 +02004134#ifdef MS_WINDOWS
4135 /* Windows implementation */
4136#ifndef WSA_FLAG_NO_HANDLE_INHERIT
4137#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
4138#endif
4139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004140 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02004141 if (support_wsa_no_inherit) {
4142 fd = WSASocket(family, type, proto,
4143 NULL, 0,
4144 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
4145 if (fd == INVALID_SOCKET) {
4146 /* Windows 7 or Windows 2008 R2 without SP1 or the hotfix */
4147 support_wsa_no_inherit = 0;
4148 fd = socket(family, type, proto);
4149 }
4150 }
4151 else {
4152 fd = socket(family, type, proto);
4153 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004154 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00004155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004156 if (fd == INVALID_SOCKET) {
4157 set_error();
4158 return -1;
4159 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02004160
4161 if (!support_wsa_no_inherit) {
4162 if (!SetHandleInformation((HANDLE)fd, HANDLE_FLAG_INHERIT, 0)) {
4163 closesocket(fd);
4164 PyErr_SetFromWindowsErr(0);
4165 return -1;
4166 }
4167 }
4168#else
4169 /* UNIX */
4170 Py_BEGIN_ALLOW_THREADS
4171#ifdef SOCK_CLOEXEC
4172 if (sock_cloexec_works != 0) {
4173 fd = socket(family, type | SOCK_CLOEXEC, proto);
4174 if (sock_cloexec_works == -1) {
4175 if (fd >= 0) {
4176 sock_cloexec_works = 1;
4177 }
4178 else if (errno == EINVAL) {
4179 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4180 sock_cloexec_works = 0;
4181 fd = socket(family, type, proto);
4182 }
4183 }
4184 }
4185 else
4186#endif
4187 {
4188 fd = socket(family, type, proto);
4189 }
4190 Py_END_ALLOW_THREADS
4191
4192 if (fd == INVALID_SOCKET) {
4193 set_error();
4194 return -1;
4195 }
4196
4197 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
4198 SOCKETCLOSE(fd);
4199 return -1;
4200 }
4201#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004202 }
4203 init_sockobject(s, fd, family, type, proto);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004205 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004206
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004207}
4208
4209
Guido van Rossumb6775db1994-08-01 11:34:53 +00004210/* Type object for socket objects. */
Guido van Rossum30a685f1991-06-27 15:51:29 +00004211
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004212static PyTypeObject sock_type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004213 PyVarObject_HEAD_INIT(0, 0) /* Must fill in type value later */
4214 "_socket.socket", /* tp_name */
4215 sizeof(PySocketSockObject), /* tp_basicsize */
4216 0, /* tp_itemsize */
4217 (destructor)sock_dealloc, /* tp_dealloc */
4218 0, /* tp_print */
4219 0, /* tp_getattr */
4220 0, /* tp_setattr */
4221 0, /* tp_reserved */
4222 (reprfunc)sock_repr, /* tp_repr */
4223 0, /* tp_as_number */
4224 0, /* tp_as_sequence */
4225 0, /* tp_as_mapping */
4226 0, /* tp_hash */
4227 0, /* tp_call */
4228 0, /* tp_str */
4229 PyObject_GenericGetAttr, /* tp_getattro */
4230 0, /* tp_setattro */
4231 0, /* tp_as_buffer */
4232 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4233 sock_doc, /* tp_doc */
4234 0, /* tp_traverse */
4235 0, /* tp_clear */
4236 0, /* tp_richcompare */
4237 0, /* tp_weaklistoffset */
4238 0, /* tp_iter */
4239 0, /* tp_iternext */
4240 sock_methods, /* tp_methods */
4241 sock_memberlist, /* tp_members */
Victor Stinner71694d52015-03-28 01:18:54 +01004242 sock_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004243 0, /* tp_base */
4244 0, /* tp_dict */
4245 0, /* tp_descr_get */
4246 0, /* tp_descr_set */
4247 0, /* tp_dictoffset */
4248 sock_initobj, /* tp_init */
4249 PyType_GenericAlloc, /* tp_alloc */
4250 sock_new, /* tp_new */
4251 PyObject_Del, /* tp_free */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004252};
4253
Guido van Rossum30a685f1991-06-27 15:51:29 +00004254
Guido van Rossum81194471991-07-27 21:42:02 +00004255/* Python interface to gethostname(). */
4256
4257/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004258static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00004259socket_gethostname(PyObject *self, PyObject *unused)
Guido van Rossum81194471991-07-27 21:42:02 +00004260{
Martin v. Löwis72f48422010-10-29 18:20:08 +00004261#ifdef MS_WINDOWS
4262 /* Don't use winsock's gethostname, as this returns the ANSI
4263 version of the hostname, whereas we need a Unicode string.
4264 Otherwise, gethostname apparently also returns the DNS name. */
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004265 wchar_t buf[MAX_COMPUTERNAME_LENGTH + 1];
Victor Stinner63941882011-09-29 00:42:28 +02004266 DWORD size = Py_ARRAY_LENGTH(buf);
Victor Stinner74168972011-11-17 01:11:36 +01004267 wchar_t *name;
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004268 PyObject *result;
Victor Stinner74168972011-11-17 01:11:36 +01004269
4270 if (GetComputerNameExW(ComputerNamePhysicalDnsHostname, buf, &size))
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004271 return PyUnicode_FromWideChar(buf, size);
Victor Stinner74168972011-11-17 01:11:36 +01004272
4273 if (GetLastError() != ERROR_MORE_DATA)
4274 return PyErr_SetFromWindowsErr(0);
4275
4276 if (size == 0)
4277 return PyUnicode_New(0, 0);
4278
4279 /* MSDN says ERROR_MORE_DATA may occur because DNS allows longer
4280 names */
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004281 name = PyMem_New(wchar_t, size);
4282 if (!name) {
4283 PyErr_NoMemory();
Victor Stinner74168972011-11-17 01:11:36 +01004284 return NULL;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004285 }
Victor Stinner74168972011-11-17 01:11:36 +01004286 if (!GetComputerNameExW(ComputerNamePhysicalDnsHostname,
4287 name,
4288 &size))
4289 {
4290 PyMem_Free(name);
4291 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004292 }
Victor Stinner74168972011-11-17 01:11:36 +01004293
4294 result = PyUnicode_FromWideChar(name, size);
4295 PyMem_Free(name);
4296 return result;
Martin v. Löwis72f48422010-10-29 18:20:08 +00004297#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 char buf[1024];
4299 int res;
4300 Py_BEGIN_ALLOW_THREADS
4301 res = gethostname(buf, (int) sizeof buf - 1);
4302 Py_END_ALLOW_THREADS
4303 if (res < 0)
4304 return set_error();
4305 buf[sizeof buf - 1] = '\0';
Victor Stinnera534fc42013-06-03 22:07:27 +02004306 return PyUnicode_DecodeFSDefault(buf);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004307#endif
Guido van Rossum81194471991-07-27 21:42:02 +00004308}
Guido van Rossumff4949e1992-08-05 19:58:53 +00004309
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004310PyDoc_STRVAR(gethostname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004311"gethostname() -> string\n\
4312\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004313Return the current host name.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004314
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004315#ifdef HAVE_SETHOSTNAME
4316PyDoc_STRVAR(sethostname_doc,
4317"sethostname(name)\n\n\
4318Sets the hostname to name.");
4319
4320static PyObject *
4321socket_sethostname(PyObject *self, PyObject *args)
4322{
4323 PyObject *hnobj;
4324 Py_buffer buf;
4325 int res, flag = 0;
4326
Christian Heimesd2774c72013-06-19 02:06:29 +02004327#ifdef _AIX
4328/* issue #18259, not declared in any useful header file */
4329extern int sethostname(const char *, size_t);
4330#endif
4331
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004332 if (!PyArg_ParseTuple(args, "S:sethostname", &hnobj)) {
4333 PyErr_Clear();
4334 if (!PyArg_ParseTuple(args, "O&:sethostname",
4335 PyUnicode_FSConverter, &hnobj))
4336 return NULL;
4337 flag = 1;
4338 }
4339 res = PyObject_GetBuffer(hnobj, &buf, PyBUF_SIMPLE);
4340 if (!res) {
4341 res = sethostname(buf.buf, buf.len);
4342 PyBuffer_Release(&buf);
4343 }
4344 if (flag)
4345 Py_DECREF(hnobj);
4346 if (res)
4347 return set_error();
4348 Py_RETURN_NONE;
4349}
4350#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +00004351
Guido van Rossum30a685f1991-06-27 15:51:29 +00004352/* Python interface to gethostbyname(name). */
4353
4354/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004355static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004356socket_gethostbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004357{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004358 char *name;
4359 sock_addr_t addrbuf;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004360 PyObject *ret = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004361
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004362 if (!PyArg_ParseTuple(args, "et:gethostbyname", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004363 return NULL;
4364 if (setipaddr(name, SAS2SA(&addrbuf), sizeof(addrbuf), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004365 goto finally;
4366 ret = makeipaddr(SAS2SA(&addrbuf), sizeof(struct sockaddr_in));
4367finally:
4368 PyMem_Free(name);
4369 return ret;
Guido van Rossum30a685f1991-06-27 15:51:29 +00004370}
4371
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004372PyDoc_STRVAR(gethostbyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004373"gethostbyname(host) -> address\n\
4374\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004375Return the IP address (a string of the form '255.255.255.255') for a host.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004376
4377
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004378/* Convenience function common to gethostbyname_ex and gethostbyaddr */
4379
4380static PyObject *
Victor Stinner1a62a682014-08-17 19:33:28 +02004381gethost_common(struct hostent *h, struct sockaddr *addr, size_t alen, int af)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004382{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004383 char **pch;
4384 PyObject *rtn_tuple = (PyObject *)NULL;
4385 PyObject *name_list = (PyObject *)NULL;
4386 PyObject *addr_list = (PyObject *)NULL;
4387 PyObject *tmp;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004389 if (h == NULL) {
4390 /* Let's get real error message to return */
4391 set_herror(h_errno);
4392 return NULL;
4393 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004395 if (h->h_addrtype != af) {
4396 /* Let's get real error message to return */
Victor Stinner1f33f2b2011-12-17 04:45:09 +01004397 errno = EAFNOSUPPORT;
4398 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004399 return NULL;
4400 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004402 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004404 case AF_INET:
4405 if (alen < sizeof(struct sockaddr_in))
4406 return NULL;
4407 break;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004408
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004409#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004410 case AF_INET6:
4411 if (alen < sizeof(struct sockaddr_in6))
4412 return NULL;
4413 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004414#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004416 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004418 if ((name_list = PyList_New(0)) == NULL)
4419 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004421 if ((addr_list = PyList_New(0)) == NULL)
4422 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004424 /* SF #1511317: h_aliases can be NULL */
4425 if (h->h_aliases) {
4426 for (pch = h->h_aliases; *pch != NULL; pch++) {
4427 int status;
4428 tmp = PyUnicode_FromString(*pch);
4429 if (tmp == NULL)
4430 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004432 status = PyList_Append(name_list, tmp);
4433 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004435 if (status)
4436 goto err;
4437 }
4438 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004440 for (pch = h->h_addr_list; *pch != NULL; pch++) {
4441 int status;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004443 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004445 case AF_INET:
4446 {
4447 struct sockaddr_in sin;
4448 memset(&sin, 0, sizeof(sin));
4449 sin.sin_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004450#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004451 sin.sin_len = sizeof(sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004452#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004453 memcpy(&sin.sin_addr, *pch, sizeof(sin.sin_addr));
4454 tmp = makeipaddr((struct sockaddr *)&sin, sizeof(sin));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004456 if (pch == h->h_addr_list && alen >= sizeof(sin))
4457 memcpy((char *) addr, &sin, sizeof(sin));
4458 break;
4459 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004460
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004461#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004462 case AF_INET6:
4463 {
4464 struct sockaddr_in6 sin6;
4465 memset(&sin6, 0, sizeof(sin6));
4466 sin6.sin6_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004467#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004468 sin6.sin6_len = sizeof(sin6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004469#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004470 memcpy(&sin6.sin6_addr, *pch, sizeof(sin6.sin6_addr));
4471 tmp = makeipaddr((struct sockaddr *)&sin6,
4472 sizeof(sin6));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004474 if (pch == h->h_addr_list && alen >= sizeof(sin6))
4475 memcpy((char *) addr, &sin6, sizeof(sin6));
4476 break;
4477 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004478#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004480 default: /* can't happen */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004481 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004482 "unsupported address family");
4483 return NULL;
4484 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004486 if (tmp == NULL)
4487 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004489 status = PyList_Append(addr_list, tmp);
4490 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004492 if (status)
4493 goto err;
4494 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004496 rtn_tuple = Py_BuildValue("sOO", h->h_name, name_list, addr_list);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004497
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004498 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004499 Py_XDECREF(name_list);
4500 Py_XDECREF(addr_list);
4501 return rtn_tuple;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004502}
4503
4504
4505/* Python interface to gethostbyname_ex(name). */
4506
4507/*ARGSUSED*/
4508static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004509socket_gethostbyname_ex(PyObject *self, PyObject *args)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004511 char *name;
4512 struct hostent *h;
Charles-François Natali8b759652011-12-23 16:44:51 +01004513 sock_addr_t addr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004514 struct sockaddr *sa;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004515 PyObject *ret = NULL;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004516#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004517 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004518#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004519 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004520#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004521 char buf[16384];
4522 int buf_len = (sizeof buf) - 1;
4523 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004524#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004525#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004526 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004527#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004528#endif /* HAVE_GETHOSTBYNAME_R */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004529
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004530 if (!PyArg_ParseTuple(args, "et:gethostbyname_ex", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004531 return NULL;
Charles-François Natali8b759652011-12-23 16:44:51 +01004532 if (setipaddr(name, SAS2SA(&addr), sizeof(addr), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004533 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004534 Py_BEGIN_ALLOW_THREADS
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004535#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004536#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004537 gethostbyname_r(name, &hp_allocated, buf, buf_len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004538 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004539#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004540 h = gethostbyname_r(name, &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004541#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004542 memset((void *) &data, '\0', sizeof(data));
4543 result = gethostbyname_r(name, &hp_allocated, &data);
4544 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004545#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004546#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004547#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004548 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004549#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004550 h = gethostbyname(name);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004551#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004552 Py_END_ALLOW_THREADS
4553 /* Some C libraries would require addr.__ss_family instead of
4554 addr.ss_family.
4555 Therefore, we cast the sockaddr_storage into sockaddr to
4556 access sa_family. */
Charles-François Natali8b759652011-12-23 16:44:51 +01004557 sa = SAS2SA(&addr);
4558 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004559 sa->sa_family);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004560#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004561 PyThread_release_lock(netdb_lock);
Guido van Rossum955becc1999-03-22 20:14:53 +00004562#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004563finally:
4564 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004565 return ret;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004566}
4567
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004568PyDoc_STRVAR(ghbn_ex_doc,
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004569"gethostbyname_ex(host) -> (name, aliaslist, addresslist)\n\
4570\n\
4571Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004572for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004573
4574
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004575/* Python interface to gethostbyaddr(IP). */
4576
4577/*ARGSUSED*/
4578static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004579socket_gethostbyaddr(PyObject *self, PyObject *args)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004580{
Charles-François Natali8b759652011-12-23 16:44:51 +01004581 sock_addr_t addr;
4582 struct sockaddr *sa = SAS2SA(&addr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004583 char *ip_num;
4584 struct hostent *h;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004585 PyObject *ret = NULL;
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004586#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004587 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004588#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004589 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004590#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004591 /* glibcs up to 2.10 assume that the buf argument to
4592 gethostbyaddr_r is 8-byte aligned, which at least llvm-gcc
4593 does not ensure. The attribute below instructs the compiler
4594 to maintain this alignment. */
4595 char buf[16384] Py_ALIGNED(8);
4596 int buf_len = (sizeof buf) - 1;
4597 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004598#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004599#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004600 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004601#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004602#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004603 char *ap;
4604 int al;
4605 int af;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004606
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004607 if (!PyArg_ParseTuple(args, "et:gethostbyaddr", "idna", &ip_num))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004608 return NULL;
4609 af = AF_UNSPEC;
4610 if (setipaddr(ip_num, sa, sizeof(addr), af) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004611 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004612 af = sa->sa_family;
4613 ap = NULL;
Brett Cannonb94767f2011-02-22 20:15:44 +00004614 /* al = 0; */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004615 switch (af) {
4616 case AF_INET:
4617 ap = (char *)&((struct sockaddr_in *)sa)->sin_addr;
4618 al = sizeof(((struct sockaddr_in *)sa)->sin_addr);
4619 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004620#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004621 case AF_INET6:
4622 ap = (char *)&((struct sockaddr_in6 *)sa)->sin6_addr;
4623 al = sizeof(((struct sockaddr_in6 *)sa)->sin6_addr);
4624 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004625#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004626 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004627 PyErr_SetString(PyExc_OSError, "unsupported address family");
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004628 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004629 }
4630 Py_BEGIN_ALLOW_THREADS
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004631#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004632#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004633 gethostbyaddr_r(ap, al, af,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004634 &hp_allocated, buf, buf_len,
4635 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004636#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004637 h = gethostbyaddr_r(ap, al, af,
4638 &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004639#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004640 memset((void *) &data, '\0', sizeof(data));
4641 result = gethostbyaddr_r(ap, al, af, &hp_allocated, &data);
4642 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004643#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004644#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004645#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004646 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004647#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004648 h = gethostbyaddr(ap, al, af);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004649#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004650 Py_END_ALLOW_THREADS
Charles-François Natali8b759652011-12-23 16:44:51 +01004651 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr), af);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004652#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004653 PyThread_release_lock(netdb_lock);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004654#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004655finally:
4656 PyMem_Free(ip_num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004657 return ret;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004658}
4659
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004660PyDoc_STRVAR(gethostbyaddr_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004661"gethostbyaddr(host) -> (name, aliaslist, addresslist)\n\
4662\n\
4663Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004664for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004665
Guido van Rossum30a685f1991-06-27 15:51:29 +00004666
4667/* Python interface to getservbyname(name).
4668 This only returns the port number, since the other info is already
4669 known or not useful (like the list of aliases). */
4670
4671/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004672static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004673socket_getservbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004674{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004675 char *name, *proto=NULL;
4676 struct servent *sp;
4677 if (!PyArg_ParseTuple(args, "s|s:getservbyname", &name, &proto))
4678 return NULL;
4679 Py_BEGIN_ALLOW_THREADS
4680 sp = getservbyname(name, proto);
4681 Py_END_ALLOW_THREADS
4682 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004683 PyErr_SetString(PyExc_OSError, "service/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004684 return NULL;
4685 }
4686 return PyLong_FromLong((long) ntohs(sp->s_port));
Guido van Rossum30a685f1991-06-27 15:51:29 +00004687}
4688
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004689PyDoc_STRVAR(getservbyname_doc,
Barry Warsaw11b91a02004-06-28 00:50:43 +00004690"getservbyname(servicename[, protocolname]) -> integer\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00004691\n\
4692Return a port number from a service name and protocol name.\n\
Barry Warsaw11b91a02004-06-28 00:50:43 +00004693The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4694otherwise any protocol will match.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004695
Guido van Rossum30a685f1991-06-27 15:51:29 +00004696
Barry Warsaw11b91a02004-06-28 00:50:43 +00004697/* Python interface to getservbyport(port).
4698 This only returns the service name, since the other info is already
4699 known or not useful (like the list of aliases). */
4700
4701/*ARGSUSED*/
4702static PyObject *
4703socket_getservbyport(PyObject *self, PyObject *args)
4704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004705 int port;
4706 char *proto=NULL;
4707 struct servent *sp;
4708 if (!PyArg_ParseTuple(args, "i|s:getservbyport", &port, &proto))
4709 return NULL;
4710 if (port < 0 || port > 0xffff) {
4711 PyErr_SetString(
4712 PyExc_OverflowError,
4713 "getservbyport: port must be 0-65535.");
4714 return NULL;
4715 }
4716 Py_BEGIN_ALLOW_THREADS
4717 sp = getservbyport(htons((short)port), proto);
4718 Py_END_ALLOW_THREADS
4719 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004720 PyErr_SetString(PyExc_OSError, "port/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004721 return NULL;
4722 }
4723 return PyUnicode_FromString(sp->s_name);
Barry Warsaw11b91a02004-06-28 00:50:43 +00004724}
4725
4726PyDoc_STRVAR(getservbyport_doc,
4727"getservbyport(port[, protocolname]) -> string\n\
4728\n\
4729Return the service name from a port number and protocol name.\n\
4730The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4731otherwise any protocol will match.");
4732
Guido van Rossum3901d851996-12-19 16:35:04 +00004733/* Python interface to getprotobyname(name).
4734 This only returns the protocol number, since the other info is
4735 already known or not useful (like the list of aliases). */
4736
4737/*ARGSUSED*/
4738static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004739socket_getprotobyname(PyObject *self, PyObject *args)
Guido van Rossum3901d851996-12-19 16:35:04 +00004740{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004741 char *name;
4742 struct protoent *sp;
4743 if (!PyArg_ParseTuple(args, "s:getprotobyname", &name))
4744 return NULL;
4745 Py_BEGIN_ALLOW_THREADS
4746 sp = getprotobyname(name);
4747 Py_END_ALLOW_THREADS
4748 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004749 PyErr_SetString(PyExc_OSError, "protocol not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004750 return NULL;
4751 }
4752 return PyLong_FromLong((long) sp->p_proto);
Guido van Rossum3901d851996-12-19 16:35:04 +00004753}
4754
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004755PyDoc_STRVAR(getprotobyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004756"getprotobyname(name) -> integer\n\
4757\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004758Return the protocol number for the named protocol. (Rarely used.)");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004759
Guido van Rossum3901d851996-12-19 16:35:04 +00004760
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004761#ifndef NO_DUP
4762/* dup() function for socket fds */
4763
4764static PyObject *
4765socket_dup(PyObject *self, PyObject *fdobj)
4766{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004767 SOCKET_T fd, newfd;
4768 PyObject *newfdobj;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004769#ifdef MS_WINDOWS
4770 WSAPROTOCOL_INFO info;
4771#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004773 fd = PyLong_AsSocket_t(fdobj);
4774 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4775 return NULL;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004776
Victor Stinnerdaf45552013-08-28 00:53:59 +02004777#ifdef MS_WINDOWS
4778 if (WSADuplicateSocket(fd, GetCurrentProcessId(), &info))
4779 return set_error();
4780
4781 newfd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4782 FROM_PROTOCOL_INFO,
4783 &info, 0, WSA_FLAG_OVERLAPPED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004784 if (newfd == INVALID_SOCKET)
4785 return set_error();
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004786
Victor Stinnerdaf45552013-08-28 00:53:59 +02004787 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
4788 closesocket(newfd);
4789 PyErr_SetFromWindowsErr(0);
4790 return NULL;
4791 }
4792#else
4793 /* On UNIX, dup can be used to duplicate the file descriptor of a socket */
4794 newfd = _Py_dup(fd);
4795 if (newfd == INVALID_SOCKET)
Victor Stinnere990c6e2013-11-16 00:18:58 +01004796 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004797#endif
4798
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004799 newfdobj = PyLong_FromSocket_t(newfd);
4800 if (newfdobj == NULL)
4801 SOCKETCLOSE(newfd);
4802 return newfdobj;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004803}
4804
4805PyDoc_STRVAR(dup_doc,
4806"dup(integer) -> integer\n\
4807\n\
4808Duplicate an integer socket file descriptor. This is like os.dup(), but for\n\
4809sockets; on some platforms os.dup() won't work for socket file descriptors.");
4810#endif
4811
4812
Dave Cole331708b2004-08-09 04:51:41 +00004813#ifdef HAVE_SOCKETPAIR
4814/* Create a pair of sockets using the socketpair() function.
Dave Cole07fda7e2004-08-23 05:16:23 +00004815 Arguments as for socket() except the default family is AF_UNIX if
Dave Colee8bbfe42004-08-26 00:51:16 +00004816 defined on the platform; otherwise, the default is AF_INET. */
Dave Cole331708b2004-08-09 04:51:41 +00004817
4818/*ARGSUSED*/
4819static PyObject *
4820socket_socketpair(PyObject *self, PyObject *args)
4821{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004822 PySocketSockObject *s0 = NULL, *s1 = NULL;
4823 SOCKET_T sv[2];
4824 int family, type = SOCK_STREAM, proto = 0;
4825 PyObject *res = NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004826#ifdef SOCK_CLOEXEC
4827 int *atomic_flag_works = &sock_cloexec_works;
4828#else
4829 int *atomic_flag_works = NULL;
4830#endif
4831 int ret;
Dave Cole331708b2004-08-09 04:51:41 +00004832
4833#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004834 family = AF_UNIX;
Dave Cole331708b2004-08-09 04:51:41 +00004835#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004836 family = AF_INET;
Dave Cole331708b2004-08-09 04:51:41 +00004837#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004838 if (!PyArg_ParseTuple(args, "|iii:socketpair",
4839 &family, &type, &proto))
4840 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004842 /* Create a pair of socket fds */
Victor Stinnerdaf45552013-08-28 00:53:59 +02004843 Py_BEGIN_ALLOW_THREADS
4844#ifdef SOCK_CLOEXEC
4845 if (sock_cloexec_works != 0) {
4846 ret = socketpair(family, type | SOCK_CLOEXEC, proto, sv);
4847 if (sock_cloexec_works == -1) {
4848 if (ret >= 0) {
4849 sock_cloexec_works = 1;
4850 }
4851 else if (errno == EINVAL) {
4852 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4853 sock_cloexec_works = 0;
4854 ret = socketpair(family, type, proto, sv);
4855 }
4856 }
4857 }
4858 else
4859#endif
4860 {
4861 ret = socketpair(family, type, proto, sv);
4862 }
4863 Py_END_ALLOW_THREADS
4864
4865 if (ret < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004866 return set_error();
Victor Stinnerdaf45552013-08-28 00:53:59 +02004867
4868 if (_Py_set_inheritable(sv[0], 0, atomic_flag_works) < 0)
4869 goto finally;
4870 if (_Py_set_inheritable(sv[1], 0, atomic_flag_works) < 0)
4871 goto finally;
4872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004873 s0 = new_sockobject(sv[0], family, type, proto);
4874 if (s0 == NULL)
4875 goto finally;
4876 s1 = new_sockobject(sv[1], family, type, proto);
4877 if (s1 == NULL)
4878 goto finally;
4879 res = PyTuple_Pack(2, s0, s1);
Dave Cole331708b2004-08-09 04:51:41 +00004880
4881finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004882 if (res == NULL) {
4883 if (s0 == NULL)
4884 SOCKETCLOSE(sv[0]);
4885 if (s1 == NULL)
4886 SOCKETCLOSE(sv[1]);
4887 }
4888 Py_XDECREF(s0);
4889 Py_XDECREF(s1);
4890 return res;
Dave Cole331708b2004-08-09 04:51:41 +00004891}
4892
4893PyDoc_STRVAR(socketpair_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +02004894"socketpair([family[, type [, proto]]]) -> (socket object, socket object)\n\
Dave Cole331708b2004-08-09 04:51:41 +00004895\n\
4896Create a pair of socket objects from the sockets returned by the platform\n\
4897socketpair() function.\n\
Dave Cole07fda7e2004-08-23 05:16:23 +00004898The arguments are the same as for socket() except the default family is\n\
Dave Colee8bbfe42004-08-26 00:51:16 +00004899AF_UNIX if defined on the platform; otherwise, the default is AF_INET.");
Dave Cole331708b2004-08-09 04:51:41 +00004900
4901#endif /* HAVE_SOCKETPAIR */
4902
4903
Guido van Rossum006bf911996-06-12 04:04:55 +00004904static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004905socket_ntohs(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004907 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004909 if (!PyArg_ParseTuple(args, "i:ntohs", &x1)) {
4910 return NULL;
4911 }
4912 if (x1 < 0) {
4913 PyErr_SetString(PyExc_OverflowError,
4914 "can't convert negative number to unsigned long");
4915 return NULL;
4916 }
4917 x2 = (unsigned int)ntohs((unsigned short)x1);
4918 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004919}
4920
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004921PyDoc_STRVAR(ntohs_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004922"ntohs(integer) -> integer\n\
4923\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004924Convert a 16-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004925
4926
Guido van Rossum006bf911996-06-12 04:04:55 +00004927static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004928socket_ntohl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004929{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004930 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004932 if (PyLong_Check(arg)) {
4933 x = PyLong_AsUnsignedLong(arg);
4934 if (x == (unsigned long) -1 && PyErr_Occurred())
4935 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004936#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004937 {
4938 unsigned long y;
4939 /* only want the trailing 32 bits */
4940 y = x & 0xFFFFFFFFUL;
4941 if (y ^ x)
4942 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004943 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004944 x = y;
4945 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004946#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004947 }
4948 else
4949 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004950 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004951 Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004952 return PyLong_FromUnsignedLong(ntohl(x));
Guido van Rossum006bf911996-06-12 04:04:55 +00004953}
4954
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004955PyDoc_STRVAR(ntohl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004956"ntohl(integer) -> integer\n\
4957\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004958Convert a 32-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004959
4960
Guido van Rossum006bf911996-06-12 04:04:55 +00004961static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004962socket_htons(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004963{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004964 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004966 if (!PyArg_ParseTuple(args, "i:htons", &x1)) {
4967 return NULL;
4968 }
4969 if (x1 < 0) {
4970 PyErr_SetString(PyExc_OverflowError,
4971 "can't convert negative number to unsigned long");
4972 return NULL;
4973 }
4974 x2 = (unsigned int)htons((unsigned short)x1);
4975 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004976}
4977
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004978PyDoc_STRVAR(htons_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004979"htons(integer) -> integer\n\
4980\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004981Convert a 16-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004982
4983
Guido van Rossum006bf911996-06-12 04:04:55 +00004984static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004985socket_htonl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004987 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004989 if (PyLong_Check(arg)) {
4990 x = PyLong_AsUnsignedLong(arg);
4991 if (x == (unsigned long) -1 && PyErr_Occurred())
4992 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004993#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004994 {
4995 unsigned long y;
4996 /* only want the trailing 32 bits */
4997 y = x & 0xFFFFFFFFUL;
4998 if (y ^ x)
4999 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005000 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005001 x = y;
5002 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005003#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005004 }
5005 else
5006 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005007 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005008 Py_TYPE(arg)->tp_name);
5009 return PyLong_FromUnsignedLong(htonl((unsigned long)x));
Guido van Rossum006bf911996-06-12 04:04:55 +00005010}
5011
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005012PyDoc_STRVAR(htonl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005013"htonl(integer) -> integer\n\
5014\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005015Convert a 32-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005016
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005017/* socket.inet_aton() and socket.inet_ntoa() functions. */
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005018
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005019PyDoc_STRVAR(inet_aton_doc,
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005020"inet_aton(string) -> bytes giving packed 32-bit IP representation\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005021\n\
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005022Convert 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 +00005023binary format used in low-level network functions.");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005024
5025static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005026socket_inet_aton(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005027{
Neal Norwitz88f115b2003-02-13 02:15:42 +00005028#ifdef HAVE_INET_ATON
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005029 struct in_addr buf;
Thomas Wouters477c8d52006-05-27 19:21:47 +00005030#endif
5031
5032#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
Benjamin Petersonf91df042009-02-13 02:50:59 +00005033#if (SIZEOF_INT != 4)
5034#error "Not sure if in_addr_t exists and int is not 32-bits."
5035#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005036 /* Have to use inet_addr() instead */
5037 unsigned int packed_addr;
Tim Peters1df9fdd2003-02-13 03:13:40 +00005038#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005039 char *ip_addr;
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005041 if (!PyArg_ParseTuple(args, "s:inet_aton", &ip_addr))
5042 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005043
Tim Peters1df9fdd2003-02-13 03:13:40 +00005044
5045#ifdef HAVE_INET_ATON
Thomas Wouters477c8d52006-05-27 19:21:47 +00005046
5047#ifdef USE_INET_ATON_WEAKLINK
5048 if (inet_aton != NULL) {
5049#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005050 if (inet_aton(ip_addr, &buf))
5051 return PyBytes_FromStringAndSize((char *)(&buf),
5052 sizeof(buf));
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005053
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005054 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005055 "illegal IP address string passed to inet_aton");
5056 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005057
Thomas Wouters477c8d52006-05-27 19:21:47 +00005058#ifdef USE_INET_ATON_WEAKLINK
5059 } else {
5060#endif
5061
5062#endif
5063
5064#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
5065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005066 /* special-case this address as inet_addr might return INADDR_NONE
5067 * for this */
5068 if (strcmp(ip_addr, "255.255.255.255") == 0) {
Charles-François Natali24aa0412013-08-31 14:48:25 +02005069 packed_addr = INADDR_BROADCAST;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005070 } else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00005071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005072 packed_addr = inet_addr(ip_addr);
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 if (packed_addr == INADDR_NONE) { /* invalid address */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005075 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005076 "illegal IP address string passed to inet_aton");
5077 return NULL;
5078 }
5079 }
5080 return PyBytes_FromStringAndSize((char *) &packed_addr,
5081 sizeof(packed_addr));
Thomas Wouters477c8d52006-05-27 19:21:47 +00005082
5083#ifdef USE_INET_ATON_WEAKLINK
5084 }
5085#endif
5086
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005087#endif
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005088}
5089
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005090PyDoc_STRVAR(inet_ntoa_doc,
Fred Drakee0661342000-03-07 14:05:16 +00005091"inet_ntoa(packed_ip) -> ip_address_string\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005092\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005093Convert an IP address from 32-bit packed binary format to string format");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005094
5095static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005096socket_inet_ntoa(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005097{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005098 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005099 struct in_addr packed_addr;
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005100
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005101 if (!PyArg_ParseTuple(args, "y*:inet_ntoa", &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005102 return NULL;
5103 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00005104
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005105 if (packed_ip.len != sizeof(packed_addr)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005106 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005107 "packed IP wrong length for inet_ntoa");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005108 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005109 return NULL;
5110 }
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005111
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005112 memcpy(&packed_addr, packed_ip.buf, packed_ip.len);
5113 PyBuffer_Release(&packed_ip);
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005115 return PyUnicode_FromString(inet_ntoa(packed_addr));
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005116}
Guido van Rossum82a5c661998-07-07 20:45:43 +00005117
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005118#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005119
5120PyDoc_STRVAR(inet_pton_doc,
5121"inet_pton(af, ip) -> packed IP address string\n\
5122\n\
5123Convert an IP address from string format to a packed string suitable\n\
5124for use with low-level network functions.");
5125
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005126#endif
5127
5128#ifdef HAVE_INET_PTON
5129
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005130static PyObject *
5131socket_inet_pton(PyObject *self, PyObject *args)
5132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005133 int af;
5134 char* ip;
5135 int retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005136#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005137 char packed[Py_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005138#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005139 char packed[sizeof(struct in_addr)];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005140#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005141 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5142 return NULL;
5143 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005144
Martin v. Löwis04697e82004-06-02 12:35:29 +00005145#if !defined(ENABLE_IPV6) && defined(AF_INET6)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005146 if(af == AF_INET6) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005147 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005148 "can't use AF_INET6, IPv6 is disabled");
5149 return NULL;
5150 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00005151#endif
Martin v. Löwis10649092003-08-05 06:25:06 +00005152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005153 retval = inet_pton(af, ip, packed);
5154 if (retval < 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005155 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005156 return NULL;
5157 } else if (retval == 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005158 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005159 "illegal IP address string passed to inet_pton");
5160 return NULL;
5161 } else if (af == AF_INET) {
5162 return PyBytes_FromStringAndSize(packed,
5163 sizeof(struct in_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005164#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005165 } else if (af == AF_INET6) {
5166 return PyBytes_FromStringAndSize(packed,
5167 sizeof(struct in6_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005168#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005169 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005170 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005171 return NULL;
5172 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005173}
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005174#elif defined(MS_WINDOWS)
5175
5176static PyObject *
5177socket_inet_pton(PyObject *self, PyObject *args)
5178{
5179 int af;
5180 char* ip;
5181 struct sockaddr_in6 addr;
5182 INT ret, size;
5183
5184 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5185 return NULL;
5186 }
5187
Victor Stinnere990c6e2013-11-16 00:18:58 +01005188 size = sizeof(addr);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005189 ret = WSAStringToAddressA(ip, af, NULL, (LPSOCKADDR)&addr, &size);
5190
5191 if (ret) {
5192 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5193 return NULL;
5194 } else if(af == AF_INET) {
5195 struct sockaddr_in *addr4 = (struct sockaddr_in*)&addr;
Victor Stinnere990c6e2013-11-16 00:18:58 +01005196 return PyBytes_FromStringAndSize((const char *)&(addr4->sin_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005197 sizeof(addr4->sin_addr));
5198 } else if (af == AF_INET6) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01005199 return PyBytes_FromStringAndSize((const char *)&(addr.sin6_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005200 sizeof(addr.sin6_addr));
5201 } else {
5202 PyErr_SetString(PyExc_OSError, "unknown address family");
5203 return NULL;
5204 }
5205}
5206
5207#endif
5208
5209#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Thomas Wouters477c8d52006-05-27 19:21:47 +00005210
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005211PyDoc_STRVAR(inet_ntop_doc,
5212"inet_ntop(af, packed_ip) -> string formatted IP address\n\
5213\n\
5214Convert a packed IP address of the given family to string format.");
5215
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005216#endif
5217
5218
5219#ifdef HAVE_INET_PTON
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005220static PyObject *
5221socket_inet_ntop(PyObject *self, PyObject *args)
5222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005223 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005224 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005225 const char* retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005226#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005227 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005228#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005229 char ip[INET_ADDRSTRLEN + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005230#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00005231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005232 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5233 memset((void *) &ip[0], '\0', sizeof(ip));
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005234
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005235 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005236 return NULL;
5237 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005239 if (af == AF_INET) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005240 if (packed_ip.len != sizeof(struct in_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005241 PyErr_SetString(PyExc_ValueError,
5242 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005243 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005244 return NULL;
5245 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005246#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005247 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005248 if (packed_ip.len != sizeof(struct in6_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005249 PyErr_SetString(PyExc_ValueError,
5250 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005251 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005252 return NULL;
5253 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005254#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005255 } else {
5256 PyErr_Format(PyExc_ValueError,
5257 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005258 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005259 return NULL;
5260 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005261
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005262 retval = inet_ntop(af, packed_ip.buf, ip, sizeof(ip));
5263 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005264 if (!retval) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005265 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005266 return NULL;
5267 } else {
5268 return PyUnicode_FromString(retval);
5269 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005271 /* NOTREACHED */
5272 PyErr_SetString(PyExc_RuntimeError, "invalid handling of inet_ntop");
5273 return NULL;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005274}
5275
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005276#elif defined(MS_WINDOWS)
5277
5278static PyObject *
5279socket_inet_ntop(PyObject *self, PyObject *args)
5280{
5281 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005282 Py_buffer packed_ip;
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005283 struct sockaddr_in6 addr;
5284 DWORD addrlen, ret, retlen;
Jason R. Coombs8ec784c2013-11-10 13:43:22 -05005285#ifdef ENABLE_IPV6
5286 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
5287#else
5288 char ip[INET_ADDRSTRLEN + 1];
5289#endif
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005290
5291 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5292 memset((void *) &ip[0], '\0', sizeof(ip));
5293
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005294 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005295 return NULL;
5296 }
5297
5298 if (af == AF_INET) {
5299 struct sockaddr_in * addr4 = (struct sockaddr_in *)&addr;
5300
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005301 if (packed_ip.len != sizeof(struct in_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005302 PyErr_SetString(PyExc_ValueError,
5303 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005304 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005305 return NULL;
5306 }
5307 memset(addr4, 0, sizeof(struct sockaddr_in));
5308 addr4->sin_family = AF_INET;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005309 memcpy(&(addr4->sin_addr), packed_ip.buf, sizeof(addr4->sin_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005310 addrlen = sizeof(struct sockaddr_in);
5311 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005312 if (packed_ip.len != sizeof(struct in6_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005313 PyErr_SetString(PyExc_ValueError,
5314 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005315 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005316 return NULL;
5317 }
5318
5319 memset(&addr, 0, sizeof(addr));
5320 addr.sin6_family = AF_INET6;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005321 memcpy(&(addr.sin6_addr), packed_ip.buf, sizeof(addr.sin6_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005322 addrlen = sizeof(addr);
5323 } else {
5324 PyErr_Format(PyExc_ValueError,
5325 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005326 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005327 return NULL;
5328 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005329 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005330
5331 retlen = sizeof(ip);
Victor Stinnere990c6e2013-11-16 00:18:58 +01005332 ret = WSAAddressToStringA((struct sockaddr*)&addr, addrlen, NULL,
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005333 ip, &retlen);
5334
5335 if (ret) {
5336 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5337 return NULL;
5338 } else {
5339 return PyUnicode_FromString(ip);
5340 }
5341}
5342
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005343#endif /* HAVE_INET_PTON */
5344
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005345/* Python interface to getaddrinfo(host, port). */
5346
5347/*ARGSUSED*/
5348static PyObject *
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005349socket_getaddrinfo(PyObject *self, PyObject *args, PyObject* kwargs)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005350{
Victor Stinner77af1722011-05-26 14:05:59 +02005351 static char* kwnames[] = {"host", "port", "family", "type", "proto",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005352 "flags", 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005353 struct addrinfo hints, *res;
5354 struct addrinfo *res0 = NULL;
5355 PyObject *hobj = NULL;
5356 PyObject *pobj = (PyObject *)NULL;
5357 char pbuf[30];
5358 char *hptr, *pptr;
5359 int family, socktype, protocol, flags;
5360 int error;
5361 PyObject *all = (PyObject *)NULL;
5362 PyObject *idna = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005363
Georg Brandl6083a4b2013-10-14 06:51:46 +02005364 socktype = protocol = flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005365 family = AF_UNSPEC;
Victor Stinner77af1722011-05-26 14:05:59 +02005366 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|iiii:getaddrinfo",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005367 kwnames, &hobj, &pobj, &family, &socktype,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005368 &protocol, &flags)) {
5369 return NULL;
5370 }
5371 if (hobj == Py_None) {
5372 hptr = NULL;
5373 } else if (PyUnicode_Check(hobj)) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005374 _Py_IDENTIFIER(encode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02005375
5376 idna = _PyObject_CallMethodId(hobj, &PyId_encode, "s", "idna");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005377 if (!idna)
5378 return NULL;
5379 assert(PyBytes_Check(idna));
5380 hptr = PyBytes_AS_STRING(idna);
5381 } else if (PyBytes_Check(hobj)) {
5382 hptr = PyBytes_AsString(hobj);
5383 } else {
5384 PyErr_SetString(PyExc_TypeError,
5385 "getaddrinfo() argument 1 must be string or None");
5386 return NULL;
5387 }
5388 if (PyLong_CheckExact(pobj)) {
5389 long value = PyLong_AsLong(pobj);
5390 if (value == -1 && PyErr_Occurred())
5391 goto err;
5392 PyOS_snprintf(pbuf, sizeof(pbuf), "%ld", value);
5393 pptr = pbuf;
5394 } else if (PyUnicode_Check(pobj)) {
5395 pptr = _PyUnicode_AsString(pobj);
Alexander Belopolskye239d232010-12-08 23:31:48 +00005396 if (pptr == NULL)
5397 goto err;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005398 } else if (PyBytes_Check(pobj)) {
Alexander Belopolskye239d232010-12-08 23:31:48 +00005399 pptr = PyBytes_AS_STRING(pobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005400 } else if (pobj == Py_None) {
5401 pptr = (char *)NULL;
5402 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005403 PyErr_SetString(PyExc_OSError, "Int or String expected");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005404 goto err;
5405 }
Ronald Oussorena822d3662013-06-10 10:36:28 +02005406#if defined(__APPLE__) && defined(AI_NUMERICSERV)
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005407 if ((flags & AI_NUMERICSERV) && (pptr == NULL || (pptr[0] == '0' && pptr[1] == 0))) {
5408 /* On OSX upto at least OSX 10.8 getaddrinfo crashes
Christian Heimesaf01f662013-12-21 16:19:10 +01005409 * if AI_NUMERICSERV is set and the servname is NULL or "0".
5410 * This workaround avoids a segfault in libsystem.
5411 */
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005412 pptr = "00";
5413 }
5414#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005415 memset(&hints, 0, sizeof(hints));
5416 hints.ai_family = family;
5417 hints.ai_socktype = socktype;
5418 hints.ai_protocol = protocol;
5419 hints.ai_flags = flags;
5420 Py_BEGIN_ALLOW_THREADS
5421 ACQUIRE_GETADDRINFO_LOCK
5422 error = getaddrinfo(hptr, pptr, &hints, &res0);
5423 Py_END_ALLOW_THREADS
5424 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5425 if (error) {
5426 set_gaierror(error);
5427 goto err;
5428 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005430 if ((all = PyList_New(0)) == NULL)
5431 goto err;
5432 for (res = res0; res; res = res->ai_next) {
5433 PyObject *single;
5434 PyObject *addr =
5435 makesockaddr(-1, res->ai_addr, res->ai_addrlen, protocol);
5436 if (addr == NULL)
5437 goto err;
5438 single = Py_BuildValue("iiisO", res->ai_family,
5439 res->ai_socktype, res->ai_protocol,
5440 res->ai_canonname ? res->ai_canonname : "",
5441 addr);
5442 Py_DECREF(addr);
5443 if (single == NULL)
5444 goto err;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005446 if (PyList_Append(all, single))
5447 goto err;
5448 Py_XDECREF(single);
5449 }
5450 Py_XDECREF(idna);
5451 if (res0)
5452 freeaddrinfo(res0);
5453 return all;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005454 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005455 Py_XDECREF(all);
5456 Py_XDECREF(idna);
5457 if (res0)
5458 freeaddrinfo(res0);
5459 return (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005460}
5461
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005462PyDoc_STRVAR(getaddrinfo_doc,
Berker Peksaga6ec5ee2014-06-30 11:28:40 +03005463"getaddrinfo(host, port [, family, type, proto, flags])\n\
5464 -> list of (family, type, proto, canonname, sockaddr)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005465\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005466Resolve host and port into addrinfo struct.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005467
5468/* Python interface to getnameinfo(sa, flags). */
5469
5470/*ARGSUSED*/
5471static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005472socket_getnameinfo(PyObject *self, PyObject *args)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005473{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005474 PyObject *sa = (PyObject *)NULL;
5475 int flags;
5476 char *hostp;
Charles-François Natali366999a2012-01-02 15:47:29 +01005477 int port;
5478 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005479 char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
5480 struct addrinfo hints, *res = NULL;
5481 int error;
5482 PyObject *ret = (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005484 flags = flowinfo = scope_id = 0;
5485 if (!PyArg_ParseTuple(args, "Oi:getnameinfo", &sa, &flags))
5486 return NULL;
5487 if (!PyTuple_Check(sa)) {
5488 PyErr_SetString(PyExc_TypeError,
5489 "getnameinfo() argument 1 must be a tuple");
5490 return NULL;
5491 }
Charles-François Natali366999a2012-01-02 15:47:29 +01005492 if (!PyArg_ParseTuple(sa, "si|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005493 &hostp, &port, &flowinfo, &scope_id))
5494 return NULL;
Charles-François Natali9b0c0062012-06-23 10:17:05 +02005495 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01005496 PyErr_SetString(PyExc_OverflowError,
5497 "getsockaddrarg: flowinfo must be 0-1048575.");
5498 return NULL;
5499 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005500 PyOS_snprintf(pbuf, sizeof(pbuf), "%d", port);
5501 memset(&hints, 0, sizeof(hints));
5502 hints.ai_family = AF_UNSPEC;
5503 hints.ai_socktype = SOCK_DGRAM; /* make numeric port happy */
Martin v. Löwis112c0f32010-08-25 07:38:15 +00005504 hints.ai_flags = AI_NUMERICHOST; /* don't do any name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005505 Py_BEGIN_ALLOW_THREADS
5506 ACQUIRE_GETADDRINFO_LOCK
5507 error = getaddrinfo(hostp, pbuf, &hints, &res);
5508 Py_END_ALLOW_THREADS
5509 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5510 if (error) {
5511 set_gaierror(error);
5512 goto fail;
5513 }
5514 if (res->ai_next) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005515 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005516 "sockaddr resolved to multiple addresses");
5517 goto fail;
5518 }
5519 switch (res->ai_family) {
5520 case AF_INET:
5521 {
5522 if (PyTuple_GET_SIZE(sa) != 2) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005523 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005524 "IPv4 sockaddr must be 2 tuple");
5525 goto fail;
5526 }
5527 break;
5528 }
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00005529#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005530 case AF_INET6:
5531 {
5532 struct sockaddr_in6 *sin6;
5533 sin6 = (struct sockaddr_in6 *)res->ai_addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01005534 sin6->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005535 sin6->sin6_scope_id = scope_id;
5536 break;
5537 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005538#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005539 }
Antoine Pitrou19467d22010-08-17 19:33:30 +00005540 error = getnameinfo(res->ai_addr, (socklen_t) res->ai_addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005541 hbuf, sizeof(hbuf), pbuf, sizeof(pbuf), flags);
5542 if (error) {
5543 set_gaierror(error);
5544 goto fail;
5545 }
5546 ret = Py_BuildValue("ss", hbuf, pbuf);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005547
5548fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005549 if (res)
5550 freeaddrinfo(res);
5551 return ret;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005552}
5553
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005554PyDoc_STRVAR(getnameinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005555"getnameinfo(sockaddr, flags) --> (host, port)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005556\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005557Get host and port for a sockaddr.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005558
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005559
5560/* Python API to getting and setting the default timeout value. */
5561
5562static PyObject *
5563socket_getdefaulttimeout(PyObject *self)
5564{
Victor Stinner71694d52015-03-28 01:18:54 +01005565 if (defaulttimeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005566 Py_INCREF(Py_None);
5567 return Py_None;
5568 }
Victor Stinner71694d52015-03-28 01:18:54 +01005569 else {
5570 double seconds = _PyTime_AsSecondsDouble(defaulttimeout);
5571 return PyFloat_FromDouble(seconds);
5572 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005573}
5574
5575PyDoc_STRVAR(getdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005576"getdefaulttimeout() -> timeout\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005577\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005578Returns the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005579A value of None indicates that new socket objects have no timeout.\n\
5580When the socket module is first imported, the default is None.");
5581
5582static PyObject *
5583socket_setdefaulttimeout(PyObject *self, PyObject *arg)
5584{
Victor Stinner71694d52015-03-28 01:18:54 +01005585 _PyTime_t timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005586
Victor Stinner71694d52015-03-28 01:18:54 +01005587 if (socket_parse_timeout(&timeout, arg) < 0)
5588 return NULL;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005590 defaulttimeout = timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005592 Py_INCREF(Py_None);
5593 return Py_None;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005594}
5595
5596PyDoc_STRVAR(setdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005597"setdefaulttimeout(timeout)\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005598\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005599Set the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005600A value of None indicates that new socket objects have no timeout.\n\
5601When the socket module is first imported, the default is None.");
5602
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005603#ifdef HAVE_IF_NAMEINDEX
5604/* Python API for getting interface indices and names */
5605
5606static PyObject *
5607socket_if_nameindex(PyObject *self, PyObject *arg)
5608{
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005609 PyObject *list;
Charles-François Natali60713592011-05-20 16:55:06 +02005610 int i;
5611 struct if_nameindex *ni;
Victor Stinner77af1722011-05-26 14:05:59 +02005612
Charles-François Natali60713592011-05-20 16:55:06 +02005613 ni = if_nameindex();
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005614 if (ni == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005615 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005616 return NULL;
5617 }
5618
5619 list = PyList_New(0);
5620 if (list == NULL) {
5621 if_freenameindex(ni);
5622 return NULL;
5623 }
5624
Charles-François Natali60713592011-05-20 16:55:06 +02005625 for (i = 0; ni[i].if_index != 0 && i < INT_MAX; i++) {
5626 PyObject *ni_tuple = Py_BuildValue("IO&",
5627 ni[i].if_index, PyUnicode_DecodeFSDefault, ni[i].if_name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005628
5629 if (ni_tuple == NULL || PyList_Append(list, ni_tuple) == -1) {
5630 Py_XDECREF(ni_tuple);
Charles-François Natali60713592011-05-20 16:55:06 +02005631 Py_DECREF(list);
5632 if_freenameindex(ni);
5633 return NULL;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005634 }
5635 Py_DECREF(ni_tuple);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005636 }
5637
5638 if_freenameindex(ni);
5639 return list;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005640}
5641
5642PyDoc_STRVAR(if_nameindex_doc,
5643"if_nameindex()\n\
5644\n\
5645Returns a list of network interface information (index, name) tuples.");
5646
Charles-François Natali60713592011-05-20 16:55:06 +02005647static PyObject *
5648socket_if_nametoindex(PyObject *self, PyObject *args)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005649{
Charles-François Natali60713592011-05-20 16:55:06 +02005650 PyObject *oname;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005651 unsigned long index;
5652
Charles-François Natali60713592011-05-20 16:55:06 +02005653 if (!PyArg_ParseTuple(args, "O&:if_nametoindex",
5654 PyUnicode_FSConverter, &oname))
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005655 return NULL;
5656
Charles-François Natali60713592011-05-20 16:55:06 +02005657 index = if_nametoindex(PyBytes_AS_STRING(oname));
5658 Py_DECREF(oname);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005659 if (index == 0) {
Charles-François Natali60713592011-05-20 16:55:06 +02005660 /* if_nametoindex() doesn't set errno */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005661 PyErr_SetString(PyExc_OSError, "no interface with this name");
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005662 return NULL;
5663 }
5664
5665 return PyLong_FromUnsignedLong(index);
5666}
5667
5668PyDoc_STRVAR(if_nametoindex_doc,
5669"if_nametoindex(if_name)\n\
5670\n\
5671Returns the interface index corresponding to the interface name if_name.");
5672
Charles-François Natali60713592011-05-20 16:55:06 +02005673static PyObject *
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005674socket_if_indextoname(PyObject *self, PyObject *arg)
5675{
Charles-François Natali60713592011-05-20 16:55:06 +02005676 unsigned long index;
5677 char name[IF_NAMESIZE + 1];
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005678
Charles-François Natali60713592011-05-20 16:55:06 +02005679 index = PyLong_AsUnsignedLong(arg);
5680 if (index == (unsigned long) -1)
5681 return NULL;
5682
5683 if (if_indextoname(index, name) == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005684 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005685 return NULL;
5686 }
5687
Charles-François Natali60713592011-05-20 16:55:06 +02005688 return PyUnicode_DecodeFSDefault(name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005689}
5690
5691PyDoc_STRVAR(if_indextoname_doc,
5692"if_indextoname(if_index)\n\
5693\n\
5694Returns the interface name corresponding to the interface index if_index.");
5695
5696#endif /* HAVE_IF_NAMEINDEX */
5697
5698
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005699#ifdef CMSG_LEN
5700/* Python interface to CMSG_LEN(length). */
5701
5702static PyObject *
5703socket_CMSG_LEN(PyObject *self, PyObject *args)
5704{
5705 Py_ssize_t length;
5706 size_t result;
5707
5708 if (!PyArg_ParseTuple(args, "n:CMSG_LEN", &length))
5709 return NULL;
5710 if (length < 0 || !get_CMSG_LEN(length, &result)) {
5711 PyErr_Format(PyExc_OverflowError, "CMSG_LEN() argument out of range");
5712 return NULL;
5713 }
5714 return PyLong_FromSize_t(result);
5715}
5716
5717PyDoc_STRVAR(CMSG_LEN_doc,
5718"CMSG_LEN(length) -> control message length\n\
5719\n\
5720Return the total length, without trailing padding, of an ancillary\n\
5721data item with associated data of the given length. This value can\n\
5722often be used as the buffer size for recvmsg() to receive a single\n\
5723item of ancillary data, but RFC 3542 requires portable applications to\n\
5724use CMSG_SPACE() and thus include space for padding, even when the\n\
5725item will be the last in the buffer. Raises OverflowError if length\n\
5726is outside the permissible range of values.");
5727
5728
5729#ifdef CMSG_SPACE
5730/* Python interface to CMSG_SPACE(length). */
5731
5732static PyObject *
5733socket_CMSG_SPACE(PyObject *self, PyObject *args)
5734{
5735 Py_ssize_t length;
5736 size_t result;
5737
5738 if (!PyArg_ParseTuple(args, "n:CMSG_SPACE", &length))
5739 return NULL;
5740 if (length < 0 || !get_CMSG_SPACE(length, &result)) {
5741 PyErr_SetString(PyExc_OverflowError,
5742 "CMSG_SPACE() argument out of range");
5743 return NULL;
5744 }
5745 return PyLong_FromSize_t(result);
5746}
5747
5748PyDoc_STRVAR(CMSG_SPACE_doc,
5749"CMSG_SPACE(length) -> buffer size\n\
5750\n\
5751Return the buffer size needed for recvmsg() to receive an ancillary\n\
5752data item with associated data of the given length, along with any\n\
5753trailing padding. The buffer space needed to receive multiple items\n\
5754is the sum of the CMSG_SPACE() values for their associated data\n\
5755lengths. Raises OverflowError if length is outside the permissible\n\
5756range of values.");
5757#endif /* CMSG_SPACE */
5758#endif /* CMSG_LEN */
5759
5760
Guido van Rossum30a685f1991-06-27 15:51:29 +00005761/* List of functions exported by this module. */
5762
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005763static PyMethodDef socket_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005764 {"gethostbyname", socket_gethostbyname,
5765 METH_VARARGS, gethostbyname_doc},
5766 {"gethostbyname_ex", socket_gethostbyname_ex,
5767 METH_VARARGS, ghbn_ex_doc},
5768 {"gethostbyaddr", socket_gethostbyaddr,
5769 METH_VARARGS, gethostbyaddr_doc},
5770 {"gethostname", socket_gethostname,
5771 METH_NOARGS, gethostname_doc},
Antoine Pitrou061cfb52011-02-28 22:25:22 +00005772#ifdef HAVE_SETHOSTNAME
5773 {"sethostname", socket_sethostname,
5774 METH_VARARGS, sethostname_doc},
5775#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005776 {"getservbyname", socket_getservbyname,
5777 METH_VARARGS, getservbyname_doc},
5778 {"getservbyport", socket_getservbyport,
5779 METH_VARARGS, getservbyport_doc},
5780 {"getprotobyname", socket_getprotobyname,
5781 METH_VARARGS, getprotobyname_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005782#ifndef NO_DUP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005783 {"dup", socket_dup,
5784 METH_O, dup_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005785#endif
Dave Cole331708b2004-08-09 04:51:41 +00005786#ifdef HAVE_SOCKETPAIR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005787 {"socketpair", socket_socketpair,
5788 METH_VARARGS, socketpair_doc},
Dave Cole331708b2004-08-09 04:51:41 +00005789#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005790 {"ntohs", socket_ntohs,
5791 METH_VARARGS, ntohs_doc},
5792 {"ntohl", socket_ntohl,
5793 METH_O, ntohl_doc},
5794 {"htons", socket_htons,
5795 METH_VARARGS, htons_doc},
5796 {"htonl", socket_htonl,
5797 METH_O, htonl_doc},
5798 {"inet_aton", socket_inet_aton,
5799 METH_VARARGS, inet_aton_doc},
5800 {"inet_ntoa", socket_inet_ntoa,
5801 METH_VARARGS, inet_ntoa_doc},
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005802#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005803 {"inet_pton", socket_inet_pton,
5804 METH_VARARGS, inet_pton_doc},
5805 {"inet_ntop", socket_inet_ntop,
5806 METH_VARARGS, inet_ntop_doc},
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005807#endif
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005808 {"getaddrinfo", (PyCFunction)socket_getaddrinfo,
5809 METH_VARARGS | METH_KEYWORDS, getaddrinfo_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005810 {"getnameinfo", socket_getnameinfo,
5811 METH_VARARGS, getnameinfo_doc},
5812 {"getdefaulttimeout", (PyCFunction)socket_getdefaulttimeout,
5813 METH_NOARGS, getdefaulttimeout_doc},
5814 {"setdefaulttimeout", socket_setdefaulttimeout,
5815 METH_O, setdefaulttimeout_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005816#ifdef HAVE_IF_NAMEINDEX
5817 {"if_nameindex", socket_if_nameindex,
5818 METH_NOARGS, if_nameindex_doc},
5819 {"if_nametoindex", socket_if_nametoindex,
Charles-François Natali60713592011-05-20 16:55:06 +02005820 METH_VARARGS, if_nametoindex_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005821 {"if_indextoname", socket_if_indextoname,
5822 METH_O, if_indextoname_doc},
5823#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005824#ifdef CMSG_LEN
5825 {"CMSG_LEN", socket_CMSG_LEN,
5826 METH_VARARGS, CMSG_LEN_doc},
5827#ifdef CMSG_SPACE
5828 {"CMSG_SPACE", socket_CMSG_SPACE,
5829 METH_VARARGS, CMSG_SPACE_doc},
5830#endif
5831#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005832 {NULL, NULL} /* Sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005833};
5834
Guido van Rossum30a685f1991-06-27 15:51:29 +00005835
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005836#ifdef MS_WINDOWS
5837#define OS_INIT_DEFINED
5838
5839/* Additional initialization and cleanup for Windows */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005840
5841static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005842os_cleanup(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005844 WSACleanup();
Guido van Rossumbe32c891996-06-20 16:25:29 +00005845}
5846
5847static int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005848os_init(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005849{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005850 WSADATA WSAData;
5851 int ret;
5852 ret = WSAStartup(0x0101, &WSAData);
5853 switch (ret) {
5854 case 0: /* No error */
5855 Py_AtExit(os_cleanup);
5856 return 1; /* Success */
5857 case WSASYSNOTREADY:
5858 PyErr_SetString(PyExc_ImportError,
5859 "WSAStartup failed: network not ready");
5860 break;
5861 case WSAVERNOTSUPPORTED:
5862 case WSAEINVAL:
5863 PyErr_SetString(
5864 PyExc_ImportError,
5865 "WSAStartup failed: requested version not supported");
5866 break;
5867 default:
5868 PyErr_Format(PyExc_ImportError, "WSAStartup failed: error code %d", ret);
5869 break;
5870 }
5871 return 0; /* Failure */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005872}
5873
Guido van Rossum8d665e61996-06-26 18:22:49 +00005874#endif /* MS_WINDOWS */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005875
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00005876
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005877
5878#ifndef OS_INIT_DEFINED
5879static int
5880os_init(void)
5881{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005882 return 1; /* Success */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005883}
5884#endif
5885
5886
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005887/* C API table - always add new things to the end for binary
5888 compatibility. */
5889static
5890PySocketModule_APIObject PySocketModuleAPI =
5891{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005892 &sock_type,
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005893 NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005894 NULL
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005895};
5896
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005897
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005898/* Initialize the _socket module.
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005899
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005900 This module is actually called "_socket", and there's a wrapper
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005901 "socket.py" which implements some additional functionality.
5902 The import of "_socket" may fail with an ImportError exception if
5903 os-specific initialization fails. On Windows, this does WINSOCK
Ezio Melotti13925002011-03-16 11:05:33 +02005904 initialization. When WINSOCK is initialized successfully, a call to
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005905 WSACleanup() is scheduled to be made at exit time.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005906*/
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005907
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005908PyDoc_STRVAR(socket_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005909"Implementation module for socket operations.\n\
5910\n\
5911See the socket module for documentation.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005912
Martin v. Löwis1a214512008-06-11 05:26:20 +00005913static struct PyModuleDef socketmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005914 PyModuleDef_HEAD_INIT,
5915 PySocket_MODULE_NAME,
5916 socket_doc,
5917 -1,
5918 socket_methods,
5919 NULL,
5920 NULL,
5921 NULL,
5922 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005923};
5924
Mark Hammondfe51c6d2002-08-02 02:27:13 +00005925PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00005926PyInit__socket(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005928 PyObject *m, *has_ipv6;
Fred Drake4baedc12002-04-01 14:53:37 +00005929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005930 if (!os_init())
5931 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005932
Victor Stinnerdaf45552013-08-28 00:53:59 +02005933#ifdef MS_WINDOWS
5934 if (support_wsa_no_inherit == -1) {
Steve Dower65e4cb12014-11-22 12:54:57 -08005935#if defined(_MSC_VER) && _MSC_VER >= 1800
5936 support_wsa_no_inherit = IsWindows7SP1OrGreater();
5937#else
Victor Stinnerdaf45552013-08-28 00:53:59 +02005938 DWORD version = GetVersion();
5939 DWORD major = (DWORD)LOBYTE(LOWORD(version));
5940 DWORD minor = (DWORD)HIBYTE(LOWORD(version));
5941 /* need Windows 7 SP1, 2008 R2 SP1 or later */
Steve Dower65e4cb12014-11-22 12:54:57 -08005942 support_wsa_no_inherit = major > 6 || (major == 6 && minor >= 1);
5943#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02005944 }
5945#endif
5946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005947 Py_TYPE(&sock_type) = &PyType_Type;
5948 m = PyModule_Create(&socketmodule);
5949 if (m == NULL)
5950 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005951
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005952 Py_INCREF(PyExc_OSError);
5953 PySocketModuleAPI.error = PyExc_OSError;
5954 Py_INCREF(PyExc_OSError);
5955 PyModule_AddObject(m, "error", PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005956 socket_herror = PyErr_NewException("socket.herror",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005957 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005958 if (socket_herror == NULL)
5959 return NULL;
5960 Py_INCREF(socket_herror);
5961 PyModule_AddObject(m, "herror", socket_herror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005962 socket_gaierror = PyErr_NewException("socket.gaierror", PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005963 NULL);
5964 if (socket_gaierror == NULL)
5965 return NULL;
5966 Py_INCREF(socket_gaierror);
5967 PyModule_AddObject(m, "gaierror", socket_gaierror);
5968 socket_timeout = PyErr_NewException("socket.timeout",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005969 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005970 if (socket_timeout == NULL)
5971 return NULL;
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005972 PySocketModuleAPI.timeout_error = socket_timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005973 Py_INCREF(socket_timeout);
5974 PyModule_AddObject(m, "timeout", socket_timeout);
5975 Py_INCREF((PyObject *)&sock_type);
5976 if (PyModule_AddObject(m, "SocketType",
5977 (PyObject *)&sock_type) != 0)
5978 return NULL;
5979 Py_INCREF((PyObject *)&sock_type);
5980 if (PyModule_AddObject(m, "socket",
5981 (PyObject *)&sock_type) != 0)
5982 return NULL;
Guido van Rossum09be4091999-08-09 14:40:40 +00005983
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005984#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005985 has_ipv6 = Py_True;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005986#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005987 has_ipv6 = Py_False;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005988#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005989 Py_INCREF(has_ipv6);
5990 PyModule_AddObject(m, "has_ipv6", has_ipv6);
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005992 /* Export C API */
5993 if (PyModule_AddObject(m, PySocket_CAPI_NAME,
5994 PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
5995 ) != 0)
5996 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005998 /* Address families (we only support AF_INET and AF_UNIX) */
Guido van Rossum09be4091999-08-09 14:40:40 +00005999#ifdef AF_UNSPEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006000 PyModule_AddIntMacro(m, AF_UNSPEC);
Guido van Rossum09be4091999-08-09 14:40:40 +00006001#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006002 PyModule_AddIntMacro(m, AF_INET);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006003#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006004 PyModule_AddIntMacro(m, AF_INET6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006005#endif /* AF_INET6 */
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00006006#if defined(AF_UNIX)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006007 PyModule_AddIntMacro(m, AF_UNIX);
Guido van Rossumb6775db1994-08-01 11:34:53 +00006008#endif /* AF_UNIX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006009#ifdef AF_AX25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006010 /* Amateur Radio AX.25 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006011 PyModule_AddIntMacro(m, AF_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006012#endif
6013#ifdef AF_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006014 PyModule_AddIntMacro(m, AF_IPX); /* Novell IPX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006015#endif
6016#ifdef AF_APPLETALK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006017 /* Appletalk DDP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006018 PyModule_AddIntMacro(m, AF_APPLETALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006019#endif
6020#ifdef AF_NETROM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006021 /* Amateur radio NetROM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006022 PyModule_AddIntMacro(m, AF_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006023#endif
6024#ifdef AF_BRIDGE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006025 /* Multiprotocol bridge */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006026 PyModule_AddIntMacro(m, AF_BRIDGE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006027#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006028#ifdef AF_ATMPVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006029 /* ATM PVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006030 PyModule_AddIntMacro(m, AF_ATMPVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006031#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006032#ifdef AF_AAL5
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006033 /* Reserved for Werner's ATM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006034 PyModule_AddIntMacro(m, AF_AAL5);
Guido van Rossum09be4091999-08-09 14:40:40 +00006035#endif
6036#ifdef AF_X25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006037 /* Reserved for X.25 project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006038 PyModule_AddIntMacro(m, AF_X25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006039#endif
6040#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006041 PyModule_AddIntMacro(m, AF_INET6); /* IP version 6 */
Guido van Rossum09be4091999-08-09 14:40:40 +00006042#endif
6043#ifdef AF_ROSE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006044 /* Amateur Radio X.25 PLP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006045 PyModule_AddIntMacro(m, AF_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006046#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006047#ifdef AF_DECnet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006048 /* Reserved for DECnet project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006049 PyModule_AddIntMacro(m, AF_DECnet);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006050#endif
6051#ifdef AF_NETBEUI
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006052 /* Reserved for 802.2LLC project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006053 PyModule_AddIntMacro(m, AF_NETBEUI);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006054#endif
6055#ifdef AF_SECURITY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006056 /* Security callback pseudo AF */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006057 PyModule_AddIntMacro(m, AF_SECURITY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006058#endif
6059#ifdef AF_KEY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006060 /* PF_KEY key management API */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006061 PyModule_AddIntMacro(m, AF_KEY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006062#endif
6063#ifdef AF_NETLINK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006064 /* */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006065 PyModule_AddIntMacro(m, AF_NETLINK);
6066 PyModule_AddIntMacro(m, NETLINK_ROUTE);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006067#ifdef NETLINK_SKIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006068 PyModule_AddIntMacro(m, NETLINK_SKIP);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006069#endif
6070#ifdef NETLINK_W1
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006071 PyModule_AddIntMacro(m, NETLINK_W1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006072#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006073 PyModule_AddIntMacro(m, NETLINK_USERSOCK);
6074 PyModule_AddIntMacro(m, NETLINK_FIREWALL);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006075#ifdef NETLINK_TCPDIAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006076 PyModule_AddIntMacro(m, NETLINK_TCPDIAG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006077#endif
6078#ifdef NETLINK_NFLOG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006079 PyModule_AddIntMacro(m, NETLINK_NFLOG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006080#endif
Neal Norwitz65851662006-01-16 04:31:40 +00006081#ifdef NETLINK_XFRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006082 PyModule_AddIntMacro(m, NETLINK_XFRM);
Neal Norwitz65851662006-01-16 04:31:40 +00006083#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006084#ifdef NETLINK_ARPD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006085 PyModule_AddIntMacro(m, NETLINK_ARPD);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006086#endif
6087#ifdef NETLINK_ROUTE6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006088 PyModule_AddIntMacro(m, NETLINK_ROUTE6);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006089#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006090 PyModule_AddIntMacro(m, NETLINK_IP6_FW);
Thomas Wouterscf297e42007-02-23 15:07:44 +00006091#ifdef NETLINK_DNRTMSG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006092 PyModule_AddIntMacro(m, NETLINK_DNRTMSG);
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00006093#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006094#ifdef NETLINK_TAPBASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006095 PyModule_AddIntMacro(m, NETLINK_TAPBASE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006096#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006097#endif /* AF_NETLINK */
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006098#ifdef AF_ROUTE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006099 /* Alias to emulate 4.4BSD */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006100 PyModule_AddIntMacro(m, AF_ROUTE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006101#endif
Giampaolo Rodola'80e1c432013-05-21 21:02:04 +02006102#ifdef AF_LINK
6103 PyModule_AddIntMacro(m, AF_LINK);
6104#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006105#ifdef AF_ASH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006106 /* Ash */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006107 PyModule_AddIntMacro(m, AF_ASH);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006108#endif
6109#ifdef AF_ECONET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006110 /* Acorn Econet */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006111 PyModule_AddIntMacro(m, AF_ECONET);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006112#endif
6113#ifdef AF_ATMSVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006114 /* ATM SVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006115 PyModule_AddIntMacro(m, AF_ATMSVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006116#endif
6117#ifdef AF_SNA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006118 /* Linux SNA Project (nutters!) */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006119 PyModule_AddIntMacro(m, AF_SNA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006120#endif
6121#ifdef AF_IRDA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006122 /* IRDA sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006123 PyModule_AddIntMacro(m, AF_IRDA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006124#endif
6125#ifdef AF_PPPOX
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006126 /* PPPoX sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006127 PyModule_AddIntMacro(m, AF_PPPOX);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006128#endif
6129#ifdef AF_WANPIPE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006130 /* Wanpipe API Sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006131 PyModule_AddIntMacro(m, AF_WANPIPE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006132#endif
6133#ifdef AF_LLC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006134 /* Linux LLC */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006135 PyModule_AddIntMacro(m, AF_LLC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006136#endif
Martin v. Löwis12af0482004-01-31 12:34:17 +00006137
Hye-Shik Chang81268602004-02-02 06:05:24 +00006138#ifdef USE_BLUETOOTH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006139 PyModule_AddIntMacro(m, AF_BLUETOOTH);
6140 PyModule_AddIntMacro(m, BTPROTO_L2CAP);
6141 PyModule_AddIntMacro(m, BTPROTO_HCI);
6142 PyModule_AddIntMacro(m, SOL_HCI);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006143#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006144 PyModule_AddIntMacro(m, HCI_FILTER);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006145#endif
Hye-Shik Chang81268602004-02-02 06:05:24 +00006146#if !defined(__FreeBSD__)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006147#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006148 PyModule_AddIntMacro(m, HCI_TIME_STAMP);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006149#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006150 PyModule_AddIntMacro(m, HCI_DATA_DIR);
6151 PyModule_AddIntMacro(m, BTPROTO_SCO);
Hye-Shik Chang81268602004-02-02 06:05:24 +00006152#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006153 PyModule_AddIntMacro(m, BTPROTO_RFCOMM);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006154 PyModule_AddStringConstant(m, "BDADDR_ANY", "00:00:00:00:00:00");
6155 PyModule_AddStringConstant(m, "BDADDR_LOCAL", "00:00:00:FF:FF:FF");
Martin v. Löwis12af0482004-01-31 12:34:17 +00006156#endif
6157
Charles-François Natali47413c12011-10-06 19:47:44 +02006158#ifdef AF_CAN
6159 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006160 PyModule_AddIntMacro(m, AF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006161#endif
6162#ifdef PF_CAN
6163 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006164 PyModule_AddIntMacro(m, PF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006165#endif
6166
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006167/* Reliable Datagram Sockets */
6168#ifdef AF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006169 PyModule_AddIntMacro(m, AF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006170#endif
6171#ifdef PF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006172 PyModule_AddIntMacro(m, PF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006173#endif
6174
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006175/* Kernel event messages */
6176#ifdef PF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006177 PyModule_AddIntMacro(m, PF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006178#endif
6179#ifdef AF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006180 PyModule_AddIntMacro(m, AF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006181#endif
6182
Antoine Pitroub156a462010-10-27 20:13:57 +00006183#ifdef AF_PACKET
6184 PyModule_AddIntMacro(m, AF_PACKET);
6185#endif
6186#ifdef PF_PACKET
6187 PyModule_AddIntMacro(m, PF_PACKET);
6188#endif
6189#ifdef PACKET_HOST
6190 PyModule_AddIntMacro(m, PACKET_HOST);
6191#endif
6192#ifdef PACKET_BROADCAST
6193 PyModule_AddIntMacro(m, PACKET_BROADCAST);
6194#endif
6195#ifdef PACKET_MULTICAST
6196 PyModule_AddIntMacro(m, PACKET_MULTICAST);
6197#endif
6198#ifdef PACKET_OTHERHOST
6199 PyModule_AddIntMacro(m, PACKET_OTHERHOST);
6200#endif
6201#ifdef PACKET_OUTGOING
6202 PyModule_AddIntMacro(m, PACKET_OUTGOING);
6203#endif
6204#ifdef PACKET_LOOPBACK
6205 PyModule_AddIntMacro(m, PACKET_LOOPBACK);
6206#endif
6207#ifdef PACKET_FASTROUTE
6208 PyModule_AddIntMacro(m, PACKET_FASTROUTE);
Guido van Rossum48a680c2001-03-02 06:34:14 +00006209#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006210
Christian Heimes043d6f62008-01-07 17:19:16 +00006211#ifdef HAVE_LINUX_TIPC_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006212 PyModule_AddIntMacro(m, AF_TIPC);
Christian Heimes043d6f62008-01-07 17:19:16 +00006213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006214 /* for addresses */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006215 PyModule_AddIntMacro(m, TIPC_ADDR_NAMESEQ);
6216 PyModule_AddIntMacro(m, TIPC_ADDR_NAME);
6217 PyModule_AddIntMacro(m, TIPC_ADDR_ID);
Christian Heimes043d6f62008-01-07 17:19:16 +00006218
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006219 PyModule_AddIntMacro(m, TIPC_ZONE_SCOPE);
6220 PyModule_AddIntMacro(m, TIPC_CLUSTER_SCOPE);
6221 PyModule_AddIntMacro(m, TIPC_NODE_SCOPE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006223 /* for setsockopt() */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006224 PyModule_AddIntMacro(m, SOL_TIPC);
6225 PyModule_AddIntMacro(m, TIPC_IMPORTANCE);
6226 PyModule_AddIntMacro(m, TIPC_SRC_DROPPABLE);
6227 PyModule_AddIntMacro(m, TIPC_DEST_DROPPABLE);
6228 PyModule_AddIntMacro(m, TIPC_CONN_TIMEOUT);
Christian Heimes043d6f62008-01-07 17:19:16 +00006229
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006230 PyModule_AddIntMacro(m, TIPC_LOW_IMPORTANCE);
6231 PyModule_AddIntMacro(m, TIPC_MEDIUM_IMPORTANCE);
6232 PyModule_AddIntMacro(m, TIPC_HIGH_IMPORTANCE);
6233 PyModule_AddIntMacro(m, TIPC_CRITICAL_IMPORTANCE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006235 /* for subscriptions */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006236 PyModule_AddIntMacro(m, TIPC_SUB_PORTS);
6237 PyModule_AddIntMacro(m, TIPC_SUB_SERVICE);
Christian Heimes25bb7832008-01-11 16:17:00 +00006238#ifdef TIPC_SUB_CANCEL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006239 /* doesn't seem to be available everywhere */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006240 PyModule_AddIntMacro(m, TIPC_SUB_CANCEL);
Christian Heimes25bb7832008-01-11 16:17:00 +00006241#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006242 PyModule_AddIntMacro(m, TIPC_WAIT_FOREVER);
6243 PyModule_AddIntMacro(m, TIPC_PUBLISHED);
6244 PyModule_AddIntMacro(m, TIPC_WITHDRAWN);
6245 PyModule_AddIntMacro(m, TIPC_SUBSCR_TIMEOUT);
6246 PyModule_AddIntMacro(m, TIPC_CFG_SRV);
6247 PyModule_AddIntMacro(m, TIPC_TOP_SRV);
Christian Heimes043d6f62008-01-07 17:19:16 +00006248#endif
6249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006250 /* Socket types */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006251 PyModule_AddIntMacro(m, SOCK_STREAM);
6252 PyModule_AddIntMacro(m, SOCK_DGRAM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006253/* We have incomplete socket support. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006254 PyModule_AddIntMacro(m, SOCK_RAW);
6255 PyModule_AddIntMacro(m, SOCK_SEQPACKET);
Martin v. Löwiscf8f47e2002-12-11 13:10:57 +00006256#if defined(SOCK_RDM)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006257 PyModule_AddIntMacro(m, SOCK_RDM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006258#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00006259#ifdef SOCK_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006260 PyModule_AddIntMacro(m, SOCK_CLOEXEC);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006261#endif
6262#ifdef SOCK_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006263 PyModule_AddIntMacro(m, SOCK_NONBLOCK);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006264#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006266#ifdef SO_DEBUG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006267 PyModule_AddIntMacro(m, SO_DEBUG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006268#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006269#ifdef SO_ACCEPTCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006270 PyModule_AddIntMacro(m, SO_ACCEPTCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006271#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006272#ifdef SO_REUSEADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006273 PyModule_AddIntMacro(m, SO_REUSEADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006274#endif
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006275#ifdef SO_EXCLUSIVEADDRUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006276 PyModule_AddIntMacro(m, SO_EXCLUSIVEADDRUSE);
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006277#endif
6278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006279#ifdef SO_KEEPALIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006280 PyModule_AddIntMacro(m, SO_KEEPALIVE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006281#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006282#ifdef SO_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006283 PyModule_AddIntMacro(m, SO_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006284#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006285#ifdef SO_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006286 PyModule_AddIntMacro(m, SO_BROADCAST);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006287#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006288#ifdef SO_USELOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006289 PyModule_AddIntMacro(m, SO_USELOOPBACK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006290#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006291#ifdef SO_LINGER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006292 PyModule_AddIntMacro(m, SO_LINGER);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006293#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006294#ifdef SO_OOBINLINE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006295 PyModule_AddIntMacro(m, SO_OOBINLINE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006296#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006297#ifdef SO_REUSEPORT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006298 PyModule_AddIntMacro(m, SO_REUSEPORT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006299#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006300#ifdef SO_SNDBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006301 PyModule_AddIntMacro(m, SO_SNDBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006302#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006303#ifdef SO_RCVBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006304 PyModule_AddIntMacro(m, SO_RCVBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006305#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006306#ifdef SO_SNDLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006307 PyModule_AddIntMacro(m, SO_SNDLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006308#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006309#ifdef SO_RCVLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006310 PyModule_AddIntMacro(m, SO_RCVLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006311#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006312#ifdef SO_SNDTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006313 PyModule_AddIntMacro(m, SO_SNDTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006314#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006315#ifdef SO_RCVTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006316 PyModule_AddIntMacro(m, SO_RCVTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006317#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006318#ifdef SO_ERROR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006319 PyModule_AddIntMacro(m, SO_ERROR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006320#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006321#ifdef SO_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006322 PyModule_AddIntMacro(m, SO_TYPE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006323#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006324#ifdef SO_SETFIB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006325 PyModule_AddIntMacro(m, SO_SETFIB);
Larry Hastingsf0f37952010-04-02 11:47:10 +00006326#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006327#ifdef SO_PASSCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006328 PyModule_AddIntMacro(m, SO_PASSCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006329#endif
6330#ifdef SO_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006331 PyModule_AddIntMacro(m, SO_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006332#endif
6333#ifdef LOCAL_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006334 PyModule_AddIntMacro(m, LOCAL_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006335#endif
Victor Stinnercb98bed2011-10-25 13:45:48 +02006336#ifdef SO_BINDTODEVICE
6337 PyModule_AddIntMacro(m, SO_BINDTODEVICE);
6338#endif
Benjamin Peterson1314ef72013-11-27 09:18:54 -06006339#ifdef SO_PRIORITY
6340 PyModule_AddIntMacro(m, SO_PRIORITY);
6341#endif
Charles-François Nataliea07eb92014-09-18 23:18:46 +01006342#ifdef SO_MARK
6343 PyModule_AddIntMacro(m, SO_MARK);
6344#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006346 /* Maximum number of connections for "listen" */
6347#ifdef SOMAXCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006348 PyModule_AddIntMacro(m, SOMAXCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006349#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006350 PyModule_AddIntConstant(m, "SOMAXCONN", 5); /* Common value */
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006351#endif
6352
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006353 /* Ancilliary message types */
6354#ifdef SCM_RIGHTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006355 PyModule_AddIntMacro(m, SCM_RIGHTS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006356#endif
6357#ifdef SCM_CREDENTIALS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006358 PyModule_AddIntMacro(m, SCM_CREDENTIALS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006359#endif
6360#ifdef SCM_CREDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006361 PyModule_AddIntMacro(m, SCM_CREDS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006362#endif
6363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006364 /* Flags for send, recv */
6365#ifdef MSG_OOB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006366 PyModule_AddIntMacro(m, MSG_OOB);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006367#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006368#ifdef MSG_PEEK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006369 PyModule_AddIntMacro(m, MSG_PEEK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006370#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006371#ifdef MSG_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006372 PyModule_AddIntMacro(m, MSG_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006373#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006374#ifdef MSG_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006375 PyModule_AddIntMacro(m, MSG_DONTWAIT);
Guido van Rossum2c8bcb82000-04-25 21:34:53 +00006376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006377#ifdef MSG_EOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006378 PyModule_AddIntMacro(m, MSG_EOR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006379#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006380#ifdef MSG_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006381 PyModule_AddIntMacro(m, MSG_TRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006382#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006383#ifdef MSG_CTRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006384 PyModule_AddIntMacro(m, MSG_CTRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006385#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006386#ifdef MSG_WAITALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006387 PyModule_AddIntMacro(m, MSG_WAITALL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006388#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006389#ifdef MSG_BTAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006390 PyModule_AddIntMacro(m, MSG_BTAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006391#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006392#ifdef MSG_ETAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006393 PyModule_AddIntMacro(m, MSG_ETAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006394#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006395#ifdef MSG_NOSIGNAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006396 PyModule_AddIntMacro(m, MSG_NOSIGNAL);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006397#endif
6398#ifdef MSG_NOTIFICATION
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006399 PyModule_AddIntMacro(m, MSG_NOTIFICATION);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006400#endif
6401#ifdef MSG_CMSG_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006402 PyModule_AddIntMacro(m, MSG_CMSG_CLOEXEC);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006403#endif
6404#ifdef MSG_ERRQUEUE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006405 PyModule_AddIntMacro(m, MSG_ERRQUEUE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006406#endif
6407#ifdef MSG_CONFIRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006408 PyModule_AddIntMacro(m, MSG_CONFIRM);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006409#endif
6410#ifdef MSG_MORE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006411 PyModule_AddIntMacro(m, MSG_MORE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006412#endif
6413#ifdef MSG_EOF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006414 PyModule_AddIntMacro(m, MSG_EOF);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006415#endif
6416#ifdef MSG_BCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006417 PyModule_AddIntMacro(m, MSG_BCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006418#endif
6419#ifdef MSG_MCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006420 PyModule_AddIntMacro(m, MSG_MCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006421#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006422#ifdef MSG_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006423 PyModule_AddIntMacro(m, MSG_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006424#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006426 /* Protocol level and numbers, usable for [gs]etsockopt */
6427#ifdef SOL_SOCKET
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006428 PyModule_AddIntMacro(m, SOL_SOCKET);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006429#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006430#ifdef SOL_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006431 PyModule_AddIntMacro(m, SOL_IP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006432#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006433 PyModule_AddIntConstant(m, "SOL_IP", 0);
Guido van Rossum09be4091999-08-09 14:40:40 +00006434#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006435#ifdef SOL_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006436 PyModule_AddIntMacro(m, SOL_IPX);
Guido van Rossum09be4091999-08-09 14:40:40 +00006437#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006438#ifdef SOL_AX25
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006439 PyModule_AddIntMacro(m, SOL_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006440#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006441#ifdef SOL_ATALK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006442 PyModule_AddIntMacro(m, SOL_ATALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006443#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006444#ifdef SOL_NETROM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006445 PyModule_AddIntMacro(m, SOL_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006446#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006447#ifdef SOL_ROSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006448 PyModule_AddIntMacro(m, SOL_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006449#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006450#ifdef SOL_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006451 PyModule_AddIntMacro(m, SOL_TCP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006452#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006453 PyModule_AddIntConstant(m, "SOL_TCP", 6);
Guido van Rossum09be4091999-08-09 14:40:40 +00006454#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006455#ifdef SOL_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006456 PyModule_AddIntMacro(m, SOL_UDP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006457#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006458 PyModule_AddIntConstant(m, "SOL_UDP", 17);
Guido van Rossum09be4091999-08-09 14:40:40 +00006459#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02006460#ifdef SOL_CAN_BASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006461 PyModule_AddIntMacro(m, SOL_CAN_BASE);
Charles-François Natali47413c12011-10-06 19:47:44 +02006462#endif
6463#ifdef SOL_CAN_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006464 PyModule_AddIntMacro(m, SOL_CAN_RAW);
6465 PyModule_AddIntMacro(m, CAN_RAW);
Charles-François Natali47413c12011-10-06 19:47:44 +02006466#endif
6467#ifdef HAVE_LINUX_CAN_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006468 PyModule_AddIntMacro(m, CAN_EFF_FLAG);
6469 PyModule_AddIntMacro(m, CAN_RTR_FLAG);
6470 PyModule_AddIntMacro(m, CAN_ERR_FLAG);
Charles-François Natali47413c12011-10-06 19:47:44 +02006471
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006472 PyModule_AddIntMacro(m, CAN_SFF_MASK);
6473 PyModule_AddIntMacro(m, CAN_EFF_MASK);
6474 PyModule_AddIntMacro(m, CAN_ERR_MASK);
Charles-François Natali47413c12011-10-06 19:47:44 +02006475#endif
6476#ifdef HAVE_LINUX_CAN_RAW_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006477 PyModule_AddIntMacro(m, CAN_RAW_FILTER);
6478 PyModule_AddIntMacro(m, CAN_RAW_ERR_FILTER);
6479 PyModule_AddIntMacro(m, CAN_RAW_LOOPBACK);
6480 PyModule_AddIntMacro(m, CAN_RAW_RECV_OWN_MSGS);
Charles-François Natali47413c12011-10-06 19:47:44 +02006481#endif
Charles-François Natali773e42d2013-02-05 19:42:01 +01006482#ifdef HAVE_LINUX_CAN_BCM_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006483 PyModule_AddIntMacro(m, CAN_BCM);
Charles-François Natali773e42d2013-02-05 19:42:01 +01006484 PyModule_AddIntConstant(m, "CAN_BCM_TX_SETUP", TX_SETUP);
6485 PyModule_AddIntConstant(m, "CAN_BCM_TX_DELETE", TX_DELETE);
6486 PyModule_AddIntConstant(m, "CAN_BCM_TX_READ", TX_READ);
6487 PyModule_AddIntConstant(m, "CAN_BCM_TX_SEND", TX_SEND);
6488 PyModule_AddIntConstant(m, "CAN_BCM_RX_SETUP", RX_SETUP);
6489 PyModule_AddIntConstant(m, "CAN_BCM_RX_DELETE", RX_DELETE);
6490 PyModule_AddIntConstant(m, "CAN_BCM_RX_READ", RX_READ);
6491 PyModule_AddIntConstant(m, "CAN_BCM_TX_STATUS", TX_STATUS);
6492 PyModule_AddIntConstant(m, "CAN_BCM_TX_EXPIRED", TX_EXPIRED);
6493 PyModule_AddIntConstant(m, "CAN_BCM_RX_STATUS", RX_STATUS);
6494 PyModule_AddIntConstant(m, "CAN_BCM_RX_TIMEOUT", RX_TIMEOUT);
6495 PyModule_AddIntConstant(m, "CAN_BCM_RX_CHANGED", RX_CHANGED);
6496#endif
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006497#ifdef SOL_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006498 PyModule_AddIntMacro(m, SOL_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006499#endif
6500#ifdef RDS_CANCEL_SENT_TO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006501 PyModule_AddIntMacro(m, RDS_CANCEL_SENT_TO);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006502#endif
6503#ifdef RDS_GET_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006504 PyModule_AddIntMacro(m, RDS_GET_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006505#endif
6506#ifdef RDS_FREE_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006507 PyModule_AddIntMacro(m, RDS_FREE_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006508#endif
6509#ifdef RDS_RECVERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006510 PyModule_AddIntMacro(m, RDS_RECVERR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006511#endif
6512#ifdef RDS_CONG_MONITOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006513 PyModule_AddIntMacro(m, RDS_CONG_MONITOR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006514#endif
6515#ifdef RDS_GET_MR_FOR_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006516 PyModule_AddIntMacro(m, RDS_GET_MR_FOR_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006517#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006518#ifdef IPPROTO_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006519 PyModule_AddIntMacro(m, IPPROTO_IP);
Guido van Rossum578de301998-05-28 20:18:18 +00006520#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006521 PyModule_AddIntConstant(m, "IPPROTO_IP", 0);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006522#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006523#ifdef IPPROTO_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006524 PyModule_AddIntMacro(m, IPPROTO_HOPOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006525#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006526#ifdef IPPROTO_ICMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006527 PyModule_AddIntMacro(m, IPPROTO_ICMP);
Guido van Rossum578de301998-05-28 20:18:18 +00006528#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006529 PyModule_AddIntConstant(m, "IPPROTO_ICMP", 1);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006530#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006531#ifdef IPPROTO_IGMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006532 PyModule_AddIntMacro(m, IPPROTO_IGMP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006533#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006534#ifdef IPPROTO_GGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006535 PyModule_AddIntMacro(m, IPPROTO_GGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006536#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006537#ifdef IPPROTO_IPV4
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006538 PyModule_AddIntMacro(m, IPPROTO_IPV4);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006539#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006540#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006541 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisa0f17342003-10-03 13:56:20 +00006542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006543#ifdef IPPROTO_IPIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006544 PyModule_AddIntMacro(m, IPPROTO_IPIP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006545#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006546#ifdef IPPROTO_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006547 PyModule_AddIntMacro(m, IPPROTO_TCP);
Guido van Rossum578de301998-05-28 20:18:18 +00006548#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006549 PyModule_AddIntConstant(m, "IPPROTO_TCP", 6);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006550#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006551#ifdef IPPROTO_EGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006552 PyModule_AddIntMacro(m, IPPROTO_EGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006553#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006554#ifdef IPPROTO_PUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006555 PyModule_AddIntMacro(m, IPPROTO_PUP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006556#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006557#ifdef IPPROTO_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006558 PyModule_AddIntMacro(m, IPPROTO_UDP);
Guido van Rossum578de301998-05-28 20:18:18 +00006559#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006560 PyModule_AddIntConstant(m, "IPPROTO_UDP", 17);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006561#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006562#ifdef IPPROTO_IDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006563 PyModule_AddIntMacro(m, IPPROTO_IDP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006564#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006565#ifdef IPPROTO_HELLO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006566 PyModule_AddIntMacro(m, IPPROTO_HELLO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006567#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006568#ifdef IPPROTO_ND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006569 PyModule_AddIntMacro(m, IPPROTO_ND);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006570#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006571#ifdef IPPROTO_TP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006572 PyModule_AddIntMacro(m, IPPROTO_TP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006573#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006574#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006575 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006576#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006577#ifdef IPPROTO_ROUTING
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006578 PyModule_AddIntMacro(m, IPPROTO_ROUTING);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006579#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006580#ifdef IPPROTO_FRAGMENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006581 PyModule_AddIntMacro(m, IPPROTO_FRAGMENT);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006582#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006583#ifdef IPPROTO_RSVP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006584 PyModule_AddIntMacro(m, IPPROTO_RSVP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006585#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006586#ifdef IPPROTO_GRE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006587 PyModule_AddIntMacro(m, IPPROTO_GRE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006588#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006589#ifdef IPPROTO_ESP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006590 PyModule_AddIntMacro(m, IPPROTO_ESP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006591#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006592#ifdef IPPROTO_AH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006593 PyModule_AddIntMacro(m, IPPROTO_AH);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006594#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006595#ifdef IPPROTO_MOBILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006596 PyModule_AddIntMacro(m, IPPROTO_MOBILE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006597#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006598#ifdef IPPROTO_ICMPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006599 PyModule_AddIntMacro(m, IPPROTO_ICMPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006600#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006601#ifdef IPPROTO_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006602 PyModule_AddIntMacro(m, IPPROTO_NONE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006603#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006604#ifdef IPPROTO_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006605 PyModule_AddIntMacro(m, IPPROTO_DSTOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006606#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006607#ifdef IPPROTO_XTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006608 PyModule_AddIntMacro(m, IPPROTO_XTP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006609#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006610#ifdef IPPROTO_EON
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006611 PyModule_AddIntMacro(m, IPPROTO_EON);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006612#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006613#ifdef IPPROTO_PIM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006614 PyModule_AddIntMacro(m, IPPROTO_PIM);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006615#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006616#ifdef IPPROTO_IPCOMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006617 PyModule_AddIntMacro(m, IPPROTO_IPCOMP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006618#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006619#ifdef IPPROTO_VRRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006620 PyModule_AddIntMacro(m, IPPROTO_VRRP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006621#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006622#ifdef IPPROTO_SCTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006623 PyModule_AddIntMacro(m, IPPROTO_SCTP);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006624#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006625#ifdef IPPROTO_BIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006626 PyModule_AddIntMacro(m, IPPROTO_BIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006627#endif
6628/**/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006629#ifdef IPPROTO_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006630 PyModule_AddIntMacro(m, IPPROTO_RAW);
Guido van Rossum578de301998-05-28 20:18:18 +00006631#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006632 PyModule_AddIntConstant(m, "IPPROTO_RAW", 255);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006633#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006634#ifdef IPPROTO_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006635 PyModule_AddIntMacro(m, IPPROTO_MAX);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006636#endif
6637
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006638#ifdef SYSPROTO_CONTROL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006639 PyModule_AddIntMacro(m, SYSPROTO_CONTROL);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006640#endif
6641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006642 /* Some port configuration */
6643#ifdef IPPORT_RESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006644 PyModule_AddIntMacro(m, IPPORT_RESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006645#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006646 PyModule_AddIntConstant(m, "IPPORT_RESERVED", 1024);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006647#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006648#ifdef IPPORT_USERRESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006649 PyModule_AddIntMacro(m, IPPORT_USERRESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006650#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006651 PyModule_AddIntConstant(m, "IPPORT_USERRESERVED", 5000);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006652#endif
6653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006654 /* Some reserved IP v.4 addresses */
6655#ifdef INADDR_ANY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006656 PyModule_AddIntMacro(m, INADDR_ANY);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006657#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006658 PyModule_AddIntConstant(m, "INADDR_ANY", 0x00000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006659#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006660#ifdef INADDR_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006661 PyModule_AddIntMacro(m, INADDR_BROADCAST);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006662#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006663 PyModule_AddIntConstant(m, "INADDR_BROADCAST", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006664#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006665#ifdef INADDR_LOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006666 PyModule_AddIntMacro(m, INADDR_LOOPBACK);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006667#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006668 PyModule_AddIntConstant(m, "INADDR_LOOPBACK", 0x7F000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006669#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006670#ifdef INADDR_UNSPEC_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006671 PyModule_AddIntMacro(m, INADDR_UNSPEC_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006672#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006673 PyModule_AddIntConstant(m, "INADDR_UNSPEC_GROUP", 0xe0000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006674#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006675#ifdef INADDR_ALLHOSTS_GROUP
6676 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP",
6677 INADDR_ALLHOSTS_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006678#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006679 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP", 0xe0000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006680#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006681#ifdef INADDR_MAX_LOCAL_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006682 PyModule_AddIntMacro(m, INADDR_MAX_LOCAL_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006683#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006684 PyModule_AddIntConstant(m, "INADDR_MAX_LOCAL_GROUP", 0xe00000ff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006685#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006686#ifdef INADDR_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006687 PyModule_AddIntMacro(m, INADDR_NONE);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006688#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006689 PyModule_AddIntConstant(m, "INADDR_NONE", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006690#endif
6691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006692 /* IPv4 [gs]etsockopt options */
6693#ifdef IP_OPTIONS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006694 PyModule_AddIntMacro(m, IP_OPTIONS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006695#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006696#ifdef IP_HDRINCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006697 PyModule_AddIntMacro(m, IP_HDRINCL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006698#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006699#ifdef IP_TOS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006700 PyModule_AddIntMacro(m, IP_TOS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006701#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006702#ifdef IP_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006703 PyModule_AddIntMacro(m, IP_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006704#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006705#ifdef IP_RECVOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006706 PyModule_AddIntMacro(m, IP_RECVOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006707#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006708#ifdef IP_RECVRETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006709 PyModule_AddIntMacro(m, IP_RECVRETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006710#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006711#ifdef IP_RECVDSTADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006712 PyModule_AddIntMacro(m, IP_RECVDSTADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006713#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006714#ifdef IP_RETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006715 PyModule_AddIntMacro(m, IP_RETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006716#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006717#ifdef IP_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006718 PyModule_AddIntMacro(m, IP_MULTICAST_IF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006719#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006720#ifdef IP_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006721 PyModule_AddIntMacro(m, IP_MULTICAST_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006722#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006723#ifdef IP_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006724 PyModule_AddIntMacro(m, IP_MULTICAST_LOOP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006725#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006726#ifdef IP_ADD_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006727 PyModule_AddIntMacro(m, IP_ADD_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006728#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006729#ifdef IP_DROP_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006730 PyModule_AddIntMacro(m, IP_DROP_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006731#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006732#ifdef IP_DEFAULT_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006733 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_TTL);
Guido van Rossum09be4091999-08-09 14:40:40 +00006734#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006735#ifdef IP_DEFAULT_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006736 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_LOOP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006737#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006738#ifdef IP_MAX_MEMBERSHIPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006739 PyModule_AddIntMacro(m, IP_MAX_MEMBERSHIPS);
Guido van Rossum09be4091999-08-09 14:40:40 +00006740#endif
Charles-François Natali564a42c2011-12-17 14:59:56 +01006741#ifdef IP_TRANSPARENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006742 PyModule_AddIntMacro(m, IP_TRANSPARENT);
Charles-François Natali564a42c2011-12-17 14:59:56 +01006743#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006745 /* IPv6 [gs]etsockopt options, defined in RFC2553 */
6746#ifdef IPV6_JOIN_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006747 PyModule_AddIntMacro(m, IPV6_JOIN_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006748#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006749#ifdef IPV6_LEAVE_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006750 PyModule_AddIntMacro(m, IPV6_LEAVE_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006751#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006752#ifdef IPV6_MULTICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006753 PyModule_AddIntMacro(m, IPV6_MULTICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006754#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006755#ifdef IPV6_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006756 PyModule_AddIntMacro(m, IPV6_MULTICAST_IF);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006757#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006758#ifdef IPV6_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006759 PyModule_AddIntMacro(m, IPV6_MULTICAST_LOOP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006760#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006761#ifdef IPV6_UNICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006762 PyModule_AddIntMacro(m, IPV6_UNICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006763#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006764 /* Additional IPV6 socket options, defined in RFC 3493 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006765#ifdef IPV6_V6ONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006766 PyModule_AddIntMacro(m, IPV6_V6ONLY);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006767#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006768 /* Advanced IPV6 socket options, from RFC 3542 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006769#ifdef IPV6_CHECKSUM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006770 PyModule_AddIntMacro(m, IPV6_CHECKSUM);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006771#endif
6772#ifdef IPV6_DONTFRAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006773 PyModule_AddIntMacro(m, IPV6_DONTFRAG);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006774#endif
6775#ifdef IPV6_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006776 PyModule_AddIntMacro(m, IPV6_DSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006777#endif
6778#ifdef IPV6_HOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006779 PyModule_AddIntMacro(m, IPV6_HOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006780#endif
6781#ifdef IPV6_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006782 PyModule_AddIntMacro(m, IPV6_HOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006783#endif
6784#ifdef IPV6_NEXTHOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006785 PyModule_AddIntMacro(m, IPV6_NEXTHOP);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006786#endif
6787#ifdef IPV6_PATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006788 PyModule_AddIntMacro(m, IPV6_PATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006789#endif
6790#ifdef IPV6_PKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006791 PyModule_AddIntMacro(m, IPV6_PKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006792#endif
6793#ifdef IPV6_RECVDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006794 PyModule_AddIntMacro(m, IPV6_RECVDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006795#endif
6796#ifdef IPV6_RECVHOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006797 PyModule_AddIntMacro(m, IPV6_RECVHOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006798#endif
6799#ifdef IPV6_RECVHOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006800 PyModule_AddIntMacro(m, IPV6_RECVHOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006801#endif
6802#ifdef IPV6_RECVPKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006803 PyModule_AddIntMacro(m, IPV6_RECVPKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006804#endif
6805#ifdef IPV6_RECVRTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006806 PyModule_AddIntMacro(m, IPV6_RECVRTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006807#endif
6808#ifdef IPV6_RECVTCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006809 PyModule_AddIntMacro(m, IPV6_RECVTCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006810#endif
6811#ifdef IPV6_RTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006812 PyModule_AddIntMacro(m, IPV6_RTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006813#endif
6814#ifdef IPV6_RTHDRDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006815 PyModule_AddIntMacro(m, IPV6_RTHDRDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006816#endif
6817#ifdef IPV6_RTHDR_TYPE_0
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006818 PyModule_AddIntMacro(m, IPV6_RTHDR_TYPE_0);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006819#endif
6820#ifdef IPV6_RECVPATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006821 PyModule_AddIntMacro(m, IPV6_RECVPATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006822#endif
6823#ifdef IPV6_TCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006824 PyModule_AddIntMacro(m, IPV6_TCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006825#endif
6826#ifdef IPV6_USE_MIN_MTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006827 PyModule_AddIntMacro(m, IPV6_USE_MIN_MTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006828#endif
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006830 /* TCP options */
6831#ifdef TCP_NODELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006832 PyModule_AddIntMacro(m, TCP_NODELAY);
Guido van Rossum09be4091999-08-09 14:40:40 +00006833#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006834#ifdef TCP_MAXSEG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006835 PyModule_AddIntMacro(m, TCP_MAXSEG);
Guido van Rossum09be4091999-08-09 14:40:40 +00006836#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006837#ifdef TCP_CORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006838 PyModule_AddIntMacro(m, TCP_CORK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006839#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006840#ifdef TCP_KEEPIDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006841 PyModule_AddIntMacro(m, TCP_KEEPIDLE);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006842#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006843#ifdef TCP_KEEPINTVL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006844 PyModule_AddIntMacro(m, TCP_KEEPINTVL);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006845#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006846#ifdef TCP_KEEPCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006847 PyModule_AddIntMacro(m, TCP_KEEPCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006848#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006849#ifdef TCP_SYNCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006850 PyModule_AddIntMacro(m, TCP_SYNCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006851#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006852#ifdef TCP_LINGER2
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006853 PyModule_AddIntMacro(m, TCP_LINGER2);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006854#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006855#ifdef TCP_DEFER_ACCEPT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006856 PyModule_AddIntMacro(m, TCP_DEFER_ACCEPT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006857#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006858#ifdef TCP_WINDOW_CLAMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006859 PyModule_AddIntMacro(m, TCP_WINDOW_CLAMP);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006860#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006861#ifdef TCP_INFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006862 PyModule_AddIntMacro(m, TCP_INFO);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006863#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006864#ifdef TCP_QUICKACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006865 PyModule_AddIntMacro(m, TCP_QUICKACK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006866#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006867#ifdef TCP_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006868 PyModule_AddIntMacro(m, TCP_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006869#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006871 /* IPX options */
6872#ifdef IPX_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006873 PyModule_AddIntMacro(m, IPX_TYPE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006874#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00006875
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006876/* Reliable Datagram Sockets */
6877#ifdef RDS_CMSG_RDMA_ARGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006878 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_ARGS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006879#endif
6880#ifdef RDS_CMSG_RDMA_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006881 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006882#endif
6883#ifdef RDS_CMSG_RDMA_MAP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006884 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_MAP);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006885#endif
6886#ifdef RDS_CMSG_RDMA_STATUS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006887 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_STATUS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006888#endif
6889#ifdef RDS_CMSG_RDMA_UPDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006890 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_UPDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006891#endif
6892#ifdef RDS_RDMA_READWRITE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006893 PyModule_AddIntMacro(m, RDS_RDMA_READWRITE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006894#endif
6895#ifdef RDS_RDMA_FENCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006896 PyModule_AddIntMacro(m, RDS_RDMA_FENCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006897#endif
6898#ifdef RDS_RDMA_INVALIDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006899 PyModule_AddIntMacro(m, RDS_RDMA_INVALIDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006900#endif
6901#ifdef RDS_RDMA_USE_ONCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006902 PyModule_AddIntMacro(m, RDS_RDMA_USE_ONCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006903#endif
6904#ifdef RDS_RDMA_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006905 PyModule_AddIntMacro(m, RDS_RDMA_DONTWAIT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006906#endif
6907#ifdef RDS_RDMA_NOTIFY_ME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006908 PyModule_AddIntMacro(m, RDS_RDMA_NOTIFY_ME);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006909#endif
6910#ifdef RDS_RDMA_SILENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006911 PyModule_AddIntMacro(m, RDS_RDMA_SILENT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006912#endif
6913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006914 /* get{addr,name}info parameters */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006915#ifdef EAI_ADDRFAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006916 PyModule_AddIntMacro(m, EAI_ADDRFAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006917#endif
6918#ifdef EAI_AGAIN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006919 PyModule_AddIntMacro(m, EAI_AGAIN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006920#endif
6921#ifdef EAI_BADFLAGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006922 PyModule_AddIntMacro(m, EAI_BADFLAGS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006923#endif
6924#ifdef EAI_FAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006925 PyModule_AddIntMacro(m, EAI_FAIL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006926#endif
6927#ifdef EAI_FAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006928 PyModule_AddIntMacro(m, EAI_FAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006929#endif
6930#ifdef EAI_MEMORY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006931 PyModule_AddIntMacro(m, EAI_MEMORY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006932#endif
6933#ifdef EAI_NODATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006934 PyModule_AddIntMacro(m, EAI_NODATA);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006935#endif
6936#ifdef EAI_NONAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006937 PyModule_AddIntMacro(m, EAI_NONAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006938#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006939#ifdef EAI_OVERFLOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006940 PyModule_AddIntMacro(m, EAI_OVERFLOW);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006941#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006942#ifdef EAI_SERVICE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006943 PyModule_AddIntMacro(m, EAI_SERVICE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006944#endif
6945#ifdef EAI_SOCKTYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006946 PyModule_AddIntMacro(m, EAI_SOCKTYPE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006947#endif
6948#ifdef EAI_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006949 PyModule_AddIntMacro(m, EAI_SYSTEM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006950#endif
6951#ifdef EAI_BADHINTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006952 PyModule_AddIntMacro(m, EAI_BADHINTS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006953#endif
6954#ifdef EAI_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006955 PyModule_AddIntMacro(m, EAI_PROTOCOL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006956#endif
6957#ifdef EAI_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006958 PyModule_AddIntMacro(m, EAI_MAX);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006959#endif
6960#ifdef AI_PASSIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006961 PyModule_AddIntMacro(m, AI_PASSIVE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006962#endif
6963#ifdef AI_CANONNAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006964 PyModule_AddIntMacro(m, AI_CANONNAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006965#endif
6966#ifdef AI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006967 PyModule_AddIntMacro(m, AI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006968#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006969#ifdef AI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006970 PyModule_AddIntMacro(m, AI_NUMERICSERV);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006971#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006972#ifdef AI_MASK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006973 PyModule_AddIntMacro(m, AI_MASK);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006974#endif
6975#ifdef AI_ALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006976 PyModule_AddIntMacro(m, AI_ALL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006977#endif
6978#ifdef AI_V4MAPPED_CFG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006979 PyModule_AddIntMacro(m, AI_V4MAPPED_CFG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006980#endif
6981#ifdef AI_ADDRCONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006982 PyModule_AddIntMacro(m, AI_ADDRCONFIG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006983#endif
6984#ifdef AI_V4MAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006985 PyModule_AddIntMacro(m, AI_V4MAPPED);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006986#endif
6987#ifdef AI_DEFAULT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006988 PyModule_AddIntMacro(m, AI_DEFAULT);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006989#endif
6990#ifdef NI_MAXHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006991 PyModule_AddIntMacro(m, NI_MAXHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006992#endif
6993#ifdef NI_MAXSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006994 PyModule_AddIntMacro(m, NI_MAXSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006995#endif
6996#ifdef NI_NOFQDN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006997 PyModule_AddIntMacro(m, NI_NOFQDN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006998#endif
6999#ifdef NI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007000 PyModule_AddIntMacro(m, NI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007001#endif
7002#ifdef NI_NAMEREQD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007003 PyModule_AddIntMacro(m, NI_NAMEREQD);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007004#endif
7005#ifdef NI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007006 PyModule_AddIntMacro(m, NI_NUMERICSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007007#endif
7008#ifdef NI_DGRAM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007009 PyModule_AddIntMacro(m, NI_DGRAM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007010#endif
7011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007012 /* shutdown() parameters */
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007013#ifdef SHUT_RD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007014 PyModule_AddIntMacro(m, SHUT_RD);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007015#elif defined(SD_RECEIVE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007016 PyModule_AddIntConstant(m, "SHUT_RD", SD_RECEIVE);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007017#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007018 PyModule_AddIntConstant(m, "SHUT_RD", 0);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007019#endif
7020#ifdef SHUT_WR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007021 PyModule_AddIntMacro(m, SHUT_WR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007022#elif defined(SD_SEND)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007023 PyModule_AddIntConstant(m, "SHUT_WR", SD_SEND);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007024#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007025 PyModule_AddIntConstant(m, "SHUT_WR", 1);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007026#endif
7027#ifdef SHUT_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007028 PyModule_AddIntMacro(m, SHUT_RDWR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007029#elif defined(SD_BOTH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007030 PyModule_AddIntConstant(m, "SHUT_RDWR", SD_BOTH);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007031#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007032 PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007033#endif
7034
Christian Heimesfaf2f632008-01-06 16:59:19 +00007035#ifdef SIO_RCVALL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007036 {
7037 DWORD codes[] = {SIO_RCVALL, SIO_KEEPALIVE_VALS};
7038 const char *names[] = {"SIO_RCVALL", "SIO_KEEPALIVE_VALS"};
7039 int i;
Victor Stinner63941882011-09-29 00:42:28 +02007040 for(i = 0; i<Py_ARRAY_LENGTH(codes); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007041 PyObject *tmp;
7042 tmp = PyLong_FromUnsignedLong(codes[i]);
7043 if (tmp == NULL)
7044 return NULL;
7045 PyModule_AddObject(m, names[i], tmp);
7046 }
7047 }
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007048 PyModule_AddIntMacro(m, RCVALL_OFF);
7049 PyModule_AddIntMacro(m, RCVALL_ON);
7050 PyModule_AddIntMacro(m, RCVALL_SOCKETLEVELONLY);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007051#ifdef RCVALL_IPLEVEL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007052 PyModule_AddIntMacro(m, RCVALL_IPLEVEL);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007053#endif
7054#ifdef RCVALL_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007055 PyModule_AddIntMacro(m, RCVALL_MAX);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007056#endif
Christian Heimesfaf2f632008-01-06 16:59:19 +00007057#endif /* _MSTCPIP_ */
7058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007059 /* Initialize gethostbyname lock */
Just van Rossum1040d2c2003-05-09 07:53:18 +00007060#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007061 netdb_lock = PyThread_allocate_lock();
Guido van Rossum4f199ea1998-04-09 20:56:35 +00007062#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007063 return m;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00007064}
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007065
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007066
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007067#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +00007068#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007069
7070/* Simplistic emulation code for inet_pton that only works for IPv4 */
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00007071/* These are not exposed because they do not set errno properly */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007072
Guido van Rossum3eede5a2002-06-07 02:08:35 +00007073int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007074inet_pton(int af, const char *src, void *dst)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007076 if (af == AF_INET) {
Benjamin Petersonf91df042009-02-13 02:50:59 +00007077#if (SIZEOF_INT != 4)
7078#error "Not sure if in_addr_t exists and int is not 32-bits."
7079#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007080 unsigned int packed_addr;
7081 packed_addr = inet_addr(src);
7082 if (packed_addr == INADDR_NONE)
7083 return 0;
7084 memcpy(dst, &packed_addr, 4);
7085 return 1;
7086 }
7087 /* Should set errno to EAFNOSUPPORT */
7088 return -1;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007089}
7090
Martin v. Löwisc925b1532001-07-21 09:42:15 +00007091const char *
7092inet_ntop(int af, const void *src, char *dst, socklen_t size)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007094 if (af == AF_INET) {
7095 struct in_addr packed_addr;
7096 if (size < 16)
7097 /* Should set errno to ENOSPC. */
7098 return NULL;
7099 memcpy(&packed_addr, src, sizeof(packed_addr));
7100 return strncpy(dst, inet_ntoa(packed_addr), size);
7101 }
7102 /* Should set errno to EAFNOSUPPORT */
7103 return NULL;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007104}
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007105
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007106#endif
Christian Heimesb6150692007-11-15 23:37:07 +00007107#endif