aboutsummaryrefslogtreecommitdiffstats
path: root/include/arpa/inet.h
blob: a9a3ecdaf64dcda5a5f8044ba8430e683b3fa463 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/**
 * slibc — Yet another C library
 * Copyright © 2015, 2016  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _ARAP_INET_H
#define _ARAP_INET_H
#include <slibc/version.h>
#include <slibc/features.h>



#define __NEED_uint16_t
#define __NEED_uint32_t
#if defined(__SLIBC_SOURCE)
# define __NEED_uint64_t
#endif

#include <bits/types.h>



/* On some implementations, these functions are defined as macros. */

/**
 * Convert a 16-bit quantity from network byte order
 * little endian) to host byte order.
 * 
 * @etymology  (N)etwork byte order (to) (h)ost byte order, (s)hort.
 * 
 * @param   value  A 16-bit quantity to convert.
 * @return         The value in host byte order.
 * 
 * @since  Always.
 */
uint16_t _ntohs(uint16_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if !defined(__PORTABLE)
# define ntohs  _ntohs
#else
# define ntohs(value)  (_ntohs(value))
#endif

/**
 * Convert a 32-bit quantity from network byte order
 * (little endian) to host byte order.
 * 
 * @etymology  (N)etwork byte order (to) (h)ost byte order, (l)ong.
 * 
 * @param   value  A 32-bit quantity to convert.
 * @return         The value in host byte order.
 * 
 * @since  Always.
 */
uint32_t _ntohl(uint32_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if !defined(__PORTABLE)
# define ntohl  _ntohl
#else
# define ntohl(value)  (_ntohl(value))
#endif

#if defined(__SLIBC_SOURCE)
/**
 * Convert a 64-bit quantity from network byte order
 * (little endian) to host byte order.
 * 
 * This is a slibc extension.
 * 
 * @etymology  (N)etwork byte order (to) (h)ost byte order, (l)ong (l)ong.
 * 
 * @param   value  A 64-bit quantity to convert.
 * @return         The value in host byte order.
 * 
 * @since  Always.
 */
uint64_t _ntohll(uint64_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
# if !defined(__PORTABLE)
#  define ntohll  _ntohll
# else
#  define ntohll(value)  (_ntohll(value))
# endif
#endif

/**
 * Convert a 16-bit quantity from host byte order
 * little endian) to network byte order.
 * 
 * @etymology  (H)ost byte order (to) (n)etwork byte order, (s)hort.
 * 
 * @param   value  A 16-bit quantity to convert.
 * @return         The value in network byte order.
 * 
 * @since  Always.
 */
uint16_t _htons(uint16_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if !defined(__PORTABLE)
# define htons  _htons
#else
# define htons(value)  (_htons(value))
#endif

/**
 * Convert a 32-bit quantity from host byte order
 * (little endian) to network byte order.
 * 
 * @etymology  (H)ost byte order (to) (n)etwork byte order, (l)ong.
 * 
 * @param   value  A 32-bit quantity to convert.
 * @return         The value in network byte order.
 * 
 * @since  Always.
 */
uint32_t _htonl(uint32_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if !defined(__PORTABLE)
# define htonl  _htonl
#else
# define htonl(value)  (_htonl(value))
#endif

#if defined(__SLIBC_SOURCE)
/**
 * Convert a 64-bit quantity from host byte order
 * (little endian) to network byte order.
 * 
 * This is a slibc extension.
 * 
 * @etymology  (H)ost byte order (to) (n)etwork byte order, (l)ong (l)ong.
 * 
 * @param   value  A 64-bit quantity to convert.
 * @return         The value in network byte order.
 * 
 * @since  Always.
 */
uint64_t _htonll(uint64_t)
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
# if !defined(__PORTABLE)
#  define htonll  _htonll
# else
#  define htonll(value)  (_htonll(value))
# endif
#endif


/* TODO We "need" conversion to and from two's complement.
 *      It is important to remember than intN_t cannot be
 *      used for this functions because they require two's
 *      complement.
 *
 *         unsigned to_twos_complement(signed v) {
 *           unsigned r;
 *           if (v >= -0)
 *             return (unsigned)v;
 *           r = (unsigned)-v;
 *           r = ~(r - 1);
 *           return r;
 *         }
 *
 *         signed from_twos_complement(unsigned v) {
 *           signed r;
 *           if ((v >> (X_BIT - 1)) == 0)
 *             return (signed)v;
 *           r = ~r;
 *           if (r == X_MAX)
 *             return errno = ERANGE, 0;
 *           return errno = 0, r + 1;
 *         }
 */



#endif