wshtcpip.h File Reference

#include <stdarg.h>
#include <windef.h>
#include <winbase.h>
#include <wsahelp.h>
#include <tdiinfo.h>
#include <tcpioctl.h>
#include <tdilib.h>
#include <ws2tcpip.h>
#include <rtlfuncs.h>

Include dependency graph for wshtcpip.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_QUEUED_REQUEST
struct	_SOCKET_CONTEXT

Macros
#define	WIN32_NO_STATUS
#define	_INC_WINDOWS
#define	COM_NO_WINDOWS_H
#define	EXPORT   WINAPI
#define	DD_TCP_DEVICE_NAME   L"\\Device\\Tcp"
#define	DD_UDP_DEVICE_NAME   L"\\Device\\Udp"
#define	DD_RAW_IP_DEVICE_NAME   L"\\Device\\RawIp"

Typedefs
typedef enum _SOCKET_STATE	SOCKET_STATE
typedef enum _SOCKET_STATE *	PSOCKET_STATE
typedef struct _QUEUED_REQUEST	QUEUED_REQUEST
typedef struct _QUEUED_REQUEST *	PQUEUED_REQUEST
typedef struct _SOCKET_CONTEXT	SOCKET_CONTEXT
typedef struct _SOCKET_CONTEXT *	PSOCKET_CONTEXT

Enumerations
enum	_SOCKET_STATE {   SocketOpen, SocketBound, SocketBoundUdp, SocketConnected,   SocketClosed, SocketStateCreated, SocketStateBound, SocketStateListening,   SocketStateConnected, SocketUndefined = -1, SocketOpen, SocketBound,   SocketBoundUdp, SocketConnected, SocketClosed }

Functions
INT	WSHIoctl_GetInterfaceList (IN LPVOID OutputBuffer, IN DWORD OutputBufferLength, OUT LPDWORD NumberOfBytesReturned, OUT LPBOOL NeedsCompletion)

Macro Definition Documentation

_INC_WINDOWS

#define _INC_WINDOWS

Definition at line 11 of file wshtcpip.h.

COM_NO_WINDOWS_H

#define COM_NO_WINDOWS_H

Definition at line 12 of file wshtcpip.h.

DD_RAW_IP_DEVICE_NAME

#define DD_RAW_IP_DEVICE_NAME   L"\\Device\\RawIp"

Definition at line 29 of file wshtcpip.h.

DD_TCP_DEVICE_NAME

#define DD_TCP_DEVICE_NAME   L"\\Device\\Tcp"

Definition at line 27 of file wshtcpip.h.

DD_UDP_DEVICE_NAME

#define DD_UDP_DEVICE_NAME   L"\\Device\\Udp"

Definition at line 28 of file wshtcpip.h.

EXPORT

#define EXPORT   WINAPI

Definition at line 25 of file wshtcpip.h.

WIN32_NO_STATUS

#define WIN32_NO_STATUS

Definition at line 10 of file wshtcpip.h.

Typedef Documentation

PQUEUED_REQUEST

typedef struct _QUEUED_REQUEST * PQUEUED_REQUEST

PSOCKET_CONTEXT

typedef struct _SOCKET_CONTEXT * PSOCKET_CONTEXT

PSOCKET_STATE

typedef enum _SOCKET_STATE * PSOCKET_STATE

QUEUED_REQUEST

typedef struct _QUEUED_REQUEST QUEUED_REQUEST

SOCKET_CONTEXT

typedef struct _SOCKET_CONTEXT SOCKET_CONTEXT

SOCKET_STATE

typedef enum _SOCKET_STATE SOCKET_STATE

Enumeration Type Documentation

_SOCKET_STATE

enum _SOCKET_STATE

Enumerator
SocketOpen
SocketBound
SocketBoundUdp
SocketConnected
SocketClosed
SocketStateCreated
SocketStateBound
SocketStateListening
SocketStateConnected
SocketUndefined
SocketOpen
SocketBound
SocketBoundUdp
SocketConnected
SocketClosed

Definition at line 31 of file wshtcpip.h.

                           {
    SocketStateCreated,
    SocketStateBound,
    SocketStateListening,
    SocketStateConnected
} SOCKET_STATE, *PSOCKET_STATE;

Function Documentation

WSHIoctl_GetInterfaceList()

INT WSHIoctl_GetInterfaceList	(	IN LPVOID	OutputBuffer,
		IN DWORD	OutputBufferLength,
		OUT LPDWORD	NumberOfBytesReturned,
		OUT LPBOOL	NeedsCompletion
	)

Definition at line 216 of file iflist.c.

{
    IntfIDItem *IntfIDList;
    IntfIDItem *pIntfIDItem, *pIntfIDNext;
    TCP_REQUEST_QUERY_INFORMATION_EX inTcpReq1;
    TDIEntityID *outEntityID, *pEntityID;
    IPSNMPInfo outIPSNMPInfo;
    IPAddrEntry *pIPAddrEntry;
    IFEntry *pIFEntry = NULL;
    LPINTERFACE_INFO pIntfInfo;
    DWORD outIDCount, i1, iAddr;
    DWORD bCastAddr, outNumberOfBytes;
    ULONG BufLenNeeded, BufLen, IFEntryLen, TdiType; 
    HANDLE TcpFile = 0;
    HANDLE hHeap = GetProcessHeap();
    DWORD LastErr;
    INT res = -1;

    /* Init Interface-ID-List */
    IntfIDList = HeapAlloc(hHeap, 0, sizeof(*IntfIDList));
    list_init(&IntfIDList->entry);

    /* open tcp-driver */
    LastErr = openTcpFile(&TcpFile, FILE_READ_DATA | FILE_WRITE_DATA);
    if (!NT_SUCCESS(LastErr))
    {
        res = (INT)LastErr;
        goto cleanup;
    }

    DPRINT("TcpFile %p\n", TcpFile);

    if (!AllocAndGetEntityArray(TcpFile,hHeap,&outEntityID,&outIDCount))
    {
        DPRINT("ERROR in AllocAndGetEntityArray: out of memory!\n");
        res = ERROR_OUTOFMEMORY;
        goto cleanup;
    }

    IFEntryLen = sizeof(IFEntry) + MAX_ADAPTER_DESCRIPTION_LENGTH + 1;
    pIFEntry = HeapAlloc(hHeap, 0, IFEntryLen);
    if (pIFEntry == 0)
    {
        DPRINT("ERROR\n");
        res = ERROR_OUTOFMEMORY;
        goto cleanup;
    } 
    
    /* get addresses */
    pEntityID = outEntityID;
    for (i1 = 0; i1 < outIDCount; i1++)
    {
        /* we are only interessted in network layers */
        if ( (pEntityID->tei_entity != CL_NL_ENTITY) &&
             (pEntityID->tei_entity != CO_NL_ENTITY) )
        {
            pEntityID++;
            continue;
        }
        /* Get IPSNMPInfo */
        res = GetIPSNMPInfo(TcpFile, pEntityID, &outIPSNMPInfo);
        if (res != NO_ERROR)
            goto cleanup;
       
        /* add to array */
        pIntfIDItem = (IntfIDItem*)HeapAlloc(hHeap, 0, sizeof(IntfIDItem));
        list_add_head(&IntfIDList->entry, &pIntfIDItem->entry);
        pIntfIDItem->id = *pEntityID;
        pIntfIDItem->numaddr = outIPSNMPInfo.ipsi_numaddr;
        /* filled later */
        pIntfIDItem->pIPAddrEntry0 = NULL;

        pEntityID++;
    }
    
    /* Calculate needed size */
    outNumberOfBytes = 0;
    LIST_FOR_EACH_ENTRY(pIntfIDItem, &IntfIDList->entry, struct _IntfIDItem, entry)
    {
        outNumberOfBytes += (pIntfIDItem->numaddr * sizeof(INTERFACE_INFO));
    }   
    DPRINT("Buffer size needed: %lu\n", outNumberOfBytes);
    if (outNumberOfBytes > OutputBufferLength)
    {
        /* Buffer to small */
        if (NumberOfBytesReturned)
            *NumberOfBytesReturned = 0;
        res = WSAEFAULT;
        goto cleanup;
    }
    
    /* Get address info */
    RtlZeroMemory(&inTcpReq1,sizeof(inTcpReq1));
    inTcpReq1.ID.toi_class = INFO_CLASS_PROTOCOL;
    inTcpReq1.ID.toi_type = INFO_TYPE_PROVIDER;
    inTcpReq1.ID.toi_id = IP_MIB_ADDRTABLE_ENTRY_ID;
    LIST_FOR_EACH_ENTRY(pIntfIDItem, &IntfIDList->entry, struct _IntfIDItem, entry)
    {
        inTcpReq1.ID.toi_entity = pIntfIDItem->id;

        BufLen = sizeof(IPAddrEntry) * pIntfIDItem->numaddr;
        pIntfIDItem->pIPAddrEntry0 = HeapAlloc(hHeap, 0, BufLen);
        
        if (!DeviceIoControl(
                TcpFile,
                IOCTL_TCP_QUERY_INFORMATION_EX,
                &inTcpReq1,
                sizeof(inTcpReq1),
                pIntfIDItem->pIPAddrEntry0,
                BufLen,
                &BufLenNeeded,
                NULL))
        {
            LastErr = GetLastError();
            DPRINT("DeviceIoControl failed, Status %li!\n", LastErr);
            res = WSAEFAULT;
            goto cleanup;
        }
    }

    /* build result */
    pIntfInfo = (LPINTERFACE_INFO)OutputBuffer;
    LIST_FOR_EACH_ENTRY(pIntfIDItem, &IntfIDList->entry, struct _IntfIDItem, entry)
    {
        DPRINT("Number of addresses %d\n", pIntfIDItem->numaddr);

        pIPAddrEntry = pIntfIDItem->pIPAddrEntry0;
        for (iAddr = 0; iAddr < pIntfIDItem->numaddr; iAddr++)
        {
            DPRINT("BufLen %lu\n",BufLenNeeded);
            DPRINT("pIPAddrEntry->iae_addr %lx\n",pIPAddrEntry->iae_addr);
            DPRINT("pIPAddrEntry->iae_bcastaddr %lx\n",pIPAddrEntry->iae_bcastaddr);
            DPRINT("pIPAddrEntry->iae_mask %lx\n",pIPAddrEntry->iae_mask);
            DPRINT("pIPAddrEntry->iae_reasmsize %lx\n",pIPAddrEntry->iae_reasmsize);

            pIntfInfo->iiAddress.AddressIn.sin_family = AF_INET;
            pIntfInfo->iiAddress.AddressIn.sin_port = 0;
            pIntfInfo->iiAddress.AddressIn.sin_addr.s_addr = pIPAddrEntry->iae_addr;

            pIntfInfo->iiBroadcastAddress.AddressIn.sin_family = AF_INET;
            pIntfInfo->iiBroadcastAddress.AddressIn.sin_port = 0;
            bCastAddr = (pIPAddrEntry->iae_bcastaddr == 0) ? 0 : 0xffffffff;
            pIntfInfo->iiBroadcastAddress.AddressIn.sin_addr.s_addr = bCastAddr;

            pIntfInfo->iiNetmask.AddressIn.sin_family = AF_INET;
            pIntfInfo->iiNetmask.AddressIn.sin_port = 0;
            pIntfInfo->iiNetmask.AddressIn.sin_addr.s_addr = pIPAddrEntry->iae_mask;

            pIntfInfo->iiFlags = IFF_BROADCAST | IFF_MULTICAST;
            if (pIPAddrEntry->iae_addr == ntohl(INADDR_LOOPBACK))
                pIntfInfo->iiFlags |= IFF_LOOPBACK;
            
            pIPAddrEntry++;
            pIntfInfo++;
        }
        res = NO_ERROR;
    }
    
    /* Get Interface up/down-state and patch pIntfInfo->iiFlags */
    pEntityID = outEntityID;
    for (i1 = 0; i1 < outIDCount; i1++)        
    {           
        res = GetTdiEntityType(TcpFile, pEntityID, &TdiType);
        if (res != NO_ERROR)
            goto cleanup;
       
        if (TdiType != IF_MIB)
        {
            pEntityID++;
            continue;
        }

        res = GetIFEntry(TcpFile, pEntityID, pIFEntry, IFEntryLen);
        if (res != NO_ERROR)
            goto cleanup;
        
        /* if network isn't up -> no patch needed */
        if (pIFEntry->if_operstatus < IF_OPER_STATUS_CONNECTING)
        {
            pEntityID++;
            continue;
        }

        /* patching ... if interface-index matches */
        pIntfInfo = (LPINTERFACE_INFO)OutputBuffer;
        LIST_FOR_EACH_ENTRY(pIntfIDItem, &IntfIDList->entry, struct _IntfIDItem, entry)
        {
            pIPAddrEntry = pIntfIDItem->pIPAddrEntry0;
            for (iAddr = 0; iAddr < pIntfIDItem->numaddr; iAddr++) 
            {
                if (pIPAddrEntry->iae_index == pIFEntry->if_index)
                    pIntfInfo->iiFlags |= IFF_UP;

                pIPAddrEntry++;
                pIntfInfo++;
            }
        }
        
        pEntityID++;
    }

    if (NumberOfBytesReturned)
        *NumberOfBytesReturned = outNumberOfBytes;
    if (NeedsCompletion != NULL)
        *NeedsCompletion = FALSE;

    res = NO_ERROR;
cleanup:
    DPRINT("WSHIoctl_GetInterfaceList - CLEANUP\n");
    if (TcpFile != 0)
        NtClose(TcpFile);
    if (pIFEntry != NULL)
        HeapFree(hHeap, 0, pIFEntry);
    LIST_FOR_EACH_ENTRY_SAFE_REV(pIntfIDItem, pIntfIDNext,
                                 &IntfIDList->entry, struct _IntfIDItem, entry)
    {
        if (pIntfIDItem->pIPAddrEntry0 != NULL)
            HeapFree(hHeap, 0, pIntfIDItem->pIPAddrEntry0);
        list_remove(&pIntfIDItem->entry);
        HeapFree(hHeap, 0, pIntfIDItem);
    }
    HeapFree(hHeap, 0, IntfIDList);
    return res;
}

Referenced by WSHIoctl().