1*70a7ec85SAndroid Build Coastguard Worker /*
2*70a7ec85SAndroid Build Coastguard Worker * Copyright (C) 2017 The Android Open Source Project
3*70a7ec85SAndroid Build Coastguard Worker *
4*70a7ec85SAndroid Build Coastguard Worker * Licensed under the Apache License, Version 2.0 (the "License");
5*70a7ec85SAndroid Build Coastguard Worker * you may not use this file except in compliance with the License.
6*70a7ec85SAndroid Build Coastguard Worker * You may obtain a copy of the License at
7*70a7ec85SAndroid Build Coastguard Worker *
8*70a7ec85SAndroid Build Coastguard Worker * http://www.apache.org/licenses/LICENSE-2.0
9*70a7ec85SAndroid Build Coastguard Worker *
10*70a7ec85SAndroid Build Coastguard Worker * Unless required by applicable law or agreed to in writing, software
11*70a7ec85SAndroid Build Coastguard Worker * distributed under the License is distributed on an "AS IS" BASIS,
12*70a7ec85SAndroid Build Coastguard Worker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*70a7ec85SAndroid Build Coastguard Worker * See the License for the specific language governing permissions and
14*70a7ec85SAndroid Build Coastguard Worker * limitations under the License.
15*70a7ec85SAndroid Build Coastguard Worker */
16*70a7ec85SAndroid Build Coastguard Worker
17*70a7ec85SAndroid Build Coastguard Worker #include "KernelConfigParser.h"
18*70a7ec85SAndroid Build Coastguard Worker
19*70a7ec85SAndroid Build Coastguard Worker #include <regex>
20*70a7ec85SAndroid Build Coastguard Worker
21*70a7ec85SAndroid Build Coastguard Worker #define KEY "(CONFIG[\\w_]+)"
22*70a7ec85SAndroid Build Coastguard Worker #define COMMENT "(?:#.*)"
23*70a7ec85SAndroid Build Coastguard Worker
24*70a7ec85SAndroid Build Coastguard Worker namespace android {
25*70a7ec85SAndroid Build Coastguard Worker namespace vintf {
26*70a7ec85SAndroid Build Coastguard Worker
KernelConfigParser(bool processComments,bool relaxedFormat)27*70a7ec85SAndroid Build Coastguard Worker KernelConfigParser::KernelConfigParser(bool processComments, bool relaxedFormat)
28*70a7ec85SAndroid Build Coastguard Worker : mProcessComments(processComments), mRelaxedFormat(relaxedFormat) {}
29*70a7ec85SAndroid Build Coastguard Worker
finish()30*70a7ec85SAndroid Build Coastguard Worker status_t KernelConfigParser::finish() {
31*70a7ec85SAndroid Build Coastguard Worker return process("\n", 1 /* sizeof "\n" */);
32*70a7ec85SAndroid Build Coastguard Worker }
33*70a7ec85SAndroid Build Coastguard Worker
error() const34*70a7ec85SAndroid Build Coastguard Worker std::stringbuf* KernelConfigParser::error() const {
35*70a7ec85SAndroid Build Coastguard Worker return mError.rdbuf();
36*70a7ec85SAndroid Build Coastguard Worker }
37*70a7ec85SAndroid Build Coastguard Worker
configs()38*70a7ec85SAndroid Build Coastguard Worker std::map<std::string, std::string>& KernelConfigParser::configs() {
39*70a7ec85SAndroid Build Coastguard Worker return mConfigs;
40*70a7ec85SAndroid Build Coastguard Worker }
41*70a7ec85SAndroid Build Coastguard Worker
configs() const42*70a7ec85SAndroid Build Coastguard Worker const std::map<std::string, std::string>& KernelConfigParser::configs() const {
43*70a7ec85SAndroid Build Coastguard Worker return mConfigs;
44*70a7ec85SAndroid Build Coastguard Worker }
45*70a7ec85SAndroid Build Coastguard Worker
46*70a7ec85SAndroid Build Coastguard Worker // trim spaces between value and #, value and end of line
trimTrailingSpaces(const std::string & s)47*70a7ec85SAndroid Build Coastguard Worker std::string trimTrailingSpaces(const std::string& s) {
48*70a7ec85SAndroid Build Coastguard Worker auto r = s.rbegin();
49*70a7ec85SAndroid Build Coastguard Worker for (; r != s.rend() && std::isspace(*r); ++r)
50*70a7ec85SAndroid Build Coastguard Worker ;
51*70a7ec85SAndroid Build Coastguard Worker return std::string{s.begin(), r.base()};
52*70a7ec85SAndroid Build Coastguard Worker }
53*70a7ec85SAndroid Build Coastguard Worker
processRemaining()54*70a7ec85SAndroid Build Coastguard Worker status_t KernelConfigParser::processRemaining() {
55*70a7ec85SAndroid Build Coastguard Worker if (mRemaining.empty()) {
56*70a7ec85SAndroid Build Coastguard Worker return OK;
57*70a7ec85SAndroid Build Coastguard Worker }
58*70a7ec85SAndroid Build Coastguard Worker
59*70a7ec85SAndroid Build Coastguard Worker static const std::regex sKeyValuePattern("^\\s*" KEY "\\s*=\\s*([^#]+)" COMMENT "?$");
60*70a7ec85SAndroid Build Coastguard Worker static const std::regex sNotSetPattern("^\\s*#\\s*" KEY " is not set\\s*$");
61*70a7ec85SAndroid Build Coastguard Worker static const std::regex sCommentPattern("^\\s*" COMMENT "$");
62*70a7ec85SAndroid Build Coastguard Worker
63*70a7ec85SAndroid Build Coastguard Worker std::smatch match;
64*70a7ec85SAndroid Build Coastguard Worker
65*70a7ec85SAndroid Build Coastguard Worker if (mRelaxedFormat) {
66*70a7ec85SAndroid Build Coastguard Worker // Allow free format like " CONFIG_FOO = bar #trailing comments"
67*70a7ec85SAndroid Build Coastguard Worker if (std::regex_match(mRemaining, match, sKeyValuePattern)) {
68*70a7ec85SAndroid Build Coastguard Worker if (mConfigs.emplace(match[1], trimTrailingSpaces(match[2])).second) {
69*70a7ec85SAndroid Build Coastguard Worker return OK;
70*70a7ec85SAndroid Build Coastguard Worker }
71*70a7ec85SAndroid Build Coastguard Worker mError << "Duplicated key in configs: " << match[1] << "\n";
72*70a7ec85SAndroid Build Coastguard Worker return UNKNOWN_ERROR;
73*70a7ec85SAndroid Build Coastguard Worker }
74*70a7ec85SAndroid Build Coastguard Worker } else {
75*70a7ec85SAndroid Build Coastguard Worker // No spaces. Strictly like "CONFIG_FOO=bar"
76*70a7ec85SAndroid Build Coastguard Worker size_t equalPos = mRemaining.find('=');
77*70a7ec85SAndroid Build Coastguard Worker if (equalPos != std::string::npos) {
78*70a7ec85SAndroid Build Coastguard Worker std::string key = mRemaining.substr(0, equalPos);
79*70a7ec85SAndroid Build Coastguard Worker std::string value = mRemaining.substr(equalPos + 1);
80*70a7ec85SAndroid Build Coastguard Worker if (mConfigs.emplace(std::move(key), std::move(value)).second) {
81*70a7ec85SAndroid Build Coastguard Worker return OK;
82*70a7ec85SAndroid Build Coastguard Worker }
83*70a7ec85SAndroid Build Coastguard Worker mError << "Duplicated key in configs: " << mRemaining.substr(0, equalPos) << "\n";
84*70a7ec85SAndroid Build Coastguard Worker return UNKNOWN_ERROR;
85*70a7ec85SAndroid Build Coastguard Worker }
86*70a7ec85SAndroid Build Coastguard Worker }
87*70a7ec85SAndroid Build Coastguard Worker
88*70a7ec85SAndroid Build Coastguard Worker if (mProcessComments && std::regex_match(mRemaining, match, sNotSetPattern)) {
89*70a7ec85SAndroid Build Coastguard Worker if (mConfigs.emplace(match[1], "n").second) {
90*70a7ec85SAndroid Build Coastguard Worker return OK;
91*70a7ec85SAndroid Build Coastguard Worker }
92*70a7ec85SAndroid Build Coastguard Worker mError << "Key " << match[1] << " is set but commented as not set"
93*70a7ec85SAndroid Build Coastguard Worker << "\n";
94*70a7ec85SAndroid Build Coastguard Worker return UNKNOWN_ERROR;
95*70a7ec85SAndroid Build Coastguard Worker }
96*70a7ec85SAndroid Build Coastguard Worker
97*70a7ec85SAndroid Build Coastguard Worker if (mRelaxedFormat) {
98*70a7ec85SAndroid Build Coastguard Worker // Allow free format like " #comments here"
99*70a7ec85SAndroid Build Coastguard Worker if (std::regex_match(mRemaining, match, sCommentPattern)) {
100*70a7ec85SAndroid Build Coastguard Worker return OK;
101*70a7ec85SAndroid Build Coastguard Worker }
102*70a7ec85SAndroid Build Coastguard Worker } else {
103*70a7ec85SAndroid Build Coastguard Worker // No leading spaces before the comment
104*70a7ec85SAndroid Build Coastguard Worker if (mRemaining.at(0) == '#') {
105*70a7ec85SAndroid Build Coastguard Worker return OK;
106*70a7ec85SAndroid Build Coastguard Worker }
107*70a7ec85SAndroid Build Coastguard Worker }
108*70a7ec85SAndroid Build Coastguard Worker
109*70a7ec85SAndroid Build Coastguard Worker mError << "Unrecognized line in configs: " << mRemaining << "\n";
110*70a7ec85SAndroid Build Coastguard Worker return UNKNOWN_ERROR;
111*70a7ec85SAndroid Build Coastguard Worker }
112*70a7ec85SAndroid Build Coastguard Worker
process(const char * buf,size_t len)113*70a7ec85SAndroid Build Coastguard Worker status_t KernelConfigParser::process(const char* buf, size_t len) {
114*70a7ec85SAndroid Build Coastguard Worker const char* begin = buf;
115*70a7ec85SAndroid Build Coastguard Worker const char* end = buf;
116*70a7ec85SAndroid Build Coastguard Worker const char* stop = buf + len;
117*70a7ec85SAndroid Build Coastguard Worker status_t err = OK;
118*70a7ec85SAndroid Build Coastguard Worker while (end < stop) {
119*70a7ec85SAndroid Build Coastguard Worker if (*end == '\n') {
120*70a7ec85SAndroid Build Coastguard Worker mRemaining.insert(mRemaining.size(), begin, end - begin);
121*70a7ec85SAndroid Build Coastguard Worker status_t newErr = processRemaining();
122*70a7ec85SAndroid Build Coastguard Worker if (newErr != OK && err == OK) {
123*70a7ec85SAndroid Build Coastguard Worker err = newErr;
124*70a7ec85SAndroid Build Coastguard Worker // but continue to get more
125*70a7ec85SAndroid Build Coastguard Worker }
126*70a7ec85SAndroid Build Coastguard Worker mRemaining.clear();
127*70a7ec85SAndroid Build Coastguard Worker begin = end + 1;
128*70a7ec85SAndroid Build Coastguard Worker }
129*70a7ec85SAndroid Build Coastguard Worker end++;
130*70a7ec85SAndroid Build Coastguard Worker }
131*70a7ec85SAndroid Build Coastguard Worker mRemaining.insert(mRemaining.size(), begin, end - begin);
132*70a7ec85SAndroid Build Coastguard Worker return err;
133*70a7ec85SAndroid Build Coastguard Worker }
134*70a7ec85SAndroid Build Coastguard Worker
processAndFinish(const char * buf,size_t len)135*70a7ec85SAndroid Build Coastguard Worker status_t KernelConfigParser::processAndFinish(const char* buf, size_t len) {
136*70a7ec85SAndroid Build Coastguard Worker status_t err = process(buf, len);
137*70a7ec85SAndroid Build Coastguard Worker if (err != OK) {
138*70a7ec85SAndroid Build Coastguard Worker return err;
139*70a7ec85SAndroid Build Coastguard Worker }
140*70a7ec85SAndroid Build Coastguard Worker return finish();
141*70a7ec85SAndroid Build Coastguard Worker }
142*70a7ec85SAndroid Build Coastguard Worker
processAndFinish(const std::string & content)143*70a7ec85SAndroid Build Coastguard Worker status_t KernelConfigParser::processAndFinish(const std::string& content) {
144*70a7ec85SAndroid Build Coastguard Worker return processAndFinish(content.c_str(), content.size());
145*70a7ec85SAndroid Build Coastguard Worker }
146*70a7ec85SAndroid Build Coastguard Worker
147*70a7ec85SAndroid Build Coastguard Worker } // namespace vintf
148*70a7ec85SAndroid Build Coastguard Worker } // namespace android
149