datapath-windows: clarify 'portIdHashArray' in the swithc context

In this patch, we update the documentation for 'portIdHashArray' to
indicate that a vport would exist in this hash table if and only if it
also exists on the Hyper-V switch.

This functionality to implement this semantic will follow in subsequent
patches.

Signed-off-by: Nithin Raju <nithin@vmware.com>
Signed-off-by: Gurucharan Shetty <gshetty@nicira.com>

diff --git a/datapath-windows/ovsext/Switch.h b/datapath-windows/ovsext/Switch.h
index 8df2500..61f74c4 100644 (file)
--- a/datapath-windows/ovsext/Switch.h
+++ b/datapath-windows/ovsext/Switch.h
@@ -136,7 +136,10 @@ typedef struct _OVS_SWITCH_CONTEXT
     /*
      * 'portIdHashArray' ONLY contains ports that exist on the Hyper-V switch,
      * namely: VIF (vNIC) ports, external port and Hyper-V internal port.
-     * 'numHvVports' counts the ports in 'portIdHashArray'.
+     * 'numHvVports' counts the ports in 'portIdHashArray'. If a port got
+     * deleted on the Hyper-V switch, it gets deleted from 'portIdHashArray'.
+     * The port itself will not get deallocated if it has been added from OVS
+     * userspace. 'numHvVports' is decremented when the port is deallocated.
      *
      * 'portNoHashArray' ONLY contains ports that are added from OVS userspace,
      * regardless of whether that port exists on the Hyper-V switch or not.