OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/net/lib/http/README_http_parser

15 lines
544 B
Plaintext
Raw Normal View History

iot: Add HTTP support for Zephyr This commit adds HTTP message handling support for Zephyr. So, no network routines are involved at this level. To add HTTP message handling support for Zephyr, we explored the following options: 1. Importing an external project and perhaps adapting it to fit our requirements. The criteria to pick one codebase among all the available projects are: licensing, correctness and performance. 2. Writing our own implementation from scratch. We decided to import an external project instead of implementing our own parser, mainly due to code maturity and correctness. It could take more time to obtain a production-ready parser from scratch than adapting a state-of-art library. The following is a list of some projects offering similar functionality. lighttpd (many files) * License: revised BSD license * Supported: active * Comments: this parser can't be integrated to Zephyr due to dependencies that currently are not satisficed by our SDK. nginx (src/http/ngx_http_parse.c) * License: 2-clause BSD-like * Supported: very active * Comments: this parser can't be integrated to Zephyr due to dependencies that currently are not satisficed by our SDK. wget (src/http-parse.c) * License: GPL 3.0 * Supported: very active * Comments: this code can't be included in Zephyr due to licensing issues curl (lib/http.c) * License: MIT/X derivate, see: https://curl.haxx.se/docs/copyright.html * Supported: very active * Comment: it must be forked and adapted to run in Zephyr. It is not optimized for low-power devices. nodejs http-parser (http_parser.c) * License: nginx license (2-clause BSD-like) and MIT license * Supported: very active * Comments: optimized with performance in mind. From https://github.com/nodejs/http-parser: "It does not make any syscalls nor allocations, it does not buffer data, it can be interrupted at anytime. It only requires about 40 bytes of data per message stream." So, nodejs/http-parser looks a very good choice for Zephyr. In this commit, we integrate nodejs' parser to Zephyr. Origin: https://github.com/nodejs/http-parser/releases/tag/v2.7.1 https://github.com/nodejs/http-parser/archive/v2.7.1.tar.gz NOTE: This patch reformats the http_parser files to reduce checkpatch warnings. Changes made in this refactoring are available at: Repo: https://gitlab.com/santes/http_parser/commits/refactoring1 Commit: 9ccfaa23f1c8438855211fa902ec8e7236b702b1 Jira: ZEP-346 Jira: ZEP-776 Change-Id: I29b1d47f323a5841cd4d0a2afbc2cc83a0f576f0 Signed-off-by: Flavio Santes <flavio.santes@intel.com>
2016-09-01 10:46:36 +08:00
HTTP Parser Support in Zephyr
-----------------------------
The http-parser library* from the nodejs project is a downstream of an
externally maintained open source project. The original upstream code
can be found at:
https://github.com/nodejs/http-parser/releases/tag/v2.7.1
https://github.com/nodejs/http-parser/archive/v2.7.1.tar.gz
net: lib: http: split out URL parsing as a separate CONFIG With the introduction of CoAP and other protocols, URL parsing is be needed when HTTP_PARSER is not. Let's split out the existing functionality of URL parsing into it's own CONFIG and let HTTP_PARSER use it by automatically selecting HTTP_PARSER_URL when HTTP_PARSER is enabled. Signed-off-by: Michael Scott <michael.scott@linaro.org>
2017-10-17 06:11:00 +08:00
NOTE: The portions which relate to URL parsing have been split out into
http_parser_url.c (orignially located in http_parser.c).
iot: Add HTTP support for Zephyr This commit adds HTTP message handling support for Zephyr. So, no network routines are involved at this level. To add HTTP message handling support for Zephyr, we explored the following options: 1. Importing an external project and perhaps adapting it to fit our requirements. The criteria to pick one codebase among all the available projects are: licensing, correctness and performance. 2. Writing our own implementation from scratch. We decided to import an external project instead of implementing our own parser, mainly due to code maturity and correctness. It could take more time to obtain a production-ready parser from scratch than adapting a state-of-art library. The following is a list of some projects offering similar functionality. lighttpd (many files) * License: revised BSD license * Supported: active * Comments: this parser can't be integrated to Zephyr due to dependencies that currently are not satisficed by our SDK. nginx (src/http/ngx_http_parse.c) * License: 2-clause BSD-like * Supported: very active * Comments: this parser can't be integrated to Zephyr due to dependencies that currently are not satisficed by our SDK. wget (src/http-parse.c) * License: GPL 3.0 * Supported: very active * Comments: this code can't be included in Zephyr due to licensing issues curl (lib/http.c) * License: MIT/X derivate, see: https://curl.haxx.se/docs/copyright.html * Supported: very active * Comment: it must be forked and adapted to run in Zephyr. It is not optimized for low-power devices. nodejs http-parser (http_parser.c) * License: nginx license (2-clause BSD-like) and MIT license * Supported: very active * Comments: optimized with performance in mind. From https://github.com/nodejs/http-parser: "It does not make any syscalls nor allocations, it does not buffer data, it can be interrupted at anytime. It only requires about 40 bytes of data per message stream." So, nodejs/http-parser looks a very good choice for Zephyr. In this commit, we integrate nodejs' parser to Zephyr. Origin: https://github.com/nodejs/http-parser/releases/tag/v2.7.1 https://github.com/nodejs/http-parser/archive/v2.7.1.tar.gz NOTE: This patch reformats the http_parser files to reduce checkpatch warnings. Changes made in this refactoring are available at: Repo: https://gitlab.com/santes/http_parser/commits/refactoring1 Commit: 9ccfaa23f1c8438855211fa902ec8e7236b702b1 Jira: ZEP-346 Jira: ZEP-776 Change-Id: I29b1d47f323a5841cd4d0a2afbc2cc83a0f576f0 Signed-off-by: Flavio Santes <flavio.santes@intel.com>
2016-09-01 10:46:36 +08:00
* "http-parser" is the project's name, "http_parser" is used in filenames.