Logger.h

Go to the documentation of this file.

/* Copyright (c) 2018 Skyward Experimental Rocketry
 * Author: Federico Terraneo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <Singleton.h>
#include <miosix.h>
#include <stdint.h>
 
#include <cstdio>
#include <list>
#include <queue>
#include <string>
#include <type_traits>
 
#include "LoggerStats.h"
 
namespace Boardcore
{
 
enum class LoggerResult
{
    Queued,   
    Dropped,  
    Ignored,  
    TooLarge  
};
 
class Logger : public Singleton<Logger>
{
    friend class Singleton<Logger>;
 
public:
    bool start();
 
    void stop();
 
    static bool testSDCard();
 
    int getCurrentLogNumber();
 
    std::string getCurrentFileName();
 
    LoggerStats getStats();
 
    void resetStats();
 
    bool isStarted() const;
 
    template <typename T>
    LoggerResult log(const T& t);
 
    void logStats();
 
    static constexpr unsigned int getMaxFilenameNumber()
    {
        return maxFilenameNumber;
    }
 
private:
    Logger();
 
    static std::string getFileName(int logNumber);
 
    static void packThreadLauncher(void* argv);
 
    static void writeThreadLauncher(void* argv);
 
    void packThread();
 
    void writeThread();
 
    LoggerResult logImpl(const char* name, const void* data, unsigned int size);
 
    static constexpr unsigned int maxFilenameNumber =
        10000;  
#ifndef _ARCH_CORTEXM3_STM32F2
    static constexpr unsigned int maxRecordSize = 512;  
    static constexpr unsigned int numRecords = 512;  
    static constexpr unsigned int numBuffers = 8;    
    static constexpr unsigned int bufferSize = 64 * 1024;  
#else
    static constexpr unsigned int maxRecordSize = 512;  
    static constexpr unsigned int numRecords = 64;  
    static constexpr unsigned int numBuffers = 8;   
    static constexpr unsigned int bufferSize = 4 * 1024;  
#endif
 
    class Record
    {
    public:
        Record() : size(0) {}
        char data[maxRecordSize] = {};
        unsigned int size;
    };
 
    class Buffer
    {
    public:
        Buffer() : size(0) {}
        char data[bufferSize] = {};
        unsigned int size;
    };
 
    int fileNumber = -1;
 
    miosix::Queue<Record*, numRecords> fullRecordsQueue;
    miosix::Queue<Record*, numRecords> emptyRecordsQueue;
    std::queue<Buffer*, std::list<Buffer*>> fullBufferList;
    std::queue<Buffer*, std::list<Buffer*>> emptyBufferList;
    miosix::FastMutex mutex;  
    miosix::ConditionVariable cond;  
 
    miosix::Thread* packTh  = nullptr;  
    miosix::Thread* writeTh = nullptr;  
 
    volatile bool started = false;  
 
    FILE* file = nullptr;  
    LoggerStats stats;     
};
 
template <typename T>
LoggerResult Logger::log(const T& t)
{
    static_assert(
        std::is_trivially_copyable<T>::value,
        "The type T must be trivially copyable in order to be logged!");
 
    return logImpl(typeid(t).name(), &t, sizeof(t));
}
 
}  // namespace Boardcore