1 /**
2  * @file
3  * Sockets API internal implementations (do not use in application code)
4  */
5 
6 /*
7  * Copyright (c) 2017 Joel Cunningham, Garmin International, Inc. <joel.cunningham@garmin.com>
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  *    this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  *    this list of conditions and the following disclaimer in the documentation
17  *    and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30  * OF SUCH DAMAGE.
31  *
32  * This file is part of the lwIP TCP/IP stack.
33  *
34  * Author: Joel Cunningham <joel.cunningham@me.com>
35  *
36  */
37 #ifndef LWIP_HDR_SOCKETS_PRIV_H
38 #define LWIP_HDR_SOCKETS_PRIV_H
39 
40 #include "lwip/opt.h"
41 
42 #if LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */
43 
44 #include "lwip/err.h"
45 #include "lwip/sockets.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 #if LWIP_SOCKET_SET_ERRNO
52 #ifndef set_errno
53 #define set_errno(err) do { if (err) { errno = (err); } } while(0)
54 #endif
55 #else /* LWIP_SOCKET_SET_ERRNO */
56 #define set_errno(err)
57 #endif /* LWIP_SOCKET_SET_ERRNO */
58 
59 #if !LWIP_TCPIP_CORE_LOCKING
60 /** Maximum optlen used by setsockopt/getsockopt */
61 #define LWIP_SETGETSOCKOPT_MAXOPTLEN 16
62 
63 /** This struct is used to pass data to the set/getsockopt_internal
64  * functions running in tcpip_thread context (only a void* is allowed) */
65 struct lwip_setgetsockopt_data {
66   /** socket index for which to change options */
67   int s;
68   /** level of the option to process */
69   int level;
70   /** name of the option to process */
71   int optname;
72   /** set: value to set the option to
73     * get: value of the option is stored here */
74 #if LWIP_MPU_COMPATIBLE
75   u8_t optval[LWIP_SETGETSOCKOPT_MAXOPTLEN];
76 #else
77   union {
78     void *p;
79     const void *pc;
80   } optval;
81 #endif
82   /** size of *optval */
83   socklen_t optlen;
84   /** if an error occurs, it is temporarily stored here */
85   int err;
86   /** semaphore to wake up the calling task */
87   void* completed_sem;
88 };
89 #endif /* !LWIP_TCPIP_CORE_LOCKING */
90 
91 #ifdef __cplusplus
92 }
93 #endif
94 
95 #endif /* LWIP_SOCKET */
96 
97 #endif /* LWIP_HDR_SOCKETS_PRIV_H */
98