/********************************************************************/
/**                     Microsoft LAN Manager                      **/
/**     Copyright (c) Microsoft Corporation. All rights reserved.  **/
/********************************************************************/

//** IPEXPORT.H - IP public definitions.
//  This file contains public definitions exported to transport layer and
//  application software.

#ifndef IP_EXPORT_INCLUDED
#define IP_EXPORT_INCLUDED  1

// IP type definitions.
#define IPAddr ULONG        // An IP address.
#define IPMask ULONG        // An IP subnet mask.
#define IP_STATUS ULONG     // Status code returned from IP APIs.

#ifndef s6_addr
// Duplicate these definitions here so that this file can be included by
// kernel-mode components which cannot include ws2tcpip.h, as well as
// by user-mode components which do.
struct IN6_ADDR {
  union {
    UCHAR       Byte[16];
    USHORT      Word[8];
  }u;
};

#define in6_addr IN6_ADDR
#define in_addr6 in6_addr

// Defines to match RFC 2553.
#define _S6_un      u
#define _S6_u8      Byte
#define s6_addr     _S6_un._S6_u8

// Defines for our implementation.
#define s6_bytes    u.Byte
#define s6_words    u.Word

#endif

//typedef struct in6_addr IPv6Addr;

/*INC*/
// The ip_option_information structure describes the options to be
// included in the header of an IP packet. The TTL, TOS, and Flags
// values are carried in specific fields in the header. The OptionsData
// bytes are carried in the options area following the standard IP header.
// With the exception of source route options, this data must be in the
// format to be transmitted on the wire as specified in RFC 791. A source
// route option should contain the full route - first hop thru final
// destination - in the route data. The first hop will be pulled out of the
// data and the option will be reformatted accordingly. Otherwise, the route
// option should be formatted as specified in RFC 791.
struct IP_OPTION_INFORMATION{
  UCHAR   Ttl;                // Time To Live
  UCHAR   Tos;                // Type Of Service
  UCHAR   Flags;              // IP header flags
  UCHAR   OptionsSize;        // Size in bytes of options data
  PUCHAR  OptionsData;        // Pointer to options data
};

#define ip_option_information IP_OPTION_INFORMATION

#ifdef _WIN64

struct IP_OPTION_INFORMATION32{
  UCHAR   Ttl;
  UCHAR   Tos;
  UCHAR   Flags;
  UCHAR   OptionsSize;
  UCHAR * POINTER_32 OptionsData;
};

#define ip_option_information32 IP_OPTION_INFORMATION32

#endif // _WIN64

// The icmp_echo_reply structure describes the data returned in response
// to an echo request.
struct ICMP_ECHO_REPLY{
  IPAddr  Address;            // Replying address
  ULONG   Status;             // Reply IP_STATUS
  ULONG   RoundTripTime;      // RTT in milliseconds
  USHORT  DataSize;           // Reply data size in bytes
  USHORT  Reserved;           // Reserved for system use
  PVOID   Data;               // Pointer to the reply data
  struct ip_option_information Options; // Reply options
};

#define icmp_echo_reply ICMP_ECHO_REPLY

#ifdef _WIN64

struct ICMP_ECHO_REPLY32{
  IPAddr  Address;
  ULONG   Status;
  ULONG   RoundTripTime;
  USHORT  DataSize;
  USHORT  Reserved;
  VOID * POINTER_32 Data;
  struct ip_option_information32 Options;
};

#define icmp_echo_reply32 ICMP_ECHO_REPLY32

#endif // _WIN64

struct arp_send_reply{
  IPAddr  DestAddress;
  IPAddr  SrcAddress;
};
#define ARP_SEND_REPLY arp_send_reply

struct tcp_reserve_port_range{
  USHORT  UpperRange;
  USHORT  LowerRange;
};
#define TCP_RESERVE_PORT_RANGE tcp_reserve_port_range

#define MAX_ADAPTER_NAME 128

struct IP_ADAPTER_INDEX_MAP{
  ULONG   Index;
  WCHAR   Name[MAX_ADAPTER_NAME];
};

struct IP_INTERFACE_INFO{
  LONG    NumAdapters;
  IP_ADAPTER_INDEX_MAP Adapter[1];
};

struct IP_UNIDIRECTIONAL_ADAPTER_ADDRESS{
  ULONG   NumAdapters;
  IPAddr  Address[1];
};

struct IP_ADAPTER_ORDER_MAP{
  ULONG   NumAdapters;
  ULONG   AdapterOrder[1];
};

struct IP_MCAST_COUNTER_INFO{
  qword InMcastOctets;
  qword OutMcastOctets;
  qword InMcastPkts;
  qword OutMcastPkts;
};

// IP_STATUS codes returned from IP APIs
#define IP_STATUS_BASE              11000
#define IP_SUCCESS                  0
#define IP_BUF_TOO_SMALL            IP_STATUS_BASE + 1
#define IP_DEST_NET_UNREACHABLE     IP_STATUS_BASE + 2
#define IP_DEST_HOST_UNREACHABLE    IP_STATUS_BASE + 3
#define IP_DEST_PROT_UNREACHABLE    IP_STATUS_BASE + 4
#define IP_DEST_PORT_UNREACHABLE    IP_STATUS_BASE + 5
#define IP_NO_RESOURCES             IP_STATUS_BASE + 6
#define IP_BAD_OPTION               IP_STATUS_BASE + 7
#define IP_HW_ERROR                 IP_STATUS_BASE + 8
#define IP_PACKET_TOO_BIG           IP_STATUS_BASE + 9
#define IP_REQ_TIMED_OUT            IP_STATUS_BASE + 10
#define IP_BAD_REQ                  IP_STATUS_BASE + 11
#define IP_BAD_ROUTE                IP_STATUS_BASE + 12
#define IP_TTL_EXPIRED_TRANSIT      IP_STATUS_BASE + 13
#define IP_TTL_EXPIRED_REASSEM      IP_STATUS_BASE + 14
#define IP_PARAM_PROBLEM            IP_STATUS_BASE + 15
#define IP_SOURCE_QUENCH            IP_STATUS_BASE + 16
#define IP_OPTION_TOO_BIG           IP_STATUS_BASE + 17
#define IP_BAD_DESTINATION          IP_STATUS_BASE + 18

// Variants of the above using IPv6 terminology, where different
#define IP_DEST_NO_ROUTE            IP_STATUS_BASE + 2
#define IP_DEST_ADDR_UNREACHABLE    IP_STATUS_BASE + 3
#define IP_DEST_PROHIBITED          IP_STATUS_BASE + 4
#define IP_DEST_PORT_UNREACHABLE    IP_STATUS_BASE + 5
#define IP_HOP_LIMIT_EXCEEDED       IP_STATUS_BASE + 13
#define IP_REASSEMBLY_TIME_EXCEEDED IP_STATUS_BASE + 14
#define IP_PARAMETER_PROBLEM        IP_STATUS_BASE + 15

// IPv6-only status codes
#define IP_DEST_UNREACHABLE         IP_STATUS_BASE + 40
#define IP_TIME_EXCEEDED            IP_STATUS_BASE + 41
#define IP_BAD_HEADER               IP_STATUS_BASE + 42
#define IP_UNRECOGNIZED_NEXT_HEADER IP_STATUS_BASE + 43
#define IP_ICMP_ERROR               IP_STATUS_BASE + 44
#define IP_DEST_SCOPE_MISMATCH      IP_STATUS_BASE + 45

// The next group are status codes passed up on status indications to
// transport layer protocols.
#define IP_ADDR_DELETED             IP_STATUS_BASE + 19
#define IP_SPEC_MTU_CHANGE          IP_STATUS_BASE + 20
#define IP_MTU_CHANGE               IP_STATUS_BASE + 21
#define IP_UNLOAD                   IP_STATUS_BASE + 22
#define IP_ADDR_ADDED               IP_STATUS_BASE + 23
#define IP_MEDIA_CONNECT            IP_STATUS_BASE + 24
#define IP_MEDIA_DISCONNECT         IP_STATUS_BASE + 25
#define IP_BIND_ADAPTER             IP_STATUS_BASE + 26
#define IP_UNBIND_ADAPTER           IP_STATUS_BASE + 27
#define IP_DEVICE_DOES_NOT_EXIST    IP_STATUS_BASE + 28
#define IP_DUPLICATE_ADDRESS        IP_STATUS_BASE + 29
#define IP_INTERFACE_METRIC_CHANGE  IP_STATUS_BASE + 30
#define IP_RECONFIG_SECFLTR         IP_STATUS_BASE + 31
#define IP_NEGOTIATING_IPSEC        IP_STATUS_BASE + 32
#define IP_INTERFACE_WOL_CAPABILITY_CHANGE IP_STATUS_BASE + 33
#define IP_DUPLICATE_IPADD          IP_STATUS_BASE + 34
#define IP_GENERAL_FAILURE          IP_STATUS_BASE + 50
#define MAX_IP_STATUS               IP_GENERAL_FAILURE
#define IP_PENDING                  IP_STATUS_BASE + 255

// Values used in the IP header Flags field.
#define IP_FLAG_DF      0x2         // Don't fragment this packet.

// Supported IP Option Types.
// These types define the options which may be used in the OptionsData field
// of the ip_option_information structure.  See RFC 791 for a complete
// description of each.
#define IP_OPT_EOL      0          // End of list option
#define IP_OPT_NOP      1          // No operation
#define IP_OPT_SECURITY 0x82       // Security option
#define IP_OPT_LSRR     0x83       // Loose source route
#define IP_OPT_SSRR     0x89       // Strict source route
#define IP_OPT_RR       0x7        // Record route
#define IP_OPT_TS       0x44       // Timestamp
#define IP_OPT_SID      0x88       // Stream ID (obsolete)
#define IP_OPT_ROUTER_ALERT 0x94  // Router Alert Option

#define MAX_OPT_SIZE    40         // Maximum length of IP options in bytes

// Ioctls code exposed by Memphis tcpip stack.
// For NT these ioctls are define in ntddip.h  (private\inc)

#define IOCTL_IP_RTCHANGE_NOTIFY_REQUEST   101
#define IOCTL_IP_ADDCHANGE_NOTIFY_REQUEST  102
#define IOCTL_ARP_SEND_REQUEST             103
#define IOCTL_IP_INTERFACE_INFO            104
#define IOCTL_IP_GET_BEST_INTERFACE        105
#define IOCTL_IP_UNIDIRECTIONAL_ADAPTER_ADDRESS        106

extern WINAPI "icmp.dll"
{
	dword IcmpCreateFile(void);
	BOOL IcmpCloseHandle(dword);
	dword IcmpSendEcho(dword,IPAddr,dword,WORD,dword,dword,dword,dword);
}

#endif // IP_EXPORT_INCLUDED
