Minoca-os/drivers/net/netcore/netcore.c

/*++

Copyright (c) 2013 Minoca Corp.

    This file is licensed under the terms of the GNU General Public License
    version 3. Alternative licensing terms are available. Contact
    info@minocacorp.com for details. See the LICENSE file at the root of this
    project for complete licensing information.

Module Name:

    netcore.c

Abstract:

    This module implements the networking core library.

Author:

    Evan Green 4-Apr-2013

Environment:

    Kernel

--*/

//
// ------------------------------------------------------------------- Includes
//

#include <minoca/kernel/driver.h>
#include "netcore.h"

//
// ---------------------------------------------------------------- Definitions
//

//
// Define the maximum port value that requires special bind permission.
//

#define NET_PORT_PERMISSIONS_MAX 1023

//
// ------------------------------------------------------ Data Type Definitions
//

/*++

Structure Description:

    This structure defines a basic network socket option.

Members:

    InformationType - Stores the information type for the socket option.

    Option - Stores the type-specific option identifier.

    Size - Stores the size of the option value, in bytes.

    SetAllowed - Stores a boolean indicating whether or not the option is
        allowed to be set.

--*/

typedef struct _NET_SOCKET_OPTION {
    SOCKET_INFORMATION_TYPE InformationType;
    UINTN Option;
    UINTN Size;
    BOOL SetAllowed;
} NET_SOCKET_OPTION, *PNET_SOCKET_OPTION;

//
// ----------------------------------------------- Internal Function Prototypes
//

KSTATUS
NetCreateSocket (
    NET_DOMAIN_TYPE Domain,
    NET_SOCKET_TYPE Type,
    ULONG Protocol,
    PSOCKET *NewSocket
    );

VOID
NetDestroySocket (
    PSOCKET Socket
    );

KSTATUS
NetBindToAddress (
    PSOCKET Socket,
    PVOID Link,
    PNETWORK_ADDRESS Address
    );

KSTATUS
NetListen (
    PSOCKET Socket,
    ULONG BacklogCount
    );

KSTATUS
NetAccept (
    PSOCKET Socket,
    PIO_HANDLE *NewConnectionSocket,
    PNETWORK_ADDRESS RemoteAddress
    );

KSTATUS
NetConnect (
    PSOCKET Socket,
    PNETWORK_ADDRESS Address
    );

KSTATUS
NetCloseSocket (
    PSOCKET Socket
    );

KSTATUS
NetSendData (
    BOOL FromKernelMode,
    PSOCKET Socket,
    PSOCKET_IO_PARAMETERS Parameters,
    PIO_BUFFER IoBuffer
    );

KSTATUS
NetReceiveData (
    BOOL FromKernelMode,
    PSOCKET Socket,
    PSOCKET_IO_PARAMETERS Parameters,
    PIO_BUFFER IoBuffer
    );

KSTATUS
NetGetSetSocketInformation (
    PSOCKET Socket,
    SOCKET_INFORMATION_TYPE InformationType,
    UINTN SocketOption,
    PVOID Data,
    PUINTN DataSize,
    BOOL Set
    );

KSTATUS
NetShutdown (
    PSOCKET Socket,
    ULONG ShutdownType
    );

KSTATUS
NetUserControl (
    PSOCKET Socket,
    ULONG CodeNumber,
    BOOL FromKernelMode,
    PVOID ContextBuffer,
    UINTN ContextBufferSize
    );

VOID
NetpDestroyProtocol (
    PNET_PROTOCOL_ENTRY Protocol
    );

//
// -------------------------------------------------------------------- Globals
//

//
// Define the lists of supported types for various networking layers.
//

LIST_ENTRY NetProtocolList;
LIST_ENTRY NetNetworkList;
LIST_ENTRY NetDataLinkList;
PSHARED_EXCLUSIVE_LOCK NetPluginListLock;

BOOL NetInitialized = FALSE;

//
// Define the global debug flag, which propagates throughout the networking
// subsystem.
//

BOOL NetGlobalDebug = FALSE;

//
// Optimize a bit by storing pointers directly to the super common network and
// protocol entries.
//

PNET_NETWORK_ENTRY NetArpNetworkEntry = NULL;
PNET_NETWORK_ENTRY NetIp4NetworkEntry = NULL;
PNET_NETWORK_ENTRY NetIp6NetworkEntry = NULL;

PNET_PROTOCOL_ENTRY NetTcpProtocolEntry = NULL;
PNET_PROTOCOL_ENTRY NetUdpProtocolEntry = NULL;
PNET_PROTOCOL_ENTRY NetRawProtocolEntry = NULL;

NET_INTERFACE NetInterface = {
    NetCreateSocket,
    NetDestroySocket,
    NetBindToAddress,
    NetListen,
    NetAccept,
    NetConnect,
    NetCloseSocket,
    NetSendData,
    NetReceiveData,
    NetGetSetSocketInformation,
    NetShutdown,
    NetUserControl
};

NET_SOCKET_OPTION NetBasicSocketOptions[] = {
    {
        SocketInformationBasic,
        SocketBasicOptionType,
        sizeof(NET_SOCKET_TYPE),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionDomain,
        sizeof(NET_DOMAIN_TYPE),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionLocalAddress,
        sizeof(NETWORK_ADDRESS),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionRemoteAddress,
        sizeof(NETWORK_ADDRESS),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionReuseAnyAddress,
        sizeof(ULONG),
        TRUE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionReuseTimeWait,
        sizeof(ULONG),
        TRUE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionReuseExactAddress,
        sizeof(ULONG),
        TRUE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionBroadcastEnabled,
        sizeof(ULONG),
        TRUE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionErrorStatus,
        sizeof(KSTATUS),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionAcceptConnections,
        sizeof(ULONG),
        FALSE
    },

    {
        SocketInformationBasic,
        SocketBasicOptionSendTimeout,
        sizeof(SOCKET_TIME),
        FALSE
    },
};

//
// ------------------------------------------------------------------ Functions
//

__USED
KSTATUS
DriverEntry (
    PDRIVER Driver
    )

/*++

Routine Description:

    This routine implements the initial entry point of the networking core
    library, called when the library is first loaded.

Arguments:

    Driver - Supplies a pointer to the driver object.

Return Value:

    Status code.

--*/

{

    BOOL BuffersInitialized;
    KSTATUS Status;

    ASSERT(NetInitialized == FALSE);

    BuffersInitialized = FALSE;

    //
    // The core networking driver never goes away, even if the driver that
    // imported it is unloaded.
    //

    IoDriverAddReference(Driver);
    INITIALIZE_LIST_HEAD(&NetProtocolList);
    INITIALIZE_LIST_HEAD(&NetNetworkList);
    INITIALIZE_LIST_HEAD(&NetDataLinkList);
    NetPluginListLock = KeCreateSharedExclusiveLock();
    if (NetPluginListLock == NULL) {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto DriverEntryEnd;
    }

    Status = NetpInitializeBuffers();
    if (!KSUCCESS(Status)) {
        goto DriverEntryEnd;
    }

    BuffersInitialized = TRUE;
    Status = NetpInitializeNetworkLayer();
    if (!KSUCCESS(Status)) {
        goto DriverEntryEnd;
    }

    //
    // Set up the built in protocols, networks, data links and miscellaneous
    // components.
    //

    NetpEthernetInitialize();
    NetpArpInitialize();
    NetpIp4Initialize();
    NetpUdpInitialize();
    NetpTcpInitialize();
    NetpRawInitialize();
    NetpIgmpInitialize();
    NetpDhcpInitialize();
    NetpNetlinkInitialize();
    NetpNetlinkGenericInitialize(0);

    //
    // Set up the networking interface to the kernel.
    //

    IoInitializeCoreNetworking(&NetInterface);
    NetInitialized = TRUE;
    Status = STATUS_SUCCESS;

    //
    // Handle any post-registration work for the built in protocols, networks,
    // data links and miscellaneous components.
    //

    NetpNetlinkGenericInitialize(1);

DriverEntryEnd:
    if (!KSUCCESS(Status)) {
        if (NetPluginListLock != NULL) {
            KeDestroySharedExclusiveLock(NetPluginListLock);
            NetPluginListLock = NULL;
        }

        if (BuffersInitialized != FALSE) {
            NetpDestroyBuffers();
        }
    }

    return Status;
}

NET_API
KSTATUS
NetRegisterProtocol (
    PNET_PROTOCOL_ENTRY NewProtocol,
    PHANDLE ProtocolHandle
    )

/*++

Routine Description:

    This routine registers a new protocol type with the core networking
    library.

Arguments:

    NewProtocol - Supplies a pointer to the protocol information. The core
        library will not reference this memory after the function returns, a
        copy will be made.

    ProtocolHandle - Supplies an optional pointer that receives a handle to the
        registered protocol on success.

Return Value:

    STATUS_SUCCESS on success.

    STATUS_INVALID_PARAMETER if part of the structure isn't filled out
    correctly.

    STATUS_INSUFFICIENT_RESOURCES if memory could not be allocated.

    STATUS_DUPLICATE_ENTRY if the socket type is already registered.

--*/

{

    PLIST_ENTRY CurrentEntry;
    HANDLE Handle;
    BOOL LockHeld;
    PNET_PROTOCOL_ENTRY NewProtocolCopy;
    PNET_PROTOCOL_ENTRY Protocol;
    KSTATUS Status;

    ASSERT(KeGetRunLevel() == RunLevelLow);

    LockHeld = FALSE;
    Handle = INVALID_HANDLE;
    NewProtocolCopy = NULL;
    if ((NewProtocol->Type == NetSocketInvalid) ||
        (NewProtocol->Interface.CreateSocket == NULL) ||
        (NewProtocol->Interface.DestroySocket == NULL) ||
        (NewProtocol->Interface.BindToAddress == NULL) ||
        (NewProtocol->Interface.Listen == NULL) ||
        (NewProtocol->Interface.Accept == NULL) ||
        (NewProtocol->Interface.Connect == NULL) ||
        (NewProtocol->Interface.Close == NULL) ||
        (NewProtocol->Interface.Shutdown == NULL) ||
        (NewProtocol->Interface.Send == NULL) ||
        (NewProtocol->Interface.ProcessReceivedData == NULL) ||
        (NewProtocol->Interface.Receive == NULL) ||
        (NewProtocol->Interface.GetSetInformation == NULL) ||
        (NewProtocol->Interface.UserControl == NULL) ||
        (NewProtocol->Interface.ProcessReceivedSocketData == NULL)) {

        Status = STATUS_INVALID_PARAMETER;
        goto RegisterProtocolEnd;
    }

    //
    // Create a copy of the new protocol.
    //

    NewProtocolCopy = MmAllocatePagedPool(sizeof(NET_PROTOCOL_ENTRY),
                                          NET_CORE_ALLOCATION_TAG);

    if (NewProtocolCopy == NULL) {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto RegisterProtocolEnd;
    }

    RtlCopyMemory(NewProtocolCopy, NewProtocol, sizeof(NET_PROTOCOL_ENTRY));
    NewProtocolCopy->SocketLock = KeCreateSharedExclusiveLock();
    if (NewProtocolCopy->SocketLock == NULL) {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto RegisterProtocolEnd;
    }

    RtlRedBlackTreeInitialize(&(NewProtocolCopy->SocketTree[SocketUnbound]),
                              0,
                              NetpCompareUnboundSockets);

    RtlRedBlackTreeInitialize(
                            &(NewProtocolCopy->SocketTree[SocketLocallyBound]),
                            0,
                            NetpCompareLocallyBoundSockets);

    RtlRedBlackTreeInitialize(&(NewProtocolCopy->SocketTree[SocketFullyBound]),
                              0,
                              NetpCompareFullyBoundSockets);

    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    LockHeld = TRUE;

    //
    // Loop through looking for a previous registration with this protocol type
    // and parent protocol number pair.
    //

    CurrentEntry = NetProtocolList.Next;
    while (CurrentEntry != &NetProtocolList) {
        Protocol = LIST_VALUE(CurrentEntry, NET_PROTOCOL_ENTRY, ListEntry);
        if ((Protocol->Type == NewProtocol->Type) &&
            (Protocol->ParentProtocolNumber ==
             NewProtocol->ParentProtocolNumber)) {

            Status = STATUS_DUPLICATE_ENTRY;
            goto RegisterProtocolEnd;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    //
    // There are no duplicates, add this entry to the back of the list.
    //

    INSERT_BEFORE(&(NewProtocolCopy->ListEntry), &NetProtocolList);

    //
    // Save the common ones for quick access.
    //

    if ((NewProtocolCopy->Type == NetSocketStream) &&
        (NewProtocolCopy->ParentProtocolNumber ==
         SOCKET_INTERNET_PROTOCOL_TCP)) {

        NetTcpProtocolEntry = NewProtocolCopy;

    } else if ((NewProtocolCopy->Type == NetSocketDatagram) &&
               (NewProtocolCopy->ParentProtocolNumber ==
                SOCKET_INTERNET_PROTOCOL_UDP)) {

        NetUdpProtocolEntry = NewProtocolCopy;

    } else if (NewProtocolCopy->Type == NetSocketRaw) {
        NetRawProtocolEntry = NewProtocolCopy;
    }

    Status = STATUS_SUCCESS;
    Handle = NewProtocolCopy;

RegisterProtocolEnd:
    if (LockHeld != FALSE) {
        KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    }

    if (!KSUCCESS(Status)) {
        if (NewProtocolCopy != NULL) {
            NetpDestroyProtocol(NewProtocolCopy);
        }
    }

    if (ProtocolHandle != NULL) {
        *ProtocolHandle = Handle;
    }

    return Status;
}

NET_API
VOID
NetUnregisterProtocol (
    HANDLE ProtocolHandle
    )

/*++

Routine Description:

    This routine unregisters the given protocol from the core networking
    library.

Arguments:

    ProtocolHandle - Supplies the handle to the protocol to unregister.

Return Value:

    None.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_PROTOCOL_ENTRY FoundProtocol;
    PNET_PROTOCOL_ENTRY Protocol;

    FoundProtocol = NULL;

    //
    // Loop through looking for a previous registration with this protocol
    // handle.
    //

    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    CurrentEntry = NetProtocolList.Next;
    while (CurrentEntry != &NetProtocolList) {
        Protocol = LIST_VALUE(CurrentEntry, NET_PROTOCOL_ENTRY, ListEntry);
        if (Protocol == ProtocolHandle) {
            FoundProtocol = Protocol;
            LIST_REMOVE(CurrentEntry);
            break;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    if (FoundProtocol != NULL) {
        NetpDestroyProtocol(FoundProtocol);
    }

    return;
}

NET_API
KSTATUS
NetRegisterNetworkLayer (
    PNET_NETWORK_ENTRY NewNetworkEntry,
    PHANDLE NetworkHandle
    )

/*++

Routine Description:

    This routine registers a new network type with the core networking library.

Arguments:

    NewNetworkEntry - Supplies a pointer to the network information. The core
        library will not reference this memory after the function returns, a
        copy will be made.

    NetworkHandle - Supplies a pointer that receives a handle to the
        registered network layer on success.

Return Value:

    STATUS_SUCCESS on success.

    STATUS_INVALID_PARAMETER if part of the structure isn't filled out
    correctly.

    STATUS_INSUFFICIENT_RESOURCES if memory could not be allocated.

    STATUS_DUPLICATE_ENTRY if the network type is already registered.

--*/

{

    PLIST_ENTRY CurrentEntry;
    HANDLE Handle;
    BOOL LockHeld;
    PNET_NETWORK_ENTRY Network;
    PNET_NETWORK_ENTRY NewNetworkCopy;
    KSTATUS Status;

    ASSERT(KeGetRunLevel() == RunLevelLow);

    LockHeld = FALSE;
    Handle = INVALID_HANDLE;
    NewNetworkCopy = NULL;
    if ((NewNetworkEntry->Domain == NetDomainInvalid) ||
        (NewNetworkEntry->Interface.InitializeLink == NULL) ||
        (NewNetworkEntry->Interface.DestroyLink == NULL) ||
        (NewNetworkEntry->Interface.ProcessReceivedData == NULL)) {

        Status = STATUS_INVALID_PARAMETER;
        goto RegisterNetworkLayerEnd;
    }

    //
    // Networks on which sockets will be created must register with the socket
    // API functions.
    //

    if ((NET_IS_SOCKET_NETWORK_DOMAIN(NewNetworkEntry->Domain) != FALSE) &&
        ((NewNetworkEntry->Interface.InitializeSocket == NULL) ||
         (NewNetworkEntry->Interface.BindToAddress == NULL) ||
         (NewNetworkEntry->Interface.Listen == NULL) ||
         (NewNetworkEntry->Interface.Connect == NULL) ||
         (NewNetworkEntry->Interface.Disconnect == NULL) ||
         (NewNetworkEntry->Interface.Close == NULL) ||
         (NewNetworkEntry->Interface.Send == NULL) ||
         (NewNetworkEntry->Interface.GetSetInformation == NULL))) {

        Status = STATUS_INVALID_PARAMETER;
        goto RegisterNetworkLayerEnd;
    }

    //
    // Create a copy of the new network entry.
    //

    NewNetworkCopy = MmAllocatePagedPool(sizeof(NET_NETWORK_ENTRY),
                                         NET_CORE_ALLOCATION_TAG);

    if (NewNetworkCopy == NULL) {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto RegisterNetworkLayerEnd;
    }

    RtlCopyMemory(NewNetworkCopy, NewNetworkEntry, sizeof(NET_NETWORK_ENTRY));
    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    LockHeld = TRUE;

    //
    // Loop through looking for a previous registration with this network layer
    // number.
    //

    CurrentEntry = NetNetworkList.Next;
    while (CurrentEntry != &NetNetworkList) {
        Network = LIST_VALUE(CurrentEntry, NET_NETWORK_ENTRY, ListEntry);
        if (Network->Domain == NewNetworkEntry->Domain) {
            Status = STATUS_DUPLICATE_ENTRY;
            goto RegisterNetworkLayerEnd;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    //
    // There are no duplicates, add this entry to the back of the list.
    //

    INSERT_BEFORE(&(NewNetworkCopy->ListEntry), &NetNetworkList);

    //
    // Save quick-access pointers for the common ones.
    //

    if (NewNetworkCopy->Domain == NetDomainIp4) {
        NetIp4NetworkEntry = NewNetworkCopy;

    } else if (NewNetworkCopy->Domain == NetDomainIp6) {
        NetIp6NetworkEntry = NewNetworkCopy;

    } else if (NewNetworkCopy->Domain == NetDomainArp) {
        NetArpNetworkEntry = NewNetworkCopy;
    }

    Status = STATUS_SUCCESS;
    Handle = NewNetworkCopy;

RegisterNetworkLayerEnd:
    if (LockHeld != FALSE) {
        KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    }

    if (!KSUCCESS(Status)) {
        if (NewNetworkCopy != NULL) {
            MmFreePagedPool(NewNetworkCopy);
        }
    }

    if (NetworkHandle != NULL) {
        *NetworkHandle = Handle;
    }

    return Status;
}

NET_API
VOID
NetUnregisterNetworkLayer (
    HANDLE NetworkHandle
    )

/*++

Routine Description:

    This routine unregisters the given network layer from the core networking
    library.

Arguments:

    NetworkHandle - Supplies the handle to the network layer to unregister.

Return Value:

    None.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_NETWORK_ENTRY FoundNetwork;
    PNET_NETWORK_ENTRY Network;

    FoundNetwork = NULL;

    //
    // Loop through looking for a previous registration with this network
    // handle.
    //

    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    CurrentEntry = NetNetworkList.Next;
    while (CurrentEntry != &NetNetworkList) {
        Network = LIST_VALUE(CurrentEntry, NET_NETWORK_ENTRY, ListEntry);
        if (Network == NetworkHandle) {
            FoundNetwork = Network;
            LIST_REMOVE(CurrentEntry);
            break;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    if (FoundNetwork != NULL) {
        MmFreePagedPool(FoundNetwork);
    }

    return;
}

NET_API
KSTATUS
NetRegisterDataLinkLayer (
    PNET_DATA_LINK_ENTRY NewDataLinkEntry,
    PHANDLE DataLinkHandle
    )

/*++

Routine Description:

    This routine registers a new data link type with the core networking
    library.

Arguments:

    NewDataLinkEntry - Supplies a pointer to the link information. The core
        library will not reference this memory after the function returns, a
        copy will be made.

    DataLinkHandle - Supplies a pointer that receives a handle to the
        registered data link layer on success.

Return Value:

    STATUS_SUCCESS on success.

    STATUS_INVALID_PARAMETER if part of the structure isn't filled out
    correctly.

    STATUS_INSUFFICIENT_RESOURCES if memory could not be allocated.

    STATUS_DUPLICATE_ENTRY if the link type is already registered.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_DATA_LINK_ENTRY DataLink;
    HANDLE Handle;
    BOOL LockHeld;
    PNET_DATA_LINK_ENTRY NewDataLinkCopy;
    KSTATUS Status;

    ASSERT(KeGetRunLevel() == RunLevelLow);

    LockHeld = FALSE;
    Handle = INVALID_HANDLE;
    NewDataLinkCopy = NULL;
    if ((NewDataLinkEntry->Domain == NetDomainInvalid) ||
        (NewDataLinkEntry->Interface.InitializeLink == NULL) ||
        (NewDataLinkEntry->Interface.DestroyLink == NULL) ||
        (NewDataLinkEntry->Interface.Send == NULL) ||
        (NewDataLinkEntry->Interface.ProcessReceivedPacket == NULL) ||
        (NewDataLinkEntry->Interface.ConvertToPhysicalAddress == NULL) ||
        (NewDataLinkEntry->Interface.GetPacketSizeInformation == NULL)) {

        Status = STATUS_INVALID_PARAMETER;
        goto RegisterDataLinkLayerEnd;
    }

    //
    // Create a copy of the new link entry.
    //

    NewDataLinkCopy = MmAllocatePagedPool(sizeof(NET_DATA_LINK_ENTRY),
                                          NET_CORE_ALLOCATION_TAG);

    if (NewDataLinkCopy == NULL) {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto RegisterDataLinkLayerEnd;
    }

    RtlCopyMemory(NewDataLinkCopy,
                  NewDataLinkEntry,
                  sizeof(NET_DATA_LINK_ENTRY));

    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    LockHeld = TRUE;

    //
    // Loop through looking for a previous registration with this data link
    // type.
    //

    CurrentEntry = NetDataLinkList.Next;
    while (CurrentEntry != &NetDataLinkList) {
        DataLink = LIST_VALUE(CurrentEntry, NET_DATA_LINK_ENTRY, ListEntry);
        if (DataLink->Domain == NewDataLinkEntry->Domain) {
            Status = STATUS_DUPLICATE_ENTRY;
            goto RegisterDataLinkLayerEnd;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    //
    // There are no duplicates, add this entry to the back of the list.
    //

    INSERT_BEFORE(&(NewDataLinkCopy->ListEntry), &NetDataLinkList);
    Status = STATUS_SUCCESS;
    Handle = NewDataLinkCopy;

RegisterDataLinkLayerEnd:
    if (LockHeld != FALSE) {
        KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    }

    if (!KSUCCESS(Status)) {
        if (NewDataLinkCopy != NULL) {
            MmFreePagedPool(NewDataLinkCopy);
        }
    }

    if (DataLinkHandle != NULL) {
        *DataLinkHandle = Handle;
    }

    return Status;
}

NET_API
VOID
NetUnregisterDataLinkLayer (
    HANDLE DataLinkHandle
    )

/*++

Routine Description:

    This routine unregisters the given data link layer from the core networking
    library.

Arguments:

    DataLinkHandle - Supplies the handle to the data link layer to unregister.

Return Value:

    None.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_DATA_LINK_ENTRY DataLink;
    PNET_DATA_LINK_ENTRY FoundDataLink;

    FoundDataLink = NULL;

    //
    // Loop through looking for a previous registration with this data link
    // handle.
    //

    KeAcquireSharedExclusiveLockExclusive(NetPluginListLock);
    CurrentEntry = NetDataLinkList.Next;
    while (CurrentEntry != &NetDataLinkList) {
        DataLink = LIST_VALUE(CurrentEntry, NET_DATA_LINK_ENTRY, ListEntry);
        if (DataLink == DataLinkHandle) {
            FoundDataLink = DataLink;
            LIST_REMOVE(CurrentEntry);
            break;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    KeReleaseSharedExclusiveLockExclusive(NetPluginListLock);
    if (FoundDataLink != NULL) {
        MmFreePagedPool(FoundDataLink);
    }

    return;
}

NET_API
PNET_NETWORK_ENTRY
NetGetNetworkEntry (
    ULONG ParentProtocolNumber
    )

/*++

Routine Description:

    This routine looks up a registered network layer given the parent protocol
    number.

Arguments:

    ParentProtocolNumber - Supplies the parent protocol number of the desired
        network layer.

Return Value:

    Returns a pointer to the network layer entry on success.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_NETWORK_ENTRY NetworkEntry;
    BOOL NetworkFound;
    ULONG NetworkProtocolNumber;

    //
    // Try the common ones first before going heavy by acquiring the lock and
    // looping over the list.
    //

    if (ParentProtocolNumber == IP4_PROTOCOL_NUMBER) {
        NetworkEntry = NetIp4NetworkEntry;

    } else if (ParentProtocolNumber == ARP_PROTOCOL_NUMBER) {
        NetworkEntry = NetArpNetworkEntry;

    } else if (ParentProtocolNumber == IP6_PROTOCOL_NUMBER) {
        NetworkEntry = NetIp6NetworkEntry;

    } else {

        //
        // Search through the list of known network entries.
        //

        NetworkEntry = NULL;
        NetworkFound = FALSE;
        KeAcquireSharedExclusiveLockShared(NetPluginListLock);
        CurrentEntry = NetNetworkList.Next;
        while (CurrentEntry != &NetNetworkList) {
            NetworkEntry = LIST_VALUE(CurrentEntry,
                                      NET_NETWORK_ENTRY,
                                      ListEntry);

            NetworkProtocolNumber = NetworkEntry->ParentProtocolNumber;
            if ((NetworkProtocolNumber != INVALID_PROTOCOL_NUMBER) &&
                (NetworkProtocolNumber == ParentProtocolNumber)) {

                NetworkFound = TRUE;
                break;
            }

            CurrentEntry = CurrentEntry->Next;
        }

        KeReleaseSharedExclusiveLockShared(NetPluginListLock);
        if (NetworkFound == FALSE) {
            return NULL;
        }
    }

    return NetworkEntry;
}

NET_API
PNET_PROTOCOL_ENTRY
NetGetProtocolEntry (
    ULONG ParentProtocolNumber
    )

/*++

Routine Description:

    This routine looks up a registered protocol layer given the parent protocol
    number.

Arguments:

    ParentProtocolNumber - Supplies the parent protocol number of the desired
        protocol layer.

Return Value:

    Returns a pointer to the protocol layer entry on success.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_PROTOCOL_ENTRY ProtocolEntry;
    BOOL ProtocolFound;

    //
    // Try the common ones first before getting heavy with the spin lock.
    //

    if (ParentProtocolNumber == SOCKET_INTERNET_PROTOCOL_TCP) {
        ProtocolEntry = NetTcpProtocolEntry;

    } else if (ParentProtocolNumber == SOCKET_INTERNET_PROTOCOL_UDP) {
        ProtocolEntry = NetUdpProtocolEntry;

    } else if (ParentProtocolNumber == SOCKET_INTERNET_PROTOCOL_RAW) {
        ProtocolEntry = NetRawProtocolEntry;

    } else {

        //
        // Search through the list of known protocols.
        //

        ProtocolEntry = NULL;
        ProtocolFound = FALSE;
        KeAcquireSharedExclusiveLockShared(NetPluginListLock);
        CurrentEntry = NetProtocolList.Next;
        while (CurrentEntry != &NetProtocolList) {
            ProtocolEntry = LIST_VALUE(CurrentEntry,
                                       NET_PROTOCOL_ENTRY,
                                       ListEntry);

            if (ProtocolEntry->ParentProtocolNumber == ParentProtocolNumber) {
                ProtocolFound = TRUE;
                break;
            }

            CurrentEntry = CurrentEntry->Next;
        }

        KeReleaseSharedExclusiveLockShared(NetPluginListLock);
        if (ProtocolFound == FALSE) {
            return NULL;
        }
    }

    return ProtocolEntry;
}

NET_API
VOID
NetProcessReceivedPacket (
    PNET_LINK Link,
    PNET_PACKET_BUFFER Packet
    )

/*++

Routine Description:

    This routine is called by the low level NIC driver to pass received packets
    onto the core networking library for dispatching.

Arguments:

    Link - Supplies a pointer to the link that received the packet.

    Packet - Supplies a pointer to a structure describing the incoming packet.
        This structure may be used as a scratch space while this routine
        executes and the packet travels up the stack, but will not be accessed
        after this routine returns.

Return Value:

    None. When the function returns, the memory associated with the packet may
    be reclaimed and reused.

--*/

{

    //
    // Call the data link layer to process the packet.
    //

    Link->DataLinkEntry->Interface.ProcessReceivedPacket(Link->DataLinkContext,
                                                         Packet);

    return;
}

NET_API
BOOL
NetGetGlobalDebugFlag (
    VOID
    )

/*++

Routine Description:

    This routine returns the current value of the global networking debug flag.

Arguments:

    None.

Return Value:

    TRUE if debug information should be collected throughout the networking
    subsystem.

    FALSE if verbose debug information should be suppressed globally.

--*/

{

    return NetGlobalDebug;
}

NET_API
VOID
NetDebugPrintAddress (
    PNETWORK_ADDRESS Address
    )

/*++

Routine Description:

    This routine prints the given address to the debug console.

Arguments:

    Address - Supplies a pointer to the address to print.

Return Value:

    None.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_DATA_LINK_ENTRY DataLinkEntry;
    ULONG Length;
    PNET_NETWORK_ENTRY NetworkEntry;
    CHAR StringBuffer[NET_PRINT_ADDRESS_STRING_LENGTH];

    if (Address == NULL) {
        RtlDebugPrint("(NullNetworkAddress)");
        return;
    }

    StringBuffer[0] = '\0';

    //
    // If the address is a physical one, find the data link layer and print the
    // string.
    //

    KeAcquireSharedExclusiveLockShared(NetPluginListLock);
    if (NET_IS_PHYSICAL_DOMAIN(Address->Domain) != FALSE) {
        CurrentEntry = NetDataLinkList.Next;
        while (CurrentEntry != &NetDataLinkList) {
            DataLinkEntry = LIST_VALUE(CurrentEntry,
                                       NET_DATA_LINK_ENTRY,
                                       ListEntry);

            if (DataLinkEntry->Domain == Address->Domain) {
                if (DataLinkEntry->Interface.PrintAddress != NULL) {
                    Length = DataLinkEntry->Interface.PrintAddress(
                                              Address,
                                              StringBuffer,
                                              NET_PRINT_ADDRESS_STRING_LENGTH);

                    ASSERT(Length <= NET_PRINT_ADDRESS_STRING_LENGTH);
                }

                break;
            }

            CurrentEntry = CurrentEntry->Next;
        }

    //
    // Otherwise, find the network layer and print this string.
    //

    } else {
        CurrentEntry = NetNetworkList.Next;
        while (CurrentEntry != &NetNetworkList) {
            NetworkEntry = LIST_VALUE(CurrentEntry,
                                      NET_NETWORK_ENTRY,
                                      ListEntry);

            if (NetworkEntry->Domain == Address->Domain) {
                if (NetworkEntry->Interface.PrintAddress != NULL) {
                    Length = NetworkEntry->Interface.PrintAddress(
                                              Address,
                                              StringBuffer,
                                              NET_PRINT_ADDRESS_STRING_LENGTH);

                    ASSERT(Length <= NET_PRINT_ADDRESS_STRING_LENGTH);
                }

                break;
            }

            CurrentEntry = CurrentEntry->Next;
        }
    }

    KeReleaseSharedExclusiveLockShared(NetPluginListLock);
    StringBuffer[NET_PRINT_ADDRESS_STRING_LENGTH - 1] = '\0';
    RtlDebugPrint("%s", StringBuffer);
    return;
}

KSTATUS
NetCreateSocket (
    NET_DOMAIN_TYPE Domain,
    NET_SOCKET_TYPE Type,
    ULONG Protocol,
    PSOCKET *NewSocket
    )

/*++

Routine Description:

    This routine allocates resources associated with a new socket. The core
    networking driver is responsible for allocating the structure (with
    additional length for any of its context). The kernel will fill in the
    common header when this routine returns.

Arguments:

    Domain - Supplies the network domain to use on the socket.

    Type - Supplies the socket connection type.

    Protocol - Supplies the raw protocol value for this socket used on the
        network. This value is network specific.

    NewSocket - Supplies a pointer where a pointer to a newly allocated
        socket structure will be returned. The caller is responsible for
        allocating the socket (and potentially a larger structure for its own
        context). The kernel will fill in the standard socket structure after
        this routine returns.

Return Value:

    Status code.

--*/

{

    PLIST_ENTRY CurrentEntry;
    PNET_NETWORK_ENTRY NetworkEntry;
    BOOL NetworkFound;
    PNET_PROTOCOL_ENTRY ProtocolEntry;
    ULONG ProtocolFlags;
    BOOL ProtocolFound;
    PNET_SOCKET Socket;
    KSTATUS Status;

    Socket = NULL;
    NetworkEntry = NULL;
    ProtocolEntry = NULL;
    ProtocolFlags = 0;

    //
    // If the domain is not within the bounds of the socket portion of the
    // net domain namespace, error out immediately.
    //

    if (NET_IS_SOCKET_NETWORK_DOMAIN(Domain) == FALSE) {
        Status = STATUS_DOMAIN_NOT_SUPPORTED;
        goto CreateSocketEnd;
    }

    //
    // Attempt to find a handler for this protocol and network. Make sure that
    // the supplied network protocol matches the found protocol entry's parent
    // protocol. If not, then it's a protocol for a different network. Skip
    // this check if the protocol entry specifies that it will match any given
    // protocol value.
    //

    ProtocolFound = FALSE;
    NetworkFound = FALSE;
    KeAcquireSharedExclusiveLockShared(NetPluginListLock);
    CurrentEntry = NetProtocolList.Next;
    while (CurrentEntry != &NetProtocolList) {
        ProtocolEntry = LIST_VALUE(CurrentEntry, NET_PROTOCOL_ENTRY, ListEntry);
        CurrentEntry = CurrentEntry->Next;
        if (ProtocolEntry->Type != Type) {
            continue;
        }

        ProtocolFlags = ProtocolEntry->Flags;
        if ((Protocol != 0) &&
            ((ProtocolFlags & NET_PROTOCOL_FLAG_MATCH_ANY_PROTOCOL) == 0) &&
            (ProtocolEntry->ParentProtocolNumber != Protocol)) {

            continue;
        }

        ProtocolFound = TRUE;
        break;
    }

    CurrentEntry = NetNetworkList.Next;
    while (CurrentEntry != &NetNetworkList) {
        NetworkEntry = LIST_VALUE(CurrentEntry, NET_NETWORK_ENTRY, ListEntry);
        if (NetworkEntry->Domain == Domain) {
            NetworkFound = TRUE;
            break;
        }

        CurrentEntry = CurrentEntry->Next;
    }

    KeReleaseSharedExclusiveLockShared(NetPluginListLock);
    if (NetworkFound == FALSE) {
        Status = STATUS_DOMAIN_NOT_SUPPORTED;
        goto CreateSocketEnd;
    }

    if (ProtocolFound == FALSE) {
        Status = STATUS_PROTOCOL_NOT_SUPPORTED;
        goto CreateSocketEnd;
    }

    //
    // A supplied protocol value of 0 typically indicates that the default
    // protocol value should be set. There are some protocol entries, however,
    // that may actually want 0 to be supplied to socket creation.
    //

    if ((Protocol == 0) &&
        ((ProtocolFlags & NET_PROTOCOL_FLAG_NO_DEFAULT_PROTOCOL) == 0)) {

        Protocol = ProtocolEntry->ParentProtocolNumber;
    }

    //
    // Call the protocol to create the socket.
    //

    Status = ProtocolEntry->Interface.CreateSocket(ProtocolEntry,
                                                   NetworkEntry,
                                                   Protocol,
                                                   &Socket,
                                                   0);

    if (!KSUCCESS(Status)) {
        goto CreateSocketEnd;
    }

    //
    // Initialize core networking common parameters.
    //

    Socket->Protocol = ProtocolEntry;
    Socket->Network = NetworkEntry;
    Socket->BindingType = SocketBindingInvalid;
    Socket->LastError = STATUS_SUCCESS;
    RtlCopyMemory(&(Socket->UnboundPacketSizeInformation),
                  &(Socket->PacketSizeInformation),
                  sizeof(NET_PACKET_SIZE_INFORMATION));

    //
    // Allow the protocol a chance to do more work now that the socket is
    // initialized by netcore.
    //

    Status = ProtocolEntry->Interface.CreateSocket(ProtocolEntry,
                                                   NetworkEntry,
                                                   Protocol,
                                                   &Socket,
                                                   1);

    if (!KSUCCESS(Status)) {
        goto CreateSocketEnd;
    }

CreateSocketEnd:
    if (!KSUCCESS(Status)) {
        if (Socket != NULL) {
            ProtocolEntry->Interface.Close(Socket);
            Socket = NULL;
        }
    }

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Create socket (%d, %d, %d): 0x%x: %d\n",
                      Domain,
                      Type,
                      Protocol,
                      Socket,
                      Status);
    }

    *NewSocket = (PSOCKET)Socket;
    return Status;
}

VOID
NetDestroySocket (
    PSOCKET Socket
    )

/*++

Routine Description:

    This routine destroys resources associated with an open socket, officially
    marking the end of the kernel's knowledge of this structure. It is called
    automatically when a socket's reference count drops to zero.

Arguments:

    Socket - Supplies a pointer to the socket to destroy. The kernel will have
        already destroyed any resources inside the common header, the core
        networking library should not reach through any pointers inside the
        socket header.

Return Value:

    None. This routine is responsible for freeing the memory associated with
    the socket structure itself.

--*/

{

    PNET_SOCKET NetSocket;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Destroy socket 0x%x\n", NetSocket);
    }

    if (NetSocket->RemoteTranslation != NULL) {
        NetTranslationEntryReleaseReference(NetSocket->RemoteTranslation);
    }

    if (NetSocket->Link != NULL) {
        NetLinkReleaseReference(NetSocket->Link);
        NetSocket->Link = NULL;
    }

    NetSocket->Protocol->Interface.DestroySocket(NetSocket);
    return;
}

KSTATUS
NetBindToAddress (
    PSOCKET Socket,
    PVOID Link,
    PNETWORK_ADDRESS Address
    )

/*++

Routine Description:

    This routine binds the socket to the given address and starts listening for
    client requests.

Arguments:

    Socket - Supplies a pointer to the socket to bind.

    Link - Supplies an optional pointer to a link to bind to.

    Address - Supplies a pointer to the address to bind the socket to.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    ULONG ProtocolFlags;
    KSTATUS Status;

    //
    // If the port is non-zero and less than or equal to the maximum port that
    // requires a permission check, make sure the thread as the right
    // privilege. Some protocols do not have this generic port restriction and
    // can opt out of the check.
    //

    NetSocket = (PNET_SOCKET)Socket;
    ProtocolFlags = NetSocket->Protocol->Flags;
    if ((Address->Port != 0) &&
        (Address->Port <= NET_PORT_PERMISSIONS_MAX) &&
        (ProtocolFlags & NET_PROTOCOL_FLAG_NO_BIND_PERMISSIONS) == 0) {

        Status = PsCheckPermission(PERMISSION_NET_BIND);
        if (!KSUCCESS(Status)) {
            goto BindToAddressEnd;
        }
    }

    //
    // The address's domain must match the socket's domain.
    //

    if (Address->Domain != Socket->Domain) {
        Status = STATUS_DOMAIN_NOT_SUPPORTED;
        goto BindToAddressEnd;
    }

    Status = NetSocket->Protocol->Interface.BindToAddress(NetSocket,
                                                          Link,
                                                          Address);

    if (!KSUCCESS(Status)) {
        goto BindToAddressEnd;
    }

    Status = STATUS_SUCCESS;

BindToAddressEnd:
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Bind socket 0x%x to ", NetSocket);
        NetDebugPrintAddress(Address);
        RtlDebugPrint(" on link 0x%08x: %d.\n", Link, Status);
    }

    return Status;
}

KSTATUS
NetListen (
    PSOCKET Socket,
    ULONG BacklogCount
    )

/*++

Routine Description:

    This routine adds a bound socket to the list of listening sockets,
    officially allowing sockets to attempt to connect to it.

Arguments:

    Socket - Supplies a pointer to the socket to mark as listening.

    BacklogCount - Supplies the number of attempted connections that can be
        queued before additional connections are refused.

Return Value:

    Status code.

--*/

{

    NETWORK_ADDRESS LocalAddress;
    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if ((BacklogCount == 0) || (BacklogCount > NET_MAX_INCOMING_CONNECTIONS)) {
        BacklogCount = NET_MAX_INCOMING_CONNECTIONS;
    }

    NetSocket->MaxIncomingConnections = BacklogCount;

    //
    // If the socket is not yet bound, bind it to any address and a random
    // port.
    //

    if (NetSocket->BindingType == SocketBindingInvalid) {
        RtlZeroMemory(&LocalAddress, sizeof(NETWORK_ADDRESS));
        LocalAddress.Domain = NetSocket->Network->Domain;
        Status = NetBindToAddress(Socket, NULL, &LocalAddress);
        if (!KSUCCESS(Status)) {
            if (NetGlobalDebug != FALSE) {
                RtlDebugPrint("Net: Socket 0x%x implicit bind in listen "
                              "failed: %d\n",
                              NetSocket,
                              Status);
            }

            return Status;
        }
    }

    Status = NetSocket->Protocol->Interface.Listen(NetSocket);
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Socket 0x%x listen %d: %d\n",
                      NetSocket,
                      BacklogCount,
                      Status);
    }

    return Status;
}

KSTATUS
NetAccept (
    PSOCKET Socket,
    PIO_HANDLE *NewConnectionSocket,
    PNETWORK_ADDRESS RemoteAddress
    )

/*++

Routine Description:

    This routine accepts an incoming connection on a listening connection-based
    socket.

Arguments:

    Socket - Supplies a pointer to the socket to accept a connection from.

    NewConnectionSocket - Supplies a pointer where a new socket will be
        returned that represents the accepted connection with the remote
        host.

    RemoteAddress - Supplies a pointer where the address of the connected
        remote host will be returned.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Socket 0x%x accept...\n", NetSocket);
    }

    Status = NetSocket->Protocol->Interface.Accept(NetSocket,
                                                   NewConnectionSocket,
                                                   RemoteAddress);

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Socket 0x%x accepted ", NetSocket);
        if (RemoteAddress != NULL) {
            NetDebugPrintAddress(RemoteAddress);
        }

        RtlDebugPrint("\n");
    }

    return Status;
}

KSTATUS
NetConnect (
    PSOCKET Socket,
    PNETWORK_ADDRESS Address
    )

/*++

Routine Description:

    This routine attempts to make an outgoing connection to a server.

Arguments:

    Socket - Supplies a pointer to the socket to use for the connection.

    Address - Supplies a pointer to the address to connect to.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Connecting socket 0x%x to ", NetSocket);
        NetDebugPrintAddress(Address);
        RtlDebugPrint("...\n");
    }

    //
    // The remote connection address's domain must match the socket's domain.
    //

    if (Address->Domain == Socket->Domain) {
        Status = NetSocket->Protocol->Interface.Connect(NetSocket, Address);

    } else {
        Status = STATUS_DOMAIN_NOT_SUPPORTED;
    }

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Connect socket 0x%x to ", NetSocket);
        NetDebugPrintAddress(Address);
        RtlDebugPrint(" : %d\n", Status);
    }

    return Status;
}

KSTATUS
NetCloseSocket (
    PSOCKET Socket
    )

/*++

Routine Description:

    This routine closes a socket connection.

Arguments:

    Socket - Supplies a pointer to the socket to shut down.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Close 0x%x\n", NetSocket);
    }

    return NetSocket->Protocol->Interface.Close(NetSocket);
}

KSTATUS
NetSendData (
    BOOL FromKernelMode,
    PSOCKET Socket,
    PSOCKET_IO_PARAMETERS Parameters,
    PIO_BUFFER IoBuffer
    )

/*++

Routine Description:

    This routine sends the given data buffer through the network.

Arguments:

    FromKernelMode - Supplies a boolean indicating whether the request is
        coming from kernel mode (TRUE) or user mode (FALSE).

    Socket - Supplies a pointer to the socket to send the data to.

    Parameters - Supplies a pointer to the socket I/O parameters. This will
        always be a kernel mode pointer.

    IoBuffer - Supplies a pointer to the I/O buffer containing the data to
        send.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Sending %ld on socket 0x%x...\n",
                      Parameters->Size,
                      NetSocket);
    }

    Status = NetSocket->Protocol->Interface.Send(FromKernelMode,
                                                 NetSocket,
                                                 Parameters,
                                                 IoBuffer);

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Sent %ld on socket 0x%x: %d.\n",
                      Parameters->BytesCompleted,
                      NetSocket,
                      Status);
    }

    return Status;
}

KSTATUS
NetReceiveData (
    BOOL FromKernelMode,
    PSOCKET Socket,
    PSOCKET_IO_PARAMETERS Parameters,
    PIO_BUFFER IoBuffer
    )

/*++

Routine Description:

    This routine is called by the user to receive data from the socket.

Arguments:

    FromKernelMode - Supplies a boolean indicating whether the request is
        coming from kernel mode (TRUE) or user mode (FALSE).

    Socket - Supplies a pointer to the socket to receive data from.

    Parameters - Supplies a pointer to the socket I/O parameters.

    IoBuffer - Supplies a pointer to the I/O buffer where the received data
        will be returned.

Return Value:

    STATUS_SUCCESS if any bytes were read.

    STATUS_TIMEOUT if the request timed out.

    STATUS_BUFFER_TOO_SMALL if the incoming datagram was too large for the
        buffer. The remainder of the datagram is discarded in this case.

    Other error codes on other failures.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Receiving %ld on socket 0x%x...\n",
                      Parameters->Size,
                      NetSocket);
    }

    Status = NetSocket->Protocol->Interface.Receive(FromKernelMode,
                                                    NetSocket,
                                                    Parameters,
                                                    IoBuffer);

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Received %ld on socket 0x%x: %d.\n",
                      Parameters->BytesCompleted,
                      NetSocket,
                      Status);
    }

    return Status;
}

KSTATUS
NetGetSetSocketInformation (
    PSOCKET Socket,
    SOCKET_INFORMATION_TYPE InformationType,
    UINTN Option,
    PVOID Data,
    PUINTN DataSize,
    BOOL Set
    )

/*++

Routine Description:

    This routine returns information about the given socket.

Arguments:

    Socket - Supplies a pointer to the socket to get or set information for.

    InformationType - Supplies the socket information type category to which
        specified option belongs.

    Option - Supplies the option to get or set, which is specific to the
        information type. The type of this value is generally
        SOCKET_<information_type>_OPTION.

    Data - Supplies a pointer to the data buffer where the data is either
        returned for a get operation or given for a set operation.

    DataSize - Supplies a pointer that on input constains the size of the data
        buffer. On output, this contains the required size of the data buffer.

    Set - Supplies a boolean indicating if this is a get operation (FALSE) or
        a set operation (TRUE).

Return Value:

    STATUS_SUCCESS on success.

    STATUS_INVALID_PARAMETER if the information type is incorrect.

    STATUS_BUFFER_TOO_SMALL if the data buffer is too small to receive the
        requested option.

    STATUS_NOT_SUPPORTED_BY_PROTOCOL if the socket option is not supported by
        the socket.

--*/

{

    NETWORK_ADDRESS Address;
    SOCKET_BASIC_OPTION BasicOption;
    ULONG BooleanOption;
    ULONG Count;
    KSTATUS ErrorOption;
    ULONG Flags;
    ULONG Index;
    PNET_SOCKET NetSocket;
    PNET_PROTOCOL_ENTRY Protocol;
    PNET_SOCKET_OPTION SocketOption;
    SOCKET_TIME SocketTime;
    PVOID Source;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    Protocol = NetSocket->Protocol;
    Status = STATUS_SUCCESS;

    //
    // If the requested option is something that this layer can answer, then
    // answer it.
    //

    switch (InformationType) {
    case SocketInformationBasic:

        //
        // Send the call down to the protocol layer, which can override a basic
        // option's default behavior. If the not handled status is returned,
        // then the protocol did not override the default behavior.
        //

        Status = NetSocket->Protocol->Interface.GetSetInformation(
                                                           NetSocket,
                                                           InformationType,
                                                           Option,
                                                           Data,
                                                           DataSize,
                                                           Set);

        if (Status != STATUS_NOT_HANDLED) {
            goto GetSetSocketInformationEnd;
        }

        //
        // Search to see if there is a default behavior for the socket option.
        //

        Count = sizeof(NetBasicSocketOptions) /
                sizeof(NetBasicSocketOptions[0]);

        for (Index = 0; Index < Count; Index += 1) {
            SocketOption = &(NetBasicSocketOptions[Index]);
            if ((SocketOption->InformationType == InformationType) &&
                (SocketOption->Option == Option)) {

                break;
            }
        }

        if (Index == Count) {
            Status = STATUS_NOT_SUPPORTED_BY_PROTOCOL;
            goto GetSetSocketInformationEnd;
        }

        //
        // Handle failure cases common to all options.
        //

        if (Set != FALSE) {
            if (SocketOption->SetAllowed == FALSE) {
                Status = STATUS_NOT_SUPPORTED_BY_PROTOCOL;
                goto GetSetSocketInformationEnd;
            }

            if (*DataSize < SocketOption->Size) {
                *DataSize = SocketOption->Size;
                Status = STATUS_BUFFER_TOO_SMALL;
                goto GetSetSocketInformationEnd;
            }
        }

        //
        // Truncate all copies for get requests down to the required size and
        // only return the required size on set requests.
        //

        if (*DataSize > SocketOption->Size) {
            *DataSize = SocketOption->Size;
        }

        Source = NULL;
        Status = STATUS_SUCCESS;
        BasicOption = (SOCKET_BASIC_OPTION)Option;
        switch (BasicOption) {
        case SocketBasicOptionType:

            ASSERT(Set == FALSE);

            Source = &(Socket->Type);
            break;

        case SocketBasicOptionDomain:

            ASSERT(Set == FALSE);

            Source = &(Socket->Domain);
            break;

        case SocketBasicOptionLocalAddress:
        case SocketBasicOptionRemoteAddress:

            ASSERT(Set == FALSE);

            //
            // Socket addresses are synchronized on the protocol's socket tree.
            // Acquire the lock to not return a torn address.
            //

            KeAcquireSharedExclusiveLockShared(Protocol->SocketLock);
            if (BasicOption == SocketBasicOptionLocalAddress) {
                RtlCopyMemory(&Address,
                              &(NetSocket->LocalReceiveAddress),
                              sizeof(NETWORK_ADDRESS));

                //
                // Even if the local address is not yet initialized, return the
                // any address and any port on the correct network.
                //

                if (Address.Domain == NetDomainInvalid) {
                    Address.Domain = NetSocket->KernelSocket.Domain;
                }

                RtlCopyMemory(Data, &Address, *DataSize);

            } else {

                ASSERT(BasicOption == SocketBasicOptionRemoteAddress);

                //
                // Fail if there is not a valid remote address.
                //

                if (NetSocket->RemoteAddress.Domain == NetDomainInvalid) {
                    Status = STATUS_NOT_CONNECTED;

                } else {
                    RtlCopyMemory(Data, &(NetSocket->RemoteAddress), *DataSize);
                }
            }

            KeReleaseSharedExclusiveLockShared(Protocol->SocketLock);
            break;

        case SocketBasicOptionReuseAnyAddress:
        case SocketBasicOptionReuseTimeWait:
        case SocketBasicOptionReuseExactAddress:
        case SocketBasicOptionBroadcastEnabled:
            if (BasicOption == SocketBasicOptionReuseAnyAddress) {
                Flags = NET_SOCKET_FLAG_REUSE_ANY_ADDRESS |
                        NET_SOCKET_FLAG_REUSE_TIME_WAIT;

            } else if (BasicOption == SocketBasicOptionReuseTimeWait) {
                Flags = NET_SOCKET_FLAG_REUSE_TIME_WAIT;

            } else if (BasicOption == SocketBasicOptionReuseExactAddress) {
                Flags = NET_SOCKET_FLAG_REUSE_EXACT_ADDRESS;

            } else {

                ASSERT(BasicOption == SocketBasicOptionBroadcastEnabled);

                Flags = NET_SOCKET_FLAG_BROADCAST_ENABLED;
            }

            if (Set != FALSE) {
                if (*((PULONG)Data) != FALSE) {
                    RtlAtomicOr32(&(NetSocket->Flags), Flags);

                } else {
                    RtlAtomicAnd32(&(NetSocket->Flags), ~Flags);
                }

            } else {
                Source = &BooleanOption;
                BooleanOption = FALSE;
                if ((NetSocket->Flags & Flags) == Flags) {
                    BooleanOption = TRUE;
                }
            }

            break;

        case SocketBasicOptionErrorStatus:

            ASSERT(Set == FALSE);
            ASSERT(sizeof(KSTATUS) == sizeof(ULONG));

            ErrorOption = NET_SOCKET_GET_AND_CLEAR_LAST_ERROR(NetSocket);
            Source = &ErrorOption;
            break;

        case SocketBasicOptionAcceptConnections:

            ASSERT(Set == FALSE);

            Source = &BooleanOption;
            BooleanOption = FALSE;
            break;

        case SocketBasicOptionSendTimeout:

            ASSERT(Set == FALSE);

            //
            // The indefinite wait time is represented as 0 time for the
            // SOCKET_TIME structure.
            //

            SocketTime.Seconds = 0;
            SocketTime.Microseconds = 0;
            Source = &SocketTime;
            break;

        case SocketBasicOptionDebug:

            //
            // Administrator priveleges are required to change the debug
            // option.
            //

            if (Set != FALSE) {
                Status = PsCheckPermission(PERMISSION_NET_ADMINISTRATOR);
                if (!KSUCCESS(Status)) {
                    break;
                }
            }

        case SocketBasicOptionInlineOutOfBand:
        case SocketBasicOptionRoutingDisabled:

            //
            // TODO: Implement network routing and urgent messages.
            //

        default:

            ASSERT(FALSE);

            Status = STATUS_NOT_SUPPORTED_BY_PROTOCOL;
            break;
        }

        if (!KSUCCESS(Status)) {
            break;
        }

        //
        // For get requests, copy the gathered information to the supplied data
        // buffer.
        //

        if (Set == FALSE) {
            if (Source != NULL) {
                RtlCopyMemory(Data, Source, *DataSize);
            }

            //
            // If the copy truncated the data, report that the given buffer was
            // too small. The caller can choose to ignore this if the truncated
            // data is enough.
            //

            if (*DataSize < SocketOption->Size) {
                *DataSize = SocketOption->Size;
                Status = STATUS_BUFFER_TOO_SMALL;
            }
        }

        break;

    //
    // IPv4 and IPv6 socket information is handled at the network layer.
    //

    case SocketInformationIp4:
    case SocketInformationIp6:
    case SocketInformationNetlink:
        Status = NetSocket->Network->Interface.GetSetInformation(
                                                               NetSocket,
                                                               InformationType,
                                                               Option,
                                                               Data,
                                                               DataSize,
                                                               Set);

        if (!KSUCCESS(Status)) {
            goto GetSetSocketInformationEnd;
        }

        break;

    //
    // TCP and UDP socket information is handled at the protocol layer.
    //

    case SocketInformationTcp:
    case SocketInformationUdp:
    case SocketInformationNetlinkGeneric:
        Status = NetSocket->Protocol->Interface.GetSetInformation(
                                                               NetSocket,
                                                               InformationType,
                                                               Option,
                                                               Data,
                                                               DataSize,
                                                               Set);

        if (!KSUCCESS(Status)) {
            goto GetSetSocketInformationEnd;
        }

        break;

    default:
        Status = STATUS_INVALID_PARAMETER;
        break;
    }

GetSetSocketInformationEnd:
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: GetSetSocketInformation on socket 0x%x: %d.\n",
                      NetSocket,
                      Status);
    }

    return Status;
}

KSTATUS
NetShutdown (
    PSOCKET Socket,
    ULONG ShutdownType
    )

/*++

Routine Description:

    This routine shuts down communication with a given socket.

Arguments:

    Socket - Supplies a pointer to the socket.

    ShutdownType - Supplies the shutdown type to perform. See the
        SOCKET_SHUTDOWN_* definitions.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Shutdown socket 0x%x, %d...\n",
                      NetSocket,
                      ShutdownType);
    }

    Status = NetSocket->Protocol->Interface.Shutdown(NetSocket, ShutdownType);
    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: Shutdown socket 0x%x, %d: %d\n",
                      NetSocket,
                      ShutdownType,
                      Status);
    }

    return Status;
}

KSTATUS
NetUserControl (
    PSOCKET Socket,
    ULONG CodeNumber,
    BOOL FromKernelMode,
    PVOID ContextBuffer,
    UINTN ContextBufferSize
    )

/*++

Routine Description:

    This routine handles user control requests destined for a socket.

Arguments:

    Socket - Supplies a pointer to the socket.

    CodeNumber - Supplies the minor code of the request.

    FromKernelMode - Supplies a boolean indicating whether or not this request
        (and the buffer associated with it) originates from user mode (FALSE)
        or kernel mode (TRUE).

    ContextBuffer - Supplies a pointer to the context buffer allocated by the
        caller for the request.

    ContextBufferSize - Supplies the size of the supplied context buffer.

Return Value:

    Status code.

--*/

{

    PNET_SOCKET NetSocket;
    KSTATUS Status;

    NetSocket = (PNET_SOCKET)Socket;
    Status = NetSocket->Protocol->Interface.UserControl(NetSocket,
                                                        CodeNumber,
                                                        FromKernelMode,
                                                        ContextBuffer,
                                                        ContextBufferSize);

    if (NetGlobalDebug != FALSE) {
        RtlDebugPrint("Net: UserControl socket 0x%x, %d: %d\n",
                      NetSocket,
                      CodeNumber,
                      Status);
    }

    return Status;
}

//
// --------------------------------------------------------- Internal Functions
//

VOID
NetpDestroyProtocol (
    PNET_PROTOCOL_ENTRY Protocol
    )

/*++

Routine Description:

    This routine destroys the given protocol and all its resources.

Arguments:

    Protocol - Supplies a pointer to the protocol to destroy.

Return Value:

    None.

--*/

{

    if (Protocol->SocketLock != NULL) {
        KeDestroySharedExclusiveLock(Protocol->SocketLock);
    }

    MmFreePagedPool(Protocol);
    return;
}