VBoxNetFlt.c revision 600ca2b7e602079abfd45de5979a4c9352c54e2e
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * VBoxNetFlt - Network Filter Driver (Host), Common Code.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Copyright (C) 2008-2009 Oracle Corporation
c74832c7184337c330041742d88e6dacaa07b378vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * available from http://www.virtualbox.org. This file is free software;
c74832c7184337c330041742d88e6dacaa07b378vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c74832c7184337c330041742d88e6dacaa07b378vboxsync * General Public License (GPL) as published by the Free Software
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync/** @page pg_netflt VBoxNetFlt - Network Interface Filter
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * This is a kernel module that attaches to a real interface on the host and
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * filters and injects packets.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * In the big picture we're one of the three trunk interface on the internal
c74832c7184337c330041742d88e6dacaa07b378vboxsync * network, the one named "NIC Filter Driver": @image html Networking_Overview.gif
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @section sec_netflt_locking Locking and Potential Races
da957c069c2a3c582fe265ff88170ce4c42b499dvboxsync * The main challenge here is to make sure the netfilter and internal network
c74832c7184337c330041742d88e6dacaa07b378vboxsync * instances won't be destroyed while someone is calling into them.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * The main calls into or out of of the filter driver are:
c74832c7184337c330041742d88e6dacaa07b378vboxsync * - Async send completion (not implemented yet)
c74832c7184337c330041742d88e6dacaa07b378vboxsync * - Release by the internal network.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * - Receive.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * - Disappearance of the host networking interface.
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * - Reappearance of the host networking interface.
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * The latter two calls are can be caused by driver unloading/loading or the
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * device being physical unplugged (e.g. a USB network device). Actually, the
c74832c7184337c330041742d88e6dacaa07b378vboxsync * unload scenario must fervently be prevent as it will cause panics because the
c74832c7184337c330041742d88e6dacaa07b378vboxsync * internal network will assume the trunk is around until it releases it.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @todo Need to figure which host allow unloading and block/fix it.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Currently the netfilter instance lives until the internal network releases
c74832c7184337c330041742d88e6dacaa07b378vboxsync * it. So, it is the internal networks responsibility to make sure there are no
c74832c7184337c330041742d88e6dacaa07b378vboxsync * active calls when it releases the trunk and destroys the network. The
c74832c7184337c330041742d88e6dacaa07b378vboxsync * netfilter assists in this by providing INTNETTRUNKIFPORT::pfnSetState and
c74832c7184337c330041742d88e6dacaa07b378vboxsync * INTNETTRUNKIFPORT::pfnWaitForIdle. The trunk state is used to enable/disable
c74832c7184337c330041742d88e6dacaa07b378vboxsync * promiscuous mode on the hardware NIC (or similar activation) as well
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * indicating that disconnect is imminent and no further calls shall be made
c74832c7184337c330041742d88e6dacaa07b378vboxsync * into the internal network. After changing the state to disconnecting and
c74832c7184337c330041742d88e6dacaa07b378vboxsync * prior to invoking INTNETTRUNKIFPORT::pfnDisconnectAndRelease, the internal
c74832c7184337c330041742d88e6dacaa07b378vboxsync * network will use INTNETTRUNKIFPORT::pfnWaitForIdle to wait for any still
c74832c7184337c330041742d88e6dacaa07b378vboxsync * active calls to complete.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * The netfilter employs a busy counter and an internal state in addition to the
c74832c7184337c330041742d88e6dacaa07b378vboxsync * public trunk state. All these variables are protected using a spinlock.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @section sec_netflt_msc Locking / Sequence Diagrams - OBSOLETE
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * !OBSOLETE! - THIS WAS THE OLD APPROACH!
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * This secion contains a few sequence diagrams describing the problematic
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * transitions of a host interface filter instance.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * The thing that makes it all a bit problematic is that multiple events may
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * happen at the same time, and that we have to be very careful to avoid
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * deadlocks caused by mixing our locks with the ones in the host kernel. The
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * main events are receive, send, async send completion, disappearance of the
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * host networking interface and its reappearance. The latter two events are
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * can be caused by driver unloading/loading or the device being physical
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * unplugged (e.g. a USB network device).
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * The strategy for dealing with these issues are:
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * - Use a simple state machine.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * - Require the user (IntNet) to serialize all its calls to us,
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * while at the same time not owning any lock used by any of the
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * the callbacks we might call on receive and async send completion.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * - Make sure we're 100% idle before disconnecting, and have a
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * disconnected status on both sides to fend off async calls.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * - Protect the host specific interface handle and the state variables
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * using a spinlock.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @subsection subsec_netflt_msc_dis_rel Disconnect from the network and release - OBSOLETE
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * VM, IntNet, NetFlt, Kernel, Wire;
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * VM->IntNet [label="pkt0", linecolor="green", textcolor="green"];
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * IntNet=>IntNet [label="Lock Network", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Route packet -> wire", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>NetFlt [label="pkt0 to wire", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="pkt0 to wire", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Kernel->Wire [label="pkt0 to wire", linecolor="green", textcolor="green"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * --- [label="Suspending the trunk interface"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * IntNet=>IntNet [label="Lock Network"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Wire->Kernel [label="pkt1 - racing us", linecolor="red", textcolor="red"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Kernel=>>NetFlt [label="pkt1 - racing us", linecolor="red", textcolor="red"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * NetFlt=>>IntNet [label="pkt1 recv - blocks", linecolor="red", textcolor="red"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * IntNet=>IntNet [label="Mark Trunk Suspended"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>NetFlt [label="pfnSetActive(false)"];
0c34933fc8f84dd5183d1897881bbc7683d24541vboxsync * NetFlt=>NetFlt [label="Mark inactive (atomic)"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<<NetFlt;
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>NetFlt [label="pfnWaitForIdle(forever)"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * IntNet=>>NetFlt [label="pkt1 to host", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>>Kernel [label="pkt1 to host", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Kernel<-Wire [label="pkt0 on wire", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<Kernel [label="pkt0 on wire", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet<<=NetFlt [label="pfnSGRelease", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet<<=IntNet [label="Lock Net, free SG, Unlock Net", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet>>NetFlt [label="pfnSGRelease", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt<-NetFlt [label="idle", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet<<NetFlt [label="idle (pfnWaitForIdle)"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Wire->Kernel [label="pkt2", linecolor="red", textcolor="red"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Kernel=>>NetFlt [label="pkt2", linecolor="red", textcolor="red"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>>Kernel [label="pkt2 to host", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VM->IntNet [label="pkt3", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Lock Network", linecolor="green", textcolor="green" ];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Route packet -> drop", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * --- [label="The trunk interface is idle now, disconnect it"];
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * IntNet=>IntNet [label="Lock Network"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlink Trunk"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>NetFlt [label="pfnDisconnectAndRelease"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="iflt_detach"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<=Kernel [label="iff_detached"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt>>Kernel [label="iff_detached"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<Kernel [label="iflt_detach"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Release"];
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * IntNet<<NetFlt [label="pfnDisconnectAndRelease"];
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * @subsection subsec_netflt_msc_hif_rm Host Interface Removal - OBSOLETE
c74832c7184337c330041742d88e6dacaa07b378vboxsync * The ifnet_t (pIf) is a tricky customer as any reference to it can potentially
c74832c7184337c330041742d88e6dacaa07b378vboxsync * race the filter detaching. The simple way of solving it on Darwin is to guard
c74832c7184337c330041742d88e6dacaa07b378vboxsync * all access to the pIf member with a spinlock. The other host systems will
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * probably have similar race conditions, so the spinlock is a generic thing.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * VM, IntNet, NetFlt, Kernel;
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VM->IntNet [label="pkt0", linecolor="green", textcolor="green"];
a6e58d30b4d856cf924fda15cd743fed386fff93vboxsync * IntNet=>IntNet [label="Lock Network", linecolor="green", textcolor="green" ];
509c0d9c2c05b40f3f07f79e44c06c9395c1b293vboxsync * IntNet=>IntNet [label="Route packet -> wire", linecolor="green", textcolor="green" ];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Unlock Network", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>NetFlt [label="pkt0 to wire", linecolor="green", textcolor="green" ];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>Kernel [label="ifnet_reference w/ spinlock", linecolor="green", textcolor="green" ];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt<<Kernel [label="ifnet_reference", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="pkt0 to wire (blocks)", linecolor="green", textcolor="green" ];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * --- [label="The host interface is being disconnected"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Kernel->NetFlt [label="iff_detached"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="ifnet_release w/ spinlock"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt<<Kernel [label="ifnet_release"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>NetFlt [label="fDisconnectedFromHost=true"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt>>Kernel [label="iff_detached"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt<<Kernel [label="dropped", linecolor="green", textcolor="green"];
509c0d9c2c05b40f3f07f79e44c06c9395c1b293vboxsync * NetFlt=>NetFlt [label="Acquire spinlock", linecolor="green", textcolor="green"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>Kernel [label="ifnet_release", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<Kernel [label="ifnet_release", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="pIf=NULL", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Release spinlock", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<=NetFlt [label="pfnSGRelease", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet>>NetFlt [label="pfnSGRelease", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<<NetFlt [label="pkt0 to wire", linecolor="green", textcolor="green"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @subsection subsec_netflt_msc_hif_rm Host Interface Rediscovery - OBSOLETE
c74832c7184337c330041742d88e6dacaa07b378vboxsync * The rediscovery is performed when we receive a send request and a certain
c74832c7184337c330041742d88e6dacaa07b378vboxsync * period have elapsed since the last attempt, i.e. we're polling it. We
c74832c7184337c330041742d88e6dacaa07b378vboxsync * synchronize the rediscovery with disconnection from the internal network
c74832c7184337c330041742d88e6dacaa07b378vboxsync * by means of the pfnWaitForIdle call, so no special handling is required.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VM2, VM1, IntNet, NetFlt, Kernel, Wire;
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * --- [label="Rediscovery conditions are not met"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VM1->IntNet [label="pkt0"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Lock Network"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Route packet -> wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>NetFlt [label="pkt0 to wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Read pIf(==NULL) w/ spinlock"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<<NetFlt [label="pkt0 to wire (dropped)"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * --- [label="Rediscovery conditions"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * VM1->IntNet [label="pkt1"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Lock Network"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Route packet -> wire"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Unlock Network"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>NetFlt [label="pkt1 to wire"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>NetFlt [label="Read pIf(==NULL) w/ spinlock"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>NetFlt [label="fRediscoveryPending=true w/ spinlock"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt=>Kernel [label="ifnet_find_by_name"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * NetFlt<<Kernel [label="ifnet_find_by_name (success)"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * VM2->IntNet [label="pkt2", linecolor="red", textcolor="red"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>IntNet [label="Lock Network", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Route packet -> wire", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet=>IntNet [label="Unlock Network", linecolor="red", textcolor="red"];
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * IntNet=>NetFlt [label="pkt2 to wire", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="!pIf || fRediscoveryPending (w/ spinlock)", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<<NetFlt [label="pkt2 to wire (dropped)", linecolor="red", textcolor="red"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="iflt_attach"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<Kernel [label="iflt_attach (success)"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Acquire spinlock"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Set pIf and update flags"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>NetFlt [label="Release spinlock"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt=>Kernel [label="pkt1 to wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Kernel->Wire [label="pkt1 to wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * NetFlt<<Kernel [label="pkt1 to wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync * IntNet<<NetFlt [label="pkt1 to wire"];
c74832c7184337c330041742d88e6dacaa07b378vboxsync/*******************************************************************************
c74832c7184337c330041742d88e6dacaa07b378vboxsync* Header Files *
c74832c7184337c330041742d88e6dacaa07b378vboxsync*******************************************************************************/
4fbca3751fe239da5934c23a783c3422618336e8vboxsync/*******************************************************************************
c74832c7184337c330041742d88e6dacaa07b378vboxsync* Defined Constants And Macros *
c74832c7184337c330041742d88e6dacaa07b378vboxsync*******************************************************************************/
4fbca3751fe239da5934c23a783c3422618336e8vboxsync ( (PVBOXNETFLTINS)((uint8_t *)pIfPort - RT_OFFSETOF(VBOXNETFLTINS, MyPort)) )
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncAssertCompileMemberSize(VBOXNETFLTINS, enmState, sizeof(uint32_t));
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Sets the enmState member atomically.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Used for all updates.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pThis The instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param enmNewState The new value.
c74832c7184337c330041742d88e6dacaa07b378vboxsyncDECLINLINE(void) vboxNetFltSetState(PVBOXNETFLTINS pThis, VBOXNETFTLINSSTATE enmNewState)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync ASMAtomicWriteU32((uint32_t volatile *)&pThis->enmState, enmNewState);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Gets the enmState member atomically.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Used for all reads.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @returns The enmState value.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pThis The instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsyncDECLINLINE(VBOXNETFTLINSSTATE) vboxNetFltGetState(PVBOXNETFLTINS pThis)
c74832c7184337c330041742d88e6dacaa07b378vboxsync return (VBOXNETFTLINSSTATE)ASMAtomicUoReadU32((uint32_t volatile *)&pThis->enmState);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Finds a instance by its name, the caller does the locking.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @returns Pointer to the instance by the given name. NULL if not found.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pGlobals The globals.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pszName The name of the instance.
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic PVBOXNETFLTINS vboxNetFltFindInstanceLocked(PVBOXNETFLTGLOBALS pGlobals, const char *pszName)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync for (pCur = pGlobals->pInstanceHead; pCur; pCur = pCur->pNext)
6f8a1ec7a08590986f176ea072ad499630fe5b6evboxsync * Finds a instance by its name, will request the mutex.
6f8a1ec7a08590986f176ea072ad499630fe5b6evboxsync * No reference to the instance is retained, we're assuming the caller to
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * already have one but just for some reason doesn't have the pointer to it.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @returns Pointer to the instance by the given name. NULL if not found.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pGlobals The globals.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pszName The name of the instance.
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncDECLHIDDEN(PVBOXNETFLTINS) vboxNetFltFindInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync int rc = RTSemFastMutexRequest(pGlobals->hFastMtx);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync pRet = vboxNetFltFindInstanceLocked(pGlobals, pszName);
6f8a1ec7a08590986f176ea072ad499630fe5b6evboxsync * Unlinks an instance from the chain.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pGlobals The globals.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pToUnlink The instance to unlink.
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic void vboxNetFltUnlinkLocked(PVBOXNETFLTGLOBALS pGlobals, PVBOXNETFLTINS pToUnlink)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync for (pCur = pGlobals->pInstanceHead; pCur; pCur = pCur->pNext)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Performs interface rediscovery if it was disconnected from the host.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @returns true if successfully rediscovered and connected, false if not.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @param pThis The instance.
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic bool vboxNetFltMaybeRediscovered(PVBOXNETFLTINS pThis)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Don't do rediscovery if we're called with preemption disabled.
6f8a1ec7a08590986f176ea072ad499630fe5b6evboxsync * Note! This may cause trouble if we're always called with preemptioni
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * disabled and vboxNetFltOsMaybeRediscovered actually does some real
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * work. For the time being though, only Darwin and FreeBSD depends
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * on these call outs and neither supports sending with preemption
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * disabled.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync return false;
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Rediscovered already? Time to try again?
4fbca3751fe239da5934c23a783c3422618336e8vboxsync fRediscovered = !ASMAtomicUoReadBool(&pThis->fDisconnectedFromHost);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync && !ASMAtomicUoReadBool(&pThis->fRediscoveryPending)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync && Now - ASMAtomicUoReadU64(&pThis->NanoTSLastRediscovery) > UINT64_C(5000000000); /* 5 sec */
4fbca3751fe239da5934c23a783c3422618336e8vboxsync ASMAtomicWriteBool(&pThis->fRediscoveryPending, true);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Call the OS specific code to do the job.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Update the state when the call returns, that is everything except for
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * the fDisconnectedFromHost flag which the OS specific code shall set.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync fRediscovered = vboxNetFltOsMaybeRediscovered(pThis);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync Assert(!fRediscovered || !ASMAtomicUoReadBool(&pThis->fDisconnectedFromHost));
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync ASMAtomicUoWriteU64(&pThis->NanoTSLastRediscovery, RTTimeNanoTS());
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync ASMAtomicWriteBool(&pThis->fRediscoveryPending, false);
c74832c7184337c330041742d88e6dacaa07b378vboxsync /** @todo this isn't 100% serialized. */
c74832c7184337c330041742d88e6dacaa07b378vboxsync vboxNetFltPortOsSetActive(pThis, pThis->enmTrunkState == INTNETTRUNKIFSTATE_ACTIVE);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @copydoc INTNETTRUNKIFPORT::pfnXmit
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic DECLCALLBACK(int) vboxNetFltPortXmit(PINTNETTRUNKIFPORT pIfPort, PINTNETSG pSG, uint32_t fDst)
c74832c7184337c330041742d88e6dacaa07b378vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * Input validation.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync AssertReturn(vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Connected, VERR_INVALID_STATE);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Do a busy retain and then make sure we're connected to the interface
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * before invoking the OS specific code.
c74832c7184337c330041742d88e6dacaa07b378vboxsync if (RT_LIKELY(vboxNetFltTryRetainBusyActive(pThis)))
c74832c7184337c330041742d88e6dacaa07b378vboxsync if ( !ASMAtomicUoReadBool(&pThis->fDisconnectedFromHost)
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @copydoc INTNETTRUNKIFPORT::pfnWaitForIdle
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic DECLCALLBACK(int) vboxNetFltPortWaitForIdle(PINTNETTRUNKIFPORT pIfPort, uint32_t cMillies)
c74832c7184337c330041742d88e6dacaa07b378vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Input validation.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertReturn(vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Connected, VERR_INVALID_STATE);
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertReturn(pThis->enmTrunkState == INTNETTRUNKIFSTATE_DISCONNECTING, VERR_INVALID_STATE);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Go to sleep on the semaphore after checking the busy count.
c74832c7184337c330041742d88e6dacaa07b378vboxsync rc = RTSemEventWait(pThis->hEventIdle, cMillies); /** @todo make interruptible? */
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @copydoc INTNETTRUNKIFPORT::pfnSetState
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic DECLCALLBACK(INTNETTRUNKIFSTATE) vboxNetFltPortSetState(PINTNETTRUNKIFPORT pIfPort, INTNETTRUNKIFSTATE enmState)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Input validation.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync AssertReturn(vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Connected, INTNETTRUNKIFSTATE_INVALID);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync AssertReturn(enmState > INTNETTRUNKIFSTATE_INVALID && enmState < INTNETTRUNKIFSTATE_END,
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Take the lock and change the state.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync ASMAtomicWriteU32((uint32_t volatile *)&pThis->enmTrunkState, enmState);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * If the state change indicates that the trunk has become active or
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * inactive, call the OS specific part so they can work the promiscuous
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * settings and such.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Note! The caller makes sure there are no concurrent pfnSetState calls.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync if ((enmOldTrunkState == INTNETTRUNKIFSTATE_ACTIVE) != (enmState == INTNETTRUNKIFSTATE_ACTIVE))
4fbca3751fe239da5934c23a783c3422618336e8vboxsync vboxNetFltPortOsSetActive(pThis, (enmState == INTNETTRUNKIFSTATE_ACTIVE));
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @copydoc INTNETTRUNKIFPORT::pfnNotifyMacAddress
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic DECLCALLBACK(void) vboxNetFltPortNotifyMacAddress(PINTNETTRUNKIFPORT pIfPort, INTNETIFHANDLE hIf, PCRTMAC pMac)
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Input validation.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync vboxNetFltPortOsNotifyMacAddress(pThis, hIf, pMac);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @copydoc INTNETTRUNKIFPORT::pfnConnectInterface
4fbca3751fe239da5934c23a783c3422618336e8vboxsyncstatic DECLCALLBACK(int) vboxNetFltPortConnectInterface(PINTNETTRUNKIFPORT pIfPort, INTNETIFHANDLE hIf)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Input validation.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * @copydoc INTNETTRUNKIFPORT::pfnDisconnectInterface
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic DECLCALLBACK(int) vboxNetFltPortDisconnectInterface(PINTNETTRUNKIFPORT pIfPort, INTNETIFHANDLE hIf)
c74832c7184337c330041742d88e6dacaa07b378vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Input validation.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
c74832c7184337c330041742d88e6dacaa07b378vboxsync rc = vboxNetFltPortOsDisconnectInterface(pThis, hIf);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @copydoc INTNETTRUNKIFPORT::pfnDisconnectAndRelease
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic DECLCALLBACK(void) vboxNetFltPortDisconnectAndRelease(PINTNETTRUNKIFPORT pIfPort)
c74832c7184337c330041742d88e6dacaa07b378vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * Serious paranoia.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
b7a5b3f9f9ecce32ddacf8404c625ce0451bbdc1vboxsync Assert(pThis->MyPort.u32VersionEnd == INTNETTRUNKIFPORT_VERSION);
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Connected);
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->enmTrunkState == INTNETTRUNKIFSTATE_DISCONNECTING);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Disconnect and release it.
c74832c7184337c330041742d88e6dacaa07b378vboxsync vboxNetFltSetState(pThis, kVBoxNetFltInsState_Disconnecting);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync vboxNetFltSetState(pThis, kVBoxNetFltInsState_Unconnected);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Destroy a device that has been disconnected from the switch.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * @returns true if the instance is destroyed, false otherwise.
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * @param pThis The instance to be destroyed. This is
c74832c7184337c330041742d88e6dacaa07b378vboxsync * no longer valid when this function returns.
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic bool vboxNetFltDestroyInstance(PVBOXNETFLTINS pThis)
c74832c7184337c330041742d88e6dacaa07b378vboxsync uint32_t cRefs = ASMAtomicUoReadU32((uint32_t volatile *)&pThis->cRefs);
c74832c7184337c330041742d88e6dacaa07b378vboxsync LogFlow(("vboxNetFltDestroyInstance: pThis=%p (%s)\n", pThis, pThis->szName));
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Validate the state.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert( vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Disconnecting
c74832c7184337c330041742d88e6dacaa07b378vboxsync || vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Unconnected);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync Assert(vboxNetFltGetState(pThis) == kVBoxNetFltInsState_Disconnecting);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync Assert(pThis->enmTrunkState == INTNETTRUNKIFSTATE_DISCONNECTING);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Make sure the state is 'disconnecting' / 'destroying' and let the OS
c74832c7184337c330041742d88e6dacaa07b378vboxsync * specific code do its part of the cleanup outside the mutex.
c74832c7184337c330041742d88e6dacaa07b378vboxsync rc = RTSemFastMutexRequest(pGlobals->hFastMtx); AssertRC(rc);
c74832c7184337c330041742d88e6dacaa07b378vboxsync vboxNetFltSetState(pThis, kVBoxNetFltInsState_Disconnecting);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Unlink the instance and free up its resources.
c74832c7184337c330041742d88e6dacaa07b378vboxsync rc = RTSemFastMutexRequest(pGlobals->hFastMtx); AssertRC(rc);
c74832c7184337c330041742d88e6dacaa07b378vboxsync vboxNetFltSetState(pThis, kVBoxNetFltInsState_Destroyed);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync return true;
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Releases a reference to the specified instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * This method will destroy the instance when the count reaches 0.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * It will also take care of decrementing the counter and idle wakeup.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pThis The instance.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * @param fBusy Whether the busy counter should be decremented too.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsyncDECLHIDDEN(void) vboxNetFltRelease(PVBOXNETFLTINS pThis, bool fBusy)
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Paranoid Android.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert(pThis->MyPort.u32VersionEnd == INTNETTRUNKIFPORT_VERSION);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert( vboxNetFltGetState(pThis) > kVBoxNetFltInsState_Invalid
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync && vboxNetFltGetState(pThis) < kVBoxNetFltInsState_Destroyed);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Work the busy counter.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * The object reference counting.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * @copydoc INTNETTRUNKIFPORT::pfnRetain
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsyncstatic DECLCALLBACK(void) vboxNetFltPortRelease(PINTNETTRUNKIFPORT pIfPort)
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Retains a reference to the specified instance and a busy reference too.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pThis The instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param fBusy Whether the busy counter should be incremented as well.
c74832c7184337c330041742d88e6dacaa07b378vboxsyncDECLHIDDEN(void) vboxNetFltRetain(PVBOXNETFLTINS pThis, bool fBusy)
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Paranoid Android.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync Assert(pThis->MyPort.u32VersionEnd == INTNETTRUNKIFPORT_VERSION);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync Assert( vboxNetFltGetState(pThis) > kVBoxNetFltInsState_Invalid
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync && vboxNetFltGetState(pThis) < kVBoxNetFltInsState_Destroyed);
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Retain the object.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Work the busy counter.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * Tries to retain the device as busy if the trunk is active.
4fbca3751fe239da5934c23a783c3422618336e8vboxsync * This is used before calling pfnRecv or pfnPreRecv.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * @returns true if we succeeded in retaining a busy reference to the active
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * device. false if we failed.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * @param pThis The instance.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsyncDECLHIDDEN(bool) vboxNetFltTryRetainBusyActive(PVBOXNETFLTINS pThis)
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync * Paranoid Android.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert(pThis->MyPort.u32VersionEnd == INTNETTRUNKIFPORT_VERSION);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync Assert( vboxNetFltGetState(pThis) > kVBoxNetFltInsState_Invalid
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync && vboxNetFltGetState(pThis) < kVBoxNetFltInsState_Destroyed);
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * Do the retaining and checking behind the spinlock.
c74832c7184337c330041742d88e6dacaa07b378vboxsync fRc = pThis->enmTrunkState == INTNETTRUNKIFSTATE_ACTIVE;
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertMsg(cRefs > 1 && cRefs < UINT32_MAX / 2, ("%d\n", cRefs)); NOREF(cRefs);
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertMsg(cRefs >= 1 && cRefs < UINT32_MAX / 2, ("%d\n", cRefs)); NOREF(cRefs);
a40c05ca69e15a5efdd0796ef52e26ec0b1bc4d2vboxsync * Tries to retain the device as busy if the trunk is not disconnecting.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * This is used before reporting stuff to the internal network.
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * @returns true if we succeeded in retaining a busy reference to the active
6f8a1ec7a08590986f176ea072ad499630fe5b6evboxsync * device. false if we failed.
548ca31b6b47c36bacce49bed3339cb8075b9681vboxsync * @param pThis The instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsyncDECLHIDDEN(bool) vboxNetFltTryRetainBusyNotDisconnected(PVBOXNETFLTINS pThis)
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Paranoid Android.
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32Version == INTNETTRUNKIFPORT_VERSION);
c74832c7184337c330041742d88e6dacaa07b378vboxsync Assert(pThis->MyPort.u32VersionEnd == INTNETTRUNKIFPORT_VERSION);
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync Assert( vboxNetFltGetState(pThis) > kVBoxNetFltInsState_Invalid
c74832c7184337c330041742d88e6dacaa07b378vboxsync && vboxNetFltGetState(pThis) < kVBoxNetFltInsState_Destroyed);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * Do the retaining and checking behind the spinlock.
c74832c7184337c330041742d88e6dacaa07b378vboxsync fRc = pThis->enmTrunkState == INTNETTRUNKIFSTATE_ACTIVE
c74832c7184337c330041742d88e6dacaa07b378vboxsync || pThis->enmTrunkState == INTNETTRUNKIFSTATE_INACTIVE;
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertMsg(cRefs > 1 && cRefs < UINT32_MAX / 2, ("%d\n", cRefs)); NOREF(cRefs);
c74832c7184337c330041742d88e6dacaa07b378vboxsync AssertMsg(cRefs >= 1 && cRefs < UINT32_MAX / 2, ("%d\n", cRefs)); NOREF(cRefs);
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @copydoc INTNETTRUNKIFPORT::pfnRetain
c74832c7184337c330041742d88e6dacaa07b378vboxsyncstatic DECLCALLBACK(void) vboxNetFltPortRetain(PINTNETTRUNKIFPORT pIfPort)
c74832c7184337c330041742d88e6dacaa07b378vboxsync PVBOXNETFLTINS pThis = IFPORT_2_VBOXNETFLTINS(pIfPort);
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync * Connects the instance to the specified switch port.
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync * Called while owning the lock. We're ASSUMING that the internal
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync * networking code is already owning an recursive mutex, so, there
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync * will be no deadlocks when vboxNetFltOsConnectIt calls back into
f01175bdcb5e36a1a89fca88f45d7ee7fb034ed6vboxsync * it for setting preferences.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @returns VBox status code.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pThis The instance.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param pSwitchPort The port on the internal network 'switch'.
c74832c7184337c330041742d88e6dacaa07b378vboxsync * @param ppIfPort Where to return our port interface.
static int vboxNetFltConnectIt(PVBOXNETFLTINS pThis, PINTNETTRUNKSWPORT pSwitchPort, PINTNETTRUNKIFPORT *ppIfPort)
int rc;
#ifdef VBOXNETFLT_STATIC_CONFIG
return rc;
static int vboxNetFltNewInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName, PINTNETTRUNKSWPORT pSwitchPort,
int rc;
if (!pNew)
return VERR_INTNET_FLT_IF_FAILED;
#ifdef VBOXNETFLT_STATIC_CONFIG
#ifdef VBOXNETFLT_STATIC_CONFIG
return rc;
return rc;
return rc;
#ifdef VBOXNETFLT_STATIC_CONFIG
DECLHIDDEN(int) vboxNetFltSearchCreateInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName, PVBOXNETFLTINS *ppInstance, void *pvContext)
int rc;
while (pCur)
switch (enmState)
return VINF_ALREADY_INITIALIZED;
LogRel(("VBoxNetFlt: Huh? An instance of '%s' already exists! [pCur=%p cRefs=%d fDfH=%RTbool enmState=%d]\n",
return VERR_INTNET_FLT_IF_BUSY;
# ifdef RT_STRICT
return rc;
static DECLCALLBACK(int) vboxNetFltFactoryCreateAndConnect(PINTNETTRUNKFACTORY pIfFactory, const char *pszName,
PVBOXNETFLTGLOBALS pGlobals = (PVBOXNETFLTGLOBALS)((uint8_t *)pIfFactory - RT_OFFSETOF(VBOXNETFLTGLOBALS, TrunkFactory));
int rc;
LogFlow(("vboxNetFltFactoryCreateAndConnect: pszName=%p:{%s} fFlags=%#x\n", pszName, pszName, fFlags));
if (pCur)
#ifdef VBOXNETFLT_STATIC_CONFIG
if (pCur)
return rc;
#ifdef VBOXNETFLT_STATIC_CONFIG
NULL,
ppIfPort);
return rc;
PVBOXNETFLTGLOBALS pGlobals = (PVBOXNETFLTGLOBALS)((uint8_t *)pIfFactory - RT_OFFSETOF(VBOXNETFLTGLOBALS, TrunkFactory));
static DECLCALLBACK(void *) vboxNetFltQueryFactoryInterface(PCSUPDRVFACTORY pSupDrvFactory, PSUPDRVSESSION pSession, const char *pszInterfaceUuid)
PVBOXNETFLTGLOBALS pGlobals = (PVBOXNETFLTGLOBALS)((uint8_t *)pSupDrvFactory - RT_OFFSETOF(VBOXNETFLTGLOBALS, SupDrvFactory));
#ifdef LOG_ENABLED
return NULL;
return fRc;
int rc;
return VERR_WRONG_ORDER;
return VERR_WRONG_ORDER;
return rc;
int rc;
rc = SUPR0IdcOpen(&pGlobals->SupDrvIDC, 0 /* iReqVersion = default */, 0 /* iMinVersion = default */, NULL, NULL, NULL);
return rc;
return rc;
return rc;
return rc;
return rc;
return rc;
return rc;