winsup/cygwin/winsup.h

   1 /* winsup.h: main Cygwin header file.
   2
   3    Copyright 1996, 1997, 1998, 1999, 2000, 2001 Red Hat, Inc.
   4
   5 This file is part of Cygwin.
   6
   7 This software is a copyrighted work licensed under the terms of the
   8 Cygwin license.  Please consult the file "CYGWIN_LICENSE" for
   9 details. */
  10
  11 #ifdef HAVE_CONFIG_H
  12 # include "config.h"
  13 #endif
  14
  15 #define __INSIDE_CYGWIN__
  16
  17 #define alloca __builtin_alloca
  18 #define strlen __builtin_strlen
  19 #define strcmp __builtin_strcmp
  20 #define strcpy __builtin_strcpy
  21 #define memcpy __builtin_memcpy
  22 #define memcmp __builtin_memcmp
  23 #ifdef HAVE_BUILTIN_MEMSET
  24 # define memset __builtin_memset
  25 #endif
  26
  27 #define NO_COPY __attribute__((section(".data_cygwin_nocopy")))
  28
  29 #ifdef __cplusplus
  30
  31 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ >= 199900L
  32 #define NEW_MACRO_VARARGS
  33 #endif
  34
  35 #include <sys/types.h>
  36 #include <sys/strace.h>
  37
  38 extern const char case_folded_lower[];
  39 #define cyg_tolower(c) (case_folded_lower[(unsigned char)(c)])
  40 extern const char case_folded_upper[];
  41 #define cyg_toupper(c) (case_folded_upper[(unsigned char)(c)])
  42
  43 #ifndef MALLOC_DEBUG
  44 #define cfree newlib_cfree_dont_use
  45 #endif
  46
  47 #define WIN32_LEAN_AND_MEAN 1
  48 #define _WINGDI_H
  49 #define _WINUSER_H
  50 #define _WINNLS_H
  51 #define _WINVER_H
  52 #define _WINNETWK_H
  53 #define _WINSVC_H
  54 #include <windows.h>
  55 #include <wincrypt.h>
  56 #include <lmcons.h>
  57 #undef _WINGDI_H
  58 #undef _WINUSER_H
  59 #undef _WINNLS_H
  60 #undef _WINVER_H
  61 #undef _WINNETWK_H
  62 #undef _WINSVC_H
  63
  64 #include "wincap.h"
  65
  66 /* The one function we use from winuser.h most of the time */
  67 extern "C" DWORD WINAPI GetLastError (void);
  68
  69 enum codepage_type {ansi_cp, oem_cp};
  70 extern codepage_type current_codepage;
  71
  72 /* Used to check if Cygwin DLL is dynamically loaded. */
  73 extern int dynamically_loaded;
  74
  75 #define sys_wcstombs(tgt,src,len) \
  76                     WideCharToMultiByte((current_codepage==ansi_cp?CP_ACP:CP_OEMCP),0,(src),-1,(tgt),(len),NULL,NULL)
  77 #define sys_mbstowcs(tgt,src,len) \
  78                     MultiByteToWideChar((current_codepage==ansi_cp?CP_ACP:CP_OEMCP),0,(src),-1,(tgt),(len))
  79
  80 #define TITLESIZE 1024
  81
  82 /* status bit manipulation */
  83 #define __ISSETF(what, x, prefix) \
  84   ((what)->status & prefix##_##x)
  85 #define __SETF(what, x, prefix) \
  86   ((what)->status |= prefix##_##x)
  87 #define __CLEARF(what, x, prefix) \
  88   ((what)->status &= ~prefix##_##x)
  89 #define __CONDSETF(n, what, x, prefix) \
  90   ((n) ? __SETF (what, x, prefix) : __CLEARF (what, x, prefix))
  91
  92 #include "debug.h"
  93
  94 /* Events/mutexes */
  95 extern HANDLE title_mutex;
  96
  97 /**************************** Convenience ******************************/
  98
  99 /* Used when treating / and \ as equivalent. */
 100 #define SLASH_P(ch) \
 101     ({ \
 102         char __c = (ch); \
 103         ((__c) == '/' || (__c) == '\\'); \
 104     })
 105
 106 /* Convert a signal to a signal mask */
 107 #define SIGTOMASK(sig)  (1<<((sig) - signal_shift_subtract))
 108 extern unsigned int signal_shift_subtract;
 109
 110 #ifdef NEW_MACRO_VARARGS
 111 # define api_fatal(...) __api_fatal ("%P: *** " __VA_ARGS__)
 112 #else
 113 # define api_fatal(fmt, args...) __api_fatal ("%P: *** " fmt,## args)
 114 #endif
 115
 116 #undef issep
 117 #define issep(ch) (strchr (" \t\n\r", (ch)) != NULL)
 118
 119 #define isdirsep SLASH_P
 120 #define isabspath(p) \
 121   (isdirsep (*(p)) || (isalpha (*(p)) && (p)[1] == ':' && (!(p)[2] || isdirsep ((p)[2]))))
 122
 123 /******************** Initialization/Termination **********************/
 124
 125 class per_process;
 126 /* cygwin .dll initialization */
 127 void dll_crt0 (per_process *) __asm__ ("_dll_crt0__FP11per_process");
 128 extern "C" void __stdcall _dll_crt0 ();
 129
 130 /* dynamically loaded dll initialization */
 131 extern "C" int dll_dllcrt0 (HMODULE, per_process *);
 132
 133 /* dynamically loaded dll initialization for non-cygwin apps */
 134 extern "C" int dll_noncygwin_dllcrt0 (HMODULE, per_process *);
 135
 136 /* exit the program */
 137 extern "C" void __stdcall do_exit (int) __attribute__ ((noreturn));
 138
 139 /* UID/GID */
 140 void uinfo_init (void);
 141
 142 /* various events */
 143 void events_init (void);
 144 void events_terminate (void);
 145
 146 void __stdcall close_all_files (void);
 147 BOOL __stdcall check_pty_fds (void);
 148
 149 /* Invisible window initialization/termination. */
 150 HWND __stdcall gethwnd (void);
 151 void __stdcall window_terminate (void);
 152
 153 /* Globals that handle initialization of winsock in a child process. */
 154 extern HANDLE wsock32_handle;
 155 extern HANDLE ws2_32_handle;
 156
 157 /* Globals that handle initialization of netapi in a child process. */
 158 extern HANDLE netapi32_handle;
 159
 160 /* debug_on_trap support. see exceptions.cc:try_to_debug() */
 161 extern "C" void error_start_init (const char*);
 162 extern "C" int try_to_debug (bool waitloop = 1);
 163
 164 void set_file_api_mode (codepage_type);
 165
 166 extern int cygwin_finished_initializing;
 167
 168 /**************************** Miscellaneous ******************************/
 169
 170 void __stdcall set_std_handle (int);
 171 int __stdcall writable_directory (const char *file);
 172 int __stdcall stat_dev (DWORD, int, unsigned long, struct stat *);
 173 extern BOOL allow_ntsec;
 174
 175 unsigned long __stdcall hash_path_name (unsigned long hash, const char *name) __attribute__ ((regparm(2)));
 176 void __stdcall nofinalslash (const char *src, char *dst) __attribute__ ((regparm(2)));
 177 extern "C" char *__stdcall rootdir (char *full_path) __attribute__ ((regparm(1)));
 178
 179 /* String manipulation */
 180 extern "C" char *__stdcall strccpy (char *s1, const char **s2, char c);
 181 extern "C" int __stdcall strcasematch (const char *s1, const char *s2) __attribute__ ((regparm(2)));
 182 extern "C" int __stdcall strncasematch (const char *s1, const char *s2, size_t n) __attribute__ ((regparm(3)));
 183 extern "C" char *__stdcall strcasestr (const char *searchee, const char *lookfor) __attribute__ ((regparm(2)));
 184
 185 /* Time related */
 186 void __stdcall totimeval (struct timeval *dst, FILETIME * src, int sub, int flag);
 187 long __stdcall to_time_t (FILETIME * ptr);
 188
 189 void __stdcall set_console_title (char *);
 190 void set_console_handler ();
 191
 192 int __stdcall check_null_empty_str (const char *name) __attribute__ ((regparm(1)));
 193 int __stdcall check_null_empty_str_errno (const char *name) __attribute__ ((regparm(1)));
 194 int __stdcall __check_null_invalid_struct (const void *s, unsigned sz) __attribute__ ((regparm(1)));
 195 int __stdcall __check_null_invalid_struct_errno (const void *s, unsigned sz) __attribute__ ((regparm(1)));
 196
 197 #define check_null_invalid_struct(s) \
 198   __check_null_invalid ((s), sizeof (*(s)))
 199 #define check_null_invalid_struct_errno(s) \
 200   __check_null_invalid_struct_errno ((s), sizeof (*(s)))
 201
 202 #define set_winsock_errno() __set_winsock_errno (__FUNCTION__, __LINE__)
 203 void __set_winsock_errno (const char *fn, int ln) __attribute__ ((regparm(2)));
 204
 205 extern bool wsock_started;
 206
 207 /* Printf type functions */
 208 extern "C" void __api_fatal (const char *, ...) __attribute__ ((noreturn));
 209 extern "C" int __small_sprintf (char *dst, const char *fmt, ...) /*__attribute__ ((regparm (2)))*/;
 210 extern "C" int __small_vsprintf (char *dst, const char *fmt, va_list ap) /*__attribute__ ((regparm (3)))*/;
 211 extern void multiple_cygwin_die () __attribute__ ((noreturn));
 212
 213 extern "C" void __malloc_lock (struct _reent *);
 214 extern "C" void __malloc_unlock (struct _reent *);
 215
 216 extern "C" void __malloc_lock (struct _reent *);
 217 extern "C" void __malloc_unlock (struct _reent *);
 218
 219 class path_conv;
 220 int __stdcall stat_worker (const char *name, struct stat *buf, int nofollow,
 221                            path_conv *pc = NULL) __attribute__ ((regparm (3)));
 222
 223 /**************************** Exports ******************************/
 224
 225 extern "C" {
 226 int cygwin_select (int , fd_set *, fd_set *, fd_set *,
 227                    struct timeval *to);
 228 int cygwin_gethostname (char *__name, size_t __len);
 229
 230 int kill_pgrp (pid_t, int);
 231 int _kill (int, int);
 232 int _raise (int sig);
 233
 234 extern DWORD binmode;
 235 extern char _data_start__, _data_end__, _bss_start__, _bss_end__;
 236 extern void (*__CTOR_LIST__) (void);
 237 extern void (*__DTOR_LIST__) (void);
 238 extern SYSTEM_INFO system_info;
 239 };
 240
 241 /*************************** Unsorted ******************************/
 242
 243 #define WM_ASYNCIO      0x8000          // WM_APP
 244
 245 /* Note that MAX_PATH is defined in the windows headers */
 246 /* There is also PATH_MAX and MAXPATHLEN.
 247    PATH_MAX is from Posix and does *not* include the trailing NUL.
 248    MAXPATHLEN is from Unix.
 249
 250    Thou shalt use MAX_PATH throughout.  It avoids the NUL vs no-NUL
 251    issue and is neither of the Unixy ones [so we can punt on which
 252    one is the right one to use].  */
 253
 254 #define STD_RBITS (S_IRUSR | S_IRGRP | S_IROTH)
 255 #define STD_WBITS (S_IWUSR)
 256 #define STD_XBITS (S_IXUSR | S_IXGRP | S_IXOTH)
 257
 258 /* The title on program start. */
 259 extern char *old_title;
 260 extern BOOL display_title;
 261
 262 extern HANDLE hMainThread;
 263 extern HANDLE hMainProc;
 264
 265 extern bool cygwin_testing;
 266 extern unsigned _cygwin_testing_magic;
 267 extern HMODULE cygwin_hmodule;
 268
 269 #define winsock2_active (wsadata.wVersion >= 512)
 270 #define winsock_active (wsadata.wVersion < 512)
 271 extern struct WSAData wsadata;
 272
 273 #endif /* defined __cplusplus */