Support Client Migration (Client Side) #1

## Description
This PR adds the support of Client Migration (Client Side). 

This pull request includes significant changes to the QUIC connection ID management and introduces a new feature for manual connection ID generation for testing purposes. The most important changes include the replacement of `QUIC_CID_HASH_ENTRY` with `QUIC_CID_SLIST_ENTRY` to register connection IDs into more than one bindings, the addition of new APIs to add/remove local address in client, and the introduction of a conditional compilation feature for manual connection ID generation.

To manage opening new paths for a connection, Two functions (`QuicConnOpenNewPath` and `QuicConnOpenNewPaths`) are added. The former is called when an App adds a local address or the latter is called. The latter is called when the Handshake is confirmed. And `QuicConnAssignCids` is added to set Destination Connection ID for paths. This function is called when any Dest CID
 is newly added.

## Testing

Three tests are newly added and one test is modified.

ParameterValidation.ValidateConnectionParam (modified)
Basic/WithProbePathArgs.ProbePath (new)
Basic/WithMigrationArgs.Migration (new)

Basic/WithProbePathArgs.MultipleLocalAddresses (new)

## Documentation
In this PR, the following two Connection level Parameters will be added.

QUIC_PARAM_CONN_ADD_LOCAL_ADDRESS
QUIC_PARAM_CONN_REMOVE_LOCAL_ADDRESS

Author: masa-koz

src/core/binding.c

@@ -561,46 +561,91 @@ _IRQL_requires_max_(DISPATCH_LEVEL)
 BOOLEAN
 QuicBindingAddSourceConnectionID(
     _In_ QUIC_BINDING* Binding,
-    _In_ QUIC_CID_HASH_ENTRY* SourceCid
+    _In_ QUIC_CONNECTION* Connection,
+    _In_ QUIC_CID_SLIST_ENTRY* SourceCid
     )
 {
-    return QuicLookupAddLocalCid(&Binding->Lookup, SourceCid, NULL);
+    return QuicLookupAddLocalCid(&Binding->Lookup, Connection, SourceCid, NULL);
+}
+
+_IRQL_requires_max_(DISPATCH_LEVEL)
+BOOLEAN
+QuicBindingAddAllSourceConnectionIDs(
+    _In_ QUIC_BINDING* Binding,
+    _In_ QUIC_CONNECTION* Connection
+    )
+{
+    for (CXPLAT_SLIST_ENTRY* Link = Connection->SourceCids.Next;
+        Link != NULL;
+        Link = Link->Next) {
+
+        QUIC_CID_SLIST_ENTRY* Entry =
+            CXPLAT_CONTAINING_RECORD(
+                Link,
+                QUIC_CID_SLIST_ENTRY,
+                Link);
+        if (!QuicBindingAddSourceConnectionID(Binding, Connection, Entry)) {
+            return FALSE;
+        }
+    }
+
+    return TRUE;
 }
 
 _IRQL_requires_max_(DISPATCH_LEVEL)
 void
 QuicBindingRemoveSourceConnectionID(
     _In_ QUIC_BINDING* Binding,
-    _In_ QUIC_CID_HASH_ENTRY* SourceCid,
-    _In_ CXPLAT_SLIST_ENTRY** Entry
+    _In_ QUIC_CID_HASH_ENTRY* SourceCid
     )
 {
-    QuicLookupRemoveLocalCid(&Binding->Lookup, SourceCid, Entry);
+    QuicLookupRemoveLocalCid(&Binding->Lookup, SourceCid);
 }
 
 _IRQL_requires_max_(DISPATCH_LEVEL)
 void
-QuicBindingRemoveConnection(
+QuicBindingRemoveAllSourceConnectionIDs(
     _In_ QUIC_BINDING* Binding,
     _In_ QUIC_CONNECTION* Connection
     )
 {
-    if (Connection->RemoteHashEntry != NULL) {
-        QuicLookupRemoveRemoteHash(&Binding->Lookup, Connection->RemoteHashEntry);
+    for (CXPLAT_SLIST_ENTRY* Link = Connection->SourceCids.Next;
+        Link != NULL;
+        Link = Link->Next) {
+
+        QUIC_CID_SLIST_ENTRY* Entry =
+            CXPLAT_CONTAINING_RECORD(
+                Link,
+                QUIC_CID_SLIST_ENTRY,
+                Link);
+
+        CXPLAT_SLIST_ENTRY** HashLink = &Entry->HashEntries.Next;
+        while (*HashLink != NULL) {
+            QUIC_CID_HASH_ENTRY* HashEntry = 
+                CXPLAT_CONTAINING_RECORD(
+                    *HashLink,
+                    QUIC_CID_HASH_ENTRY,
+                    Link);
+            if (HashEntry->Binding == Binding) {
+                QuicBindingRemoveSourceConnectionID(Binding, HashEntry);
+                *HashLink = (*HashLink)->Next;
+                CXPLAT_FREE(HashEntry, QUIC_POOL_CIDHASH);
+                HashEntry = NULL;
+            } else {
+                HashLink = &(*HashLink)->Next;
+            }
+        }
     }
-    QuicLookupRemoveLocalCids(&Binding->Lookup, Connection);
 }
 
 _IRQL_requires_max_(DISPATCH_LEVEL)
 void
-QuicBindingMoveSourceConnectionIDs(
-    _In_ QUIC_BINDING* BindingSrc,
-    _In_ QUIC_BINDING* BindingDest,
-    _In_ QUIC_CONNECTION* Connection
+QuicBindingRemoveRemoteHash(
+    _In_ QUIC_BINDING* Binding,
+    _In_ QUIC_REMOTE_HASH_ENTRY* RemoteHashEntry
     )
 {
-    QuicLookupMoveLocalConnectionIDs(
-        &BindingSrc->Lookup, &BindingDest->Lookup, Connection);
+    QuicLookupRemoveRemoteHash(&Binding->Lookup, RemoteHashEntry);
 }
 
 _IRQL_requires_max_(DISPATCH_LEVEL)
@@ -1285,10 +1330,10 @@ QuicBindingCreateConnection(
 
     BOOLEAN BindingRefAdded = FALSE;
     CXPLAT_DBG_ASSERT(NewConnection->SourceCids.Next != NULL);
-    QUIC_CID_HASH_ENTRY* SourceCid =
+    QUIC_CID_SLIST_ENTRY* SourceCid =
         CXPLAT_CONTAINING_RECORD(
             NewConnection->SourceCids.Next,
-            QUIC_CID_HASH_ENTRY,
+            QUIC_CID_SLIST_ENTRY,
             Link);
 
     QuicConnAddRef(NewConnection, QUIC_CONN_REF_LOOKUP_RESULT);
@@ -1323,6 +1368,8 @@ QuicBindingCreateConnection(
         }
         goto Exit;
     }
+    CXPLAT_DBG_ASSERT(NewConnection->RemoteHashEntry != NULL);
+    NewConnection->RemoteHashEntry->Binding = Binding;
 
     QuicWorkerQueueConnection(NewConnection->Worker, NewConnection);
 
@@ -1357,7 +1404,7 @@ QuicBindingCreateConnection(
 
     } else {
         NewConnection->SourceCids.Next = NULL;
-        CXPLAT_FREE(SourceCid, QUIC_POOL_CIDHASH);
+        CXPLAT_FREE(SourceCid, QUIC_POOL_CIDSLIST);
         QuicConnRelease(NewConnection, QUIC_CONN_REF_LOOKUP_RESULT);
 #pragma prefast(suppress:6001, "SAL doesn't understand ref counts")
         QuicConnRelease(NewConnection, QUIC_CONN_REF_HANDLE_OWNER);

src/core/binding.h

@@ -386,7 +386,19 @@ _IRQL_requires_max_(DISPATCH_LEVEL)
 BOOLEAN
 QuicBindingAddSourceConnectionID(
     _In_ QUIC_BINDING* Binding,
-    _In_ QUIC_CID_HASH_ENTRY* SourceCid
+    _In_ QUIC_CONNECTION* Connection,
+    _In_ QUIC_CID_SLIST_ENTRY* SourceCid
+    );
+
+//
+// Attempts to insert all the connection's new source CIDs into the binding's
+// lookup table.
+//
+_IRQL_requires_max_(DISPATCH_LEVEL)
+BOOLEAN
+QuicBindingAddAllSourceConnectionIDs(
+    _In_ QUIC_BINDING* Binding,
+    _In_ QUIC_CONNECTION* Connection
     );
 
 //
@@ -396,30 +408,24 @@ _IRQL_requires_max_(DISPATCH_LEVEL)
 void
 QuicBindingRemoveSourceConnectionID(
     _In_ QUIC_BINDING* Binding,
-    _In_ QUIC_CID_HASH_ENTRY* SourceCid,
-    _In_ CXPLAT_SLIST_ENTRY** Entry
+    _In_ QUIC_CID_HASH_ENTRY* SourceCid
     );
 
 //
-// Removes all the connection's source CIDs from the binding's lookup table.
+// Removes all the source CIDs from the binding's lookup table.
 //
 _IRQL_requires_max_(DISPATCH_LEVEL)
 void
-QuicBindingRemoveConnection(
+QuicBindingRemoveAllSourceConnectionIDs(
     _In_ QUIC_BINDING* Binding,
     _In_ QUIC_CONNECTION* Connection
     );
 
-//
-// Moves all the connections source CIDs from the one binding's lookup table to
-// another.
-//
 _IRQL_requires_max_(DISPATCH_LEVEL)
 void
-QuicBindingMoveSourceConnectionIDs(
-    _In_ QUIC_BINDING* BindingSrc,
-    _In_ QUIC_BINDING* BindingDest,
-    _In_ QUIC_CONNECTION* Connection
+QuicBindingRemoveRemoteHash(
+    _In_ QUIC_BINDING* Binding,
+    _In_ QUIC_REMOTE_HASH_ENTRY* RemoteHashEntry
     );
 
 //
@@ -546,3 +552,16 @@ QuicRetryTokenDecrypt(
     CxPlatDispatchLockRelease(&Partition->StatelessRetryKeysLock);
     return QUIC_SUCCEEDED(Status);
 }
+
+//
+// Helper to get the owning QUIC_BINDING for the lookup module.
+//
+QUIC_INLINE
+_Ret_notnull_
+QUIC_BINDING*
+QuicLookupGetBinding(
+    _In_ QUIC_LOOKUP* Lookup
+    )
+{
+    return CXPLAT_CONTAINING_RECORD(Lookup, QUIC_BINDING, Lookup);
+}

src/core/cid.h

@@ -163,12 +163,21 @@ typedef struct QUIC_CID_LIST_ENTRY {
 #define QUIC_CID_VALIDATE_NULL(Conn, Cid) UNREFERENCED_PARAMETER(Cid)
 #endif
 
+typedef struct QUIC_CID_SLIST_ENTRY {
+
+    CXPLAT_SLIST_ENTRY Link;
+    CXPLAT_SLIST_ENTRY HashEntries;
+    QUIC_CID CID;
+
+} QUIC_CID_SLIST_ENTRY;
+
 typedef struct QUIC_CID_HASH_ENTRY {
 
     CXPLAT_HASHTABLE_ENTRY Entry;
     CXPLAT_SLIST_ENTRY Link;
     QUIC_CONNECTION* Connection;
-    QUIC_CID CID;
+    QUIC_BINDING* Binding;
+    QUIC_CID_SLIST_ENTRY* Parent;
 
 } QUIC_CID_HASH_ENTRY;
 
@@ -178,18 +187,16 @@ typedef struct QUIC_CID_HASH_ENTRY {
 //
 QUIC_INLINE
 _Success_(return != NULL)
-QUIC_CID_HASH_ENTRY*
-QuicCidNewNullSource(
-    _In_ QUIC_CONNECTION* Connection
-    )
+QUIC_CID_SLIST_ENTRY*
+QuicCidNewNullSource()
 {
-    QUIC_CID_HASH_ENTRY* Entry =
-        (QUIC_CID_HASH_ENTRY*)CXPLAT_ALLOC_NONPAGED(
-            sizeof(QUIC_CID_HASH_ENTRY),
-            QUIC_POOL_CIDHASH);
+    QUIC_CID_SLIST_ENTRY* Entry =
+        (QUIC_CID_SLIST_ENTRY*)CXPLAT_ALLOC_NONPAGED(
+            sizeof(QUIC_CID_SLIST_ENTRY),
+            QUIC_POOL_CIDSLIST);
 
     if (Entry != NULL) {
-        Entry->Connection = Connection;
+        Entry->HashEntries.Next = NULL;
         CxPlatZeroMemory(&Entry->CID, sizeof(Entry->CID));
     }
 
@@ -201,23 +208,22 @@ QuicCidNewNullSource(
 //
 QUIC_INLINE
 _Success_(return != NULL)
-QUIC_CID_HASH_ENTRY*
+QUIC_CID_SLIST_ENTRY*
 QuicCidNewSource(
-    _In_ QUIC_CONNECTION* Connection,
     _In_ uint8_t Length,
     _In_reads_(Length)
         const uint8_t* const Data
     )
 {
-    QUIC_CID_HASH_ENTRY* Entry =
-        (QUIC_CID_HASH_ENTRY*)
+    QUIC_CID_SLIST_ENTRY* Entry =
+        (QUIC_CID_SLIST_ENTRY*)
         CXPLAT_ALLOC_NONPAGED(
-            sizeof(QUIC_CID_HASH_ENTRY) +
+            sizeof(QUIC_CID_SLIST_ENTRY) +
             Length,
-            QUIC_POOL_CIDHASH);
+            QUIC_POOL_CIDSLIST);
 
     if (Entry != NULL) {
-        Entry->Connection = Connection;
+        Entry->HashEntries.Next = NULL;
         CxPlatZeroMemory(&Entry->CID, sizeof(Entry->CID));
         Entry->CID.Length = Length;
         if (Length != 0) {

src/core/configuration.c

@@ -465,6 +465,24 @@ QuicConfigurationParamGet(
 
         return QUIC_STATUS_SUCCESS;
     }
+#if QUIC_TEST_MANUAL_CONN_ID_GENERATION
+    if (Param  == QUIC_PARAM_CONFIGURATION_CONN_ID_GENERATION_DISABLED) {
+
+        if (*BufferLength < sizeof(BOOLEAN)) {
+            *BufferLength = sizeof(BOOLEAN);
+            return QUIC_STATUS_BUFFER_TOO_SMALL;
+        }
+
+        if (Buffer == NULL) {
+            return QUIC_STATUS_INVALID_PARAMETER;
+        }
+
+        *BufferLength = sizeof(BOOLEAN);
+        *(BOOLEAN*)Buffer = Configuration->Settings.ConnIDGenDisabled;
+
+        return QUIC_STATUS_SUCCESS;
+    }
+#endif
 
     return QUIC_STATUS_INVALID_PARAMETER;
 }
@@ -574,6 +592,20 @@ QuicConfigurationParamSet(
 
         return QUIC_STATUS_SUCCESS;
 
+#if QUIC_TEST_MANUAL_CONN_ID_GENERATION
+    case QUIC_PARAM_CONFIGURATION_CONN_ID_GENERATION_DISABLED:
+
+        if (Buffer == NULL ||
+            BufferLength < sizeof(BOOLEAN)) {
+            return QUIC_STATUS_INVALID_PARAMETER;
+        }
+
+        Configuration->Settings.IsSet.ConnIDGenDisabled = TRUE;
+        Configuration->Settings.ConnIDGenDisabled = *(BOOLEAN*)Buffer;
+
+        return QUIC_STATUS_SUCCESS;
+#endif
+
 #ifdef WIN32
     case QUIC_PARAM_CONFIGURATION_SCHANNEL_CREDENTIAL_ATTRIBUTE_W: