fnsock.h

//
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
//

#pragma once

EXTERN_C_START

#if defined(_KERNEL_MODE)
#define FNSOCK_STATUS NTSTATUS
#define FNSOCK_FAILED(X) !NT_SUCCESS(X)
#define FNSOCK_SUCCEEDED(X) NT_SUCCESS(X)
#define FNSOCK_STATUS_SUCCESS STATUS_SUCCESS
#define FNSOCK_STATUS_FAIL STATUS_UNSUCCESSFUL
#ifndef PAGEDX
#define PAGEDX __declspec(code_seg("PAGE"))
#endif
#else // defined(_KERNEL_MODE)
#define FNSOCK_STATUS HRESULT
#define FNSOCK_FAILED(X) FAILED(X)
#define FNSOCK_SUCCEEDED(X) SUCCEEDED(X)
#define FNSOCK_STATUS_SUCCESS S_OK
#define FNSOCK_STATUS_FAIL E_FAIL
#ifndef PAGEDX
#define PAGEDX
#endif
#endif // defined(_KERNEL_MODE)

/*
 * WinSock error codes are also defined in winerror.h
 * Hence the IFDEF.
 */
#ifndef WSABASEERR

/*
 * All Windows Sockets error constants are biased by WSABASEERR from
 * the "normal"
 */
#define WSABASEERR              10000

/*
 * Windows Sockets definitions of regular Microsoft C error constants
 */
#define WSAEINTR                (WSABASEERR+4)
#define WSAEBADF                (WSABASEERR+9)
#define WSAEACCES               (WSABASEERR+13)
#define WSAEFAULT               (WSABASEERR+14)
#define WSAEINVAL               (WSABASEERR+22)
#define WSAEMFILE               (WSABASEERR+24)

/*
 * Windows Sockets definitions of regular Berkeley error constants
 */
#define WSAEWOULDBLOCK          (WSABASEERR+35)
#define WSAEINPROGRESS          (WSABASEERR+36)
#define WSAEALREADY             (WSABASEERR+37)
#define WSAENOTSOCK             (WSABASEERR+38)
#define WSAEDESTADDRREQ         (WSABASEERR+39)
#define WSAEMSGSIZE             (WSABASEERR+40)
#define WSAEPROTOTYPE           (WSABASEERR+41)
#define WSAENOPROTOOPT          (WSABASEERR+42)
#define WSAEPROTONOSUPPORT      (WSABASEERR+43)
#define WSAESOCKTNOSUPPORT      (WSABASEERR+44)
#define WSAEOPNOTSUPP           (WSABASEERR+45)
#define WSAEPFNOSUPPORT         (WSABASEERR+46)
#define WSAEAFNOSUPPORT         (WSABASEERR+47)
#define WSAEADDRINUSE           (WSABASEERR+48)
#define WSAEADDRNOTAVAIL        (WSABASEERR+49)
#define WSAENETDOWN             (WSABASEERR+50)
#define WSAENETUNREACH          (WSABASEERR+51)
#define WSAENETRESET            (WSABASEERR+52)
#define WSAECONNABORTED         (WSABASEERR+53)
#define WSAECONNRESET           (WSABASEERR+54)
#define WSAENOBUFS              (WSABASEERR+55)
#define WSAEISCONN              (WSABASEERR+56)
#define WSAENOTCONN             (WSABASEERR+57)
#define WSAESHUTDOWN            (WSABASEERR+58)
#define WSAETOOMANYREFS         (WSABASEERR+59)
#define WSAETIMEDOUT            (WSABASEERR+60)
#define WSAECONNREFUSED         (WSABASEERR+61)
#define WSAELOOP                (WSABASEERR+62)
#define WSAENAMETOOLONG         (WSABASEERR+63)
#define WSAEHOSTDOWN            (WSABASEERR+64)
#define WSAEHOSTUNREACH         (WSABASEERR+65)
#define WSAENOTEMPTY            (WSABASEERR+66)
#define WSAEPROCLIM             (WSABASEERR+67)
#define WSAEUSERS               (WSABASEERR+68)
#define WSAEDQUOT               (WSABASEERR+69)
#define WSAESTALE               (WSABASEERR+70)
#define WSAEREMOTE              (WSABASEERR+71)

/*
 * Extended Windows Sockets error constant definitions
 */
#define WSASYSNOTREADY          (WSABASEERR+91)
#define WSAVERNOTSUPPORTED      (WSABASEERR+92)
#define WSANOTINITIALISED       (WSABASEERR+93)
#define WSAEDISCON              (WSABASEERR+101)
#define WSAENOMORE              (WSABASEERR+102)
#define WSAECANCELLED           (WSABASEERR+103)
#define WSAEINVALIDPROCTABLE    (WSABASEERR+104)
#define WSAEINVALIDPROVIDER     (WSABASEERR+105)
#define WSAEPROVIDERFAILEDINIT  (WSABASEERR+106)
#define WSASYSCALLFAILURE       (WSABASEERR+107)
#define WSASERVICE_NOT_FOUND    (WSABASEERR+108)
#define WSATYPE_NOT_FOUND       (WSABASEERR+109)
#define WSA_E_NO_MORE           (WSABASEERR+110)
#define WSA_E_CANCELLED         (WSABASEERR+111)
#define WSAEREFUSED             (WSABASEERR+112)

#endif

#ifndef FNSOCKAPI
#define FNSOCKAPI __declspec(dllimport)
#endif

DECLARE_HANDLE(FNSOCK_HANDLE);

FNSOCKAPI
PAGEDX
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockInitialize(
    VOID
    );

FNSOCKAPI
PAGEDX
_IRQL_requires_max_(PASSIVE_LEVEL)
VOID
FnSockUninitialize(
    VOID
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockCreate(
    _In_ INT AddressFamily,
    _In_ INT SocketType,
    _In_ INT Protocol,
    _Out_ FNSOCK_HANDLE* Socket
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
VOID
FnSockClose(
    _In_ FNSOCK_HANDLE Socket
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockBind(
    _In_ FNSOCK_HANDLE Socket,
    _In_reads_bytes_(AddressLength) const struct sockaddr* Address,
    _In_ INT AddressLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockGetSockName(
    _In_ FNSOCK_HANDLE Socket,
    _Out_writes_bytes_(*AddressLength) struct sockaddr* Address,
    _Inout_ INT* AddressLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockSetSockOpt(
    _In_ FNSOCK_HANDLE Socket,
    _In_ ULONG Level,
    _In_ ULONG OptionName,
    _In_reads_bytes_opt_(OptionLength) VOID* OptionValue,
    _In_ SIZE_T OptionLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockGetSockOpt(
    _In_ FNSOCK_HANDLE Socket,
    _In_ ULONG Level,
    _In_ ULONG OptionName,
    _Out_writes_bytes_(*OptionLength) VOID* OptionValue,
    _Inout_ SIZE_T* OptionLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockIoctl(
    _In_ FNSOCK_HANDLE Socket,
    _In_ ULONG ControlCode,
    _In_reads_bytes_opt_(InputLength) VOID* Input,
    _In_ ULONG InputLength,
    _Out_writes_bytes_opt_(OutputLength) VOID* Output,
    _In_ ULONG OutputLength,
    _Out_ ULONG* BytesReturned
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_STATUS
FnSockListen(
    _In_ FNSOCK_HANDLE Socket,
    _In_ ULONG Backlog
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
FNSOCK_HANDLE
FnSockAccept(
    _In_ FNSOCK_HANDLE Socket,
    _Out_writes_bytes_(*AddressLength) struct sockaddr* Address,
    _Inout_ INT* AddressLength
    );

FNSOCKAPI
FNSOCK_STATUS
FnSockConnect(
    _In_ FNSOCK_HANDLE Socket,
    _In_reads_bytes_(AddressLength) struct sockaddr* Address,
    _In_ INT AddressLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockSend(
    _In_ FNSOCK_HANDLE Socket,
    _In_reads_bytes_(BufferLength) const CHAR* Buffer,
    _In_ INT BufferLength,
    _In_ BOOLEAN BufferIsNonPagedPool,
    _In_ INT Flags
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockSendto(
    _In_ FNSOCK_HANDLE Socket,
    _In_reads_bytes_(BufferLength) const CHAR* Buffer,
    _In_ INT BufferLength,
    _In_ BOOLEAN BufferIsNonPagedPool,
    _In_ INT Flags,
    _In_reads_bytes_(AddressLength) const struct sockaddr* Address,
    _In_ INT AddressLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockSendMsg(
    _In_ FNSOCK_HANDLE Socket,
    _In_reads_bytes_(BufferLength) const CHAR* Buffer,
    _In_ INT BufferLength,
    _In_ BOOLEAN BufferIsNonPagedPool,
    _In_ INT Flags,
    _In_reads_bytes_(AddressLength) const struct sockaddr* Address,
    _In_ INT AddressLength,
    _In_reads_bytes_(ControlBufferLength) const CMSGHDR* ControlBuffer,
    _In_ INT ControlBufferLength
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockRecv(
    _In_ FNSOCK_HANDLE Socket,
    _Out_writes_bytes_to_(BufferLength, return) CHAR* Buffer,
    _In_ INT BufferLength,
    _In_ BOOLEAN BufferIsNonPagedPool,
    _In_ INT Flags
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockRecvMsg(
    _In_ FNSOCK_HANDLE Socket,
    _Out_writes_bytes_to_(BufferLength, return) CHAR* Buffer,
    _In_ INT BufferLength,
    _In_ BOOLEAN BufferIsNonPagedPool,
    _Out_writes_bytes_to_(*ControlBufferLength, *ControlBufferLength) CMSGHDR *ControlBuffer,
    _Inout_ INT *ControlBufferLength,
    _In_ INT *Flags
    );

FNSOCKAPI
_IRQL_requires_max_(PASSIVE_LEVEL)
INT
FnSockGetLastError(
    VOID
    );

EXTERN_C_END