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, see <http://www.gnu.org/licenses/>. *
  23  ***************************************************************************/
  24
  25 #ifndef OPENOCD_HELPER_REPLACEMENTS_H
  26 #define OPENOCD_HELPER_REPLACEMENTS_H
  27
  28 #include <stdint.h>
  29 #include <helper/system.h>
  30
  31 /* MIN,MAX macros */
  32 #ifndef MIN
  33 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
  34 #endif
  35 #ifndef MAX
  36 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
  37 #endif
  38
  39 /* for systems that do not support ENOTSUP
  40  * win32 being one of them */
  41 #ifndef ENOTSUP
  42 #define ENOTSUP 134             /* Not supported */
  43 #endif
  44
  45 /* for systems that do not support O_BINARY
  46  * linux being one of them */
  47 #ifndef O_BINARY
  48 #define O_BINARY 0
  49 #endif
  50
  51 #ifndef HAVE_SYS_TIME_H
  52
  53 #ifndef _TIMEVAL_DEFINED
  54 #define _TIMEVAL_DEFINED
  55
  56 struct timeval {
  57         long tv_sec;
  58         long tv_usec;
  59 };
  60
  61 #endif  /* _TIMEVAL_DEFINED */
  62
  63 #endif
  64
  65 /* gettimeofday() */
  66 #ifndef HAVE_GETTIMEOFDAY
  67
  68 #ifdef _WIN32
  69 struct timezone {
  70         int tz_minuteswest;
  71         int tz_dsttime;
  72 };
  73 #endif
  74 struct timezone;
  75
  76 int gettimeofday(struct timeval *tv, struct timezone *tz);
  77
  78 #endif
  79
  80 #ifndef IN_REPLACEMENTS_C
  81 /**** clear_malloc & fill_malloc ****/
  82 void *clear_malloc(size_t size);
  83 void *fill_malloc(size_t size);
  84 #endif
  85
  86 /*
  87  * Now you have 3 ways for the malloc function:
  88  *
  89  * 1. Do not change anything, use the original malloc
  90  *
  91  * 2. Use the clear_malloc function instead of the original malloc.
  92  *    In this case you must use the following define:
  93  *    #define malloc((_a)) clear_malloc((_a))
  94  *
  95  * 3. Use the fill_malloc function instead of the original malloc.
  96  *    In this case you must use the following define:
  97  *    #define malloc((_a)) fill_malloc((_a))
  98  *
  99  * We have figured out that there could exist some malloc problems
 100  * where variables are using without to be initialise. To find this
 101  * places, use the fill_malloc function. With this function we want
 102  * to initialize memory to some known bad state. This is quite easily
 103  * spotted in the debugger and will trap to an invalid address.
 104  *
 105  * clear_malloc can be used if you want to set not initialise
 106  * variable to 0.
 107  *
 108  * If you do not want to change the malloc function, to not use one of
 109  * the following macros. Which is the default way.
 110  */
 111
 112 /* #define malloc(_a) clear_malloc(_a)
 113  * #define malloc(_a) fill_malloc(_a) */
 114
 115 /* GNU extensions to the C library that may be missing on some systems */
 116 #ifndef HAVE_STRNDUP
 117 char *strndup(const char *s, size_t n);
 118 #endif  /* HAVE_STRNDUP */
 119
 120 #ifndef HAVE_STRNLEN
 121 size_t strnlen(const char *s, size_t maxlen);
 122 #endif  /* HAVE_STRNLEN */
 123
 124 #ifndef HAVE_USLEEP
 125 #ifdef _WIN32
 126 static inline unsigned usleep(unsigned int usecs)
 127 {
 128         Sleep((usecs/1000));
 129         return 0;
 130 }
 131 #else
 132 #error no usleep defined for your platform
 133 #endif
 134 #endif  /* HAVE_USLEEP */
 135
 136 /* Windows specific */
 137 #ifdef _WIN32
 138
 139 #include <windows.h>
 140 #include <time.h>
 141
 142 /* Windows does not declare sockaddr_un */
 143 #define UNIX_PATH_LEN 108
 144 struct sockaddr_un {
 145         uint16_t sun_family;
 146         char sun_path[UNIX_PATH_LEN];
 147 };
 148
 149 /* win32 systems do not support ETIMEDOUT */
 150
 151 #ifndef ETIMEDOUT
 152 #define ETIMEDOUT WSAETIMEDOUT
 153 #endif
 154
 155 #if IS_MINGW == 1
 156 static inline unsigned char inb(unsigned short int port)
 157 {
 158         unsigned char _v;
 159         __asm__ __volatile__ ("inb %w1,%0" : "=a" (_v) : "Nd" (port));
 160         return _v;
 161 }
 162
 163 static inline void outb(unsigned char value, unsigned short int port)
 164 {
 165         __asm__ __volatile__ ("outb %b0,%w1" : : "a" (value), "Nd" (port));
 166 }
 167
 168 /* mingw does not have ffs, so use gcc builtin types */
 169 #define ffs __builtin_ffs
 170
 171 #endif  /* IS_MINGW */
 172
 173 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
 174
 175 #endif  /* _WIN32 */
 176
 177 /* generic socket functions for Windows and Posix */
 178 static inline int write_socket(int handle, const void *buffer, unsigned int count)
 179 {
 180 #ifdef _WIN32
 181         return send(handle, buffer, count, 0);
 182 #else
 183         return write(handle, buffer, count);
 184 #endif
 185 }
 186
 187 static inline int read_socket(int handle, void *buffer, unsigned int count)
 188 {
 189 #ifdef _WIN32
 190         return recv(handle, buffer, count, 0);
 191 #else
 192         return read(handle, buffer, count);
 193 #endif
 194 }
 195
 196 static inline int close_socket(int sock)
 197 {
 198 #ifdef _WIN32
 199         return closesocket(sock);
 200 #else
 201         return close(sock);
 202 #endif
 203 }
 204
 205 static inline void socket_block(int fd)
 206 {
 207 #ifdef _WIN32
 208         unsigned long nonblock = 0;
 209         ioctlsocket(fd, FIONBIO, &nonblock);
 210 #else
 211         int oldopts = fcntl(fd, F_GETFL, 0);
 212         fcntl(fd, F_SETFL, oldopts & ~O_NONBLOCK);
 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,
 228         fd_set *rfds,
 229         fd_set *wfds,
 230         fd_set *efds,
 231         struct timeval *tv)
 232 {
 233 #ifdef _WIN32
 234         return win_select(max_fd, rfds, wfds, efds, tv);
 235 #else
 236         return select(max_fd, rfds, wfds, efds, tv);
 237 #endif
 238 }
 239
 240 #ifndef HAVE_ELF_H
 241
 242 typedef uint32_t Elf32_Addr;
 243 typedef uint16_t Elf32_Half;
 244 typedef uint32_t Elf32_Off;
 245 typedef uint32_t Elf32_Word;
 246 typedef uint32_t Elf32_Size;
 247
 248 #define EI_NIDENT   16
 249
 250 typedef struct {
 251         unsigned char e_ident[EI_NIDENT];       /* Magic number and other info */
 252         Elf32_Half e_type;                      /* Object file type */
 253         Elf32_Half e_machine;                   /* Architecture */
 254         Elf32_Word e_version;                   /* Object file version */
 255         Elf32_Addr e_entry;                     /* Entry point virtual address */
 256         Elf32_Off e_phoff;                      /* Program header table file offset */
 257         Elf32_Off e_shoff;                      /* Section header table file offset */
 258         Elf32_Word e_flags;                     /* Processor-specific flags */
 259         Elf32_Half e_ehsize;                    /* ELF header size in bytes */
 260         Elf32_Half e_phentsize;         /* Program header table entry size */
 261         Elf32_Half e_phnum;                     /* Program header table entry count */
 262         Elf32_Half e_shentsize;         /* Section header table entry size */
 263         Elf32_Half e_shnum;                     /* Section header table entry count */
 264         Elf32_Half e_shstrndx;                  /* Section header string table index */
 265 } Elf32_Ehdr;
 266
 267 #define ELFMAG                  "\177ELF"
 268 #define SELFMAG                 4
 269
 270 #define EI_CLASS                4               /* File class byte index */
 271 #define ELFCLASS32              1               /* 32-bit objects */
 272 #define ELFCLASS64              2               /* 64-bit objects */
 273
 274 #define EI_DATA                 5               /* Data encoding byte index */
 275 #define ELFDATA2LSB             1               /* 2's complement, little endian */
 276 #define ELFDATA2MSB             2               /* 2's complement, big endian */
 277
 278 typedef struct {
 279         Elf32_Word p_type;              /* Segment type */
 280         Elf32_Off p_offset;             /* Segment file offset */
 281         Elf32_Addr p_vaddr;             /* Segment virtual address */
 282         Elf32_Addr p_paddr;             /* Segment physical address */
 283         Elf32_Size p_filesz;    /* Segment size in file */
 284         Elf32_Size p_memsz;             /* Segment size in memory */
 285         Elf32_Word p_flags;             /* Segment flags */
 286         Elf32_Size p_align;             /* Segment alignment */
 287 } Elf32_Phdr;
 288
 289 #define PT_LOAD                 1               /* Loadable program segment */
 290
 291 #endif  /* HAVE_ELF_H */
 292
 293 #ifndef HAVE_ELF64
 294
 295 typedef uint64_t Elf64_Addr;
 296 typedef uint16_t Elf64_Half;
 297 typedef uint64_t Elf64_Off;
 298 typedef uint32_t Elf64_Word;
 299 typedef uint64_t Elf64_Xword;
 300
 301 typedef struct {
 302         unsigned char e_ident[EI_NIDENT];       /* Magic number and other info */
 303         Elf64_Half e_type;                      /* Object file type */
 304         Elf64_Half e_machine;           /* Architecture */
 305         Elf64_Word e_version;           /* Object file version */
 306         Elf64_Addr e_entry;                     /* Entry point virtual address */
 307         Elf64_Off e_phoff;                      /* Program header table file offset */
 308         Elf64_Off e_shoff;                      /* Section header table file offset */
 309         Elf64_Word e_flags;                     /* Processor-specific flags */
 310         Elf64_Half e_ehsize;            /* ELF header size in bytes */
 311         Elf64_Half e_phentsize;         /* Program header table entry size */
 312         Elf64_Half e_phnum;                     /* Program header table entry count */
 313         Elf64_Half e_shentsize;         /* Section header table entry size */
 314         Elf64_Half e_shnum;                     /* Section header table entry count */
 315         Elf64_Half e_shstrndx;          /* Section header string table index */
 316 } Elf64_Ehdr;
 317
 318 typedef struct {
 319         Elf64_Word p_type;              /* Segment type */
 320         Elf64_Word p_flags;             /* Segment flags */
 321         Elf64_Off p_offset;             /* Segment file offset */
 322         Elf64_Addr p_vaddr;             /* Segment virtual address */
 323         Elf64_Addr p_paddr;             /* Segment physical address */
 324         Elf64_Xword p_filesz;   /* Segment size in file */
 325         Elf64_Xword p_memsz;    /* Segment size in memory */
 326         Elf64_Xword p_align;    /* Segment alignment */
 327 } Elf64_Phdr;
 328
 329 #endif /* HAVE_ELF64 */
 330
 331 #if defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME
 332 const char *libusb_error_name(int error_code);
 333 #endif /* defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME */
 334
 335 #endif /* OPENOCD_HELPER_REPLACEMENTS_H */