Add zephyr civetweb example (#489)

Example from samples/net/sockets/civetweb

Author: julianobst

.github/workflows/examples.yml

@@ -51,13 +51,15 @@ jobs:
           - "examples/zephyr-blink"
           - "examples/zephyr-cpp-synchronization"
           - "examples/zephyr-drivers-can"
+          - "examples/zephyr-net-civetweb"
           - "examples/zephyr-net-https-client"
           - "examples/zephyr-subsys-usb-hid-mouse"
           - "tests/arduino-blink-different-cores"
         exclude:
           - {python-version: 2.7, example: "examples/zephyr-blink"}
           - {python-version: 2.7, example: "examples/zephyr-cpp-synchronization"}
           - {python-version: 2.7, example: "examples/zephyr-drivers-can"}
+          - {python-version: 2.7, example: "examples/zephyr-net-civetweb"}
           - {python-version: 2.7, example: "examples/zephyr-net-https-client"}
           - {python-version: 2.7, example: "examples/zephyr-subsys-usb-hid-mouse"}
     runs-on: ${{ matrix.os }}

examples/zephyr-net-civetweb/.gitignore

@@ -0,0 +1 @@
+.pio

examples/zephyr-net-civetweb/.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

examples/zephyr-net-civetweb/README.rst

@@ -0,0 +1,33 @@
+..  Copyright 2019-present PlatformIO <[email protected]>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+How to build PlatformIO based project
+=====================================
+
+1. `Install PlatformIO Core <http://docs.platformio.org/page/core.html>`_
+2. Download `development platform with examples <https://github.com/platformio/platform-ststm32/archive/develop.zip>`_
+3. Extract ZIP archive
+4. Change IP configuration in platform-ststm32/examples/zephyr-net-civetweb/zephyr/prj.conf file. Default server IPv4 address: `10.0.0.111`
+5. Run these commands:
+
+.. code-block:: bash
+
+    # Change directory to example
+    > cd platform-ststm32/examples/zephyr-net-civetweb
+
+    # Build project
+    > platformio run
+
+    # Upload firmware
+    > platformio run --target upload
+
+    # Clean build files
+    > platformio run --target clean

examples/zephyr-net-civetweb/include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

examples/zephyr-net-civetweb/include/external_log_access.inl

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2019 Antmicro Ltd
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+static void log_access(const struct mg_connection *conn)
+{
+	const struct mg_request_info *ri;
+	char src_addr[IP_ADDR_STR_LEN];
+
+	if (!conn || !conn->dom_ctx) {
+		return;
+	}
+
+	ri = &conn->request_info;
+
+	sockaddr_to_string(src_addr, sizeof(src_addr), &conn->client.rsa);
+
+	printf("%s - \"%s %s%s%s HTTP/%s\" %d\n",
+	       src_addr,
+	       ri->request_method ? ri->request_method : "-",
+	       ri->request_uri ? ri->request_uri : "-",
+	       ri->query_string ? "?" : "",
+	       ri->query_string ? ri->query_string : "",
+	       ri->http_version,
+	       conn->status_code);
+}

examples/zephyr-net-civetweb/include/external_mg_cry_internal_impl.inl

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2019 Antmicro Ltd
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+static void mg_cry_internal_impl(const struct mg_connection *conn,
+                                 const char *func,
+                                 unsigned line,
+                                 const char *fmt,
+                                 va_list ap)
+{
+	(void)conn;
+
+	printf("[INTERNAL ERROR]: %s @ %d\n", func, line);
+	vprintf(fmt, ap);
+	printf("\n");
+}

examples/zephyr-net-civetweb/include/libc_extensions.h

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2019 Antmicro Ltd
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr.h>
+#include <string.h>
+#include <stdio.h>
+#include <sys/types.h>
+#include <net/socket.h>
+
+#define pollfd zsock_pollfd
+#define fcntl zsock_fcntl
+
+#define POLLIN ZSOCK_POLLIN
+#define POLLOUT ZSOCK_POLLOUT
+
+#define addrinfo zsock_addrinfo
+
+#define F_SETFD 2
+#define FD_CLOEXEC 1
+
+size_t strcspn(const char *s1, const char *s2);
+size_t strspn(const char *s1, const char *s2);
+int iscntrl(int c);
+
+double atof(const char *str);
+long long int strtoll(const char *str, char **endptr, int base);
+int sscanf(const char *s, const char *format, ...);
+char *strerror(int err);
+unsigned long long int strtoull(const char *str, char **endptr, int base);
+
+time_t time(time_t *t);
+struct tm *gmtime(const time_t *ptime);
+size_t strftime(char *dst, size_t dst_size, const char *fmt,
+		const struct tm *tm);
+double difftime(time_t end, time_t beg);
+struct tm *localtime(const time_t *timer);
+
+int fileno(FILE *stream);
+int ferror(FILE *stream);
+int fclose(FILE *stream);
+int fseeko(FILE *stream, off_t offset, int whence);
+FILE *fopen(const char *filename, const char *mode);
+char *fgets(char *str, int num, FILE *stream);
+size_t fread(void *ptr, size_t size, size_t count, FILE *stream);
+int remove(const char *filename);
+
+int getsockname(int sock, struct sockaddr *addr, socklen_t *addrlen);
+int poll(struct zsock_pollfd *fds, int nfds, int timeout);
+
+int getnameinfo(const struct sockaddr *addr, socklen_t addrlen,
+		char *host, socklen_t hostlen,
+		char *serv, socklen_t servlen, int flags);
+
+ssize_t send(int sock, const void *buf, size_t len, int flags);
+ssize_t recv(int sock, void *buf, size_t max_len, int flags);
+int socket(int family, int type, int proto);
+int getaddrinfo(const char *host, const char *service,
+		const struct zsock_addrinfo *hints,
+		struct zsock_addrinfo **res);
+
+void freeaddrinfo(struct zsock_addrinfo *ai);
+int connect(int sock, const struct sockaddr *addr, socklen_t addrlen);
+int getsockopt(int sock, int level, int optname,
+	       void *optval, socklen_t *optlen);
+int setsockopt(int sock, int level, int optname,
+	       const void *optval, socklen_t optlen);
+int listen(int sock, int backlog);
+int accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
+int bind(int sock, const struct sockaddr *addr, socklen_t addrlen);

examples/zephyr-net-civetweb/lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

examples/zephyr-net-civetweb/platformio.ini

@@ -0,0 +1,13 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter, extra scripting
+;   Upload options: custom port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;
+; Please visit documentation for the other options and examples
+; http://docs.platformio.org/page/projectconf.html
+
+[env:nucleo_f767zi]
+platform = ststm32
+framework = zephyr
+board = nucleo_f767zi