src/helper/replacements.h

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