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