- add gdb pipe support to native win32 (--pipe option)
[fw/openocd] / src / helper / replacements.h
1 /***************************************************************************
2  *   Copyright (C) 2006 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  *   This program is distributed in the hope that it will be useful,       *
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
19  *   GNU General Public License for more details.                          *
20  *                                                                         *
21  *   You should have received a copy of the GNU General Public License     *
22  *   along with this program; if not, write to the                         *
23  *   Free Software Foundation, Inc.,                                       *
24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
25  ***************************************************************************/
26 #ifndef REPLACEMENTS_H
27 #define REPLACEMENTS_H
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include "types.h"
34
35 #if BUILD_ECOSBOARD
36 #include <pkgconf/system.h>
37 #include <stdlib.h>
38 #include <sys/select.h>
39 #endif
40
41 /* include necessary headers for socket functionality */
42 #ifdef _WIN32
43 #include <winsock2.h>
44 #else
45 #include <sys/socket.h>
46 #include <sys/poll.h>
47 #include <netinet/in.h>
48 #include <unistd.h>
49 #include <fcntl.h>
50 #endif
51
52 #ifdef HAVE_SYS_PARAM_H
53 #include <sys/param.h> /* for MIN/MAX macros */
54 #endif
55
56 /* MIN,MAX macros */
57 #ifndef MIN
58 #define MIN(a,b) (((a)<(b))?(a):(b))
59 #endif
60 #ifndef MAX
61 #define MAX(a,b) (((a)>(b))?(a):(b))
62 #endif
63
64 /* for systems that do not support ENOTSUP
65  * win32 being one of them */
66 #ifndef ENOTSUP
67 #define ENOTSUP 134             /* Not supported */
68 #endif
69
70 #ifndef HAVE_SYS_TIME_H
71
72 #ifndef _TIMEVAL_DEFINED
73 #define _TIMEVAL_DEFINED
74
75 struct timeval {
76         long tv_sec;
77         long tv_usec;
78 };
79
80 #endif /* _TIMEVAL_DEFINED */
81
82 #endif
83
84 /* gettimeofday() */
85 #ifndef HAVE_GETTIMEOFDAY
86
87 #ifdef _WIN32
88 struct timezone {
89         int tz_minuteswest;
90         int tz_dsttime;
91 };
92 #endif
93 struct timezone;
94
95 extern int gettimeofday(struct timeval *tv, struct timezone *tz);
96 #endif
97
98 /**** clear_malloc & fill_malloc ****/
99 void *clear_malloc(size_t size);
100 void *fill_malloc(size_t size);
101
102 /*
103  * Now you have 3 ways for the malloc function:
104  *
105  * 1. Do not change anything, use the original malloc
106  *
107  * 2. Use the clear_malloc function instead of the original malloc.
108  *    In this case you must use the following define:
109  *    #define malloc((_a)) clear_malloc((_a))
110  *
111  * 3. Use the fill_malloc function instead of the original malloc.
112  *    In this case you must use the following define:
113  *    #define malloc((_a)) fill_malloc((_a))
114  *
115  * We have figured out that there could exist some malloc problems
116  * where variables are using without to be initialise. To find this
117  * places, use the fill_malloc function. With this function we want
118  * to initialize memory to some known bad state. This is quite easily
119  * spotted in the debugger and will trap to an invalid address.
120  *
121  * clear_malloc can be used if you want to set not initialise
122  * variable to 0.
123  *
124  * If you do not want to change the malloc function, to not use one of
125  * the following macros. Which is the default way.
126  */
127
128 /* #define malloc(_a) clear_malloc(_a) */
129 /* #define malloc(_a) fill_malloc(_a) */
130
131 /* GNU extensions to the C library that may be missing on some systems */
132 #ifndef HAVE_STRNDUP
133 extern char* strndup(const char *s, size_t n);
134 #endif /* HAVE_STRNDUP */
135
136 #ifndef HAVE_STRNLEN
137 extern size_t strnlen(const char *s, size_t maxlen);
138 #endif /* HAVE_STRNLEN */
139
140 #ifndef HAVE_USLEEP
141 #ifdef _WIN32
142 static __inline unsigned usleep(unsigned int usecs)
143 {
144         Sleep((usecs/1000));
145         return 0;
146 }
147 #else
148 #if BUILD_ECOSBOARD
149 void usleep(int us);
150 #else
151 #error no usleep defined for your platform
152 #endif
153 #endif
154 #endif /* HAVE_USLEEP */
155
156 /* Windows specific */
157 #ifdef _WIN32
158
159 #define WIN32_LEAN_AND_MEAN
160 #include <windows.h>
161 #include <time.h>
162
163 /* win32 systems do not support ETIMEDOUT */
164
165 #ifndef ETIMEDOUT
166 #define ETIMEDOUT WSAETIMEDOUT
167 #endif
168
169 #if IS_MINGW == 1
170 static __inline unsigned char inb(unsigned short int port)
171 {
172         unsigned char _v;
173         __asm__ __volatile__ ("inb %w1,%0":"=a" (_v):"Nd" (port));
174         return _v;
175 }
176
177 static __inline void outb(unsigned char value, unsigned short int port)
178 {
179         __asm__ __volatile__ ("outb %b0,%w1": :"a" (value), "Nd" (port));
180 }
181
182 #endif /* IS_MINGW */
183
184 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
185
186 #endif  /* _WIN32 */
187
188 /* generic socket functions for Windows and Posix */
189 static __inline int write_socket( int handle, const void *buffer, unsigned int count )
190 {
191 #ifdef _WIN32
192         return send(handle, buffer, count, 0);
193 #else
194         return write(handle, buffer, count);
195 #endif
196 }
197
198 static __inline int read_socket( int handle, void *buffer, unsigned int count )
199 {
200 #ifdef _WIN32
201         return recv(handle, buffer, count, 0);
202 #else
203         return read(handle, buffer, count);
204 #endif
205 }
206
207 static __inline int close_socket(int sock)
208 {
209 #ifdef _WIN32
210         return closesocket(sock);
211 #else
212         return close(sock);
213 #endif
214 }
215
216 static __inline void socket_nonblock(int fd)
217 {
218 #ifdef _WIN32
219         unsigned long nonblock = 1;
220         ioctlsocket(fd, FIONBIO, &nonblock );
221 #else
222         int oldopts = fcntl(fd, F_GETFL, 0);
223         fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
224 #endif
225 }
226
227 static __inline int socket_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv)
228 {
229 #ifdef _WIN32
230         return win_select(max_fd, rfds, wfds, efds, tv);
231 #else
232         return select(max_fd, rfds, wfds, efds, tv);
233 #endif
234 }
235
236 #ifndef HAVE_ELF_H
237
238 typedef struct
239 {
240         unsigned char   e_ident[16];    /* Magic number and other info */
241         u16     e_type;                 /* Object file type */
242         u16     e_machine;              /* Architecture */
243         u32     e_version;              /* Object file version */
244         u32 e_entry;            /* Entry point virtual address */
245         u32 e_phoff;            /* Program header table file offset */
246         u32     e_shoff;                /* Section header table file offset */
247         u32     e_flags;                /* Processor-specific flags */
248         u16     e_ehsize;               /* ELF header size in bytes */
249         u16     e_phentsize;    /* Program header table entry size */
250         u16     e_phnum;                /* Program header table entry count */
251         u16     e_shentsize;    /* Section header table entry size */
252         u16     e_shnum;                /* Section header table entry count */
253         u16     e_shstrndx;             /* Section header string table index */
254 } Elf32_Ehdr;
255
256 #define ELFMAG          "\177ELF"
257 #define SELFMAG         4
258
259 #define EI_CLASS        4               /* File class byte index */
260 #define ELFCLASS32      1               /* 32-bit objects */
261 #define ELFCLASS64      2               /* 64-bit objects */
262
263 #define EI_DATA         5               /* Data encoding byte index */
264 #define ELFDATA2LSB     1               /* 2's complement, little endian */
265 #define ELFDATA2MSB     2               /* 2's complement, big endian */
266
267 typedef struct
268 {
269         u32 p_type;                     /* Segment type */
270         u32 p_offset;           /* Segment file offset */
271         u32 p_vaddr;            /* Segment virtual address */
272         u32 p_paddr;            /* Segment physical address */
273         u32 p_filesz;           /* Segment size in file */
274         u32 p_memsz;            /* Segment size in memory */
275         u32 p_flags;            /* Segment flags */
276         u32 p_align;            /* Segment alignment */
277 } Elf32_Phdr;
278
279 #define PT_LOAD         1               /* Loadable program segment */
280
281 #endif /* HAVE_ELF_H */
282
283 #endif /* REPLACEMENTS_H */