otubus.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2019, 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.
 */
 
#ifndef OTBR_AGENT_OTUBUS_HPP_
#define OTBR_AGENT_OTUBUS_HPP_
 
#include "openthread-br/config.h"
 
#include <stdarg.h>
#include <time.h>
 
#include <openthread/ip6.h>
#include <openthread/link.h>
#include <openthread/netdiag.h>
#include <openthread/udp.h>
 
#include "common/code_utils.hpp"
#include "common/mainloop.hpp"
#include "ncp/ncp_openthread.hpp"
 
extern "C" {
#include <libubox/blobmsg_json.h>
#include <libubox/uloop.h>
#include <libubox/ustream.h>
#include <libubox/utils.h>
#include <libubus.h>
}
 
namespace otbr {
namespace Ncp {
class ControllerOpenThread;
}
 
namespace ubus {
 
class UbusServer
{
public:
    static void Initialize(Ncp::ControllerOpenThread *aController, std::mutex *aMutex);
 
    static UbusServer &GetInstance(void);
 
    void InstallUbusObject(void);
 
    static int UbusScanHandler(struct ubus_context *     aContext,
                               struct ubus_object *      aObj,
                               struct ubus_request_data *aRequest,
                               const char *              aMethod,
                               struct blob_attr *        aMsg);
 
    static int UbusChannelHandler(struct ubus_context *     aContext,
                                  struct ubus_object *      aObj,
                                  struct ubus_request_data *aRequest,
                                  const char *              aMethod,
                                  struct blob_attr *        aMsg);
 
    static int UbusSetChannelHandler(struct ubus_context *     aContext,
                                     struct ubus_object *      aObj,
                                     struct ubus_request_data *aRequest,
                                     const char *              aMethod,
                                     struct blob_attr *        aMsg);
 
    static int UbusNetworknameHandler(struct ubus_context *     aContext,
                                      struct ubus_object *      aObj,
                                      struct ubus_request_data *aRequest,
                                      const char *              aMethod,
                                      struct blob_attr *        aMsg);
 
    static int UbusSetNetworknameHandler(struct ubus_context *     aContext,
                                         struct ubus_object *      aObj,
                                         struct ubus_request_data *aRequest,
                                         const char *              aMethod,
                                         struct blob_attr *        aMsg);
 
    static int UbusStateHandler(struct ubus_context *     aContext,
                                struct ubus_object *      aObj,
                                struct ubus_request_data *aRequest,
                                const char *              aMethod,
                                struct blob_attr *        aMsg);
 
    static int UbusMacfilterSetStateHandler(struct ubus_context *     aContext,
                                            struct ubus_object *      aObj,
                                            struct ubus_request_data *aRequest,
                                            const char *              aMethod,
                                            struct blob_attr *        aMsg);
 
    static int UbusPanIdHandler(struct ubus_context *     aContext,
                                struct ubus_object *      aObj,
                                struct ubus_request_data *aRequest,
                                const char *              aMethod,
                                struct blob_attr *        aMsg);
 
    static int UbusSetPanIdHandler(struct ubus_context *     aContext,
                                   struct ubus_object *      aObj,
                                   struct ubus_request_data *aRequest,
                                   const char *              aMethod,
                                   struct blob_attr *        aMsg);
 
    static int UbusPskcHandler(struct ubus_context *     aContext,
                               struct ubus_object *      aObj,
                               struct ubus_request_data *aRequest,
                               const char *              aMethod,
                               struct blob_attr *        aMsg);
 
    static int UbusSetPskcHandler(struct ubus_context *     aContext,
                                  struct ubus_object *      aObj,
                                  struct ubus_request_data *aRequest,
                                  const char *              aMethod,
                                  struct blob_attr *        aMsg);
 
    static int UbusNetworkkeyHandler(struct ubus_context *     aContext,
                                     struct ubus_object *      aObj,
                                     struct ubus_request_data *aRequest,
                                     const char *              aMethod,
                                     struct blob_attr *        aMsg);
 
    static int UbusSetNetworkkeyHandler(struct ubus_context *     aContext,
                                        struct ubus_object *      aObj,
                                        struct ubus_request_data *aRequest,
                                        const char *              aMethod,
                                        struct blob_attr *        aMsg);
 
    static int UbusRloc16Handler(struct ubus_context *     aContext,
                                 struct ubus_object *      aObj,
                                 struct ubus_request_data *aRequest,
                                 const char *              aMethod,
                                 struct blob_attr *        aMsg);
 
    static int UbusExtPanIdHandler(struct ubus_context *     aContext,
                                   struct ubus_object *      aObj,
                                   struct ubus_request_data *aRequest,
                                   const char *              aMethod,
                                   struct blob_attr *        aMsg);
 
    static int UbusSetExtPanIdHandler(struct ubus_context *     aContext,
                                      struct ubus_object *      aObj,
                                      struct ubus_request_data *aRequest,
                                      const char *              aMethod,
                                      struct blob_attr *        aMsg);
 
    static int UbusModeHandler(struct ubus_context *     aContext,
                               struct ubus_object *      aObj,
                               struct ubus_request_data *aRequest,
                               const char *              aMethod,
                               struct blob_attr *        aMsg);
 
    static int UbusSetModeHandler(struct ubus_context *     aContext,
                                  struct ubus_object *      aObj,
                                  struct ubus_request_data *aRequest,
                                  const char *              aMethod,
                                  struct blob_attr *        aMsg);
 
    static int UbusPartitionIdHandler(struct ubus_context *     aContext,
                                      struct ubus_object *      aObj,
                                      struct ubus_request_data *aRequest,
                                      const char *              aMethod,
                                      struct blob_attr *        aMsg);
 
    static int UbusLeaderdataHandler(struct ubus_context *     aContext,
                                     struct ubus_object *      aObj,
                                     struct ubus_request_data *aRequest,
                                     const char *              aMethod,
                                     struct blob_attr *        aMsg);
 
    static int UbusNetworkdataHandler(struct ubus_context *     aContext,
                                      struct ubus_object *      aObj,
                                      struct ubus_request_data *aRequest,
                                      const char *              aMethod,
                                      struct blob_attr *        aMsg);
 
    static int UbusParentHandler(struct ubus_context *     aContext,
                                 struct ubus_object *      aObj,
                                 struct ubus_request_data *aRequest,
                                 const char *              aMethod,
                                 struct blob_attr *        aMsg);
 
    static int UbusNeighborHandler(struct ubus_context *     aContext,
                                   struct ubus_object *      aObj,
                                   struct ubus_request_data *aRequest,
                                   const char *              aMethod,
                                   struct blob_attr *        aMsg);
 
    static int UbusThreadStartHandler(struct ubus_context *     aContext,
                                      struct ubus_object *      aObj,
                                      struct ubus_request_data *aRequest,
                                      const char *              aMethod,
                                      struct blob_attr *        aMsg);
 
    static int UbusThreadStopHandler(struct ubus_context *     aContext,
                                     struct ubus_object *      aObj,
                                     struct ubus_request_data *aRequest,
                                     const char *              aMethod,
                                     struct blob_attr *        aMsg);
 
    static int UbusLeaveHandler(struct ubus_context *     aContext,
                                struct ubus_object *      aObj,
                                struct ubus_request_data *aRequest,
                                const char *              aMethod,
                                struct blob_attr *        aMsg);
 
    static int UbusMacfilterAddrHandler(struct ubus_context *     aContext,
                                        struct ubus_object *      aObj,
                                        struct ubus_request_data *aRequest,
                                        const char *              aMethod,
                                        struct blob_attr *        aMsg);
 
    static int UbusMacfilterStateHandler(struct ubus_context *     aContext,
                                         struct ubus_object *      aObj,
                                         struct ubus_request_data *aRequest,
                                         const char *              aMethod,
                                         struct blob_attr *        aMsg);
 
    static int UbusMacfilterAddHandler(struct ubus_context *     aContext,
                                       struct ubus_object *      aObj,
                                       struct ubus_request_data *aRequest,
                                       const char *              aMethod,
                                       struct blob_attr *        aMsg);
 
    static int UbusMacfilterClearHandler(struct ubus_context *     aContext,
                                         struct ubus_object *      aObj,
                                         struct ubus_request_data *aRequest,
                                         const char *              aMethod,
                                         struct blob_attr *        aMsg);
 
    static int UbusMacfilterRemoveHandler(struct ubus_context *     aContext,
                                          struct ubus_object *      aObj,
                                          struct ubus_request_data *aRequest,
                                          const char *              aMethod,
                                          struct blob_attr *        aMsg);
 
    static int UbusCommissionerStartHandler(struct ubus_context *     aContext,
                                            struct ubus_object *      aObj,
                                            struct ubus_request_data *aRequest,
                                            const char *              aMethod,
                                            struct blob_attr *        aMsg);
 
    static int UbusJoinerAddHandler(struct ubus_context *     aContext,
                                    struct ubus_object *      aObj,
                                    struct ubus_request_data *aRequest,
                                    const char *              aMethod,
                                    struct blob_attr *        aMsg);
 
    static int UbusJoinerRemoveHandler(struct ubus_context *     aContext,
                                       struct ubus_object *      aObj,
                                       struct ubus_request_data *aRequest,
                                       const char *              aMethod,
                                       struct blob_attr *        aMsg);
 
    static int UbusJoinerNumHandler(struct ubus_context *     aContext,
                                    struct ubus_object *      aObj,
                                    struct ubus_request_data *aRequest,
                                    const char *              aMethod,
                                    struct blob_attr *        aMsg);
 
    static int UbusMgmtsetHandler(struct ubus_context *     aContext,
                                  struct ubus_object *      aObj,
                                  struct ubus_request_data *aRequest,
                                  const char *              aMethod,
                                  struct blob_attr *        aMsg);
 
    static void HandleDiagnosticGetResponse(otError              aError,
                                            otMessage *          aMessage,
                                            const otMessageInfo *aMessageInfo,
                                            void *               aContext);
 
    void HandleDiagnosticGetResponse(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo);
 
private:
    bool                       mIfFinishScan;
    struct ubus_context *      mContext;
    const char *               mSockPath;
    struct blob_buf            mBuf;
    struct blob_buf            mNetworkdataBuf;
    Ncp::ControllerOpenThread *mController;
    std::mutex *               mNcpThreadMutex;
    time_t                     mSecond;
    enum
    {
        kDefaultJoinerTimeout = 120,
    };
 
    UbusServer(Ncp::ControllerOpenThread *aController, std::mutex *aMutex);
 
    void ProcessScan(void);
 
    int UbusScanHandlerDetail(struct ubus_context *     aContext,
                              struct ubus_object *      aObj,
                              struct ubus_request_data *aRequest,
                              const char *              aMethod,
                              struct blob_attr *        aMsg);
 
    static void HandleActiveScanResult(otActiveScanResult *aResult, void *aContext);
 
    void HandleActiveScanResultDetail(otActiveScanResult *aResult);
 
    int UbusNeighborHandlerDetail(struct ubus_context *     aContext,
                                  struct ubus_object *      aObj,
                                  struct ubus_request_data *aRequest,
                                  const char *              aMethod,
                                  struct blob_attr *        aMsg);
 
    int UbusParentHandlerDetail(struct ubus_context *     aContext,
                                struct ubus_object *      aObj,
                                struct ubus_request_data *aRequest,
                                const char *              aMethod,
                                struct blob_attr *        aMsg);
 
    int UbusMgmtset(struct ubus_context *     aContext,
                    struct ubus_object *      aObj,
                    struct ubus_request_data *aRequest,
                    const char *              aMethod,
                    struct blob_attr *        aMsg);
 
    int UbusLeaveHandlerDetail(struct ubus_context *     aContext,
                               struct ubus_object *      aObj,
                               struct ubus_request_data *aRequest,
                               const char *              aMethod,
                               struct blob_attr *        aMsg);
 
    int UbusThreadHandler(struct ubus_context *     aContext,
                          struct ubus_object *      aObj,
                          struct ubus_request_data *aRequest,
                          const char *              aMethod,
                          struct blob_attr *        aMsg,
                          const char *              aAction);
 
    int UbusGetInformation(struct ubus_context *     aContext,
                           struct ubus_object *      aObj,
                           struct ubus_request_data *aRequest,
                           const char *              aMethod,
                           struct blob_attr *        aMsg,
                           const char *              action);
 
    int UbusSetInformation(struct ubus_context *     aContext,
                           struct ubus_object *      aObj,
                           struct ubus_request_data *aRequest,
                           const char *              aMethod,
                           struct blob_attr *        aMsg,
                           const char *              aAction);
 
    int UbusCommissioner(struct ubus_context *     aContext,
                         struct ubus_object *      aObj,
                         struct ubus_request_data *aRequest,
                         const char *              aMethod,
                         struct blob_attr *        aMsg,
                         const char *              aAction);
 
    static void HandleStateChanged(otCommissionerState aState, void *aContext);
 
    void HandleStateChanged(otCommissionerState aState);
 
    static void HandleJoinerEvent(otCommissionerJoinerEvent aEvent,
                                  const otJoinerInfo *      aJoinerInfo,
                                  const otExtAddress *      aJoinerId,
                                  void *                    aContext);
 
    void HandleJoinerEvent(otCommissionerJoinerEvent aEvent,
                           const otJoinerInfo *      aJoinerInfo,
                           const otExtAddress *      aJoinerId);
 
    void GetState(otInstance *aInstance, char *aState);
 
    void UbusAddFd(void);
 
    static void UbusReconnTimer(struct uloop_timeout *aTimeout);
 
    void UbusReconnTimerDetail(struct uloop_timeout *aTimeout);
 
    static void UbusConnectionLost(struct ubus_context *aContext);
 
    int DisplayUbusInit(const char *aPath);
 
    void DisplayUbusDone(void);
 
    otError ParseLong(char *aString, long &aLong);
 
    int Hex2Bin(const char *aHex, uint8_t *aBin, uint16_t aBinLength);
 
    void OutputBytes(const uint8_t *aBytes, uint8_t aLength, char *aOutput);
 
    void AppendResult(otError aError, struct ubus_context *aContext, struct ubus_request_data *aRequest);
};
 
class UBusAgent : public MainloopProcessor
{
public:
    UBusAgent(otbr::Ncp::ControllerOpenThread &aNcp)
        : mNcp(aNcp)
        , mThreadMutex()
    {
    }
 
    void Init(void);
 
    void Update(MainloopContext &aMainloop) override;
    void Process(const MainloopContext &aMainloop) override;
 
private:
    static void UbusServerRun(void) { otbr::ubus::UbusServer::GetInstance().InstallUbusObject(); }
 
    otbr::Ncp::ControllerOpenThread &mNcp;
    std::mutex                       mThreadMutex;
};
} // namespace ubus
} // namespace otbr
 
#endif // OTBR_AGENT_OTUBUS_HPP_