GenericPlatformManagerImpl_POSIX.h

/*
 *
 *    Copyright (c) 2020 Project CHIP Authors
 *    Copyright (c) 2018 Nest Labs, Inc.
 *
 *    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.
 */

/**
 *    @file
 *          Provides an generic implementation of PlatformManager features
 *          for use on Linux platforms.
 */

#pragma once

#include <platform/internal/GenericPlatformManagerImpl.h>

#include <fcntl.h>
#include <sched.h>
#include <sys/select.h>
#include <sys/time.h>
#include <unistd.h>

#include <atomic>
#include <pthread.h>
#include <queue>

namespace chip {
namespace DeviceLayer {
namespace Internal {

/**
 * Provides a generic implementation of PlatformManager features that works on any OSAL platform.
 *
 * This template contains implementations of select features from the PlatformManager abstract
 * interface that are suitable for use on OSAL-based platforms.  It is intended to be inherited
 * (directly or indirectly) by the PlatformManagerImpl class, which also appears as the template's
 * ImplClass parameter.
 */
template <class ImplClass>
class GenericPlatformManagerImpl_POSIX : public GenericPlatformManagerImpl<ImplClass>
{
protected:
    // Members for select loop
    int mMaxFd;
    fd_set mReadSet;
    fd_set mWriteSet;
    fd_set mErrorSet;
    struct timeval mNextTimeout;

    // OS-specific members (pthread)
    pthread_mutex_t mChipStackLock;
    std::queue<ChipDeviceEvent> mChipEventQueue;

    enum TaskType
    {
        kExternallyManagedTask = 0,
        kInternallyManagedTask = 1
    };

    pthread_t mChipTask;
    bool mHasValidChipTask = false;
    TaskType mTaskType;
    pthread_cond_t mEventQueueStoppedCond;
    pthread_mutex_t mStateLock;

    //
    // TODO: This variable is very similar to mMainLoopIsStarted, track the
    // cleanup and consolidation in this issue:
    //
    bool mEventQueueHasStopped = false;

    pthread_attr_t mChipTaskAttr;
    struct sched_param mChipTaskSchedParam;

#if defined(CHIP_STACK_LOCK_TRACKING_ENABLED)
    bool mMainLoopStarted   = false;
    bool mChipStackIsLocked = false;
    pthread_t mChipStackLockOwnerThread;
#endif

    // ===== Methods that implement the PlatformManager abstract interface.

    CHIP_ERROR
    _InitChipStack();
    void _LockChipStack();
    bool _TryLockChipStack();
    void _UnlockChipStack();
    void _PostEvent(const ChipDeviceEvent * event);
    void _RunEventLoop();
    CHIP_ERROR _StartEventLoopTask();
    CHIP_ERROR _StopEventLoopTask();
    CHIP_ERROR _StartChipTimer(int64_t durationMS);
    CHIP_ERROR _Shutdown();

#if defined(CHIP_STACK_LOCK_TRACKING_ENABLED)
    bool _IsChipStackLockedByCurrentThread() const;
#endif

    // ===== Methods available to the implementation subclass.

private:
    // ===== Private members for use by this class only.

    inline ImplClass * Impl() { return static_cast<ImplClass *>(this); }

    void SysUpdate();
    void SysProcess();
    static void SysOnEventSignal(void * arg);

    void ProcessDeviceEvents();

    std::atomic<bool> mShouldRunEventLoop;
    static void * EventLoopTaskMain(void * arg);
};

// Instruct the compiler to instantiate the template only when explicitly told to do so.
extern template class GenericPlatformManagerImpl_POSIX<PlatformManagerImpl>;

} // namespace Internal
} // namespace DeviceLayer
} // namespace chip