IPCore String-based API removal #11942

michalpasztamobica · 2019-11-26T09:25:22Z

Summary of change

Remove the deprecated string-based APIs. This is a breaking change, targeted for mbed-os-6.0.
The APIs were deperecated in mbed-os-5.15, see #11914. Their internal usage was given up in #11941.

The following API functions are being removed:

TCPServer (whole class is deprecated already)
TCPSocket::connect(const char *host, uint16_t port);
TLSSocket::connect(const char *host, uint16_t port);
DTLSSocket::connect(const char *host, uint16_t port)
InternetDatagramSocket::sendto(const char *host, uint16_t port, data, size);
InternetSocket::bind(const char *address, uint16_t port);
L3IP:add_ipv4_multicast_group(const char *address);
L3IP:add_ipv6_multicast_group(const char *address)
L3IP:remove_ipv4_multicast_group(const char *address);
L3IP:remove_ipv6_multicast_group(const char *address)
NetworkInterface::get_ip_address()
NetworkInterface::get_netmask()
NetworkInterface::get_gateway()
NetworkInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
NetworkStack::get_ip_address()
NetworkStack::get_ip_address_if()

Impact of changes

Applications using the old APIs will not compile.

Migration actions required

Users are expected to use their SocketAddress-based counterparts and explicitly call gethostbyname() if DNS address resolution is needed.

Documentation

Documentation was added to the first PR: #11914.

Pull request type

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[x] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[] No Tests required for this change (E.g docs only update)
[x] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@AnttiKauppila
@SeppoTakalo

ciarmcom · 2019-11-26T10:00:36Z

@michalpasztamobica, thank you for your changes.
@AnttiKauppila @SeppoTakalo @ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-wan @ARMmbed/mbed-os-maintainers please review.

0xc0170 · 2019-11-26T14:01:01Z

Please review travis failures, they look related

michalpasztamobica · 2019-11-26T20:19:45Z

@0xc0170 , this PR removes the deprecated string-based APIs. It will only compile when the internal usage of these deprecated API functions is removed. So, effectively, this PR depends on #11941 .
Sorry if I submitted this prematurely, at least we have time for everyone to review...

0xc0170 · 2019-11-27T07:57:34Z

@michalpasztamobica All fine here, just state the dependency (adding here label needs preceding PR)

michalpasztamobica · 2019-12-02T07:46:22Z

This is now rebased and ready for CI, @0xc0170 .
Just a reminder: this is a breaking change... I think we need that big red label here?

0xc0170 · 2019-12-02T10:07:39Z

CI started

mbed-ci · 2019-12-02T10:45:18Z

Test run: FAILED

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

Failed test jobs:

jenkins-ci/mbed-os-ci_build-GCC_ARM
jenkins-ci/mbed-os-ci_build-IAR
jenkins-ci/mbed-os-ci_build-ARM

michalpasztamobica · 2019-12-02T13:21:15Z

CI has found a number of platforms, which I did not build locally, that may need adjustments as they are still using the deprecated API. Unfortunately I did not find them all in #11941, as I was not able to build every possible platform. I will replace their usage with the new API, but it will take some time.

michalpasztamobica · 2019-12-02T14:34:59Z

@0xc0170 , please help me make sure I got things right.
It seems that CI is using the examples.py script to build and run official example projects (I found CI failing in this line).
To have this PR merged I therefore need to fix all the example projects first?
I already have some code prepared, for example here: ARMmbed/mbed-os-example-wifi#176. But this will only compile, when I update the mbed-os versions to a commit which contains the new SocketAddress-based API.
I can therefore either:

wait for mbed-os-5.15 release, then update all the examples,
OR
update all the examples, with mbed-os.lib pointing to the commit which contains new API addition (but does not have any particular tag).

I guess option (2) is not real, I have only seen mbed-os.lib being updated to release tags.

Either way I can only resolve the failures of this PR once examples are all updated.

Is that right, or is there some smarter way of merging this sooner?

0xc0170

I updated the description (new template as we used here the old back in November).

mbed-ci · 2020-02-11T12:57:49Z

Test run: FAILED

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

Failed test jobs:

jenkins-ci/mbed-os-ci_build-IAR

michalpasztamobica · 2020-02-11T13:16:04Z

@0xc0170 , failures seem unrelated (K66F mesh-minimal-example):

[DEBUG] Output:   DigitalOut led_1(MBED_CONF_APP_LED, 1);
[DEBUG] Output:                    ^
[DEBUG] Output: "/builds/ws/mbed-os-ci_build-IAR@6/examples/mbed-os-example-mesh-minimal/mesh_led_control_example.cpp",39  Error[Pe020]: identifier "MBED_CONF_APP_LED" is undefined
[DEBUG] Output: 
[DEBUG] Output:   InterruptIn my_button(MBED_CONF_APP_BUTTON);
[DEBUG] Output:                         ^
[DEBUG] Output: "/builds/ws/mbed-os-ci_build-IAR@6/examples/mbed-os-example-mesh-minimal/mesh_led_control_example.cpp",40  Error[Pe020]: identifier "MBED_CONF_APP_BUTTON" is undefined
[DEBUG] Output: 
[DEBUG] Output:   DigitalOut output(MBED_CONF_APP_RELAY_CONTROL, 1);
[DEBUG] Output:                     ^
[DEBUG] Output: "/builds/ws/mbed-os-ci_build-IAR@6/examples/mbed-os-example-mesh-minimal/mesh_led_control_example.cpp",41  Error[Pe020]: identifier "MBED_CONF_APP_RELAY_CONTROL" is undefined
[DEBUG] Output: 
[DEBUG] Output:           my_button.mode(MBED_CONF_APP_BUTTON_MODE);
[DEBUG] Output:                          ^
[DEBUG] Output: "/builds/ws/mbed-os-ci_build-IAR@6/examples/mbed-os-example-mesh-minimal/mesh_led_control_example.cpp",210  Error[Pe020]: identifier "MBED_CONF_APP_BUTTON_MODE" is undefined

And then things like this for nanostack-border-router:

[DEBUG] Output: "/builds/ws/mbed-os-ci_build-IAR@6/examples/nanostack-border-router/source/static_6lowpan_config.h",40  Error[Pe020]: identifier "MBED_CONF_APP_BEACON_PROTOCOL_ID" is undefined

And the same happened for NUCLEO_F429ZI

EDIT: and they only occur for IAR 👀

michalpasztamobica · 2020-02-13T07:46:16Z

I tried to rerun just the IAR build which failed, but it yielded the same result (could not build blinky-baremetal). The logs are not showing which version gets built, so I assume it might just be building the old code?
@0xc0170 , could it help if you triggered the CI to run from scratch?

0xc0170 · 2020-02-13T08:52:26Z

CI restarted

mbed-ci · 2020-02-13T10:44:03Z

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 12
Build artifacts

0xc0170 · 2020-02-13T12:21:19Z

Final approval from @bulislaw and this will go in soon.

0xc0170 · 2020-02-21T10:16:36Z

CI started (to make sure nothing has changed in the last days), should be quick

mbed-ci · 2020-02-21T12:09:17Z

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 13
Build artifacts

kjbracey · 2020-02-21T13:20:19Z

I've been busy shifting virtual to override, and rebasing on top of this revealed some misalignments between base and derived classes. See my PRs.

cmonr · 2020-02-22T03:51:48Z

Leaving a note here.
Looks like one of the examples in the docs needs to be updated.

Docs are now failing one of the code snippet tests: https://travis-ci.org/ARMmbed/mbed-os-5-docs/jobs/653627350#L807

michalpasztamobica force-pushed the remove_deprecated_apis branch from 40634cb to dd971dd Compare November 26, 2019 10:00

ciarmcom requested review from AnttiKauppila, SeppoTakalo and a team November 26, 2019 10:00

ciarmcom added the needs: review label Nov 26, 2019

0xc0170 added the release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0 label Nov 26, 2019

SeppoTakalo previously approved these changes Nov 26, 2019

View reviewed changes

0xc0170 added needs: work and removed needs: review labels Nov 26, 2019

0xc0170 added the needs: preceding PR label Nov 27, 2019

michalpasztamobica force-pushed the remove_deprecated_apis branch 2 times, most recently from 483d921 to 676c07b Compare December 2, 2019 07:05

0xc0170 added BREAKING-CHANGE needs: CI and removed needs: preceding PR needs: work labels Dec 2, 2019

0xc0170 added needs: work and removed needs: CI labels Dec 2, 2019

michalpasztamobica force-pushed the remove_deprecated_apis branch from 676c07b to 0e48843 Compare December 2, 2019 18:29

0xc0170 approved these changes Feb 11, 2020

View reviewed changes

mergify bot added needs: work and removed needs: CI labels Feb 11, 2020

michalpasztamobica mentioned this pull request Feb 11, 2020

Add get_time function to ESP8266 #12300

Merged

0xc0170 mentioned this pull request Feb 12, 2020

Nightly: K66F and NUCLEO_F429ZI fail to build some examples #12414

Closed

0xc0170 added needs: review and removed needs: work labels Feb 13, 2020

0xc0170 added release-version: 6.0.0-alpha-3 and removed release-version: 6.0.0-alpha-2 Second pre-release version of 6.0.0 labels Feb 21, 2020

bulislaw approved these changes Feb 21, 2020

View reviewed changes

0xc0170 added needs: CI and removed needs: review labels Feb 21, 2020

mergify bot added ready for merge and removed needs: CI labels Feb 21, 2020

0xc0170 merged commit 8f1bf96 into ARMmbed:master Feb 21, 2020

mergify bot removed the ready for merge label Feb 21, 2020

kivaisan mentioned this pull request Feb 21, 2020

Build failure if PPP and mbed trace or L3IPInterface is enabled #12486

Closed

kjbracey mentioned this pull request Feb 21, 2020

C++11-ify virtualisation in netsocket #12487

Merged

kjbracey mentioned this pull request Feb 21, 2020

C++11-ify virtualisation in lwIP classes #12489

Merged

kivaisan mentioned this pull request Feb 25, 2020

Fix 2 string based IP address removal regressions #12506

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IPCore String-based API removal #11942

IPCore String-based API removal #11942

michalpasztamobica commented Nov 26, 2019 •

edited by 0xc0170

Loading

ciarmcom commented Nov 26, 2019

0xc0170 commented Nov 26, 2019

michalpasztamobica commented Nov 26, 2019

0xc0170 commented Nov 27, 2019

michalpasztamobica commented Dec 2, 2019

0xc0170 commented Dec 2, 2019

mbed-ci commented Dec 2, 2019

michalpasztamobica commented Dec 2, 2019

michalpasztamobica commented Dec 2, 2019

0xc0170 left a comment

mbed-ci commented Feb 11, 2020

michalpasztamobica commented Feb 11, 2020 •

edited

Loading

michalpasztamobica commented Feb 13, 2020

0xc0170 commented Feb 13, 2020

mbed-ci commented Feb 13, 2020

0xc0170 commented Feb 13, 2020

0xc0170 commented Feb 21, 2020

mbed-ci commented Feb 21, 2020

kjbracey commented Feb 21, 2020

cmonr commented Feb 22, 2020

IPCore String-based API removal #11942

IPCore String-based API removal #11942

Conversation

michalpasztamobica commented Nov 26, 2019 • edited by 0xc0170 Loading

Summary of change

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

ciarmcom commented Nov 26, 2019

0xc0170 commented Nov 26, 2019

michalpasztamobica commented Nov 26, 2019

0xc0170 commented Nov 27, 2019

michalpasztamobica commented Dec 2, 2019

0xc0170 commented Dec 2, 2019

mbed-ci commented Dec 2, 2019

Test run: FAILED

michalpasztamobica commented Dec 2, 2019

michalpasztamobica commented Dec 2, 2019

0xc0170 left a comment

Choose a reason for hiding this comment

mbed-ci commented Feb 11, 2020

Test run: FAILED

michalpasztamobica commented Feb 11, 2020 • edited Loading

michalpasztamobica commented Feb 13, 2020

0xc0170 commented Feb 13, 2020

mbed-ci commented Feb 13, 2020

Test run: SUCCESS

0xc0170 commented Feb 13, 2020

0xc0170 commented Feb 21, 2020

mbed-ci commented Feb 21, 2020

Test run: SUCCESS

kjbracey commented Feb 21, 2020

cmonr commented Feb 22, 2020

michalpasztamobica commented Nov 26, 2019 •

edited by 0xc0170

Loading

michalpasztamobica commented Feb 11, 2020 •

edited

Loading