Skip to content

Commit

Permalink
[posix-app] platform UDP (#3070)
Browse files Browse the repository at this point in the history
This commit defines a set of platform APIs to integrate UDP layer of
OpenThread with that of the platform.

With this commit, services and applications developed upon OpenThread can
also be accessed through platform's own network interface, e.g. socket() on
POSIX.
  • Loading branch information
bukepo authored and jwhui committed Oct 14, 2018
1 parent 8e7dba9 commit 677d49b
Show file tree
Hide file tree
Showing 16 changed files with 817 additions and 51 deletions.
24 changes: 23 additions & 1 deletion .travis/before_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,29 @@ cd /tmp || die
}

[ $BUILD_TARGET != posix-app-pty ] || {
sudo apt-get install socat expect || die
sudo apt-get install socat expect libdbus-1-dev autoconf-archive || die
JOBS=$(getconf _NPROCESSORS_ONLN)
(
WPANTUND_TMPDIR=/tmp/wpantund
git clone --depth 1 https://github.com/openthread/wpantund.git $WPANTUND_TMPDIR
cd $WPANTUND_TMPDIR
./bootstrap.sh
./configure --prefix= --exec-prefix=/usr --disable-ncp-dummy --enable-static-link-ncp-plugin=spinel
make -j $JOBS
sudo make install
) || die
(
LIBCOAP_TMPDIR=/tmp/libcoap
mkdir $LIBCOAP_TMPDIR
cd $LIBCOAP_TMPDIR
wget https://github.com/obgm/libcoap/archive/bsd-licensed.tar.gz
tar xvf bsd-licensed.tar.gz
cd libcoap-bsd-licensed
./autogen.sh
./configure --prefix= --exec-prefix=/usr --with-boost=internal --disable-tests --disable-documentation
make -j $JOBS
sudo make install
) || die
}

[ $BUILD_TARGET != scan-build ] || {
Expand Down
115 changes: 115 additions & 0 deletions .travis/check-posix-app-pty
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
#!/bin/bash
#
# Copyright (c) 2018, The OpenThread Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

set -e
set -x

die() {
echo " *** ERROR: " $*
exit 1
}

at_exit() {
EXIT_CODE=$?
sudo killall wpantund || true
killall socat || true
exit $EXIT_CODE
}

build() {
./bootstrap
COVERAGE=1 make -f examples/Makefile-posix
COVERAGE=1 make -f src/posix/Makefile-posix PLATFORM_UDP=1
}

check() {
trap at_exit INT TERM EXIT

SOCAT_OUTPUT=/tmp/ot-socat
socat -d -d pty,raw,b115200,echo=0 pty,raw,b115200,echo=0 > /dev/null 2> $SOCAT_OUTPUT &
while true; do
if test $(head -n2 $SOCAT_OUTPUT | wc -l) = 2; then
RADIO_PTY=$(head -n1 $SOCAT_OUTPUT | grep -o '/dev/.\+')
CORE_PTY=$(head -n2 $SOCAT_OUTPUT | tail -n1 | grep -o '/dev/.\+')
break
fi
echo 'Waiting for socat ready...'
sleep 1
done
echo 'RADIO_PTY' $DEVICE_PTY
echo 'CORE_PTY' $CORE_PTY

RADIO_NCP_PATH="$(pwd)/$(ls output/*linux*/bin/ot-ncp-radio)"
$RADIO_NCP_PATH 1 > $RADIO_PTY < $RADIO_PTY &
OT_NCP_PATH="$(pwd)/$(ls output/posix/*linux*/bin/ot-ncp)"
PLATFORM_NETIF=wpan0 sudo -E wpantund -I wpan0 -o Thread:Config:FilterRLOCAddresses 0 -s "system:${OT_NCP_PATH} ${CORE_PTY}" &

while true; do
sleep 5
if sudo wpanctl status; then
break
else
echo 'Still waiting for wpantund'
fi
done

sudo wpanctl leave || true
sudo wpanctl form -c 18 OpenThreadTest

mleid=$(sudo wpanctl status | grep MeshLocalAddress | cut -d'"' -f4)
echo "ML-EID is: ${mleid}"

netstat -an | grep -q 61631 || die 'TMF port is not available!'
xaddress=$(sudo wpanctl get 'NCP:ExtendedAddress' | cut -d= -f2 | tr -d ' []')
echo "Extended address is: ${xaddress}"

# Retrievie extended address through network diagnostic get
coap_response=$(echo -n '120100' | xxd -r -p | coap-client -m POST coap://[${mleid}]:61631/d/dg -f- | xxd -p -u | grep 0008)
echo "CoAP response is: ${coap_response}"

# Verify CoAP response contains the extended address
[[ "${coap_response}" = *${xaddress}* ]] || die 'failed to get extended address'

# Leave so that code coverage will be flushed
sudo wpanctl leave || true
}

main() {
case $1 in
check)
check
;;
*)
build
check
;;
esac
}

main "$@"
44 changes: 1 addition & 43 deletions .travis/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -490,49 +490,7 @@ python --version || die
}

[ $BUILD_TARGET != posix-app-pty ] || {
./bootstrap
COVERAGE=1 make -f examples/Makefile-posix
COVERAGE=1 make -f src/posix/Makefile-posix

SOCAT_OUTPUT=/tmp/ot-socat
socat -d -d pty,raw,echo=0 pty,raw,echo=0 > /dev/null 2> $SOCAT_OUTPUT &
while true; do
if test $(head -n2 $SOCAT_OUTPUT | wc -l) = 2; then
RADIO_PTY=$(head -n1 $SOCAT_OUTPUT | grep -o '/dev/.\+')
CORE_PTY=$(head -n2 $SOCAT_OUTPUT | tail -n1 | grep -o '/dev/.\+')
break
fi
echo 'Waiting for socat ready...'
sleep 1
done
echo 'RADIO_PTY' $DEVICE_PTY
echo 'CORE_PTY' $CORE_PTY

RADIO_NCP_PATH="$(pwd)/$(ls output/*linux*/bin/ot-ncp-radio)"
$RADIO_NCP_PATH 1 > $RADIO_PTY < $RADIO_PTY &
OT_CLI_PATH="$(pwd)/$(ls output/posix/*linux*/bin/ot-cli)"

expect <<EOF || die
spawn $OT_CLI_PATH $CORE_PTY
set timeout 2
send "panid 0xface\r\n"
expect "Done"
send "ifconfig up\r\n"
expect "Done"
send "thread start\r\n"
expect "Done"
sleep 5
send "state\r\n"
expect {
"leader" {
send "exit\r\n"
expect eof
}
timeout abort
}
send_user "Success"
EOF
killall socat
.travis/check-posix-app-pty || die
}

[ $BUILD_TARGET != posix-mtd ] || {
Expand Down
29 changes: 29 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -795,6 +795,35 @@ AC_SUBST(OPENTHREAD_ENABLE_APPLICATION_COAP_SECURE)
AM_CONDITIONAL([OPENTHREAD_ENABLE_APPLICATION_COAP_SECURE], [test "${enable_application_coap_secure}" = "yes"])
AC_DEFINE_UNQUOTED([OPENTHREAD_ENABLE_APPLICATION_COAP_SECURE],[${OPENTHREAD_ENABLE_APPLICATION_COAP_SECURE}],[Define to 1 if you want to enable CoAP Secure to an application.])

#
# Platform UDP
#

AC_ARG_ENABLE(platform_udp,
[AS_HELP_STRING([--enable-platform-udp],[Enable platform UDP support @<:@default=no@:>@.])],
[
case "${enableval}" in
no|yes)
enable_platform_udp=${enableval}
;;
*)
AC_MSG_ERROR([Invalid value ${enable_platform_udp} for --enable-platform-udp])
;;
esac
],
[enable_platform_udp=no])

if test "$enable_platform_udp" = "yes"; then
OPENTHREAD_ENABLE_PLATFORM_UDP=1
else
OPENTHREAD_ENABLE_PLATFORM_UDP=0
fi

AC_MSG_RESULT(${enable_platform_udp})
AC_SUBST(OPENTHREAD_ENABLE_PLATFORM_UDP)
AM_CONDITIONAL([OPENTHREAD_ENABLE_PLATFORM_UDP], [test "${enable_platform_udp}" = "yes"])
AC_DEFINE_UNQUOTED([OPENTHREAD_ENABLE_PLATFORM_UDP], [${OPENTHREAD_ENABLE_PLATFORM_UDP}], [Define to 1 to enable platform UDP.])

#
# Thread Commissioner
#
Expand Down
1 change: 1 addition & 0 deletions include/openthread/platform/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ ot_platform_headers = \
random.h \
time.h \
uart.h \
udp.h \
spi-slave.h \
settings.h \
messagepool.h \
Expand Down
103 changes: 103 additions & 0 deletions include/openthread/platform/udp.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/*
* Copyright (c) 2018, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

/**
* @file
* @brief
* This file includes the abstraction for the platform UDP service.
*/

#ifndef OPENTHREAD_PLATFORM_UDP_H_
#define OPENTHREAD_PLATFORM_UDP_H_

#ifdef __cplusplus
extern "C" {
#endif

/**
* This function initializes the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
* @retval OT_ERROR_NONE Successfully initialized UDP socket by platform.
* @retval OT_ERROR_FAILED Failed to initialize UDP Socket.
*
*/
otError otPlatUdpSocket(otUdpSocket *aUdpSocket);

/**
* This function closes the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
* @retval OT_ERROR_NONE Successfully closed UDP socket by platform.
* @retval OT_ERROR_FAILED Failed to close UDP Socket.
*
*/
otError otPlatUdpClose(otUdpSocket *aUdpSocket);

/**
* This function binds the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
* @retval OT_ERROR_NONE Successfully binded UDP socket by platform.
* @retval OT_ERROR_FAILED Failed to bind UDP socket.
*
*/
otError otPlatUdpBind(otUdpSocket *aUdpSocket);

/**
* This function connects UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
* @retval OT_ERROR_NONE Successfully connected by platform.
* @retval OT_ERROR_FAILED Failed to connect UDP socket.
*
*/
otError otPlatUdpConnect(otUdpSocket *aUdpSocket);

/**
* This function sends UDP payload by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
* @param[in] aMessage A pointer to the message to send.
* @param[in] aMessageInfo A pointer to the message info associated with @p aMessage.
*
* @retval OT_ERROR_NONE Successfully sent by platform, and @p aMessage is freed.
* @retval OT_ERROR_FAILED Failed to binded UDP socket.
*
*/
otError otPlatUdpSend(otUdpSocket *aUdpSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo);

#ifdef __cplusplus
} // extern "C"
#endif

#endif // OPENTHREAD_PLATFORM_UDP_H_
11 changes: 11 additions & 0 deletions include/openthread/udp.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ typedef struct otUdpSocket
otSockAddr mPeerName; ///< The peer IPv6 socket address.
otUdpReceive mHandler; ///< A function pointer to the application callback.
void * mContext; ///< A pointer to application-specific context.
void * mHandle; ///< A handle to platform's UDP
struct otUdpSocket *mNext; ///< A pointer to the next UDP socket (internal use only).
} otUdpSocket;

Expand Down Expand Up @@ -253,6 +254,16 @@ void otUdpProxyReceive(otInstance * aInstance,
const otIp6Address *aPeerAddr,
uint16_t aSockPort);

/**
* This function gets the existing UDP Sockets.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
* @returns A pointer to the first UDP Socket.
*
*/
otUdpSocket *otUdpGetSockets(otInstance *aInstance);

/**
* @}
*
Expand Down
9 changes: 9 additions & 0 deletions src/core/api/udp_api.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,12 @@ void otUdpProxyReceive(otInstance * aInstance,
static_cast<ot::Message *>(aMessage)->Free();
}
#endif // OPENTHREAD_ENABLE_UDP_PROXY

#if OPENTHREAD_ENABLE_PLATFORM_UDP
otUdpSocket *otUdpGetSockets(otInstance *aInstance)
{
Instance &instance = *static_cast<Instance *>(aInstance);

return instance.Get<Ip6::Ip6>().GetUdp().GetUdpSockets();
}
#endif

0 comments on commit 677d49b

Please sign in to comment.