Long live QNetworkDatagram!

This commit adds a new class called QNetworkDatagram that encapsulates
the IP packet header and UDP/IP stack metadata along with the actual
payload data. It can be used for both receiving as well as sending data.

It's called QNetworkDatagram so it can be used by QSctpSocket too, when
that lands.

[ChangeLog][QtNetwork] Added QNetworkDatagram class, along with new
function receiveDatagram in QUdpSocket that returns it and an overload
to writeDatagram that can accept it.

Change-Id: Iee8cbc07c4434ce9b560ffff13ca467f425ddc3d
Reviewed-by: Alex Trotsenko <alex1973tr@gmail.com>
Reviewed-by: Richard J. Moore <rich@kde.org>

4 files changed, 225 insertions, 33 deletions

diff --git a/tests/auto/network/kernel/kernel.pro b/tests/auto/network/kernel/kernel.pro
index bb13c7dd7d..6c3a234de5 100644
--- a/tests/auto/network/kernel/kernel.pro
+++ b/tests/auto/network/kernel/kernel.pro
@@ -7,6 +7,7 @@ SUBDIRS=\
    qauthenticator \
    qnetworkproxy \
    qnetworkinterface \
+   qnetworkdatagram \
    qnetworkaddressentry \
    qhostaddress \
 
diff --git a/tests/auto/network/kernel/qnetworkdatagram/qnetworkdatagram.pro b/tests/auto/network/kernel/qnetworkdatagram/qnetworkdatagram.pro
new file mode 100644
index 0000000000..a2fe44060e
--- /dev/null
+++ b/tests/auto/network/kernel/qnetworkdatagram/qnetworkdatagram.pro
@@ -0,0 +1,5 @@
+CONFIG += testcase console
+CONFIG -= app_bundle
+TARGET = tst_qnetworkdatagram
+SOURCES  += tst_qnetworkdatagram.cpp
+QT = core network testlib
diff --git a/tests/auto/network/kernel/qnetworkdatagram/tst_qnetworkdatagram.cpp b/tests/auto/network/kernel/qnetworkdatagram/tst_qnetworkdatagram.cpp
new file mode 100644
index 0000000000..3295580432
--- /dev/null
+++ b/tests/auto/network/kernel/qnetworkdatagram/tst_qnetworkdatagram.cpp
@@ -0,0 +1,146 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Intel Corporation.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtNetwork module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QNetworkDatagram>
+#include <QtTest>
+#include <QCoreApplication>
+
+class tst_QNetworkDatagram : public QObject
+{
+    Q_OBJECT
+
+public:
+    tst_QNetworkDatagram();
+
+private Q_SLOTS:
+    void getSetCheck();
+    void makeReply_data();
+    void makeReply();
+};
+
+tst_QNetworkDatagram::tst_QNetworkDatagram()
+{
+}
+
+void tst_QNetworkDatagram::getSetCheck()
+{
+    QNetworkDatagram dg;
+
+    QVERIFY(dg.isNull());
+    QVERIFY(!dg.isValid());
+    QCOMPARE(dg.senderAddress(), QHostAddress());
+    QCOMPARE(dg.destinationAddress(), QHostAddress());
+    QCOMPARE(dg.senderPort(), -1);
+    QCOMPARE(dg.destinationPort(), -1);
+    QCOMPARE(dg.hopLimit(), -1);
+    QCOMPARE(dg.interfaceIndex(), 0U);
+
+    dg.setHopLimit(1);
+    QCOMPARE(dg.hopLimit(), 1);
+    dg.setHopLimit(255);
+    QCOMPARE(dg.hopLimit(), 255);
+
+    dg.setInterfaceIndex(1);
+    QCOMPARE(dg.interfaceIndex(), 1U);
+    dg.setInterfaceIndex(1234567U);
+    QCOMPARE(dg.interfaceIndex(), 1234567U);
+
+    dg.setSender(QHostAddress::Any, 12345);
+    QCOMPARE(dg.senderAddress(), QHostAddress(QHostAddress::Any));
+    QCOMPARE(dg.senderPort(), 12345);
+    dg.setSender(QHostAddress::LocalHost);
+    QCOMPARE(dg.senderAddress(), QHostAddress(QHostAddress::LocalHost));
+    QCOMPARE(dg.senderPort(), 0);
+
+    dg.setDestination(QHostAddress::LocalHostIPv6, 12345);
+    QCOMPARE(dg.destinationAddress(), QHostAddress(QHostAddress::LocalHostIPv6));
+    QCOMPARE(dg.destinationPort(), 12345);
+    dg.setDestination(QHostAddress::Broadcast, 137);
+    QCOMPARE(dg.destinationAddress(), QHostAddress(QHostAddress::Broadcast));
+    QCOMPARE(dg.destinationPort(), 137);
+}
+
+void tst_QNetworkDatagram::makeReply_data()
+{
+    qRegisterMetaType<QNetworkDatagram>();
+    QTest::addColumn<QNetworkDatagram>("dgram");
+    QTest::addColumn<QString>("localAddress");
+
+    QNetworkDatagram dgram("some data", QHostAddress("192.0.2.1"), 10001);
+    dgram.setHopLimit(64);
+    dgram.setSender(QHostAddress::LocalHost, 12345);
+    QTest::newRow("ipv4") << dgram << "192.0.2.1";
+
+    dgram.setDestination(QHostAddress("224.0.0.1"), 10002);
+    QTest::newRow("ipv4-multicast") << dgram << QString();
+
+    dgram.setSender(QHostAddress::LocalHostIPv6, 12346);
+    dgram.setDestination(QHostAddress("2001:db8::1"), 12347);
+    QTest::newRow("ipv6") << dgram << "2001:db8::1";
+
+    dgram.setSender(QHostAddress("fe80::1%1"), 10003);
+    dgram.setDestination(QHostAddress("fe80::2%1"), 10004);
+    dgram.setInterfaceIndex(1);
+    QTest::newRow("ipv6-linklocal") << dgram << "fe80::2%1";
+
+    dgram.setDestination(QHostAddress("ff02::1%1"), 10005);
+    QTest::newRow("ipv6-multicast") << dgram << QString();
+}
+
+void tst_QNetworkDatagram::makeReply()
+{
+    QFETCH(QNetworkDatagram, dgram);
+    QFETCH(QString, localAddress);
+
+    {
+        QNetworkDatagram reply = dgram.makeReply("World");
+        QCOMPARE(reply.data(), QByteArray("World"));
+        QCOMPARE(reply.senderAddress(), QHostAddress(localAddress));
+        QCOMPARE(reply.senderPort(), localAddress.isEmpty() ? -1 : dgram.destinationPort());
+        QCOMPARE(reply.destinationAddress(), dgram.senderAddress());
+        QCOMPARE(reply.destinationPort(), dgram.senderPort());
+        QCOMPARE(reply.interfaceIndex(), dgram.interfaceIndex());
+        QCOMPARE(reply.hopLimit(), -1);
+    }
+
+    QNetworkDatagram copy = dgram;
+    copy.setData(copy.data());
+    {
+        QNetworkDatagram reply = qMove(copy).makeReply("World");
+        QCOMPARE(reply.data(), QByteArray("World"));
+        QCOMPARE(reply.senderAddress(), QHostAddress(localAddress));
+        QCOMPARE(reply.senderPort(), localAddress.isEmpty() ? -1 : dgram.destinationPort());
+        QCOMPARE(reply.destinationAddress(), dgram.senderAddress());
+        QCOMPARE(reply.destinationPort(), dgram.senderPort());
+        QCOMPARE(reply.interfaceIndex(), dgram.interfaceIndex());
+        QCOMPARE(reply.hopLimit(), -1);
+    }
+}
+
+QTEST_MAIN(tst_QNetworkDatagram)
+#include "tst_qnetworkdatagram.moc"
diff --git a/tests/auto/network/socket/qudpsocket/tst_qudpsocket.cpp b/tests/auto/network/socket/qudpsocket/tst_qudpsocket.cpp
index 942a074c87..aa01384350 100644
--- a/tests/auto/network/socket/qudpsocket/tst_qudpsocket.cpp
+++ b/tests/auto/network/socket/qudpsocket/tst_qudpsocket.cpp
@@ -39,6 +39,7 @@
 #include <qhostinfo.h>
 #include <qtcpsocket.h>
 #include <qmap.h>
+#include <qnetworkdatagram.h>
 #include <QNetworkProxy>
 #include <QNetworkInterface>
 
@@ -114,6 +115,7 @@ protected slots:
     void async_readDatagramSlot();
 
 private:
+    QList<QHostAddress> allAddresses;
 #ifndef QT_NO_BEARERMANAGEMENT
     QNetworkConfigurationManager *netConfMan;
     QNetworkConfiguration networkConfiguration;
@@ -173,6 +175,7 @@ void tst_QUdpSocket::initTestCase()
 {
     if (!QtNetworkSettings::verifyTestNetworkSettings())
         QSKIP("No network test server available");
+    allAddresses = QNetworkInterface::allAddresses();
 }
 
 void tst_QUdpSocket::init()
@@ -252,6 +255,11 @@ void tst_QUdpSocket::unconnectedServerAndClientTest()
                 int(strlen(message[i])));
         buf[strlen(message[i])] = '\0';
         QCOMPARE(QByteArray(buf), QByteArray(message[i]));
+        QCOMPARE(port, clientSocket.localPort());
+        if (host.toIPv4Address()) // in case the sender is IPv4 mapped in IPv6
+            QCOMPARE(host.toIPv4Address(), makeNonAny(clientSocket.localAddress()).toIPv4Address());
+        else
+            QCOMPARE(host, makeNonAny(clientSocket.localAddress()));
     }
 }
 
@@ -325,14 +333,32 @@ void tst_QUdpSocket::broadcasting()
             QVERIFY(serverSocket.hasPendingDatagrams());
 
             do {
-                QByteArray arr; arr.resize(serverSocket.pendingDatagramSize() + 1);
-                QHostAddress host;
-                quint16 port;
                 const int messageLength = int(strlen(message[i]));
-                QCOMPARE((int) serverSocket.readDatagram(arr.data(), arr.size() - 1, &host, &port),
-                         messageLength);
+                QNetworkDatagram dgram = serverSocket.receiveDatagram();
+                QVERIFY(dgram.isValid());
+                QByteArray arr = dgram.data();
+
+                QCOMPARE(arr.length(), messageLength);
                 arr.resize(messageLength);
                 QCOMPARE(arr, QByteArray(message[i]));
+
+                if (dgram.senderAddress().toIPv4Address()) // in case it's a v6-mapped address
+                    QVERIFY2(allAddresses.contains(QHostAddress(dgram.senderAddress().toIPv4Address())),
+                             dgram.senderAddress().toString().toLatin1());
+                else if (!dgram.senderAddress().isNull())
+                    QVERIFY2(allAddresses.contains(dgram.senderAddress()),
+                             dgram.senderAddress().toString().toLatin1());
+                QCOMPARE(dgram.senderPort(), int(broadcastSocket.localPort()));
+                if (!dgram.destinationAddress().isNull()) {
+                    QVERIFY2(dgram.destinationAddress() == QHostAddress::Broadcast
+                            || broadcastAddresses.contains(dgram.destinationAddress()),
+                             dgram.destinationAddress().toString().toLatin1());
+                    QCOMPARE(dgram.destinationPort(), int(serverSocket.localPort()));
+                }
+
+                int ttl = dgram.hopLimit();
+                if (ttl != -1)
+                    QVERIFY(ttl != 0);
             } while (serverSocket.hasPendingDatagrams());
         }
     }
@@ -1070,7 +1096,7 @@ void tst_QUdpSocket::zeroLengthDatagram()
 #ifdef FORCE_SESSION
     sender.setProperty("_q_networksession", QVariant::fromValue(networkSession));
 #endif
-    QCOMPARE(sender.writeDatagram(QByteArray(), QHostAddress::LocalHost, receiver.localPort()), qint64(0));
+    QCOMPARE(sender.writeDatagram(QNetworkDatagram(QByteArray(), QHostAddress::LocalHost, receiver.localPort())), qint64(0));
 
     QVERIFY2(receiver.waitForReadyRead(1000), QtNetworkSettings::msgSocketError(receiver).constData());
     QVERIFY(receiver.hasPendingDatagrams());
@@ -1355,10 +1381,20 @@ void tst_QUdpSocket::multicast()
     QVERIFY(receiver.hasPendingDatagrams());
     QList<QByteArray> receivedDatagrams;
     while (receiver.hasPendingDatagrams()) {
-        QByteArray datagram;
-        datagram.resize(receiver.pendingDatagramSize());
-        receiver.readDatagram(datagram.data(), datagram.size(), 0, 0);
-        receivedDatagrams << datagram;
+        QNetworkDatagram dgram = receiver.receiveDatagram();
+        receivedDatagrams << dgram.data();
+
+        QVERIFY2(allAddresses.contains(dgram.senderAddress()),
+                dgram.senderAddress().toString().toLatin1());
+        QCOMPARE(dgram.senderPort(), int(sender.localPort()));
+        if (!dgram.destinationAddress().isNull()) {
+            QCOMPARE(dgram.destinationAddress(), groupAddress);
+            QCOMPARE(dgram.destinationPort(), int(receiver.localPort()));
+        }
+
+        int ttl = dgram.hopLimit();
+        if (ttl != -1)
+            QVERIFY(ttl != 0);
     }
     QCOMPARE(receivedDatagrams, datagrams);
 
@@ -1453,7 +1489,8 @@ void tst_QUdpSocket::linkLocalIPv6()
     quint16 port = 0;
     foreach (const QHostAddress& addr, addresses) {
         QUdpSocket *s = new QUdpSocket;
-        QVERIFY2(s->bind(addr, port), qPrintable(s->errorString()));
+        QVERIFY2(s->bind(addr, port), addr.toString().toLatin1()
+                 + '/' + QByteArray::number(port) + ": " + qPrintable(s->errorString()));
         port = s->localPort(); //bind same port, different networks
         sockets << s;
     }
@@ -1463,24 +1500,25 @@ void tst_QUdpSocket::linkLocalIPv6()
     QSignalSpy neutralReadSpy(&neutral, SIGNAL(readyRead()));
 
     QByteArray testData("hello");
-    QByteArray receiveBuffer("xxxxx");
     foreach (QUdpSocket *s, sockets) {
         QSignalSpy spy(s, SIGNAL(readyRead()));
 
         neutralReadSpy.clear();
         QVERIFY(s->writeDatagram(testData, s->localAddress(), neutral.localPort()));
         QTRY_VERIFY(neutralReadSpy.count() > 0); //note may need to accept a firewall prompt
-        QHostAddress from;
-        quint16 fromPort;
-        QCOMPARE((int)neutral.readDatagram(receiveBuffer.data(), receiveBuffer.length(), &from, &fromPort), testData.length());
-        QCOMPARE(from, s->localAddress());
-        QCOMPARE(fromPort, s->localPort());
-        QCOMPARE(receiveBuffer, testData);
-
-        QVERIFY(neutral.writeDatagram(testData, s->localAddress(), s->localPort()));
+
+        QNetworkDatagram dgram = neutral.receiveDatagram(testData.length() * 2);
+        QVERIFY(dgram.isValid());
+        QCOMPARE(dgram.senderAddress(), s->localAddress());
+        QCOMPARE(dgram.senderPort(), int(s->localPort()));
+        QCOMPARE(dgram.data().length(), testData.length());
+        QCOMPARE(dgram.data(), testData);
+
+        QVERIFY(neutral.writeDatagram(dgram.makeReply(testData)));
         QTRY_VERIFY(spy.count() > 0); //note may need to accept a firewall prompt
-        QCOMPARE((int)s->readDatagram(receiveBuffer.data(), receiveBuffer.length(), &from, &fromPort), testData.length());
-        QCOMPARE(receiveBuffer, testData);
+
+        dgram = s->receiveDatagram(testData.length() * 2);
+        QCOMPARE(dgram.data(), testData);
 
         //sockets bound to other interfaces shouldn't have received anything
         foreach (QUdpSocket *s2, sockets) {
@@ -1535,21 +1573,23 @@ void tst_QUdpSocket::linkLocalIPv4()
     QVERIFY(neutral.bind(QHostAddress(QHostAddress::AnyIPv4)));
 
     QByteArray testData("hello");
-    QByteArray receiveBuffer("xxxxx");
     foreach (QUdpSocket *s, sockets) {
         QVERIFY(s->writeDatagram(testData, s->localAddress(), neutral.localPort()));
         QVERIFY2(neutral.waitForReadyRead(10000), QtNetworkSettings::msgSocketError(neutral).constData());
-        QHostAddress from;
-        quint16 fromPort;
-        QCOMPARE((int)neutral.readDatagram(receiveBuffer.data(), receiveBuffer.length(), &from, &fromPort), testData.length());
-        QCOMPARE(from, s->localAddress());
-        QCOMPARE(fromPort, s->localPort());
-        QCOMPARE(receiveBuffer, testData);
-
-        QVERIFY(neutral.writeDatagram(testData, s->localAddress(), s->localPort()));
+
         QVERIFY2(s->waitForReadyRead(10000), QtNetworkSettings::msgSocketError(*s).constData());
-        QCOMPARE((int)s->readDatagram(receiveBuffer.data(), receiveBuffer.length(), &from, &fromPort), testData.length());
-        QCOMPARE(receiveBuffer, testData);
+        QNetworkDatagram dgram = neutral.receiveDatagram(testData.length() * 2);
+        QVERIFY(dgram.isValid());
+        QCOMPARE(dgram.senderAddress(), s->localAddress());
+        QCOMPARE(dgram.senderPort(), int(s->localPort()));
+        QCOMPARE(dgram.data().length(), testData.length());
+        QCOMPARE(dgram.data(), testData);
+
+        QVERIFY(neutral.writeDatagram(dgram.makeReply(testData)));
+
+        dgram = s->receiveDatagram(testData.length() * 2);
+        QVERIFY(dgram.isValid());
+        QCOMPARE(dgram.data(), testData);
 
         //sockets bound to other interfaces shouldn't have received anything
         foreach (QUdpSocket *s2, sockets) {