EI2I_4_projet_1_2017-2018 / Mbed 2 deprecated Main_V3

Version finale

Dependencies:   mbed

Fork of Main_V3_Old by EI2I_4_projet_1_2017-2018

DebugTrace.cpp@7:2748b1a2742c, 2018-01-15 (annotated)

Committer:
ramialjed
Date:
Mon Jan 15 16:34:24 2018 +0000
Revision:
7:2748b1a2742c
Parent:
4:784c4b53a3d4 
Version finale

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ChrisnieM 4:784c4b53a3d4 1 /*
ChrisnieM 4:784c4b53a3d4 2 * DebugTrace. Allows dumping debug messages/values to serial or
ChrisnieM 4:784c4b53a3d4 3 * to file.
ChrisnieM 4:784c4b53a3d4 4 *
ChrisnieM 4:784c4b53a3d4 5 * Copyright (C) <2009> Petras Saduikis <petras@petras.co.uk>
ChrisnieM 4:784c4b53a3d4 6 *
ChrisnieM 4:784c4b53a3d4 7 * This file is part of DebugTrace.
ChrisnieM 4:784c4b53a3d4 8 *
ChrisnieM 4:784c4b53a3d4 9 * DebugTrace is free software: you can redistribute it and/or modify
ChrisnieM 4:784c4b53a3d4 10 * it under the terms of the GNU General Public License as published by
ChrisnieM 4:784c4b53a3d4 11 * the Free Software Foundation, either version 3 of the License, or
ChrisnieM 4:784c4b53a3d4 12 * (at your option) any later version.
ChrisnieM 4:784c4b53a3d4 13 *
ChrisnieM 4:784c4b53a3d4 14 * DebugTrace is distributed in the hope that it will be useful,
ChrisnieM 4:784c4b53a3d4 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ChrisnieM 4:784c4b53a3d4 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ChrisnieM 4:784c4b53a3d4 17 * GNU General Public License for more details.
ChrisnieM 4:784c4b53a3d4 18 *
ChrisnieM 4:784c4b53a3d4 19 * You should have received a copy of the GNU General Public License
ChrisnieM 4:784c4b53a3d4 20 * along with DebugTrace. If not, see <http://www.gnu.org/licenses/>.
ChrisnieM 4:784c4b53a3d4 21 */
ChrisnieM 4:784c4b53a3d4 22
ChrisnieM 4:784c4b53a3d4 23 #include "DebugTrace.h"
ChrisnieM 4:784c4b53a3d4 24 #include <mbed.h>
ChrisnieM 4:784c4b53a3d4 25 #include <stdarg.h>
ChrisnieM 4:784c4b53a3d4 26 #include <string.h>
ChrisnieM 4:784c4b53a3d4 27
ChrisnieM 4:784c4b53a3d4 28 Serial logSerial(USBTX, USBRX);
ChrisnieM 4:784c4b53a3d4 29 //LocalFileSystem local("local");
ChrisnieM 4:784c4b53a3d4 30
ChrisnieM 4:784c4b53a3d4 31 const char* FILE_PATH = "/local/";
ChrisnieM 4:784c4b53a3d4 32 const char* EXTN = ".bak";
ChrisnieM 4:784c4b53a3d4 33
ChrisnieM 4:784c4b53a3d4 34 DebugTrace::DebugTrace(eLog on, eLogTarget mode, const char* fileName, int maxSize) :
ChrisnieM 4:784c4b53a3d4 35 enabled(on), logMode(mode), maxFileSize(maxSize), currentFileSize(0),
ChrisnieM 4:784c4b53a3d4 36 logFileStatus(0)
ChrisnieM 4:784c4b53a3d4 37 {
ChrisnieM 4:784c4b53a3d4 38 // allocate memory for file name strings
ChrisnieM 4:784c4b53a3d4 39 int str_size = (strlen(fileName) + strlen(FILE_PATH) + strlen(EXTN) + 1) * sizeof(char);
ChrisnieM 4:784c4b53a3d4 40 logFile = (char*)malloc(str_size);
ChrisnieM 4:784c4b53a3d4 41 logFileBackup = (char*)malloc(str_size);
ChrisnieM 4:784c4b53a3d4 42
ChrisnieM 4:784c4b53a3d4 43 // add path to log file name
ChrisnieM 4:784c4b53a3d4 44 strcpy(logFile, FILE_PATH);
ChrisnieM 4:784c4b53a3d4 45 strcat(logFile, fileName);
ChrisnieM 4:784c4b53a3d4 46
ChrisnieM 4:784c4b53a3d4 47 // create backup file name
ChrisnieM 4:784c4b53a3d4 48 strcpy(logFileBackup, logFile);
ChrisnieM 4:784c4b53a3d4 49 strcpy(logFileBackup, strtok(logFileBackup, "."));
ChrisnieM 4:784c4b53a3d4 50 strcat(logFileBackup, EXTN);
ChrisnieM 4:784c4b53a3d4 51 }
ChrisnieM 4:784c4b53a3d4 52
ChrisnieM 4:784c4b53a3d4 53 DebugTrace::~DebugTrace()
ChrisnieM 4:784c4b53a3d4 54 {
ChrisnieM 4:784c4b53a3d4 55 // dust to dust, ashes to ashes
ChrisnieM 4:784c4b53a3d4 56 if (logFile != NULL) free(logFile);
ChrisnieM 4:784c4b53a3d4 57 if (logFileBackup != NULL) free(logFileBackup);
ChrisnieM 4:784c4b53a3d4 58 }
ChrisnieM 4:784c4b53a3d4 59
ChrisnieM 4:784c4b53a3d4 60 void DebugTrace::clear()
ChrisnieM 4:784c4b53a3d4 61 {
ChrisnieM 4:784c4b53a3d4 62 // don't care about whether these fail
ChrisnieM 4:784c4b53a3d4 63 remove(logFile);
ChrisnieM 4:784c4b53a3d4 64 remove(logFileBackup);
ChrisnieM 4:784c4b53a3d4 65 }
ChrisnieM 4:784c4b53a3d4 66
ChrisnieM 4:784c4b53a3d4 67 void DebugTrace::backupLog()
ChrisnieM 4:784c4b53a3d4 68 {
ChrisnieM 4:784c4b53a3d4 69 // delete previous backup file
ChrisnieM 4:784c4b53a3d4 70 if (remove(logFileBackup))
ChrisnieM 4:784c4b53a3d4 71 {
ChrisnieM 4:784c4b53a3d4 72 // standard copy stuff
ChrisnieM 4:784c4b53a3d4 73 char ch;
ChrisnieM 4:784c4b53a3d4 74 FILE* to = fopen(logFileBackup, "wb");
ChrisnieM 4:784c4b53a3d4 75 if (NULL != to)
ChrisnieM 4:784c4b53a3d4 76 {
ChrisnieM 4:784c4b53a3d4 77 FILE* from = fopen(logFile, "rb");
ChrisnieM 4:784c4b53a3d4 78 if (NULL != from)
ChrisnieM 4:784c4b53a3d4 79 {
ChrisnieM 4:784c4b53a3d4 80 while(!feof(from))
ChrisnieM 4:784c4b53a3d4 81 {
ChrisnieM 4:784c4b53a3d4 82 ch = fgetc(from);
ChrisnieM 4:784c4b53a3d4 83 if (ferror(from)) break;
ChrisnieM 4:784c4b53a3d4 84
ChrisnieM 4:784c4b53a3d4 85 if(!feof(from)) fputc(ch, to);
ChrisnieM 4:784c4b53a3d4 86 if (ferror(to)) break;
ChrisnieM 4:784c4b53a3d4 87 }
ChrisnieM 4:784c4b53a3d4 88 }
ChrisnieM 4:784c4b53a3d4 89
ChrisnieM 4:784c4b53a3d4 90 if (NULL != from) fclose(from);
ChrisnieM 4:784c4b53a3d4 91 if (NULL != to) fclose(to);
ChrisnieM 4:784c4b53a3d4 92 }
ChrisnieM 4:784c4b53a3d4 93 }
ChrisnieM 4:784c4b53a3d4 94
ChrisnieM 4:784c4b53a3d4 95 // now delete the log file, so we are ready to start again
ChrisnieM 4:784c4b53a3d4 96 // even if backup creation failed - the show must go on!
ChrisnieM 4:784c4b53a3d4 97 logFileStatus = remove(logFile);
ChrisnieM 4:784c4b53a3d4 98 }
ChrisnieM 4:784c4b53a3d4 99
ChrisnieM 4:784c4b53a3d4 100 void DebugTrace::traceOut(const char* fmt, ...)
ChrisnieM 4:784c4b53a3d4 101 {
ChrisnieM 4:784c4b53a3d4 102 if (enabled)
ChrisnieM 4:784c4b53a3d4 103 {
ChrisnieM 4:784c4b53a3d4 104 va_list ap; // argument list pointer
ChrisnieM 4:784c4b53a3d4 105 va_start(ap, fmt);
ChrisnieM 4:784c4b53a3d4 106
ChrisnieM 4:784c4b53a3d4 107 if (TO_SERIAL == logMode)
ChrisnieM 4:784c4b53a3d4 108 {
ChrisnieM 4:784c4b53a3d4 109 vfprintf(logSerial, fmt, ap);
ChrisnieM 4:784c4b53a3d4 110 }
ChrisnieM 4:784c4b53a3d4 111 else // TO_FILE
ChrisnieM 4:784c4b53a3d4 112 {
ChrisnieM 4:784c4b53a3d4 113 if (0 == logFileStatus) // otherwise we failed to remove a full log file
ChrisnieM 4:784c4b53a3d4 114 {
ChrisnieM 4:784c4b53a3d4 115 // Write data to file. Note the file size may go over limit
ChrisnieM 4:784c4b53a3d4 116 // as we check total size afterwards, using the size written to file.
ChrisnieM 4:784c4b53a3d4 117 // This is not a big issue, as this mechanism is only here
ChrisnieM 4:784c4b53a3d4 118 // to stop the file growing unchecked. Just remember log file sizes may
ChrisnieM 4:784c4b53a3d4 119 // be some what over (as apposed to some what under), so don't push it
ChrisnieM 4:784c4b53a3d4 120 // with the max file size.
ChrisnieM 4:784c4b53a3d4 121 FILE* fp = fopen(logFile, "a");
ChrisnieM 4:784c4b53a3d4 122 if (NULL == fp)
ChrisnieM 4:784c4b53a3d4 123 {
ChrisnieM 4:784c4b53a3d4 124 va_end(ap);
ChrisnieM 4:784c4b53a3d4 125 return;
ChrisnieM 4:784c4b53a3d4 126 }
ChrisnieM 4:784c4b53a3d4 127 int size_written = vfprintf(fp, fmt, ap);
ChrisnieM 4:784c4b53a3d4 128 fclose(fp);
ChrisnieM 4:784c4b53a3d4 129
ChrisnieM 4:784c4b53a3d4 130 // check if we are over the max file size
ChrisnieM 4:784c4b53a3d4 131 // if so backup file and start again
ChrisnieM 4:784c4b53a3d4 132 currentFileSize += size_written;
ChrisnieM 4:784c4b53a3d4 133 if (currentFileSize >= maxFileSize)
ChrisnieM 4:784c4b53a3d4 134 {
ChrisnieM 4:784c4b53a3d4 135 backupLog();
ChrisnieM 4:784c4b53a3d4 136 currentFileSize = 0;
ChrisnieM 4:784c4b53a3d4 137 }
ChrisnieM 4:784c4b53a3d4 138 }
ChrisnieM 4:784c4b53a3d4 139 }
ChrisnieM 4:784c4b53a3d4 140
ChrisnieM 4:784c4b53a3d4 141 va_end(ap);
ChrisnieM 4:784c4b53a3d4 142 }
ChrisnieM 4:784c4b53a3d4 143 }