xref: /aosp_15_r20/system/core/init/parser.cpp (revision 00c7fec1bb09f3284aad6a6f96d2f63dfc3650ad)
1*00c7fec1SAndroid Build Coastguard Worker /*
2*00c7fec1SAndroid Build Coastguard Worker  * Copyright (C) 2010 The Android Open Source Project
3*00c7fec1SAndroid Build Coastguard Worker  *
4*00c7fec1SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*00c7fec1SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*00c7fec1SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*00c7fec1SAndroid Build Coastguard Worker  *
8*00c7fec1SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*00c7fec1SAndroid Build Coastguard Worker  *
10*00c7fec1SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*00c7fec1SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*00c7fec1SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*00c7fec1SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*00c7fec1SAndroid Build Coastguard Worker  * limitations under the License.
15*00c7fec1SAndroid Build Coastguard Worker  */
16*00c7fec1SAndroid Build Coastguard Worker 
17*00c7fec1SAndroid Build Coastguard Worker #include "parser.h"
18*00c7fec1SAndroid Build Coastguard Worker 
19*00c7fec1SAndroid Build Coastguard Worker #include <dirent.h>
20*00c7fec1SAndroid Build Coastguard Worker 
21*00c7fec1SAndroid Build Coastguard Worker #include <map>
22*00c7fec1SAndroid Build Coastguard Worker 
23*00c7fec1SAndroid Build Coastguard Worker #include <android-base/chrono_utils.h>
24*00c7fec1SAndroid Build Coastguard Worker #include <android-base/file.h>
25*00c7fec1SAndroid Build Coastguard Worker #include <android-base/logging.h>
26*00c7fec1SAndroid Build Coastguard Worker #include <android-base/stringprintf.h>
27*00c7fec1SAndroid Build Coastguard Worker #include <android-base/strings.h>
28*00c7fec1SAndroid Build Coastguard Worker 
29*00c7fec1SAndroid Build Coastguard Worker #include "tokenizer.h"
30*00c7fec1SAndroid Build Coastguard Worker #include "util.h"
31*00c7fec1SAndroid Build Coastguard Worker 
32*00c7fec1SAndroid Build Coastguard Worker namespace android {
33*00c7fec1SAndroid Build Coastguard Worker namespace init {
34*00c7fec1SAndroid Build Coastguard Worker 
Parser()35*00c7fec1SAndroid Build Coastguard Worker Parser::Parser() {}
36*00c7fec1SAndroid Build Coastguard Worker 
AddSectionParser(const std::string & name,std::unique_ptr<SectionParser> parser)37*00c7fec1SAndroid Build Coastguard Worker void Parser::AddSectionParser(const std::string& name, std::unique_ptr<SectionParser> parser) {
38*00c7fec1SAndroid Build Coastguard Worker     section_parsers_[name] = std::move(parser);
39*00c7fec1SAndroid Build Coastguard Worker }
40*00c7fec1SAndroid Build Coastguard Worker 
AddSingleLineParser(const std::string & prefix,LineCallback callback)41*00c7fec1SAndroid Build Coastguard Worker void Parser::AddSingleLineParser(const std::string& prefix, LineCallback callback) {
42*00c7fec1SAndroid Build Coastguard Worker     line_callbacks_.emplace_back(prefix, std::move(callback));
43*00c7fec1SAndroid Build Coastguard Worker }
44*00c7fec1SAndroid Build Coastguard Worker 
ParseData(const std::string & filename,std::string * data)45*00c7fec1SAndroid Build Coastguard Worker void Parser::ParseData(const std::string& filename, std::string* data) {
46*00c7fec1SAndroid Build Coastguard Worker     data->push_back('\n');
47*00c7fec1SAndroid Build Coastguard Worker     data->push_back('\0');
48*00c7fec1SAndroid Build Coastguard Worker 
49*00c7fec1SAndroid Build Coastguard Worker     parse_state state;
50*00c7fec1SAndroid Build Coastguard Worker     state.line = 0;
51*00c7fec1SAndroid Build Coastguard Worker     state.ptr = data->data();
52*00c7fec1SAndroid Build Coastguard Worker     state.nexttoken = 0;
53*00c7fec1SAndroid Build Coastguard Worker 
54*00c7fec1SAndroid Build Coastguard Worker     SectionParser* section_parser = nullptr;
55*00c7fec1SAndroid Build Coastguard Worker     int section_start_line = -1;
56*00c7fec1SAndroid Build Coastguard Worker     std::vector<std::string> args;
57*00c7fec1SAndroid Build Coastguard Worker 
58*00c7fec1SAndroid Build Coastguard Worker     // If we encounter a bad section start, there is no valid parser object to parse the subsequent
59*00c7fec1SAndroid Build Coastguard Worker     // sections, so we must suppress errors until the next valid section is found.
60*00c7fec1SAndroid Build Coastguard Worker     bool bad_section_found = false;
61*00c7fec1SAndroid Build Coastguard Worker 
62*00c7fec1SAndroid Build Coastguard Worker     auto end_section = [&] {
63*00c7fec1SAndroid Build Coastguard Worker         bad_section_found = false;
64*00c7fec1SAndroid Build Coastguard Worker         if (section_parser == nullptr) return;
65*00c7fec1SAndroid Build Coastguard Worker 
66*00c7fec1SAndroid Build Coastguard Worker         if (auto result = section_parser->EndSection(); !result.ok()) {
67*00c7fec1SAndroid Build Coastguard Worker             parse_error_count_++;
68*00c7fec1SAndroid Build Coastguard Worker             LOG(ERROR) << filename << ": " << section_start_line << ": " << result.error();
69*00c7fec1SAndroid Build Coastguard Worker         }
70*00c7fec1SAndroid Build Coastguard Worker 
71*00c7fec1SAndroid Build Coastguard Worker         section_parser = nullptr;
72*00c7fec1SAndroid Build Coastguard Worker         section_start_line = -1;
73*00c7fec1SAndroid Build Coastguard Worker     };
74*00c7fec1SAndroid Build Coastguard Worker 
75*00c7fec1SAndroid Build Coastguard Worker     for (;;) {
76*00c7fec1SAndroid Build Coastguard Worker         switch (next_token(&state)) {
77*00c7fec1SAndroid Build Coastguard Worker             case T_EOF:
78*00c7fec1SAndroid Build Coastguard Worker                 end_section();
79*00c7fec1SAndroid Build Coastguard Worker 
80*00c7fec1SAndroid Build Coastguard Worker                 for (const auto& [section_name, section_parser] : section_parsers_) {
81*00c7fec1SAndroid Build Coastguard Worker                     section_parser->EndFile();
82*00c7fec1SAndroid Build Coastguard Worker                 }
83*00c7fec1SAndroid Build Coastguard Worker 
84*00c7fec1SAndroid Build Coastguard Worker                 return;
85*00c7fec1SAndroid Build Coastguard Worker             case T_NEWLINE: {
86*00c7fec1SAndroid Build Coastguard Worker                 state.line++;
87*00c7fec1SAndroid Build Coastguard Worker                 if (args.empty()) break;
88*00c7fec1SAndroid Build Coastguard Worker                 // If we have a line matching a prefix we recognize, call its callback and unset any
89*00c7fec1SAndroid Build Coastguard Worker                 // current section parsers.  This is meant for /sys/ and /dev/ line entries for
90*00c7fec1SAndroid Build Coastguard Worker                 // uevent.
91*00c7fec1SAndroid Build Coastguard Worker                 auto line_callback = std::find_if(
92*00c7fec1SAndroid Build Coastguard Worker                     line_callbacks_.begin(), line_callbacks_.end(),
93*00c7fec1SAndroid Build Coastguard Worker                     [&args](const auto& c) { return android::base::StartsWith(args[0], c.first); });
94*00c7fec1SAndroid Build Coastguard Worker                 if (line_callback != line_callbacks_.end()) {
95*00c7fec1SAndroid Build Coastguard Worker                     end_section();
96*00c7fec1SAndroid Build Coastguard Worker 
97*00c7fec1SAndroid Build Coastguard Worker                     if (auto result = line_callback->second(std::move(args)); !result.ok()) {
98*00c7fec1SAndroid Build Coastguard Worker                         parse_error_count_++;
99*00c7fec1SAndroid Build Coastguard Worker                         LOG(ERROR) << filename << ": " << state.line << ": " << result.error();
100*00c7fec1SAndroid Build Coastguard Worker                     }
101*00c7fec1SAndroid Build Coastguard Worker                 } else if (section_parsers_.count(args[0])) {
102*00c7fec1SAndroid Build Coastguard Worker                     end_section();
103*00c7fec1SAndroid Build Coastguard Worker                     section_parser = section_parsers_[args[0]].get();
104*00c7fec1SAndroid Build Coastguard Worker                     section_start_line = state.line;
105*00c7fec1SAndroid Build Coastguard Worker                     if (auto result =
106*00c7fec1SAndroid Build Coastguard Worker                                 section_parser->ParseSection(std::move(args), filename, state.line);
107*00c7fec1SAndroid Build Coastguard Worker                         !result.ok()) {
108*00c7fec1SAndroid Build Coastguard Worker                         parse_error_count_++;
109*00c7fec1SAndroid Build Coastguard Worker                         LOG(ERROR) << filename << ": " << state.line << ": " << result.error();
110*00c7fec1SAndroid Build Coastguard Worker                         section_parser = nullptr;
111*00c7fec1SAndroid Build Coastguard Worker                         bad_section_found = true;
112*00c7fec1SAndroid Build Coastguard Worker                     }
113*00c7fec1SAndroid Build Coastguard Worker                 } else if (section_parser) {
114*00c7fec1SAndroid Build Coastguard Worker                     if (auto result = section_parser->ParseLineSection(std::move(args), state.line);
115*00c7fec1SAndroid Build Coastguard Worker                         !result.ok()) {
116*00c7fec1SAndroid Build Coastguard Worker                         parse_error_count_++;
117*00c7fec1SAndroid Build Coastguard Worker                         LOG(ERROR) << filename << ": " << state.line << ": " << result.error();
118*00c7fec1SAndroid Build Coastguard Worker                     }
119*00c7fec1SAndroid Build Coastguard Worker                 } else if (!bad_section_found) {
120*00c7fec1SAndroid Build Coastguard Worker                     parse_error_count_++;
121*00c7fec1SAndroid Build Coastguard Worker                     LOG(ERROR) << filename << ": " << state.line
122*00c7fec1SAndroid Build Coastguard Worker                                << ": Invalid section keyword found";
123*00c7fec1SAndroid Build Coastguard Worker                 }
124*00c7fec1SAndroid Build Coastguard Worker                 args.clear();
125*00c7fec1SAndroid Build Coastguard Worker                 break;
126*00c7fec1SAndroid Build Coastguard Worker             }
127*00c7fec1SAndroid Build Coastguard Worker             case T_TEXT:
128*00c7fec1SAndroid Build Coastguard Worker                 args.emplace_back(state.text);
129*00c7fec1SAndroid Build Coastguard Worker                 break;
130*00c7fec1SAndroid Build Coastguard Worker         }
131*00c7fec1SAndroid Build Coastguard Worker     }
132*00c7fec1SAndroid Build Coastguard Worker }
133*00c7fec1SAndroid Build Coastguard Worker 
ParseConfigFileInsecure(const std::string & path,bool follow_symlinks=false)134*00c7fec1SAndroid Build Coastguard Worker bool Parser::ParseConfigFileInsecure(const std::string& path, bool follow_symlinks = false) {
135*00c7fec1SAndroid Build Coastguard Worker     std::string config_contents;
136*00c7fec1SAndroid Build Coastguard Worker     if (!android::base::ReadFileToString(path, &config_contents, follow_symlinks)) {
137*00c7fec1SAndroid Build Coastguard Worker         return false;
138*00c7fec1SAndroid Build Coastguard Worker     }
139*00c7fec1SAndroid Build Coastguard Worker 
140*00c7fec1SAndroid Build Coastguard Worker     ParseData(path, &config_contents);
141*00c7fec1SAndroid Build Coastguard Worker     return true;
142*00c7fec1SAndroid Build Coastguard Worker }
143*00c7fec1SAndroid Build Coastguard Worker 
ParseConfigFile(const std::string & path)144*00c7fec1SAndroid Build Coastguard Worker Result<void> Parser::ParseConfigFile(const std::string& path) {
145*00c7fec1SAndroid Build Coastguard Worker     LOG(INFO) << "Parsing file " << path << "...";
146*00c7fec1SAndroid Build Coastguard Worker     android::base::Timer t;
147*00c7fec1SAndroid Build Coastguard Worker     auto config_contents = ReadFile(path);
148*00c7fec1SAndroid Build Coastguard Worker     if (!config_contents.ok()) {
149*00c7fec1SAndroid Build Coastguard Worker         return Error() << "Unable to read config file '" << path
150*00c7fec1SAndroid Build Coastguard Worker                        << "': " << config_contents.error();
151*00c7fec1SAndroid Build Coastguard Worker     }
152*00c7fec1SAndroid Build Coastguard Worker 
153*00c7fec1SAndroid Build Coastguard Worker     ParseData(path, &config_contents.value());
154*00c7fec1SAndroid Build Coastguard Worker 
155*00c7fec1SAndroid Build Coastguard Worker     LOG(VERBOSE) << "(Parsing " << path << " took " << t << ".)";
156*00c7fec1SAndroid Build Coastguard Worker     return {};
157*00c7fec1SAndroid Build Coastguard Worker }
158*00c7fec1SAndroid Build Coastguard Worker 
ParseConfigDir(const std::string & path)159*00c7fec1SAndroid Build Coastguard Worker bool Parser::ParseConfigDir(const std::string& path) {
160*00c7fec1SAndroid Build Coastguard Worker     LOG(INFO) << "Parsing directory " << path << "...";
161*00c7fec1SAndroid Build Coastguard Worker     std::unique_ptr<DIR, decltype(&closedir)> config_dir(opendir(path.c_str()), closedir);
162*00c7fec1SAndroid Build Coastguard Worker     if (!config_dir) {
163*00c7fec1SAndroid Build Coastguard Worker         PLOG(INFO) << "Could not import directory '" << path << "'";
164*00c7fec1SAndroid Build Coastguard Worker         return false;
165*00c7fec1SAndroid Build Coastguard Worker     }
166*00c7fec1SAndroid Build Coastguard Worker     dirent* current_file;
167*00c7fec1SAndroid Build Coastguard Worker     std::vector<std::string> files;
168*00c7fec1SAndroid Build Coastguard Worker     while ((current_file = readdir(config_dir.get()))) {
169*00c7fec1SAndroid Build Coastguard Worker         // Ignore directories and only process regular files.
170*00c7fec1SAndroid Build Coastguard Worker         if (current_file->d_type == DT_REG) {
171*00c7fec1SAndroid Build Coastguard Worker             std::string current_path =
172*00c7fec1SAndroid Build Coastguard Worker                 android::base::StringPrintf("%s/%s", path.c_str(), current_file->d_name);
173*00c7fec1SAndroid Build Coastguard Worker             files.emplace_back(current_path);
174*00c7fec1SAndroid Build Coastguard Worker         }
175*00c7fec1SAndroid Build Coastguard Worker     }
176*00c7fec1SAndroid Build Coastguard Worker     // Sort first so we load files in a consistent order (bug 31996208)
177*00c7fec1SAndroid Build Coastguard Worker     std::sort(files.begin(), files.end());
178*00c7fec1SAndroid Build Coastguard Worker     for (const auto& file : files) {
179*00c7fec1SAndroid Build Coastguard Worker         if (auto result = ParseConfigFile(file); !result.ok()) {
180*00c7fec1SAndroid Build Coastguard Worker             LOG(ERROR) << "could not import file '" << file << "': " << result.error();
181*00c7fec1SAndroid Build Coastguard Worker         }
182*00c7fec1SAndroid Build Coastguard Worker     }
183*00c7fec1SAndroid Build Coastguard Worker     return true;
184*00c7fec1SAndroid Build Coastguard Worker }
185*00c7fec1SAndroid Build Coastguard Worker 
ParseConfig(const std::string & path)186*00c7fec1SAndroid Build Coastguard Worker bool Parser::ParseConfig(const std::string& path) {
187*00c7fec1SAndroid Build Coastguard Worker     if (is_dir(path.c_str())) {
188*00c7fec1SAndroid Build Coastguard Worker         return ParseConfigDir(path);
189*00c7fec1SAndroid Build Coastguard Worker     }
190*00c7fec1SAndroid Build Coastguard Worker     auto result = ParseConfigFile(path);
191*00c7fec1SAndroid Build Coastguard Worker     if (!result.ok()) {
192*00c7fec1SAndroid Build Coastguard Worker         LOG(INFO) << result.error();
193*00c7fec1SAndroid Build Coastguard Worker     }
194*00c7fec1SAndroid Build Coastguard Worker     return result.ok();
195*00c7fec1SAndroid Build Coastguard Worker }
196*00c7fec1SAndroid Build Coastguard Worker 
197*00c7fec1SAndroid Build Coastguard Worker }  // namespace init
198*00c7fec1SAndroid Build Coastguard Worker }  // namespace android
199