Home | History | Annotate | Download | only in foundation
      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 
     27 namespace android {
     28 
     29 inline 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 #define CHECK(condition)                                \
     57     LOG_ALWAYS_FATAL_IF(                                \
     58             !(condition),                               \
     59             "%s",                                       \
     60             __FILE__ ":" LITERAL_TO_STRING(__LINE__)    \
     61             " CHECK(" #condition ") failed.")
     62 
     63 #define MAKE_COMPARATOR(suffix,op)                          \
     64     template<class A, class B>                              \
     65     AString Compare_##suffix(const A &a, const B &b) {      \
     66         AString res;                                        \
     67         if (!(a op b)) {                                    \
     68             res.append(a);                                  \
     69             res.append(" vs. ");                            \
     70             res.append(b);                                  \
     71         }                                                   \
     72         return res;                                         \
     73     }
     74 
     75 MAKE_COMPARATOR(EQ,==)
     76 MAKE_COMPARATOR(NE,!=)
     77 MAKE_COMPARATOR(LE,<=)
     78 MAKE_COMPARATOR(GE,>=)
     79 MAKE_COMPARATOR(LT,<)
     80 MAKE_COMPARATOR(GT,>)
     81 
     82 #define CHECK_OP(x,y,suffix,op)                                         \
     83     do {                                                                \
     84         AString ___res = Compare_##suffix(x, y);                        \
     85         if (!___res.empty()) {                                          \
     86             AString ___full =                                           \
     87                 __FILE__ ":" LITERAL_TO_STRING(__LINE__)                \
     88                     " CHECK_" #suffix "( " #x "," #y ") failed: ";      \
     89             ___full.append(___res);                                     \
     90                                                                         \
     91             LOG_ALWAYS_FATAL("%s", ___full.c_str());                    \
     92         }                                                               \
     93     } while (false)
     94 
     95 #define CHECK_EQ(x,y)   CHECK_OP(x,y,EQ,==)
     96 #define CHECK_NE(x,y)   CHECK_OP(x,y,NE,!=)
     97 #define CHECK_LE(x,y)   CHECK_OP(x,y,LE,<=)
     98 #define CHECK_LT(x,y)   CHECK_OP(x,y,LT,<)
     99 #define CHECK_GE(x,y)   CHECK_OP(x,y,GE,>=)
    100 #define CHECK_GT(x,y)   CHECK_OP(x,y,GT,>)
    101 
    102 #define TRESPASS() \
    103         LOG_ALWAYS_FATAL(                                       \
    104             __FILE__ ":" LITERAL_TO_STRING(__LINE__)            \
    105                 " Should not be here.");
    106 
    107 struct ADebug {
    108     enum Level {
    109         kDebugNone,             // no debug
    110         kDebugLifeCycle,        // lifecycle events: creation/deletion
    111         kDebugState,            // commands and events
    112         kDebugConfig,           // configuration
    113         kDebugInternalState,    // internal state changes
    114         kDebugAll,              // all
    115         kDebugMax = kDebugAll,
    116 
    117     };
    118 
    119     // parse the property or string to get a long-type level for a component name
    120     // string format is:
    121     // <level>[:<glob>][,<level>[:<glob>]...]
    122     // - <level> is 0-5 corresponding to ADebug::Level
    123     // - <glob> is used to match component name case insensitively, if omitted, it
    124     //   matches all components
    125     // - string is read left-to-right, and the last matching level is returned, or
    126     //   the def if no terms matched
    127     static long GetLevelFromSettingsString(
    128             const char *name, const char *value, long def);
    129     static long GetLevelFromProperty(
    130             const char *name, const char *value, long def);
    131 
    132     // same for ADebug::Level - performs clamping to valid debug ranges
    133     static Level GetDebugLevelFromProperty(
    134             const char *name, const char *propertyName, Level def = kDebugNone);
    135 
    136     // remove redundant segments of a codec name, and return a newly allocated
    137     // string suitable for debugging
    138     static char *GetDebugName(const char *name);
    139 
    140     inline static bool isExperimentEnabled(
    141             const char *name __unused /* nonnull */, bool allow __unused = true) {
    142 #ifdef ENABLE_STAGEFRIGHT_EXPERIMENTS
    143         if (!strcmp(name, "legacy-adaptive")) {
    144             return getExperimentFlag(allow, name, 2, 1); // every other day
    145         } else if (!strcmp(name, "legacy-setsurface")) {
    146             return getExperimentFlag(allow, name, 3, 1); // every third day
    147         } else {
    148             ALOGE("unknown experiment '%s' (disabled)", name);
    149         }
    150 #endif
    151         return false;
    152     }
    153 
    154 private:
    155     // pass in allow, so we can print in the log if the experiment is disabled
    156     static bool getExperimentFlag(
    157             bool allow, const char *name, uint64_t modulo, uint64_t limit,
    158             uint64_t plus = 0, uint64_t timeDivisor = 24 * 60 * 60 /* 1 day */);
    159 };
    160 
    161 }  // namespace android
    162 
    163 #endif  // A_DEBUG_H_
    164 
    165