1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef A_DEBUG_H_
18
19#define A_DEBUG_H_
20
21#include <string.h>
22
23#include <media/stagefright/foundation/ABase.h>
24#include <media/stagefright/foundation/AString.h>
25#include <utils/Log.h>
26
27namespace android {
28
29inline static const char *asString(status_t i, const char *def = "??") {
30    switch (i) {
31        case NO_ERROR:              return "NO_ERROR";
32        case UNKNOWN_ERROR:         return "UNKNOWN_ERROR";
33        case NO_MEMORY:             return "NO_MEMORY";
34        case INVALID_OPERATION:     return "INVALID_OPERATION";
35        case BAD_VALUE:             return "BAD_VALUE";
36        case BAD_TYPE:              return "BAD_TYPE";
37        case NAME_NOT_FOUND:        return "NAME_NOT_FOUND";
38        case PERMISSION_DENIED:     return "PERMISSION_DENIED";
39        case NO_INIT:               return "NO_INIT";
40        case ALREADY_EXISTS:        return "ALREADY_EXISTS";
41        case DEAD_OBJECT:           return "DEAD_OBJECT";
42        case FAILED_TRANSACTION:    return "FAILED_TRANSACTION";
43        case BAD_INDEX:             return "BAD_INDEX";
44        case NOT_ENOUGH_DATA:       return "NOT_ENOUGH_DATA";
45        case WOULD_BLOCK:           return "WOULD_BLOCK";
46        case TIMED_OUT:             return "TIMED_OUT";
47        case UNKNOWN_TRANSACTION:   return "UNKNOWN_TRANSACTION";
48        case FDS_NOT_ALLOWED:       return "FDS_NOT_ALLOWED";
49        default:                    return def;
50    }
51}
52
53#define LITERAL_TO_STRING_INTERNAL(x)    #x
54#define LITERAL_TO_STRING(x) LITERAL_TO_STRING_INTERNAL(x)
55
56#ifdef CHECK
57#undef CHECK
58#endif
59#define CHECK(condition)                                \
60    LOG_ALWAYS_FATAL_IF(                                \
61            !(condition),                               \
62            "%s",                                       \
63            __FILE__ ":" LITERAL_TO_STRING(__LINE__)    \
64            " CHECK(" #condition ") failed.")
65
66#define MAKE_COMPARATOR(suffix,op)                          \
67    template<class A, class B>                              \
68    AString Compare_##suffix(const A &a, const B &b) {      \
69        AString res;                                        \
70        if (!(a op b)) {                                    \
71            res.append(a);                                  \
72            res.append(" vs. ");                            \
73            res.append(b);                                  \
74        }                                                   \
75        return res;                                         \
76    }
77
78MAKE_COMPARATOR(EQ,==)
79MAKE_COMPARATOR(NE,!=)
80MAKE_COMPARATOR(LE,<=)
81MAKE_COMPARATOR(GE,>=)
82MAKE_COMPARATOR(LT,<)
83MAKE_COMPARATOR(GT,>)
84
85#ifdef CHECK_OP
86#undef CHECK_OP
87#endif
88
89#define CHECK_OP(x,y,suffix,op)                                         \
90    do {                                                                \
91        AString ___res = Compare_##suffix(x, y);                        \
92        if (!___res.empty()) {                                          \
93            AString ___full =                                           \
94                __FILE__ ":" LITERAL_TO_STRING(__LINE__)                \
95                    " CHECK_" #suffix "( " #x "," #y ") failed: ";      \
96            ___full.append(___res);                                     \
97                                                                        \
98            LOG_ALWAYS_FATAL("%s", ___full.c_str());                    \
99        }                                                               \
100    } while (false)
101
102#ifdef CHECK_EQ
103#undef CHECK_EQ
104#undef CHECK_NE
105#undef CHECK_LE
106#undef CHECK_LT
107#undef CHECK_GE
108#undef CHECK_GT
109#endif
110
111#define CHECK_EQ(x,y)   CHECK_OP(x,y,EQ,==)
112#define CHECK_NE(x,y)   CHECK_OP(x,y,NE,!=)
113#define CHECK_LE(x,y)   CHECK_OP(x,y,LE,<=)
114#define CHECK_LT(x,y)   CHECK_OP(x,y,LT,<)
115#define CHECK_GE(x,y)   CHECK_OP(x,y,GE,>=)
116#define CHECK_GT(x,y)   CHECK_OP(x,y,GT,>)
117
118#define TRESPASS(...) \
119        LOG_ALWAYS_FATAL(                                       \
120            __FILE__ ":" LITERAL_TO_STRING(__LINE__)            \
121                " Should not be here. " __VA_ARGS__);
122
123#ifdef NDEBUG
124#define CHECK_DBG CHECK
125#define CHECK_EQ_DBG CHECK_EQ
126#define CHECK_NE_DBG CHECK_NE
127#define CHECK_LE_DBG CHECK_LE
128#define CHECK_LT_DBG CHECK_LT
129#define CHECK_GE_DBG CHECK_GE
130#define CHECK_GT_DBG CHECK_GT
131#define TRESPASS_DBG TRESPASS
132#else
133#define CHECK_DBG(condition)
134#define CHECK_EQ_DBG(x,y)
135#define CHECK_NE_DBG(x,y)
136#define CHECK_LE_DBG(x,y)
137#define CHECK_LT_DBG(x,y)
138#define CHECK_GE_DBG(x,y)
139#define CHECK_GT_DBG(x,y)
140#define TRESPASS_DBG(...)
141#endif
142
143struct ADebug {
144    enum Level {
145        kDebugNone,             // no debug
146        kDebugLifeCycle,        // lifecycle events: creation/deletion
147        kDebugState,            // commands and events
148        kDebugConfig,           // configuration
149        kDebugInternalState,    // internal state changes
150        kDebugAll,              // all
151        kDebugMax = kDebugAll,
152
153    };
154
155    // parse the property or string to get a long-type level for a component name
156    // string format is:
157    // <level>[:<glob>][,<level>[:<glob>]...]
158    // - <level> is 0-5 corresponding to ADebug::Level
159    // - <glob> is used to match component name case insensitively, if omitted, it
160    //   matches all components
161    // - string is read left-to-right, and the last matching level is returned, or
162    //   the def if no terms matched
163    static long GetLevelFromSettingsString(
164            const char *name, const char *value, long def);
165    static long GetLevelFromProperty(
166            const char *name, const char *value, long def);
167
168    // same for ADebug::Level - performs clamping to valid debug ranges
169    static Level GetDebugLevelFromProperty(
170            const char *name, const char *propertyName, Level def = kDebugNone);
171
172    // remove redundant segments of a codec name, and return a newly allocated
173    // string suitable for debugging
174    static char *GetDebugName(const char *name);
175
176    inline static bool isExperimentEnabled(
177            const char *name __unused /* nonnull */, bool allow __unused = true) {
178#ifdef ENABLE_STAGEFRIGHT_EXPERIMENTS
179        if (!strcmp(name, "legacy-adaptive")) {
180            return getExperimentFlag(allow, name, 2, 1); // every other day
181        } else if (!strcmp(name, "legacy-setsurface")) {
182            return getExperimentFlag(allow, name, 3, 1); // every third day
183        } else {
184            ALOGE("unknown experiment '%s' (disabled)", name);
185        }
186#endif
187        return false;
188    }
189
190private:
191    // pass in allow, so we can print in the log if the experiment is disabled
192    static bool getExperimentFlag(
193            bool allow, const char *name, uint64_t modulo, uint64_t limit,
194            uint64_t plus = 0, uint64_t timeDivisor = 24 * 60 * 60 /* 1 day */);
195};
196
197}  // namespace android
198
199#endif  // A_DEBUG_H_
200
201