iphlpapi_private.h File Reference

#include <stdio.h>
#include <stdlib.h>
#include <windef.h>
#include <winbase.h>
#include <winreg.h>
#include <winnls.h>
#include <ws2tcpip.h>
#include <ndk/iofuncs.h>
#include <ndk/obfuncs.h>
#include <ndk/rtlfuncs.h>
#include <iphlpapi.h>
#include <iphlpapi_undoc.h>
#include "resinfo.h"
#include <wine/debug.h>
#include "dhcp.h"
#include <dhcpcsdk.h>
#include <dhcpcapi.h>
#include <tdiinfo.h>
#include <tcpioctl.h>
#include <tdilib.h>
#include "ifenum.h"
#include "ipstats.h"
#include "route.h"
#include <w32api.h>

Include dependency graph for iphlpapi_private.h:

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

Go to the source code of this file.

Classes
struct	_IPRouteEntry
union	_IFEntrySafelySized
union	_TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY
union	_TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY
struct	_IFInfo
struct	_IP_SET_DATA

Macros
#define	NtCurrentTeb   NtXCurrentTeb
#define	WIN32_NO_STATUS
#define	_INC_WINDOWS
#define	COM_NO_WINDOWS_H
#define	NTOS_MODE_USER
#define	ETH_ALEN   6
#define	INADDR_NONE   (~0U)
#define	IFENT_SOFTWARE_LOOPBACK   24 /* This is an SNMP constant from rfc1213 */
#define	INDEX_IS_LOOPBACK   0x00800000
#define	IFNAMSIZ   0x20
#define	TCP_REQUEST_QUERY_INFORMATION_INIT   { { { 0 } } }
#define	TCP_REQUEST_SET_INFORMATION_INIT   { { 0 } }
#define	GAA_FLAG_SKIP_UNICAST   0x0001
#define	GAA_FLAG_SKIP_FRIENDLY_NAME   0x0020

Typedefs
typedef struct _IPRouteEntry	IPRouteEntry
typedef char *	caddr_t
typedef union _IFEntrySafelySized	IFEntrySafelySized
typedef union _TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY	TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY
typedef union _TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY *	PTCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY
typedef union _TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY	TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY
typedef union _TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY *	PTCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY
typedef struct _IFInfo	IFInfo
typedef struct _IP_SET_DATA	IP_SET_DATA
typedef struct _IP_SET_DATA *	PIP_SET_DATA
typedef enum _IPHLPAddrType	IPHLPAddrType
typedef VOID(*	EnumNameServersFunc) (PWCHAR Interface, PWCHAR NameServer, PVOID Data)

Enumerations
enum	_IPHLPAddrType {   IPAAddr , IPABcast , IPAMask , IFMtu ,   IFStatus }

Functions
NTSTATUS	getNthIpEntity (HANDLE tcpFile, DWORD index, TDIEntityID *ent)
NTSTATUS	tdiGetIpAddrsForIpEntity (HANDLE tcpFile, TDIEntityID *ent, IPAddrEntry **addrs, PDWORD numAddrs)
int	GetLongestChildKeyName (HANDLE RegHandle)
LONG	OpenChildKeyRead (HANDLE RegHandle, PWCHAR ChildKeyName, PHKEY ReturnHandle)
PWCHAR	GetNthChildKeyName (HANDLE RegHandle, DWORD n)
void	ConsumeChildKeyName (PWCHAR Name)
PWCHAR	QueryRegistryValueString (HANDLE RegHandle, PWCHAR ValueName)
PWCHAR *	QueryRegistryValueStringMulti (HANDLE RegHandle, PWCHAR ValueName)
void	ConsumeRegValueString (PWCHAR NameServer)
BOOL	isInterface (TDIEntityID *if_maybe)
BOOL	hasArp (HANDLE tcpFile, TDIEntityID *arp_maybe)
LSTATUS	EnumNameServers (HKEY RegHandle, LPWSTR Interface, PVOID Data, EnumNameServersFunc cb)
NTSTATUS	getIPAddrEntryForIf (HANDLE tcpFile, char *name, DWORD index, IFInfo *ifInfo)
DWORD	TCPSendIoctl (HANDLE hDevice, DWORD dwIoControlCode, LPVOID lpInBuffer, PULONG pInBufferSize, LPVOID lpOutBuffer, PULONG pOutBufferSize)
BOOL WINAPI	GetComputerNameExA (COMPUTER_NAME_FORMAT, LPSTR, LPDWORD)

Macro Definition Documentation

_INC_WINDOWS

#define _INC_WINDOWS

Definition at line 23 of file iphlpapi_private.h.

COM_NO_WINDOWS_H

#define COM_NO_WINDOWS_H

Definition at line 24 of file iphlpapi_private.h.

ETH_ALEN

#define ETH_ALEN   6

Definition at line 54 of file iphlpapi_private.h.

GAA_FLAG_SKIP_FRIENDLY_NAME

#define GAA_FLAG_SKIP_FRIENDLY_NAME   0x0020

Definition at line 82 of file iphlpapi_private.h.

GAA_FLAG_SKIP_UNICAST

#define GAA_FLAG_SKIP_UNICAST   0x0001

Definition at line 78 of file iphlpapi_private.h.

IFENT_SOFTWARE_LOOPBACK

#define IFENT_SOFTWARE_LOOPBACK   24 /* This is an SNMP constant from rfc1213 */

Definition at line 62 of file iphlpapi_private.h.

IFNAMSIZ

#define IFNAMSIZ   0x20

Definition at line 70 of file iphlpapi_private.h.

INADDR_NONE

#define INADDR_NONE   (~0U)

Definition at line 58 of file iphlpapi_private.h.

INDEX_IS_LOOPBACK

#define INDEX_IS_LOOPBACK   0x00800000

Definition at line 65 of file iphlpapi_private.h.

NtCurrentTeb

#define NtCurrentTeb

(

void

)

NtXCurrentTeb

Definition at line 4 of file iphlpapi_private.h.

NTOS_MODE_USER

#define NTOS_MODE_USER

Definition at line 31 of file iphlpapi_private.h.

TCP_REQUEST_QUERY_INFORMATION_INIT

#define TCP_REQUEST_QUERY_INFORMATION_INIT   { { { 0 } } }

Definition at line 73 of file iphlpapi_private.h.

TCP_REQUEST_SET_INFORMATION_INIT

#define TCP_REQUEST_SET_INFORMATION_INIT   { { 0 } }

Definition at line 74 of file iphlpapi_private.h.

WIN32_NO_STATUS

#define WIN32_NO_STATUS

Definition at line 22 of file iphlpapi_private.h.

Typedef Documentation

caddr_t

typedef char* caddr_t

Definition at line 104 of file iphlpapi_private.h.

EnumNameServersFunc

typedef VOID(* EnumNameServersFunc) (PWCHAR Interface, PWCHAR NameServer, PVOID Data)

Definition at line 160 of file iphlpapi_private.h.

IFEntrySafelySized

typedef union _IFEntrySafelySized IFEntrySafelySized

IFInfo

typedef struct _IFInfo IFInfo

IP_SET_DATA

typedef struct _IP_SET_DATA IP_SET_DATA

IPHLPAddrType

typedef enum _IPHLPAddrType IPHLPAddrType

IPRouteEntry

typedef struct _IPRouteEntry IPRouteEntry

PIP_SET_DATA

typedef struct _IP_SET_DATA * PIP_SET_DATA

PTCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY

typedef union _TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY * PTCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY

PTCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY

typedef union _TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY * PTCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY

TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY

typedef union _TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY TCP_REQUEST_SET_INFORMATION_EX_ARP_ENTRY

TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY

typedef union _TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY TCP_REQUEST_SET_INFORMATION_EX_ROUTE_ENTRY

Enumeration Type Documentation

_IPHLPAddrType

enum _IPHLPAddrType

Enumerator
IPAAddr
IPABcast
IPAMask
IFMtu
IFStatus

Definition at line 140 of file iphlpapi_private.h.

                            {
    IPAAddr, IPABcast, IPAMask, IFMtu, IFStatus
} IPHLPAddrType;

Function Documentation

ConsumeChildKeyName()

void ConsumeChildKeyName

(

PWCHAR

Name

)

Definition at line 63 of file registry.c.

                                        {
  if (Name) HeapFree( GetProcessHeap(), 0, Name );
}

ConsumeRegValueString()

void ConsumeRegValueString

(

PWCHAR

NameServer

)

Definition at line 140 of file registry.c.

                                           {
  if (Value) HeapFree(GetProcessHeap(), 0, Value);
}

EnumNameServers()

LSTATUS EnumNameServers	(	HKEY	RegHandle,
		LPWSTR	Interface,
		PVOID	Data,
		EnumNameServersFunc	cb
	)

Referenced by GetPerAdapterInfo().

GetComputerNameExA()

BOOL WINAPI GetComputerNameExA	(	COMPUTER_NAME_FORMAT	NameType,
		LPSTR	lpBuffer,
		LPDWORD	nSize
	)

Definition at line 376 of file compname.c.

{
    UNICODE_STRING UnicodeString;
    ANSI_STRING AnsiString;
    BOOL Result;
    PWCHAR TempBuffer = NULL;
 
    if ((nSize == NULL) ||
        (lpBuffer == NULL && *nSize > 0))
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        return FALSE;
    }
 
    if (*nSize > 0)
    {
        TempBuffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, *nSize * sizeof(WCHAR));
        if (!TempBuffer)
        {
            SetLastError(ERROR_NOT_ENOUGH_MEMORY);
            return FALSE;
        }
    }
 
    AnsiString.MaximumLength = (USHORT)*nSize;
    AnsiString.Length = 0;
    AnsiString.Buffer = lpBuffer;
 
    Result = GetComputerNameExW(NameType, TempBuffer, nSize);
 
    if (Result)
    {
        UnicodeString.MaximumLength = (USHORT)*nSize * sizeof(WCHAR) + sizeof(WCHAR);
        UnicodeString.Length = (USHORT)*nSize * sizeof(WCHAR);
        UnicodeString.Buffer = TempBuffer;
 
        RtlUnicodeStringToAnsiString(&AnsiString,
                                     &UnicodeString,
                                     FALSE);
    }
 
    RtlFreeHeap(RtlGetProcessHeap(), 0, TempBuffer);
 
    return Result;
}

Referenced by get_computer_name(), GetComputerNameA(), ShowInfo(), START_TEST(), TestGetComputerNameEx(), and TestReturnValues().

getIPAddrEntryForIf()

NTSTATUS getIPAddrEntryForIf	(	HANDLE	tcpFile,
		char *	name,
		DWORD	index,
		IFInfo *	ifInfo
	)

Definition at line 460 of file ifenum_reactos.c.

                                             {
    NTSTATUS status =
        name ?
        getInterfaceInfoByName( tcpFile, name, ifInfo ) :
        getInterfaceInfoByIndex( tcpFile, index, ifInfo );
 
    if (!NT_SUCCESS(status)) {
        ERR("getIPAddrEntryForIf returning %lx\n", status);
    }
 
    return status;
}

Referenced by getAddrByIndexOrName().

GetLongestChildKeyName()

int GetLongestChildKeyName

(

HANDLE

RegHandle

)

Definition at line 3 of file registry.c.

                                               {
  LONG Status;
  DWORD MaxAdapterName;
 
  Status = RegQueryInfoKeyW(RegHandle,
                NULL,
                NULL,
                NULL,
                NULL,
                &MaxAdapterName,
                NULL,
                NULL,
                NULL,
                NULL,
                NULL,
                NULL);
  if (Status == ERROR_SUCCESS)
    return MaxAdapterName + 1;
  else
    return -1;
}

Referenced by GetNthChildKeyName().

GetNthChildKeyName()

PWCHAR GetNthChildKeyName	(	HANDLE	RegHandle,
		DWORD	n
	)

Definition at line 39 of file registry.c.

                                                       {
  LONG Status;
  int MaxAdapterName = GetLongestChildKeyName( RegHandle );
  PWCHAR Value;
  DWORD ValueLen;
 
  if (MaxAdapterName == -1)
    return 0;
 
  ValueLen = MaxAdapterName;
  Value = (PWCHAR)HeapAlloc( GetProcessHeap(), 0, MaxAdapterName * sizeof(WCHAR) );
  if (!Value) return 0;
 
  Status = RegEnumKeyExW( RegHandle, n, Value, &ValueLen,
              NULL, NULL, NULL, NULL );
  if (Status != ERROR_SUCCESS) {
    HeapFree(GetProcessHeap(), 0, Value);
    return 0;
  } else {
    Value[ValueLen] = 0;
    return Value;
  }
}

getNthIpEntity()

NTSTATUS getNthIpEntity	(	HANDLE	tcpFile,
		DWORD	index,
		TDIEntityID *	ent
	)

Prototypes

Definition at line 65 of file ipstats_reactos.c.

                                                                         {
    DWORD numEntities = 0;
    DWORD numRoutes = 0;
    TDIEntityID *entitySet = 0;
    NTSTATUS status = tdiGetEntityIDSet( tcpFile, &entitySet, &numEntities );
    int i;
 
    if( !NT_SUCCESS(status) )
        return status;
 
    for( i = 0; i < numEntities; i++ ) {
        if( isIpEntity( tcpFile, &entitySet[i] ) ) {
            TRACE("Entity %d is an IP Entity\n", i);
            if( numRoutes == index ) break;
            else numRoutes++;
        }
    }
 
    if( numRoutes == index && i < numEntities ) {
        TRACE("Index %lu is entity #%d - %04x:%08x\n", index, i,
              entitySet[i].tei_entity, entitySet[i].tei_instance);
        memcpy( ent, &entitySet[i], sizeof(*ent) );
        tdiFreeThingSet( entitySet );
        return STATUS_SUCCESS;
    } else {
        tdiFreeThingSet( entitySet );
        return STATUS_UNSUCCESSFUL;
    }
}

Referenced by createIpForwardEntry(), deleteIpForwardEntry(), getInterfaceInfoSet(), getRouteTable(), and SetIpNetEntry().

hasArp()

BOOL hasArp	(	HANDLE	tcpFile,
		TDIEntityID *	arp_maybe
	)

Definition at line 131 of file ifenum_reactos.c.

                                                      {
    TCP_REQUEST_QUERY_INFORMATION_EX req = TCP_REQUEST_QUERY_INFORMATION_INIT;
    NTSTATUS status = STATUS_SUCCESS;
    DWORD returnSize, type;
 
    req.ID.toi_class                = INFO_CLASS_GENERIC;
    req.ID.toi_type                 = INFO_TYPE_PROVIDER;
    req.ID.toi_id                   = ENTITY_TYPE_ID;
    req.ID.toi_entity.tei_entity    = AT_ENTITY;
    req.ID.toi_entity.tei_instance  = arp_maybe->tei_instance;
 
    status = DeviceIoControl( tcpFile,
                              IOCTL_TCP_QUERY_INFORMATION_EX,
                              &req,
                              sizeof(req),
                              &type,
                              sizeof(type),
                              &returnSize,
                              NULL );
    if( !NT_SUCCESS(status) ) return FALSE;
 
    /* AT_ARP corresponds to an individual TDI entity type */
    return (type == AT_ARP);
}

Referenced by getArpTable(), getNumArpEntries(), getNumTcpEntries(), getNumUdpEntries(), getTcpTable(), and getUdpTable().

isInterface()

BOOL isInterface

(

TDIEntityID *

if_maybe

)

Definition at line 114 of file ifenum_reactos.c.

                                          {
    return
        if_maybe->tei_entity == IF_ENTITY;
}

Referenced by getArpTable(), getInterfaceInfoSet(), getNthInterfaceEntity(), getNumArpEntries(), and getNumInterfacesInt().

OpenChildKeyRead()

LONG OpenChildKeyRead	(	HANDLE	RegHandle,
		PWCHAR	ChildKeyName,
		PHKEY	ReturnHandle
	)

Definition at line 25 of file registry.c.

                                    {
  return RegOpenKeyExW( RegHandle,
            ChildKeyName,
            0,
            KEY_READ,
            ReturnHandle );
}

QueryRegistryValueString()

PWCHAR QueryRegistryValueString	(	HANDLE	RegHandle,
		PWCHAR	ValueName
	)

Definition at line 119 of file registry.c.

{
    PWCHAR String, TerminatedString;
    DWORD Type, Length;
 
    String = QueryRegistryValue(RegHandle, ValueName, &Type, &Length);
    if (!String) return NULL;
    if (Type != REG_SZ)
    {
        DbgPrint("Type mismatch for %S (%d != %d)\n", ValueName, Type, REG_SZ);
        //HeapFree(GetProcessHeap(), 0, String);
        //return NULL;
    }
 
    TerminatedString = TerminateReadString(String, Length);
    HeapFree(GetProcessHeap(), 0, String);
    if (!TerminatedString) return NULL;
 
    return TerminatedString;
}

QueryRegistryValueStringMulti()

PWCHAR * QueryRegistryValueStringMulti	(	HANDLE	RegHandle,
		PWCHAR	ValueName
	)

Definition at line 144 of file registry.c.

                                                                            {
    PWCHAR String, TerminatedString, Tmp;
    PWCHAR *Table;
    DWORD Type, Length, i, j;
 
    String = QueryRegistryValue(RegHandle, ValueName, &Type, &Length);
    if (!String) return NULL;
    if (Type != REG_MULTI_SZ)
    {
        DbgPrint("Type mismatch for %S (%d != %d)\n", ValueName, Type, REG_MULTI_SZ);
        //HeapFree(GetProcessHeap(), 0, String);
        //return NULL;
    }
 
    TerminatedString = TerminateReadString(String, Length);
    HeapFree(GetProcessHeap(), 0, String);
    if (!TerminatedString) return NULL;
 
    for (Tmp = TerminatedString, i = 0; *Tmp; Tmp++, i++) while (*Tmp) Tmp++;
 
    Table = HeapAlloc(GetProcessHeap(), 0, (i + 1) * sizeof(PWCHAR));
    if (!Table)
    {
        HeapFree(GetProcessHeap(), 0, TerminatedString);
        return NULL;
    }
 
    for (Tmp = TerminatedString, j = 0; *Tmp; Tmp++, j++)
    {
        PWCHAR Orig = Tmp;
 
        for (i = 0; *Tmp; i++, Tmp++);
 
        Table[j] = HeapAlloc(GetProcessHeap(), 0, i * sizeof(WCHAR));
        memcpy(Table[j], Orig, i * sizeof(WCHAR));
    }
 
    Table[j] = NULL;
 
    HeapFree(GetProcessHeap(), 0, TerminatedString);
 
    return Table;
}

TCPSendIoctl()

DWORD TCPSendIoctl	(	HANDLE	hDevice,
		DWORD	dwIoControlCode,
		LPVOID	lpInBuffer,
		PULONG	pInBufferSize,
		LPVOID	lpOutBuffer,
		PULONG	pOutBufferSize
	)

Definition at line 13 of file iphlpapi_reactos.c.

{
    BOOL Hack = FALSE;
    HANDLE Event;
    IO_STATUS_BLOCK IoStatusBlock;
    NTSTATUS Status;
 
    /* FIXME: We don't have a global handle opened to \Device\Ip, so open one each time
     * we need. In a future, it would be cool, just to pass it to TCPSendIoctl using the first arg
     */
    if (hDevice == INVALID_HANDLE_VALUE)
    {
        UNICODE_STRING DevName = RTL_CONSTANT_STRING(L"\\Device\\Ip");
        OBJECT_ATTRIBUTES ObjectAttributes;
 
        FIXME("Using the handle hack\n");
        Hack = TRUE;
 
        InitializeObjectAttributes(&ObjectAttributes,
                                   &DevName,
                                   OBJ_CASE_INSENSITIVE,
                                   NULL,
                                   NULL);
 
        Status = NtCreateFile(&hDevice, GENERIC_EXECUTE, &ObjectAttributes,
                              &IoStatusBlock, 0, FILE_ATTRIBUTE_NORMAL, FILE_SHARE_READ | FILE_SHARE_WRITE, FILE_OPEN_IF,
                              0, NULL, 0);
        if (!NT_SUCCESS(Status))
        {
          return RtlNtStatusToDosError(Status);
        }
    }
 
    /* Sync event */
    Event = CreateEventW(NULL, TRUE, FALSE, NULL);
    if (Event == NULL)
    {
        /* FIXME: See upper */
        if (Hack)
        {
            CloseHandle(hDevice);
        }
        return GetLastError();
    }
 
    /* Reinit, and call the networking stack */
    IoStatusBlock.Status = STATUS_SUCCESS;
    IoStatusBlock.Information = 0;
    Status = NtDeviceIoControlFile(hDevice, Event, NULL, NULL, &IoStatusBlock, dwIoControlCode, lpInBuffer, *pInBufferSize, lpOutBuffer, *pOutBufferSize);
    if (Status == STATUS_PENDING)
    {
        NtWaitForSingleObject(Event, FALSE, NULL);
        Status = IoStatusBlock.Status;
    }
 
    /* Close & return size info */
    CloseHandle(Event);
    *pOutBufferSize = IoStatusBlock.Information;
 
    /* FIXME: See upper */
    if (Hack)
    {
        CloseHandle(hDevice);
    }
 
    /* Return result */
    if (!NT_SUCCESS(Status))
    {
        return RtlNtStatusToDosError(Status);
    }
 
    return ERROR_SUCCESS;
}

Referenced by SendARP().

tdiGetIpAddrsForIpEntity()

NTSTATUS tdiGetIpAddrsForIpEntity	(	HANDLE	tcpFile,
		TDIEntityID *	ent,
		IPAddrEntry **	addrs,
		PDWORD	numAddrs
	)

Definition at line 258 of file ipstats_reactos.c.

                                                                           {
    NTSTATUS status;
 
    TRACE("TdiGetIpAddrsForIpEntity(tcpFile 0x%p, entityId 0x%x)\n",
          tcpFile, ent->tei_instance);
 
    status = tdiGetSetOfThings(tcpFile,
                               INFO_CLASS_PROTOCOL,
                               INFO_TYPE_PROVIDER,
                               IP_MIB_ADDRTABLE_ENTRY_ID,
                               CL_NL_ENTITY,
                               ent->tei_instance,
                               0,
                               sizeof(IPAddrEntry),
                               (PVOID *)addrs,
                               numAddrs);
 
    return status;
}

Referenced by getInterfaceInfoSet().