5cd6f722271ccb062279a6192e1a838c69d004e0
[sbcl.git] / contrib / sb-bsd-sockets / constants.lisp
1 ;;; -*- Lisp -*-
2
3 ;;; This isn't really lisp, but it's definitely a source file.  we
4 ;;; name it thus to avoid having to mess with the clc lpn translations
5
6 ;;; first, the headers necessary to find definitions of everything
7 ("sys/types.h" "sys/socket.h" "sys/stat.h" "unistd.h" "sys/un.h"
8  "netinet/in.h" "netinet/in_systm.h" "netinet/ip.h" "net/if.h"
9  "netdb.h" "errno.h" "netinet/tcp.h" "fcntl.h" )
10
11 ;;; then the stuff we're looking for
12 ((:integer af-inet "AF_INET" "IP Protocol family")
13  (:integer af-unspec "AF_UNSPEC" "Unspecified")
14  (:integer af-local
15            #+(or sunos solaris) "AF_UNIX"
16            #-(or sunos solaris) "AF_LOCAL"
17            "Local to host (pipes and file-domain).")
18  #+linux (:integer af-inet6 "AF_INET6"   "IP version 6")
19  #+linux (:integer af-route "AF_NETLINK" "Alias to emulate 4.4BSD ")
20
21  (:integer sock-stream "SOCK_STREAM"
22            "Sequenced, reliable, connection-based byte streams.")
23  (:integer sock-dgram "SOCK_DGRAM"
24            "Connectionless, unreliable datagrams of fixed maximum length.")
25  (:integer sock-raw "SOCK_RAW"
26            "Raw protocol interface.")
27  (:integer sock-rdm "SOCK_RDM"
28            "Reliably-delivered messages.")
29  (:integer sock-seqpacket "SOCK_SEQPACKET"
30            "Sequenced, reliable, connection-based, datagrams of fixed maximum length.")
31
32  (:integer sol-socket "SOL_SOCKET")
33
34  ;; some of these may be linux-specific
35  (:integer so-debug "SO_DEBUG"
36            "Enable debugging in underlying protocol modules")
37  (:integer so-reuseaddr "SO_REUSEADDR" "Enable local address reuse")
38  (:integer so-type "SO_TYPE")                   ;get only
39  (:integer so-error "SO_ERROR")         ;get only (also clears)
40  (:integer so-dontroute "SO_DONTROUTE"
41            "Bypass routing facilities: instead send direct to appropriate network interface for the network portion of the destination address")
42  (:integer so-broadcast "SO_BROADCAST" "Request permission to send broadcast datagrams")
43  (:integer so-sndbuf "SO_SNDBUF")
44  #+linux (:integer so-passcred "SO_PASSCRED")
45  (:integer so-rcvbuf "SO_RCVBUF")
46  (:integer so-keepalive "SO_KEEPALIVE"
47            "Send periodic keepalives: if peer does not respond, we get SIGPIPE")
48  (:integer so-oobinline "SO_OOBINLINE"
49            "Put out-of-band data into the normal input queue when received")
50  #-freebsd
51  (:integer so-no-check "SO_NO_CHECK")
52  #+linux (:integer so-priority "SO_PRIORITY")
53  (:integer so-linger "SO_LINGER"
54            "For reliable streams, pause a while on closing when unsent messages are queued")
55  #+linux (:integer so-bsdcompat "SO_BSDCOMPAT")
56  (:integer so-sndlowat "SO_SNDLOWAT")
57  (:integer so-rcvlowat "SO_RCVLOWAT")
58  (:integer so-sndtimeo "SO_SNDTIMEO")
59  (:integer so-rcvtimeo "SO_RCVTIMEO")
60
61  (:integer tcp-nodelay "TCP_NODELAY")
62  #+linux (:integer so-bindtodevice "SO_BINDTODEVICE")
63  (:integer ifnamsiz "IFNAMSIZ")
64
65  (:integer EADDRINUSE "EADDRINUSE")
66  (:integer EAGAIN "EAGAIN")
67  (:integer EBADF "EBADF")
68  (:integer ECONNREFUSED "ECONNREFUSED")
69  (:integer ETIMEDOUT "ETIMEDOUT")
70  (:integer EINTR "EINTR")
71  (:integer EINVAL "EINVAL")
72  (:integer ENOBUFS "ENOBUFS")
73  (:integer ENOMEM "ENOMEM")
74  (:integer EOPNOTSUPP "EOPNOTSUPP")
75  (:integer EPERM "EPERM")
76  (:integer EPROTONOSUPPORT "EPROTONOSUPPORT")
77  (:integer ESOCKTNOSUPPORT "ESOCKTNOSUPPORT")
78  (:integer ENETUNREACH "ENETUNREACH")
79  (:integer ENOTCONN "ENOTCONN")
80
81  (:integer NETDB-INTERNAL "NETDB_INTERNAL" "See errno.")
82  (:integer NETDB-SUCCESS "NETDB_SUCCESS" "No problem.")
83  (:integer HOST-NOT-FOUND "HOST_NOT_FOUND" "Authoritative Answer Host not found.")
84  (:integer TRY-AGAIN "TRY_AGAIN" "Non-Authoritative Host not found, or SERVERFAIL.")
85  (:integer NO-RECOVERY "NO_RECOVERY" "Non recoverable errors, FORMERR, REFUSED, NOTIMP.")
86  (:integer NO-DATA "NO_DATA" "Valid name, no data record of requested type.")
87  (:integer NO-ADDRESS "NO_ADDRESS" "No address, look for MX record.")
88  (:function h-strerror ("hstrerror" c-string (errno int)))
89
90  (:integer O-NONBLOCK "O_NONBLOCK")
91  (:integer f-getfl "F_GETFL")
92  (:integer f-setfl "F_SETFL")
93
94  #+linux (:integer msg-nosignal "MSG_NOSIGNAL")
95  (:integer msg-oob "MSG_OOB")
96  (:integer msg-peek "MSG_PEEK")
97  (:integer msg-trunc "MSG_TRUNC")
98  (:integer msg-waitall "MSG_WAITALL")
99  (:integer msg-eor "MSG_EOR")
100  (:integer msg-dontroute "MSG_DONTROUTE")
101  (:integer msg-dontwait "MSG_DONTWAIT")
102  (:integer msg-nosignal "MSG_NOSIGNAL")
103  #+linux (:integer msg-confirm "MSG_CONFIRM")
104  #+linux (:integer msg-more "MSG_MORE")
105
106  ;; for socket-receive
107  (:type socklen-t "socklen_t")
108  (:type size-t "size_t")
109  (:type ssize-t "ssize_t")
110
111                                         #|
112  ;;; stat is nothing to do with sockets, but I keep it around for testing
113  ;;; the ffi glue
114  (:structure stat ("struct stat"
115  (t dev "dev_t" "st_dev")
116  ((alien:integer 32) atime "time_t" "st_atime")))
117  (:function stat ("stat" (integer 32)
118  (file-name (* t))
119  (buf (* t))))
120  |#
121  (:structure protoent ("struct protoent"
122                        (c-string-pointer name "char *" "p_name")
123                        ((* (* t)) aliases "char **" "p_aliases")
124                        (integer proto "int" "p_proto")))
125  (:function getprotobyname ("getprotobyname" (* protoent)
126                                              (name c-string)))
127  (:function getprotobynumber ("getprotobynumber" (* protoent)
128                                                  (proto int)))
129  (:integer inaddr-any "INADDR_ANY")
130  (:structure in-addr ("struct in_addr"
131                       ((array (unsigned 8)) addr "u_int32_t" "s_addr")))
132  (:structure sockaddr-in ("struct sockaddr_in"
133                           (integer family "sa_family_t" "sin_family")
134                           ;; These two could be in-port-t and
135                           ;; in-addr-t, but then we'd throw away the
136                           ;; convenience (and byte-order agnosticism)
137                           ;; of the old sb-grovel scheme.
138                           ((array (unsigned 8)) port "u_int16_t" "sin_port")
139                           ((array (unsigned 8)) addr "struct in_addr" "sin_addr")))
140  (:structure sockaddr-un ("struct sockaddr_un"
141                           (integer family "sa_family_t" "sun_family")
142                           (c-string path "char" "sun_path")))
143  (:structure hostent ("struct hostent"
144                       (c-string-pointer name "char *" "h_name")
145                       ((* c-string) aliases "char **" "h_aliases")
146                       (integer type "int" "h_addrtype")
147                       (integer length "int" "h_length")
148                       ((* (* (unsigned 8))) addresses "char **" "h_addr_list")))
149  (:structure msghdr ("struct msghdr"
150                       (c-string-pointer name "void *" "msg_name")
151                       (integer namelen "socklen_t" "msg_namelen")
152                       ((* t) iov "struct iovec" "msg_iov")
153                       (integer iovlen "size_t" "msg_iovlen")
154                       ((* t) control "void *" "msg_control")
155                       (integer controllen "socklen_t" "msg_controllen")
156                       (integer flags "int" "msg_flags")))
157  (:function socket (#-netbsd "socket" #+netbsd "_socket" int
158                     (domain int)
159                     (type int)
160                     (protocol int)))
161  (:function bind ("bind" int
162                   (sockfd int)
163                   (my-addr (* t))  ; KLUDGE: sockaddr-in or sockaddr-un?
164                   (addrlen socklen-t)))
165  (:function listen ("listen" int
166                     (socket int)
167                     (backlog int)))
168  (:function accept ("accept" int
169                     (socket int)
170                     (my-addr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
171                     (addrlen socklen-t :in-out)))
172  (:function getpeername ("getpeername" int
173                          (socket int)
174                          (her-addr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
175                          (addrlen socklen-t :in-out)))
176  (:function getsockname ("getsockname" int
177                          (socket int)
178                          (my-addr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
179                          (addrlen socklen-t :in-out)))
180  (:function connect ("connect" int
181                     (socket int)
182                     (his-addr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
183                     (addrlen socklen-t)))
184  (:function close ("close" int
185                    (fd int)))
186  (:function recvfrom ("recvfrom" ssize-t
187                                  (socket int)
188                                  (buf (* t))
189                                  (len integer)
190                                  (flags int)
191                                  (sockaddr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
192                                  (socklen (* socklen-t))))
193  (:function recvmsg ("recvmsg" ssize-t
194                                (socket int)
195                                (msg (* msghdr))
196                                (flags int)))
197  (:function send ("send" ssize-t
198                          (socket int)
199                          (buf (* t))
200                          (len size-t)
201                          (flags int)))
202  (:function sendto ("sendto" int
203                              (socket int)
204                              (buf (* t))
205                              (len size-t)
206                              (flags int)
207                              (sockaddr (* t)) ; KLUDGE: sockaddr-in or sockaddr-un?
208                              (socklen socklen-t)))
209  (:function sendmsg ("sendmsg" int
210                                (socket int)
211                                (msg (* msghdr))
212                                (flags int)))
213  (:function gethostbyname ("gethostbyname" (* hostent) (name c-string)))
214  (:function gethostbyaddr ("gethostbyaddr" (* hostent)
215                                            (addr (* t))
216                                            (len int)
217                                            (af int)))
218
219  ;; Re-entrant gethostbyname
220
221  #+linux
222  (:function gethostbyname-r ("gethostbyname_r"
223                              int
224                              (name c-string)
225                              (ret (* hostent))
226                              (buf (* char))
227                              (buflen long)
228                              (result (* (* hostent)))
229                              (h-errnop (* int))))
230  ;; getaddrinfo / getnameinfo
231
232  #+sb-bsd-sockets-addrinfo
233  (:structure addrinfo ("struct addrinfo"
234                        (integer flags "int" "ai_flags")
235                        (integer family "int" "ai_family")
236                        (integer socktype "int" "ai_socktype")
237                        (integer protocol "int" "ai_protocol")
238                        (integer addrlen "size_t""ai_addrlen")
239                        ((* sockaddr-in) addr "struct sockaddr*" "ai_addr")
240                        (c-string canonname "char *" "ai_canonname")
241                        ((* t) next "struct addrinfo*" "ai_next")))
242
243  #+sb-bsd-sockets-addrinfo
244  (:function getaddrinfo ("getaddrinfo"
245                          int
246                          (node c-string)
247                          (service c-string)
248                          (hints (* addrinfo))
249                          (res (* (* addrinfo)))))
250
251  #+sb-bsd-sockets-addrinfo
252  (:function freeaddrinfo ("freeaddrinfo"
253                           void
254                           (res (* addrinfo))))
255
256  #+sb-bsd-sockets-addrinfo
257  (:function gai-strerror ("gai_strerror"
258                          c-string
259                          (error-code int)))
260
261  #+sb-bsd-sockets-addrinfo
262  (:function getnameinfo ("getnameinfo"
263                          int
264                          (address (* sockaddr-in))
265                          (address-length size-t)
266                          (host (* char))
267                          (host-len size-t)
268                          (service (* char))
269                          (service-len size-t)
270                          (flags int)))
271
272  (:integer EAI-FAMILY "EAI_FAMILY")
273  (:integer EAI-SOCKTYPE "EAI_SOCKTYPE")
274  (:integer EAI-BADFLAGS "EAI_BADFLAGS")
275  (:integer EAI-NONAME "EAI_NONAME")
276  (:integer EAI-SERVICE "EAI_SERVICE")
277  #-freebsd
278  (:integer EAI-ADDRFAMILY "EAI_ADDRFAMILY")
279  #-freebsd
280  (:integer EAI-NODATA "EAI_NODATA")
281  (:integer EAI-MEMORY "EAI_MEMORY")
282  (:integer EAI-FAIL "EAI_FAIL")
283  (:integer EAI-AGAIN "EAI_AGAIN")
284  (:integer EAI-SYSTEM "EAI_SYSTEM")
285
286  (:integer NI-NAMEREQD "NI_NAMEREQD")
287
288  ;; Socket options
289
290  (:function setsockopt ("setsockopt" int
291                         (socket int)
292                         (level int)
293                         (optname int)
294                         (optval (* t))
295                         (optlen int))) ;;; should be socklen-t!
296  (:function fcntl ("fcntl" int
297                    (fd int)
298                    (cmd int)
299                    (arg long)))
300  (:function getsockopt ("getsockopt" int
301                         (socket int)
302                         (level int)
303                         (optname int)
304                         (optval (* t))
305                         (optlen (* int))))) ;;; should be socklen-t!
306 )