blob: 770d1cf0d0946782f86a7b34ee6cdc432803001d [file] [log] [blame]
Doug Zongker37bee622009-06-08 17:35:39 -07001/*
2 * Copyright (C) 2009 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 _EXPRESSION_H
18#define _EXPRESSION_H
19
Doug Zongker583fc122010-02-19 16:07:57 -080020#include <unistd.h>
Tianjie Xuc4447322017-03-06 14:44:59 -080021
22#include <memory>
Tao Bao59dcb9c2016-10-03 18:06:46 -070023#include <string>
Tianjie Xuc4447322017-03-06 14:44:59 -080024#include <vector>
Doug Zongker583fc122010-02-19 16:07:57 -080025
Tao Bao1fc5bf32017-10-06 07:43:41 -070026// Forward declaration to avoid including "otautil/error_code.h".
Tao Bao0bf20d52017-10-05 12:06:49 -070027enum ErrorCode : int;
28enum CauseCode : int;
Doug Zongker37bee622009-06-08 17:35:39 -070029
Tao Bao59dcb9c2016-10-03 18:06:46 -070030struct State {
Tao Bao0bf20d52017-10-05 12:06:49 -070031 State(const std::string& script, void* cookie);
Tao Bao59dcb9c2016-10-03 18:06:46 -070032
Tao Bao0bf20d52017-10-05 12:06:49 -070033 // The source of the original script.
34 const std::string& script;
Tao Bao59dcb9c2016-10-03 18:06:46 -070035
Tao Bao0bf20d52017-10-05 12:06:49 -070036 // Optional pointer to app-specific data; the core of edify never
37 // uses this value.
38 void* cookie;
Doug Zongkerd9c9d102009-06-12 12:24:39 -070039
Tao Bao0bf20d52017-10-05 12:06:49 -070040 // The error message (if any) returned if the evaluation aborts.
41 // Should be empty initially, will be either empty or a string that
42 // Evaluate() returns.
43 std::string errmsg;
Tianjie Xu16255832016-04-30 11:49:59 -070044
Tao Bao0bf20d52017-10-05 12:06:49 -070045 // error code indicates the type of failure (e.g. failure to update system image)
46 // during the OTA process.
47 ErrorCode error_code;
Tianjie Xu16255832016-04-30 11:49:59 -070048
Tao Bao0bf20d52017-10-05 12:06:49 -070049 // cause code provides more detailed reason of an OTA failure (e.g. fsync error)
50 // in addition to the error code.
51 CauseCode cause_code;
Tianjie Xu16255832016-04-30 11:49:59 -070052
Tao Bao0bf20d52017-10-05 12:06:49 -070053 bool is_retry = false;
Tao Bao59dcb9c2016-10-03 18:06:46 -070054};
Doug Zongkerd9c9d102009-06-12 12:24:39 -070055
Tianjie Xuaced5d92016-10-12 10:55:04 -070056enum ValueType {
57 VAL_INVALID = -1,
58 VAL_STRING = 1,
59 VAL_BLOB = 2,
60};
Doug Zongker512536a2010-02-17 16:11:44 -080061
Tao Bao39119ad2016-10-10 22:52:18 -070062struct Value {
Tianjie Xuaced5d92016-10-12 10:55:04 -070063 ValueType type;
64 std::string data;
65
66 Value(ValueType type, const std::string& str) :
67 type(type),
68 data(str) {}
Tao Bao39119ad2016-10-10 22:52:18 -070069};
Doug Zongker512536a2010-02-17 16:11:44 -080070
Tao Bao39119ad2016-10-10 22:52:18 -070071struct Expr;
72
Tianjie Xuc4447322017-03-06 14:44:59 -080073using Function = Value* (*)(const char* name, State* state,
74 const std::vector<std::unique_ptr<Expr>>& argv);
Doug Zongker37bee622009-06-08 17:35:39 -070075
76struct Expr {
Tianjie Xuc4447322017-03-06 14:44:59 -080077 Function fn;
78 std::string name;
79 std::vector<std::unique_ptr<Expr>> argv;
80 int start, end;
81
82 Expr(Function fn, const std::string& name, int start, int end) :
83 fn(fn),
84 name(name),
85 start(start),
86 end(end) {}
Doug Zongker37bee622009-06-08 17:35:39 -070087};
88
Tianjie Xuc4447322017-03-06 14:44:59 -080089// Evaluate the input expr, return the resulting Value.
90Value* EvaluateValue(State* state, const std::unique_ptr<Expr>& expr);
Doug Zongker512536a2010-02-17 16:11:44 -080091
Tianjie Xuc4447322017-03-06 14:44:59 -080092// Evaluate the input expr, assert that it is a string, and update the result parameter. This
93// function returns true if the evaluation succeeds. This is a convenience function for older
94// functions that want to deal only with strings.
95bool Evaluate(State* state, const std::unique_ptr<Expr>& expr, std::string* result);
Doug Zongker37bee622009-06-08 17:35:39 -070096
97// Glue to make an Expr out of a literal.
Tianjie Xuc4447322017-03-06 14:44:59 -080098Value* Literal(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
Doug Zongker37bee622009-06-08 17:35:39 -070099
100// Functions corresponding to various syntactic sugar operators.
101// ("concat" is also available as a builtin function, to concatenate
102// more than two strings.)
Tianjie Xuc4447322017-03-06 14:44:59 -0800103Value* ConcatFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
104Value* LogicalAndFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
105Value* LogicalOrFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
106Value* LogicalNotFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
107Value* SubstringFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
108Value* EqualityFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
109Value* InequalityFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
110Value* SequenceFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
Doug Zongker37bee622009-06-08 17:35:39 -0700111
Doug Zongker37bee622009-06-08 17:35:39 -0700112// Global builtins, registered by RegisterBuiltins().
Tianjie Xuc4447322017-03-06 14:44:59 -0800113Value* IfElseFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
114Value* AssertFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
115Value* AbortFn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv);
Doug Zongker37bee622009-06-08 17:35:39 -0700116
Doug Zongker37bee622009-06-08 17:35:39 -0700117// Register a new function. The same Function may be registered under
118// multiple names, but a given name should only be used once.
Tao Bao39119ad2016-10-10 22:52:18 -0700119void RegisterFunction(const std::string& name, Function fn);
Doug Zongker37bee622009-06-08 17:35:39 -0700120
121// Register all the builtins.
122void RegisterBuiltins();
123
Doug Zongker37bee622009-06-08 17:35:39 -0700124// Find the Function for a given name; return NULL if no such function
125// exists.
Tao Bao39119ad2016-10-10 22:52:18 -0700126Function FindFunction(const std::string& name);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700127
128// --- convenience functions for use in functions ---
129
Tianjie Xuc4447322017-03-06 14:44:59 -0800130// Evaluate the expressions in argv, and put the results of strings in args. If any expression
131// evaluates to nullptr, return false. Return true on success.
132bool ReadArgs(State* state, const std::vector<std::unique_ptr<Expr>>& argv,
133 std::vector<std::string>* args);
134bool ReadArgs(State* state, const std::vector<std::unique_ptr<Expr>>& argv,
135 std::vector<std::string>* args, size_t start, size_t len);
Tianjie Xuaced5d92016-10-12 10:55:04 -0700136
Tianjie Xuc4447322017-03-06 14:44:59 -0800137// Evaluate the expressions in argv, and put the results of Value* in args. If any
138// expression evaluate to nullptr, return false. Return true on success.
139bool ReadValueArgs(State* state, const std::vector<std::unique_ptr<Expr>>& argv,
140 std::vector<std::unique_ptr<Value>>* args);
141bool ReadValueArgs(State* state, const std::vector<std::unique_ptr<Expr>>& argv,
142 std::vector<std::unique_ptr<Value>>* args, size_t start, size_t len);
Doug Zongker512536a2010-02-17 16:11:44 -0800143
Doug Zongker47cace92009-06-18 10:11:50 -0700144// Use printf-style arguments to compose an error message to put into
145// *state. Returns NULL.
Tianjie Xu16255832016-04-30 11:49:59 -0700146Value* ErrorAbort(State* state, const char* format, ...)
147 __attribute__((format(printf, 2, 3), deprecated));
148
149// ErrorAbort has an optional (but recommended) argument 'cause_code'. If the cause code
150// is set, it will be logged into last_install and provides reason of OTA failures.
151Value* ErrorAbort(State* state, CauseCode cause_code, const char* format, ...)
152 __attribute__((format(printf, 3, 4)));
Doug Zongker47cace92009-06-18 10:11:50 -0700153
Tianjie Xuaced5d92016-10-12 10:55:04 -0700154// Copying the string into a Value.
155Value* StringValue(const char* str);
Doug Zongker512536a2010-02-17 16:11:44 -0800156
Tianjie Xuaced5d92016-10-12 10:55:04 -0700157Value* StringValue(const std::string& str);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700158
Tianjie Xuc4447322017-03-06 14:44:59 -0800159int parse_string(const char* str, std::unique_ptr<Expr>* root, int* error_count);
Doug Zongker0d32f252014-02-13 15:07:56 -0800160
Doug Zongker37bee622009-06-08 17:35:39 -0700161#endif // _EXPRESSION_H