Replaced `hyper` + `tokio` with our own custom API server implementation #1319

georgepisaltu · 2019-10-09T11:03:24Z

Reason for This PR

Description of Changes

The old hyper implementation of the API server is now replaced with another which uses our own HttpServer. The old api_server interface is refactored. It is now much easier to add API changes to Firecracker, as demonstrated in the commits.

Upsides

release build time down from 2m09s to 1m49s (-21.6%)
debug build time down from 50s to 40s (-20%)
release binary size down from 2.956 KiB to 2.659 KiB (-10.1%)
debug binary size down from 47.4 MiB to 36.5 MiB (-23%)
resident memory usage on a basic configuration down from 1952 KiB to 1468 KiB (-24.8%)
956 fewer lines of code (+1091-55 LOC in this PR are the HttpServer implementation)
30 fewer dependencies, down from 104 to 74 (-28.8%)
average request response time down from 1.122 ms/req to 0.766 ms/req (-31.7%)
no more futures ✨

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.

PR Checklist

All commits in this PR are signed (git commit -s).
This PR is linked to multiple issues.
The description of changes is clear and encompassing.
No docs need to be updated as part of this PR.
Code-level documentation for touched code is included in this PR.
No API changes are included in this PR`. 😆
The changes in this PR have no user impact.

Cargo.lock

api_server/src/parsed_request.rs

api_server/src/lib.rs

api_server/src/request/drive.rs

api_server/src/request/instance_info.rs

api_server/src/request/mmds.rs

api_server/swagger/firecracker.yaml

api_server/src/request/instance_info.rs

`HttpServer` is a struct that leverages `HttpConnection` for exchanging data with a client and `epoll` to be able to run on the same thread as the rest of the code. Signed-off-by: George Pisaltu <gpl@amazon.com>

Signed-off-by: George Pisaltu <gpl@amazon.com>

Replaced the existing API Server with a new one which uses HttpServer instead of using Hyper and Tokio. This reduces the number of dependencies from 104 to 74. Using this new ApiServer enables much easier addition of new API requests, as can be seen in the following commits. This commit only brings in the ApiServer framework plus processing MMDS and InstanceInfo requests, the following commits will provide processing of the other Firecracker URLs. Signed-off-by: George Pisaltu <gpl@amazon.com>

The renamed method only adds EPOLLIN events. Renamed it for clarity. Signed-off-by: George Pisaltu <gpl@amazon.com>

Signed-off-by: George Pisaltu <gpl@amazon.com>

The format for the error log has changed and this commit updates it to reflect the changes. Signed-off-by: George Pisaltu <gpl@amazon.com>

Signed-off-by: George Pisaltu <gpl@amazon.com>

georgepisaltu changed the title ~~Api server~~ Replaced hyper + tokio with our own custom API server implementation Oct 9, 2019

alxiord assigned georgepisaltu Oct 9, 2019

georgepisaltu force-pushed the api_server branch 5 times, most recently from cb7b856 to de0be0a Compare October 15, 2019 08:39

dhrgit self-requested a review October 15, 2019 08:50

acatangiu reviewed Oct 15, 2019

View reviewed changes

sandreim self-requested a review October 17, 2019 13:05

georgepisaltu force-pushed the api_server branch 2 times, most recently from 9c0571c to 20e62fb Compare October 18, 2019 16:26

sandreim reviewed Oct 22, 2019

View reviewed changes

api_server/src/request/instance_info.rs Outdated Show resolved Hide resolved

georgepisaltu added 12 commits October 22, 2019 18:05

Implemented HttpServer

259e6c4

`HttpServer` is a struct that leverages `HttpConnection` for exchanging data with a client and `epoll` to be able to run on the same thread as the rest of the code. Signed-off-by: George Pisaltu <gpl@amazon.com>

micro_http: add tests for displaying errors

5fb73b4

Signed-off-by: George Pisaltu <gpl@amazon.com>

delete the hyper-based api-server

aa7ac85

Signed-off-by: George Pisaltu <gpl@amazon.com>

epoll: rename add_event() to add_epollin_event()

70a7e80

The renamed method only adds EPOLLIN events. Renamed it for clarity. Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for logger in new api server

150d9e1

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for machine config in new api server

747d293

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for vsock in new api server

bb55a08

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for net ifaces in new api server

3418d7a

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for drives in new api server

bea4515

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for boot source in new api server

fd9f3ff

Signed-off-by: George Pisaltu <gpl@amazon.com>

add support for actions in new api server

df27043

Signed-off-by: George Pisaltu <gpl@amazon.com>

georgepisaltu force-pushed the api_server branch 2 times, most recently from c7d1257 to be5e9a8 Compare October 23, 2019 07:58

georgepisaltu added 3 commits October 23, 2019 11:26

added unit tests for all parsed requests

da2d246

Signed-off-by: George Pisaltu <gpl@amazon.com>

Fix error message in logging integration test

46e2123

The format for the error log has changed and this commit updates it to reflect the changes. Signed-off-by: George Pisaltu <gpl@amazon.com>

update micro_http documentation

bc027b5

Signed-off-by: George Pisaltu <gpl@amazon.com>

exported micro_http::MediaType

953aeaf

Signed-off-by: George Pisaltu <gpl@amazon.com>

georgepisaltu force-pushed the api_server branch from be5e9a8 to 9ecbcc1 Compare October 23, 2019 08:26

refactoring to remove duplicate code in errors

0b0dbcb

Signed-off-by: George Pisaltu <gpl@amazon.com>

georgepisaltu force-pushed the api_server branch from 9ecbcc1 to 0b0dbcb Compare October 23, 2019 10:48

sandreim self-requested a review October 23, 2019 12:13

sandreim approved these changes Oct 23, 2019

View reviewed changes

acatangiu approved these changes Oct 23, 2019

View reviewed changes

Merge branch 'master' into api_server

c7f9a8a

georgepisaltu merged commit c398f9f into firecracker-microvm:master Oct 23, 2019

acatangiu mentioned this pull request Oct 23, 2019

Implemented HttpServer #1240

Closed

7 tasks

This was referenced Oct 23, 2019

Plumbing to get rid of hyper dependency #1194

Closed

Replace hyper with custom API implementation #615

Closed

paulbaumgart mentioned this pull request Nov 12, 2019

[WIP] Implement VirtioFS device backend #1351

Closed

15 tasks

georgepisaltu deleted the api_server branch July 7, 2020 07:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Replaced `hyper` + `tokio` with our own custom API server implementation #1319

Replaced `hyper` + `tokio` with our own custom API server implementation #1319

Uh oh!

georgepisaltu commented Oct 9, 2019 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Replaced hyper + tokio with our own custom API server implementation #1319

Replaced hyper + tokio with our own custom API server implementation #1319

Uh oh!

Conversation

georgepisaltu commented Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reason for This PR

Description of Changes

License Acceptance

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Replaced `hyper` + `tokio` with our own custom API server implementation #1319

Replaced `hyper` + `tokio` with our own custom API server implementation #1319

georgepisaltu commented Oct 9, 2019 •

edited

Loading