xref: /reactos/drivers/network/tcpip/lwip/src/core/def.c (revision d6eebaa4)
1 /**
2  * @file
3  * Common functions used throughout the stack.
4  *
5  * These are reference implementations of the byte swapping functions.
6  * Again with the aim of being simple, correct and fully portable.
7  * Byte swapping is the second thing you would want to optimize. You will
8  * need to port it to your architecture and in your cc.h:
9  *
10  * \#define lwip_htons(x) your_htons
11  * \#define lwip_htonl(x) your_htonl
12  *
13  * Note lwip_ntohs() and lwip_ntohl() are merely references to the htonx counterparts.
14  *
15  * If you \#define them to htons() and htonl(), you should
16  * \#define LWIP_DONT_PROVIDE_BYTEORDER_FUNCTIONS to prevent lwIP from
17  * defining htonx/ntohx compatibility macros.
18 
19  * @defgroup sys_nonstandard Non-standard functions
20  * @ingroup sys_layer
21  * lwIP provides default implementations for non-standard functions.
22  * These can be mapped to OS functions to reduce code footprint if desired.
23  * All defines related to this section must not be placed in lwipopts.h,
24  * but in arch/cc.h!
25  * These options cannot be \#defined in lwipopts.h since they are not options
26  * of lwIP itself, but options of the lwIP port to your system.
27  */
28 
29 /*
30  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
31  * All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without modification,
34  * are permitted provided that the following conditions are met:
35  *
36  * 1. Redistributions of source code must retain the above copyright notice,
37  *    this list of conditions and the following disclaimer.
38  * 2. Redistributions in binary form must reproduce the above copyright notice,
39  *    this list of conditions and the following disclaimer in the documentation
40  *    and/or other materials provided with the distribution.
41  * 3. The name of the author may not be used to endorse or promote products
42  *    derived from this software without specific prior written permission.
43  *
44  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
45  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
46  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
47  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
48  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
49  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
50  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
51  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
52  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
53  * OF SUCH DAMAGE.
54  *
55  * This file is part of the lwIP TCP/IP stack.
56  *
57  * Author: Simon Goldschmidt
58  *
59  */
60 
61 #include "lwip/opt.h"
62 #include "lwip/def.h"
63 
64 #include <string.h>
65 
66 #if BYTE_ORDER == LITTLE_ENDIAN
67 
68 #if !defined(lwip_htons)
69 /**
70  * Convert an u16_t from host- to network byte order.
71  *
72  * @param n u16_t in host byte order
73  * @return n in network byte order
74  */
75 u16_t
lwip_htons(u16_t n)76 lwip_htons(u16_t n)
77 {
78   return PP_HTONS(n);
79 }
80 #endif /* lwip_htons */
81 
82 #if !defined(lwip_htonl)
83 /**
84  * Convert an u32_t from host- to network byte order.
85  *
86  * @param n u32_t in host byte order
87  * @return n in network byte order
88  */
89 u32_t
lwip_htonl(u32_t n)90 lwip_htonl(u32_t n)
91 {
92   return PP_HTONL(n);
93 }
94 #endif /* lwip_htonl */
95 
96 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
97 
98 #ifndef lwip_strnstr
99 /**
100  * @ingroup sys_nonstandard
101  * lwIP default implementation for strnstr() non-standard function.
102  * This can be \#defined to strnstr() depending on your platform port.
103  */
104 char *
lwip_strnstr(const char * buffer,const char * token,size_t n)105 lwip_strnstr(const char *buffer, const char *token, size_t n)
106 {
107   const char *p;
108   size_t tokenlen = strlen(token);
109   if (tokenlen == 0) {
110     return LWIP_CONST_CAST(char *, buffer);
111   }
112   for (p = buffer; *p && (p + tokenlen <= buffer + n); p++) {
113     if ((*p == *token) && (strncmp(p, token, tokenlen) == 0)) {
114       return LWIP_CONST_CAST(char *, p);
115     }
116   }
117   return NULL;
118 }
119 #endif
120 
121 #ifndef lwip_strnistr
122 /**
123  * @ingroup sys_nonstandard
124  * lwIP default implementation for strnistr() non-standard function.
125  * This can be \#defined to strnistr() depending on your platform port.
126  */
127 char *
lwip_strnistr(const char * buffer,const char * token,size_t n)128 lwip_strnistr(const char *buffer, const char *token, size_t n)
129 {
130   const char *p;
131   size_t tokenlen = strlen(token);
132   if (tokenlen == 0) {
133     return LWIP_CONST_CAST(char *, buffer);
134   }
135   for (p = buffer; *p && (p + tokenlen <= buffer + n); p++) {
136     if (lwip_strnicmp(p, token, tokenlen) == 0) {
137       return LWIP_CONST_CAST(char *, p);
138     }
139   }
140   return NULL;
141 }
142 #endif
143 
144 #ifndef lwip_stricmp
145 /**
146  * @ingroup sys_nonstandard
147  * lwIP default implementation for stricmp() non-standard function.
148  * This can be \#defined to stricmp() depending on your platform port.
149  */
150 int
lwip_stricmp(const char * str1,const char * str2)151 lwip_stricmp(const char *str1, const char *str2)
152 {
153   char c1, c2;
154 
155   do {
156     c1 = *str1++;
157     c2 = *str2++;
158     if (c1 != c2) {
159       char c1_upc = c1 | 0x20;
160       if ((c1_upc >= 'a') && (c1_upc <= 'z')) {
161         /* characters are not equal an one is in the alphabet range:
162         downcase both chars and check again */
163         char c2_upc = c2 | 0x20;
164         if (c1_upc != c2_upc) {
165           /* still not equal */
166           /* don't care for < or > */
167           return 1;
168         }
169       } else {
170         /* characters are not equal but none is in the alphabet range */
171         return 1;
172       }
173     }
174   } while (c1 != 0);
175   return 0;
176 }
177 #endif
178 
179 #ifndef lwip_strnicmp
180 /**
181  * @ingroup sys_nonstandard
182  * lwIP default implementation for strnicmp() non-standard function.
183  * This can be \#defined to strnicmp() depending on your platform port.
184  */
185 int
lwip_strnicmp(const char * str1,const char * str2,size_t len)186 lwip_strnicmp(const char *str1, const char *str2, size_t len)
187 {
188   char c1, c2;
189 
190   do {
191     c1 = *str1++;
192     c2 = *str2++;
193     if (c1 != c2) {
194       char c1_upc = c1 | 0x20;
195       if ((c1_upc >= 'a') && (c1_upc <= 'z')) {
196         /* characters are not equal an one is in the alphabet range:
197         downcase both chars and check again */
198         char c2_upc = c2 | 0x20;
199         if (c1_upc != c2_upc) {
200           /* still not equal */
201           /* don't care for < or > */
202           return 1;
203         }
204       } else {
205         /* characters are not equal but none is in the alphabet range */
206         return 1;
207       }
208     }
209     len--;
210   } while ((len != 0) && (c1 != 0));
211   return 0;
212 }
213 #endif
214 
215 #ifndef lwip_itoa
216 /**
217  * @ingroup sys_nonstandard
218  * lwIP default implementation for itoa() non-standard function.
219  * This can be \#defined to itoa() or snprintf(result, bufsize, "%d", number) depending on your platform port.
220  */
221 void
lwip_itoa(char * result,size_t bufsize,int number)222 lwip_itoa(char *result, size_t bufsize, int number)
223 {
224   char *res = result;
225   char *tmp = result + bufsize - 1;
226   int n = (number >= 0) ? number : -number;
227 
228   /* handle invalid bufsize */
229   if (bufsize < 2) {
230     if (bufsize == 1) {
231       *result = 0;
232     }
233     return;
234   }
235 
236   /* First, add sign */
237   if (number < 0) {
238     *res++ = '-';
239   }
240   /* Then create the string from the end and stop if buffer full,
241      and ensure output string is zero terminated */
242   *tmp = 0;
243   while ((n != 0) && (tmp > res)) {
244     char val = (char)('0' + (n % 10));
245     tmp--;
246     *tmp = val;
247     n = n / 10;
248   }
249   if (n) {
250     /* buffer is too small */
251     *result = 0;
252     return;
253   }
254   if (*tmp == 0) {
255     /* Nothing added? */
256     *res++ = '0';
257     *res++ = 0;
258     return;
259   }
260   /* move from temporary buffer to output buffer (sign is not moved) */
261   memmove(res, tmp, (size_t)((result + bufsize) - tmp));
262 }
263 #endif
264