dlls/iphlpapi/ifenum.h

   1 /* ifenum.h
   2  * Copyright (C) 2003 Juan Lang
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  * This module implements functions shared by DLLs that need to enumerate
  19  * network interfaces and addresses.  It's meant to hide some problematic
  20  * defines like socket(), as well as provide only one file
  21  * that needs to be ported to implement these functions on different platforms,
  22  * since the Windows API provides multiple ways to get at this info.
  23  *
  24  * Like Windows, it uses a numeric index to identify an interface uniquely.
  25  * As implemented, an interface represents a UNIX network interface, virtual
  26  * or real, and thus can have 0 or 1 IP addresses associated with it.  (This
  27  * only supports IPv4.)
  28  * The indexes returned are not guaranteed to be contiguous, so don't call
  29  * getNumInterfaces() and assume the values [0,getNumInterfaces() - 1] will be
  30  * valid indexes; use getInterfaceIndexTable() instead.
  31  *
  32  * See also the companion file, ipstats.h, for functions related to getting
  33  * statistics.
  34  */
  35 #ifndef WINE_IFENUM_H_
  36 #define WINE_IFENUM_H_
  37
  38 #include <stdarg.h>
  39
  40 #include "windef.h"
  41 #include "winbase.h"
  42 #include "iprtrmib.h"
  43
  44 #define MAX_INTERFACE_PHYSADDR    8
  45 #define MAX_INTERFACE_DESCRIPTION 256
  46
  47 /* Call before using the functions in this module */
  48 void interfaceMapInit(void);
  49 /* Call to free resources allocated in interfaceMapInit() */
  50 void interfaceMapFree(void);
  51
  52 DWORD getNumInterfaces(void);
  53 DWORD getNumNonLoopbackInterfaces(void);
  54
  55 /* A table of interface indexes, see get*InterfaceTable().  Ignore numAllocated,
  56  * it's used during the creation of the table.
  57  */
  58 typedef struct _InterfaceIndexTable {
  59   DWORD numIndexes;
  60   DWORD numAllocated;
  61   DWORD indexes[1];
  62 } InterfaceIndexTable;
  63
  64 /* Returns a table with all known interface indexes, or NULL if one could not
  65  * be allocated.  HeapFree() the returned table.
  66  */
  67 InterfaceIndexTable *getInterfaceIndexTable(void);
  68
  69 /* Like getInterfaceIndexTable, but filters out loopback interfaces. */
  70 InterfaceIndexTable *getNonLoopbackInterfaceIndexTable(void);
  71
  72 /* ByName/ByIndex versions of various getter functions. */
  73
  74 /* can be used as quick check to see if you've got a valid index, returns NULL
  75  * if not.  The buffer's only valid till the next call, so copy it right away
  76  * if you care.
  77  */
  78 const char *getInterfaceNameByIndex(DWORD index);
  79
  80 /* Fills index with the index of name, if found.  Returns
  81  * ERROR_INVALID_PARAMETER if name or index is NULL, ERROR_INVALID_DATA if name
  82  * is not found, and NO_ERROR on success.
  83  */
  84 DWORD getInterfaceIndexByName(const char *name, PDWORD index);
  85
  86 /* This bunch returns IP addresses, and INADDR_ANY or INADDR_NONE if not found,
  87  * appropriately depending on the f/n.
  88  */
  89 DWORD getInterfaceIPAddrByName(const char *name);
  90 DWORD getInterfaceIPAddrByIndex(DWORD index);
  91 DWORD getInterfaceMaskByName(const char *name);
  92 DWORD getInterfaceMaskByIndex(DWORD index);
  93 DWORD getInterfaceBCastAddrByName(const char *name);
  94 DWORD getInterfaceBCastAddrByIndex(DWORD index);
  95
  96 /* Gets a few physical charactersistics of a device:  MAC addr len, MAC addr,
  97  * and type as one of the MIB_IF_TYPEs.
  98  * len's in-out: on in, needs to say how many bytes are available in addr,
  99  * which to be safe should be MAX_INTERFACE_PHYSADDR.  On out, it's how many
 100  * bytes were set, or how many were required if addr isn't big enough.
 101  * Returns ERROR_INVALID_PARAMETER if name, len, addr, or type is NULL.
 102  * Returns ERROR_INVALID_DATA if name/index isn't valid.
 103  * Returns ERROR_INSUFFICIENT_BUFFER if addr isn't large enough for the
 104  * physical address; *len will contain the required size.
 105  * May return other errors, e.g. ERROR_OUTOFMEMORY or ERROR_NO_MORE_FILES,
 106  * if internal errors occur.
 107  * Returns NO_ERROR on success.
 108  */
 109 DWORD getInterfacePhysicalByName(const char *name, PDWORD len, PBYTE addr,
 110  PDWORD type);
 111 DWORD getInterfacePhysicalByIndex(DWORD index, PDWORD len, PBYTE addr,
 112  PDWORD type);
 113
 114 /* Get the operational status as a (MIB_)IF_OPER_STATUS type.
 115  */
 116 DWORD getInterfaceStatusByName(const char *name, PDWORD status);
 117 DWORD getInterfaceStatusByIndex(DWORD index, PDWORD status);
 118
 119 DWORD getInterfaceMtuByName(const char *name, PDWORD mtu);
 120 DWORD getInterfaceMtuByIndex(DWORD index, PDWORD mtu);
 121
 122 /* Fills in the MIB_IFROW by name/index.  Doesn't fill in interface statistics,
 123  * see ipstats.h for that.
 124  * Returns ERROR_INVALID_PARAMETER if name or entry is NULL, ERROR_INVALID_DATA
 125  * if name/index isn't valid, and NO_ERROR otherwise.
 126  */
 127 DWORD getInterfaceEntryByName(const char *name, PMIB_IFROW entry);
 128 DWORD getInterfaceEntryByIndex(DWORD index, PMIB_IFROW entry);
 129
 130 /* Converts the network-order bytes in addr to a printable string.  Returns
 131  * string.
 132  */
 133 char *toIPAddressString(unsigned int addr, char string[16]);
 134
 135 #endif /* ndef WINE_IFENUM_H_ */