1 /*
2  * Copyright (c) 2017, The Linux Foundation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *    * Redistributions of source code must retain the above copyright
8  *      notice, this list of conditions and the following disclaimer.
9  *    * Redistributions in binary form must reproduce the above
10  *      copyright notice, this list of conditions and the following
11  *      disclaimer in the documentation and/or other materials provided
12  *      with the distribution.
13  *    * Neither the name of The Linux Foundation nor the names of its
14  *      contributors may be used to endorse or promote products derived
15  *      from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef _LOCAL_LOG_BUFFER_H_
30 #define _LOCAL_LOG_BUFFER_H_
31 /* External Includes */
32 #include <deque>
33 #include <sstream>
34 #include <string>
35 #include <sys/types.h>
36 #include <vector>
37 
38 /* Namespace pollution avoidance */
39 using ::std::deque;
40 using ::std::string;
41 using ::std::stringstream;
42 using ::std::vector;
43 
44 
45 class LocalLogBuffer {
46 public:
47     class FunctionLog {
48     public:
49         FunctionLog(string /* funcName */);
50         FunctionLog(const FunctionLog& /* other */);
51         void addArg(string /* kw */, string /* arg */);
52         void addArg(string /* kw */, vector<string> /* args */);
53         void addArg(string /* kw */, uint64_t /* arg */);
54         void setResult(bool /* success */, string /* msg */);
55         void setResult(vector<unsigned int> /* ret */);
56         void setResult(uint64_t /* rx */, uint64_t /* tx */);
57         string toString();
58     private:
59         void maybeAddArgsComma();
60         const string mName;
61         bool mArgsProvided;
62         stringstream mSSArgs;
63         stringstream mSSReturn;
64     }; /* FunctionLog */
65     LocalLogBuffer(string /* name */, int /* maxLogs */);
66     void addLog(FunctionLog /* log */);
67     void toLogcat();
68     void toFd(int fd);
69 private:
70     deque<FunctionLog> mLogs;
71     const string mName;
72     const size_t mMaxLogs;
73 }; /* LocalLogBuffer */
74 #endif /* _LOCAL_LOG_BUFFER_H_ */
75