]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - win/inspircd_win32wrapper.h
Update the module descriptions.
[user/henk/code/inspircd.git] / win / inspircd_win32wrapper.h
index 75fcc41b76505031b761fb62e9fc6fd303c9ff86..b2ca05229692f9b1f8add017a4148664749dc6c0 100644 (file)
@@ -1,65 +1,57 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2013-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2015, 2018-2019, 2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2013 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2011, 2014, 2019 Adam <Adam@anope.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007 burlex <burlex@e03df62e-2008-0410-955e-edbf42e46eb7>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
+#pragma once
+
 /* Windows Port
    Wrapper Functions/Definitions
    By Burlex */
+/*
+ * Starting with PSAPI version 2 for Windows 7 and Windows Server 2008 R2, this function is defined as K32GetProcessMemoryInfo in Psapi.h and exported
+ * in Kernel32.lib and Kernel32.dll. However, you should always call this function as GetProcessMemoryInfo. To ensure correct resolution of symbols
+ * for programs that will run on earlier versions of Windows, add Psapi.lib to the TARGETLIBS macro and compile the program with PSAPI_VERSION=1.
+ *
+ * We do this before anything to make sure it's done.
+ */
+#define PSAPI_VERSION 1
 
-#ifndef INSPIRCD_WIN32WRAPPER_H
-#define INSPIRCD_WIN32WRAPPER_H
-
-#ifndef CONFIGURE_BUILD
 #include "win32service.h"
-#endif
-
-/* Define the WINDOWS macro. This means we're building on windows to the rest of the server.
-   I think this is more reasonable than using WIN32, especially if we're gonna be doing 64-bit compiles */
-#define WINDOWS 1
-#define ENABLE_CRASHDUMPS 0
 
 /* This defaults to 64, way too small for an ircd! */
-/* CRT memory debugging */
-#ifdef DEBUG
-#define _CRTDBG_MAP_ALLOC
-#include <stdlib.h>
-#include <crtdbg.h>
-#endif
 
 #define FD_SETSIZE 24000
 
-#define uint32_t DWORD
-#define uint16_t WORD
-
 /* Make builds smaller, leaner and faster */
 #define VC_EXTRALEAN
 #define WIN32_LEAN_AND_MEAN
 
-/* Not defined in windows */
-#define SIGHUP 1
-
-/* Not defined in windows, parameter to shutdown() */
-#define SHUT_WR 2
-
-/* They just have to be *different*, don't they. */
-#define PATH_MAX MAX_PATH
-
-/* Begone shitty 'safe STL' warnings */
-#define _SCL_SECURE_NO_WARNINGS
-#define _CRT_SECURE_NO_WARNINGS
-#define _AFX_SECURE_NO_WARNINGS
-#define _ATL_SECURE_NO_WARNINGS
-
-/* Macros for exporting symbols - dependant on what is being compiled */
+/* Macros for exporting symbols - dependent on what is being compiled */
 
 #ifdef DLL_BUILD
 #define CoreExport __declspec(dllimport)
 #define DllExport __declspec(dllimport)
 #endif
 
+// File numbers for standard streams.
+#define STDIN_FILENO 0
+#define STDOUT_FILENO 1
+#define STDERR_FILENO 2
+
 /* Redirect main() through a different method in win32service.cpp, to intercept service startup */
 #define ENTRYPOINT CoreExport int smain(int argc, char** argv)
 
 /* Disable the deprecation warnings.. it spams :P */
 #define _CRT_SECURE_NO_DEPRECATE
-#define _SCL_SECURE_NO_DEPRECATE
+#define _WINSOCK_DEPRECATED_NO_WARNINGS
 
-#include <string>
-
-/* Say we're building on windows 2000. Anyone running something older than this
- * reeeeeeeally needs to upgrade! */
+// Windows doesn't support getopt_long so we use ya_getopt instead.
+#include "ya_getopt.h"
 
 /* Normal windows (platform-specific) includes */
 #include <winsock2.h>
+#pragma comment(lib, "Ws2_32.lib")
 #include <windows.h>
 #include <ws2tcpip.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <direct.h>
 #include <process.h>
-#include <stdio.h>
-#include <algorithm>
+#include <io.h>
 
-#ifdef ENABLE_CRASHDUMPS
-#include <DbgHelp.h>
-#endif
+#define F_OK            0       /* test for existence of file */
+#define X_OK            (1<<0)  /* test for execute or search permission */
+#define W_OK            (1<<1)  /* test for write permission */
+#define R_OK            (1<<2)  /* test for read permission */
+
+// Windows defines these already.
+#undef ERROR
+#undef min
+#undef max
 
 /* strcasecmp is not defined on windows by default */
 #define strcasecmp _stricmp
+#define strncasecmp _strnicmp
+
+typedef SSIZE_T ssize_t;
 
-/* this standard function is nonstarard. go figure. */
+/* _popen, _pclose */
 #define popen _popen
 #define pclose _pclose
+#define getpid _getpid
+#define dup _dup
+#define fdopen _fdopen
 
-/* Error macros need to be redirected to winsock error codes */
-#define ETIMEDOUT WSAETIMEDOUT
-#define ECONNREFUSED WSAECONNREFUSED
-#define EADDRINUSE WSAEADDRINUSE
-#define EINPROGRESS WSAEWOULDBLOCK
-#define EADDRNOTAVAIL WSAEADDRNOTAVAIL
-
-/* Convert formatted (xxx.xxx.xxx.xxx) string to in_addr struct */
-CoreExport int inet_pton(int af, const char * src, void * dst);
-
-/* Convert struct to formatted (xxx.xxx.xxx.xxx) string */
-CoreExport const char * inet_ntop(int af, const void * src, char * dst, socklen_t cnt);
-
-/* Safe printf functions aren't defined in VC2003 */
-#define snprintf _snprintf
-#define vsnprintf _vsnprintf
-
-/* Since when does the ISO C++ standard *remove* C functions?! */
-#define mkdir(file,mode) _mkdir(file)
-
-/* Unix-style sleep (argument is in seconds) */
-__inline void sleep(int seconds) { Sleep(seconds * 1000); }
-
-/* IPV4 only convert string to address struct */
-CoreExport int inet_aton(const char *, struct in_addr *);
-
-/* Unix-style get running user id */
-CoreExport int geteuid();
+// warning: 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
+// Normally, this is a huge problem, but due to our new/delete remap, we can ignore it.
+#pragma warning(disable:4251)
 
-/* Handles colors in printf */
-CoreExport int printf_c(const char * format, ...);
+// warning: DLL-interface classkey 'identifier' used as base for DLL-interface classkey 'identifier'
+#pragma warning(disable:4275)
 
-/* getopt() wrapper */
-# define no_argument            0
-# define required_argument      1
-# define optional_argument      2
-struct option
-{
-       char *name;
-       int has_arg;
-       int *flag;
-       int val;
-};
-extern char optarg[514];
-int getopt_long_only (int ___argc, char *const *___argv, const char *__shortopts, const struct option *__longopts, int *__longind);
+// warning: unreferenced formal parameter
+// Unimportant for now, but for the next version, we should take a look at these again.
+#pragma warning(disable:4100)
 
-/* Module Loading */
-#define dlopen(path, state) (void*)LoadLibrary(path)
-#define dlsym(handle, export) (void*)GetProcAddress((HMODULE)handle, export)
-#define dlclose(handle) FreeLibrary((HMODULE)handle)
-const char * dlerror();
+// warning: 'class' : assignment operator could not be generated
+#pragma warning(disable:4512)
 
-/* Unix-style directory searching functions */
-#define chmod(filename, mode)  
+// warning C4127: conditional expression is constant
+// This will be triggered like crazy because FOREACH_MOD and similar macros are wrapped in do { ... } while(0) constructs
+#pragma warning(disable:4127)
 
-struct dirent
-{
-       char d_name[MAX_PATH];
-};
+// warning C4996: The POSIX name for this item is deprecated.
+#pragma warning(disable:4996)
 
-struct DIR
-{
-       dirent dirent_pointer;
-       HANDLE find_handle;
-       WIN32_FIND_DATA find_data;
-       bool first;
-};
+// warning C4244: conversion from 'x' to 'y', possible loss of data
+#pragma warning(disable:4244)
 
-CoreExport DIR * opendir(const char * path);
-CoreExport dirent * readdir(DIR * handle);
-CoreExport void closedir(DIR * handle);
+// warning C4267: 'var' : conversion from 'size_t' to 'type', possible loss of data
+#pragma warning(disable:4267)
 
-CoreExport int gettimeofday(struct timeval * tv, void * tz);
+// warning C4706: assignment within conditional expression
+#pragma warning(disable:4706)
 
-/* Disable these stupid warnings.. */
+// warning C4800: 'type' : forcing value to bool 'true' or 'false' (performance warning)
 #pragma warning(disable:4800)
-#pragma warning(disable:4251)
-#pragma warning(disable:4275)
-#pragma warning(disable:4244)          // warning C4244: '=' : conversion from 'long' to 'short', possible loss of data
-#pragma warning(disable:4267)          // warning C4267: 'argument' : conversion from 'size_t' to 'int', possible loss of data
-#pragma warning(disable:4805)          // warning C4805: '!=' : unsafe mix of type 'char' and type 'bool' in operation
-#pragma warning(disable:4311)          // warning C4311: 'type cast' : pointer truncation from 'accept_overlap *' to 'int'
-#pragma warning(disable:4312)          // warning C4312: 'type cast' : conversion from 'int' to 'HANDLE' of greater size
-#pragma warning(disable:4355)          // warning C4355: 'this' : used in base member initializer list
-#pragma warning(disable:4996)          // warning C4996: 'std::_Traits_helper::move_s' was declared deprecated
-#pragma warning(disable:4706)          // warning C4706: assignment within conditional expression
-#pragma warning(disable:4201)          // mmsystem.h generates this warning
-
-/* Mehhhh... typedefs. */
-
-typedef unsigned char uint8_t;
-typedef unsigned long long uint64_t;
-typedef signed char int8_t;
-typedef signed long int32_t;
-typedef signed long long int64_t;
 
 /* Shared memory allocation functions */
 void * ::operator new(size_t iSize);
 void ::operator delete(void * ptr);
 
-/* IPC Handlers */
-class InspIRCd;
-class ValueItem;
-class ServerConfig;
-
-/* Look up the nameserver in use from the registry on windows */
-CoreExport std::string FindNameServerWin();
-
-/* Clear a windows console */
-CoreExport void ClearConsole();
-
-CoreExport DWORD WindowsForkStart(InspIRCd* Instance);
+#include <exception>
 
-CoreExport void WindowsForkKillOwner(InspIRCd* Instance);
+class CWin32Exception : public std::exception
+{
+public:
+       CWin32Exception();
+       CWin32Exception(const CWin32Exception& other);
+       virtual const char* what() const throw();
+       DWORD GetErrorCode();
+
+private:
+       char szErrorString[500];
+       DWORD dwErrorCode;
+};
 
-CoreExport void ChangeWindowsSpecificPointers(InspIRCd* Instance);
+// Same value as EXIT_STATUS_FORK (EXIT_STATUS_FORK is unused on Windows)
+#define EXIT_STATUS_SERVICE 4
 
-CoreExport bool ValidateWindowsDnsServer(ServerConfig* conf, const char* tag, const char* value, ValueItem &data);
+// POSIX iovec
+struct iovec
+{
+       void* iov_base; // Starting address
+       size_t iov_len; // Number of bytes to transfer
+};
 
-CoreExport bool initwmi();
-CoreExport void donewmi();
-CoreExport int getcpu();
+// Windows WSABUF with POSIX field names
+struct WindowsIOVec
+{
+       // POSIX iovec has iov_base then iov_len, WSABUF in Windows has the fields in reverse order
+       u_long iov_len; // Number of bytes to transfer
+       char FAR* iov_base; // Starting address
+};
 
-#endif
+inline ssize_t writev(int fd, const WindowsIOVec* iov, int count)
+{
+       DWORD sent;
+       int ret = WSASend(fd, reinterpret_cast<LPWSABUF>(const_cast<WindowsIOVec*>(iov)), count, &sent, 0, NULL, NULL);
+       if (ret == 0)
+               return sent;
+       return -1;
+}
+
+// This wrapper is just so we don't need to do #ifdef _WIN32 everywhere in the socket code. It is
+// not actually used and does not need to be the same size as sockaddr_un on UNIX systems.
+struct sockaddr_un
+{
+       ADDRESS_FAMILY sun_family;
+       char sun_path[6];
+};
 
+struct WindowsStream
+{
+       WORD BackgroundColor;
+       WORD ForegroundColor;
+       HANDLE Handle;
+       WindowsStream(DWORD handle);
+};