• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef PANDA_LIBPANDABASE_PBASE_OS_DFX_OPTION_H
17 #define PANDA_LIBPANDABASE_PBASE_OS_DFX_OPTION_H
18 
19 #include "macros.h"
20 
21 #include <cstdint>
22 #include <string>
23 
24 namespace ark::os::dfx_option {
25 
26 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
27 #define DFX_OPTION_ELEM(D, NAME, STR) D(NAME, DfxOptionHandler::DfxOptionId::NAME##_ID, STR)
28 
29 #ifdef PANDA_TARGET_UNIX
30 // CC-OFFNXT(G.PRE.06) solid logic
31 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
32 #define DFX_OPTION_LIST(D)                                       \
33     DFX_OPTION_ELEM(D, COMPILER_NULLCHECK, "compiler-nullcheck") \
34     DFX_OPTION_ELEM(D, REFERENCE_DUMP, "reference-dump")         \
35     DFX_OPTION_ELEM(D, SIGNAL_CATCHER, "signal-catcher")         \
36     DFX_OPTION_ELEM(D, SIGNAL_HANDLER, "signal-handler")         \
37     DFX_OPTION_ELEM(D, ARK_SIGQUIT, "sigquit")                   \
38     DFX_OPTION_ELEM(D, ARK_SIGUSR1, "sigusr1")                   \
39     DFX_OPTION_ELEM(D, ARK_SIGUSR2, "sigusr2")                   \
40     DFX_OPTION_ELEM(D, MOBILE_LOG, "mobile-log")                 \
41     DFX_OPTION_ELEM(D, DFXLOG, "dfx-log")                        \
42     DFX_OPTION_ELEM(D, HUNG_UPDATE, "hung-update")               \
43     DFX_OPTION_ELEM(D, END_FLAG, "end-flag")
44 #else
45 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
46 #define DFX_OPTION_LIST(D)                               \
47     DFX_OPTION_ELEM(D, REFERENCE_DUMP, "reference-dump") \
48     DFX_OPTION_ELEM(D, DFXLOG, "dfx-log")                \
49     DFX_OPTION_ELEM(D, END_FLAG, "end-flag")
50 #endif  // PANDA_TARGET_UNIX
51 
52 class DfxOptionHandler {
53 public:
54     enum DfxOptionId : uint8_t {
55 #ifdef PANDA_TARGET_UNIX
56         COMPILER_NULLCHECK_ID,
57         SIGNAL_CATCHER_ID,
58         SIGNAL_HANDLER_ID,
59         ARK_SIGQUIT_ID,
60         ARK_SIGUSR1_ID,
61         ARK_SIGUSR2_ID,
62         MOBILE_LOG_ID,
63         HUNG_UPDATE_ID,
64 #endif  // PANDA_TARGET_UNIX
65         REFERENCE_DUMP_ID,
66         DFXLOG_ID,
67         END_FLAG_ID,
68     };
69 
70     enum DfxOption : uint8_t {
71 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
72 #define D(e, v, str) e = (v),
73         DFX_OPTION_LIST(D)
74 #undef D
75     };
76 
77     static bool IsInOptionList(const std::string &s);
78 
79     static DfxOption DfxOptionFromString(const std::string &s);
80 
81     static std::string StringFromDfxOption(DfxOptionHandler::DfxOption dfxOption);
82 };
83 
84 }  // namespace ark::os::dfx_option
85 #endif  // PANDA_LIBPANDABASE_PBASE_OS_DFX_OPTION_H
86