LwIP: add ICMPv4 Socket support #10978

vmedcy · 2019-07-05T14:41:03Z

Description

Implement ICMPSocket class, make LWIP_RAW option configurable with lwip.raw_socket_enabled, and update socket_open to support nsapi_protocol_t::NSAPI_ICMP.

This allows the application layer to hook into the IP layer itself.

This feature supports only ICMP socket (ICMPv4) and not RAW Socket

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[X] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@kjbracey-arm @tymoteuszblochmobica

Release Notes

netsocket feature is extended with ICMP socket implementation. This change is only for ICMPv4 and ICMPv6 is not currently supported

ciarmcom · 2019-07-05T15:00:33Z

@vmedcy, thank you for your changes.
@tymoteuszblochmobica @kjbracey-arm @ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-maintainers please review.

kjbracey · 2019-07-08T07:34:06Z

features/lwipstack/lwipopts.h

@@ -84,7 +84,7 @@
 #define SYS_LIGHTWEIGHT_PROT        1

 #ifndef LWIP_RAW
-#define LWIP_RAW                    0
+#define LWIP_RAW                    1


This should be configurable via JSON, like TCP. Enabling raw socket support will increase build size of lwIP, and most people will not need it.

I think it should be off by default, but maybe that could be debated.

yes I agree.

kjbracey · 2019-07-08T07:34:49Z

features/netsocket/NetworkStack.h

@@ -184,6 +184,7 @@ class NetworkStack: public DNS {
 protected:
    friend class InternetSocket;
    friend class UDPSocket;
+    friend class RAWSocket;


RawIPSocket. RAW is not an acronym, and I think we need to distinguish from non-IP cases.

If there some way to create an ICMP Socket by re-using UDPSocket class ( such as InternetDatagram Socket with ICMP protocol it would be nice)

kjbracey · 2019-07-08T07:35:26Z

features/netsocket/nsapi_types.h

@@ -127,6 +127,7 @@ typedef enum nsapi_security {
    NSAPI_SECURITY_CHAP         = 0x6,      /*!< phrase conforms to PPP authentication context */
    NSAPI_SECURITY_EAP_TLS      = 0x7,      /*!< phrase conforms to EAP-TLS */
    NSAPI_SECURITY_PEAP         = 0x8,      /*!< phrase conforms to PEAP */
+    NSAPI_SECURITY_WPA2_ENT     = 0x9,      /*!< phrase conforms to WPA2-AES and WPA-TKIP with enterprise security */


This seems separate to this PR. Can you make it separate - group it with any other change it applies too.

kjbracey · 2019-07-08T07:36:36Z

features/netsocket/nsapi_types.h

@@ -266,6 +268,7 @@ typedef enum nsapi_socket_option {
    NSAPI_ADD_MEMBERSHIP,    /*!< Add membership to multicast address */
    NSAPI_DROP_MEMBERSHIP,   /*!< Drop membership to multicast address */
    NSAPI_BIND_TO_DEVICE,        /*!< Bind socket network interface name*/
+    NSAPI_IP_TOS,            /*!< IP TOS */


Separate out from this PR - if you're adding it, I would want to see at least 1 of lwIP or Nanostack support to illustrate the parameter type.

kjbracey · 2019-07-08T07:37:23Z

features/netsocket/RAWSocket.h

+     *
+     *  To be used within accept() function. Close() will clean this up.
+     */
+    RAWSocket(RAWSocket *parent, nsapi_socket_t socket, SocketAddress address);


This was copied from TCPSocket? Not needed for raw.

I made this change by copying from UDPSocket.cpp, yes it is not needed for RAWSocket

features/lwipstack/LWIPStack.cpp

kjbracey · 2019-07-08T07:45:22Z

features/netsocket/RAWSocket.cpp

+#include "Timer.h"
+#include "mbed_assert.h"
+
+RAWSocket::RAWSocket()


This is a big duplication of UDPSocket (another one after CellularNonIPSocket). In this case it's so similar, because it's NSAPI, that I'm thinking there should be an InternetDatagramSocket base class to subsume the commonality, that both this and UDPSocket inherit from.

What do others think?

Yes InternetDatagramSocket can be a base class, if Application needs to create an ICMP socket they can use this class.

maclobdell · 2019-08-15T20:49:24Z

@balajicyp @vmedcy - Can you confirm the status of this PR from your side? It is showing changes requested. Is there a clear way forward?

0xc0170 · 2019-08-20T11:06:03Z

@balajicyp @vmedcy - Can you confirm the status of this PR from your side? It is showing changes requested. Is there a clear way forward?

If this comes to 5.14, it should be updated soon.

vmedcy · 2019-08-20T12:32:26Z

@maclobdell @0xc0170 :

If this comes to 5.14, it should be updated soon.

I expect @balajicyp will respond next week after return from vacation.

0xc0170 · 2019-08-26T11:54:55Z

If this wants to be in 5.14, it needs to be updated soon as 5.14 code freeze is end of this week.

balajicyp · 2019-08-26T14:37:56Z

I will take up this work this week.
I will create a new InternetDatagram socket class , which will have parameter as NSAPI_ICMP. The UDP socket class can inherit from this InternetDatagramSocket Class and have methods which can over-ride the base class.

The Enabling of the option LWIP_RAW will be done by *overrides in Application json file, so that by default this option will be off.

balajicyp · 2019-08-27T21:02:34Z

I have my changes here at 23b0891 , I try to push to same PR but there is some refs which are mismatched

@0xc0170 @vmedcy @@maclobdell

balajicyp · 2019-08-27T21:41:39Z

I have the new changes pushed here, please review and merge

bulislaw · 2019-08-28T10:52:23Z

@kjbracey-arm @AnttiKauppila please re-review.

kjbracey · 2019-08-28T11:04:31Z

features/lwipstack/LWIPStack.cpp

+    } else if (proto == NSAPI_UDP) {
+        netconntype = NETCONN_UDP;
+    } else {
+        netconntype = NETCONN_RAW;


For future-proofing, can you make this error for unknown proto? I know it didn't before, but it should have,

do you mean the known proto be NASPI_ERROR_PROTO_UNKNOWN and return from function as below.
...
} else if (proto == NSAPI_UDP) {
netconntype = NETCONN_UDP;
} else if { proto == NSAPI_ICMP) {
netconntype = NETCONN_RAW;
} else {
return NSAPI_ERROR_PROTO_UNKNOWN;
}

removed NSAPI_ERROR_PROTO_UNKNOWN

kjbracey · 2019-08-28T11:12:53Z

features/netsocket/RAWIPSocket.cpp

+#include "Timer.h"
+#include "mbed_assert.h"
+
+RAWIPSocket::RAWIPSocket()


In earlier review we agreed this should become ICMPSocket.

Yes I can change it to ICMPSocket.h and ICMPSocket.cpp and change class names accordingly.

kjbracey · 2019-08-28T11:14:41Z

features/netsocket/RAWIPSocket.h

+                          "The RAWSocket(S *stack) constructor is deprecated"
+                          "It discards the open() call return value."
+                          "Use another constructor and call open() explicitly, instead.")
+    RAWIPSocket(S *stack)


No need to include a deprecated constructor in a new class.

ok I will remove RAWIPSocket(S *stack)

kjbracey · 2019-08-28T11:35:55Z

features/netsocket/UDPSocket.h



 /** UDP socket implementation.
 */
-class UDPSocket : public InternetSocket {
+class UDPSocket : public RAWIPSocket {


The code sharing is good, but the class heirarchy is off. This lets you pass a UDPSocket * to someone expecting a RAWIPSocket *. Previous discussion suggested inserting an underlying datagram socket base class.

@kjbracey-arm, Please specify more details what functions Datagram Socket Base class should have? is it all the methods except for the constructor and get_proto()

@kjbracey-arm, I have added the InternetDatagram.h/InternetDatagram.cpp as Base Class, Please review.

0xc0170 · 2019-08-29T07:09:26Z

PR was updated, @kjbracey-arm @tymoteuszblochmobica Please review

Note, we are close to the 5.14 code freeze. This needs update asap

kjbracey

Nearly there. Just minor tidies and elimination of unneeded bits.

features/netsocket/ICMPSocket.h

features/netsocket/InternetDatagram.cpp

features/netsocket/InternetDatagram.h

features/netsocket/InternetDatagram.cpp

features/netsocket/InternetDatagram.h

features/netsocket/NetworkStack.h

features/netsocket/UDPSocket.h

features/netsocket/nsapi_types.h

features/lwipstack/LWIPStack.cpp

features/lwipstack/mbed_lib.json

0xc0170 · 2019-08-29T09:21:12Z

@vmedcy Let us know once answered reviewers comments above. IF this is targeting 5.14, needs to be updated asap to get its approvals otherwise will be moved to the next minor version.

balajicyp

@kjbracey-arm, I have uploaded the latest changes based on your comments, please review the same.

mbed-ci · 2019-10-28T12:04:18Z

Test run: FAILED

Summary: 1 of 4 test jobs failed
Build number : 2
Build artifacts

Failed test jobs:

jenkins-ci/mbed-os-ci_unittests

0xc0170 · 2019-10-28T12:11:07Z

One more commit to be added

It was quicker than I thought :)
Here is a commit which fixes the unittests.
This is the branch.

@vmedcy Please see this response above - it should fix unittests, cherry-pick it to your branch

balajicyp · 2019-10-28T19:13:28Z

@0xc0170
I have re-based my code to the commit done by @michalpasztamobica . Please check.

0xc0170 · 2019-10-29T09:30:17Z

CI restarted

mbed-ci · 2019-10-29T16:19:16Z

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 3
Build artifacts

0xc0170 · 2019-10-30T08:31:26Z

Release Notes

@vmedcy One missing thing for this one, please add release notes for this addition.

kjbracey · 2019-10-30T09:22:55Z

The basic description and summary needs to be updated too - it's now adding ICMPSocket specifically, not a general raw IP socket.

kjbracey · 2019-10-30T09:32:21Z

On which note, I've very belatedly realised that this implementation is specifically making an ICMPv4 socket (IP_PROTO_ICMP = 1). For IPv6 you want to be speaking ICMPv6 (IP_NEXTH_ICMP6 = 58).

ICMPv6 is a different protocol, so I guess it logically would be a separate ICMP6Socket class, and a separate NSAPI_ICMP6. There's nothing fundamentally stopping you speaking ICMPv6 on IPv4 or ICMPv4 on IPv6. It would just be dumb. An application has to know which protocol it wants to speak, you can't quietly make ICMPSocket choose different protocol numbers based on address.

So this is fine. But it should be mentioned in the release notes/docs that this is ICMPv4, and ICMPv6 is not currently supported.

balajicyp · 2019-10-30T17:59:14Z

@kjbracey-arm @0xc0170 @vmedcy
I am unable to update the release notes section or description. The Author for this is @vmedcy

@vmedcy, Please update the release notes section and the description to say this feature supports only ICMP socket (ICMPv4) and not RAW Socket

vmedcy · 2019-10-30T18:44:30Z

@balajicyp I updated the release notes and description appropriately.

balajicyp · 2019-10-30T18:47:57Z

Thanks @vmedcy

ciarmcom requested review from kjbracey, tymoteuszblochmobica and a team July 5, 2019 15:00

ciarmcom added the needs: review label Jul 5, 2019

vmedcy mentioned this pull request Jul 5, 2019

PSOC6: initial integration of Cypress HAL #10692

Merged

AnttiKauppila approved these changes Jul 7, 2019

View reviewed changes

kjbracey suggested changes Jul 8, 2019

View reviewed changes

artokin added needs: work and removed needs: review labels Jul 8, 2019

0xc0170 added the release-version: 5.14.0-rc1 label Jul 9, 2019

kjbracey suggested changes Aug 28, 2019

View reviewed changes

0xc0170 requested a review from kjbracey August 29, 2019 07:09

0xc0170 added needs: review and removed needs: work labels Aug 29, 2019

kjbracey suggested changes Aug 29, 2019

View reviewed changes

0xc0170 added needs: work and removed needs: review labels Aug 29, 2019

balajicyp reviewed Aug 29, 2019

View reviewed changes

Rebase the code Unittests aware of InternetDatagramSocket

2d410e3

0xc0170 added component: bootloader needs: CI and removed component: bootloader needs: work labels Oct 29, 2019

michalpasztamobica mentioned this pull request Oct 29, 2019

Add API to get ipv6 link local address #11279

Merged

0xc0170 added ready for merge release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0 and removed needs: CI labels Oct 30, 2019

0xc0170 added needs: work and removed ready for merge labels Oct 30, 2019

vmedcy changed the title ~~LwIP: add RAW socket support~~ LwIP: add ICMPv4 Socket support Oct 30, 2019

0xc0170 added ready for merge and removed needs: work labels Oct 31, 2019

0xc0170 merged commit da6b336 into ARMmbed:master Oct 31, 2019

0xc0170 removed the ready for merge label Oct 31, 2019

maclobdell added the priority: high label Nov 7, 2019

0xc0170 added release-version: 5.15.0-rc1 and removed release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0 labels Nov 19, 2019

LwIP: add ICMPv4 Socket support #10978

LwIP: add ICMPv4 Socket support #10978

Conversation

vmedcy commented Jul 5, 2019 • edited by 0xc0170 Loading

Description

Pull request type

Reviewers

Release Notes

ciarmcom commented Jul 5, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maclobdell commented Aug 15, 2019

0xc0170 commented Aug 20, 2019

vmedcy commented Aug 20, 2019

0xc0170 commented Aug 26, 2019

balajicyp commented Aug 26, 2019

balajicyp commented Aug 27, 2019

balajicyp commented Aug 27, 2019

bulislaw commented Aug 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xc0170 commented Aug 29, 2019 • edited Loading

kjbracey left a comment

Choose a reason for hiding this comment

0xc0170 commented Aug 29, 2019

balajicyp left a comment

Choose a reason for hiding this comment

mbed-ci commented Oct 28, 2019

0xc0170 commented Oct 28, 2019

balajicyp commented Oct 28, 2019

0xc0170 commented Oct 29, 2019

mbed-ci commented Oct 29, 2019

0xc0170 commented Oct 30, 2019

kjbracey commented Oct 30, 2019 • edited Loading

kjbracey commented Oct 30, 2019

balajicyp commented Oct 30, 2019

vmedcy commented Oct 30, 2019

balajicyp commented Oct 30, 2019

vmedcy commented Jul 5, 2019 •

edited by 0xc0170

Loading

0xc0170 commented Aug 29, 2019 •

edited

Loading

kjbracey commented Oct 30, 2019 •

edited

Loading