blob: cd6139a18fedef41f29552c4336cfa435d22a3f0 [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>
Tao Bao59dcb9c2016-10-03 18:06:46 -070021#include <string>
Doug Zongker583fc122010-02-19 16:07:57 -080022
Tianjie Xu16255832016-04-30 11:49:59 -070023#include "error_code.h"
Doug Zongker37bee622009-06-08 17:35:39 -070024
Tao Bao59dcb9c2016-10-03 18:06:46 -070025struct State {
26 State(const std::string& script, void* cookie);
27
28 // The source of the original script.
29 const std::string& script;
30
Doug Zongkerd9c9d102009-06-12 12:24:39 -070031 // Optional pointer to app-specific data; the core of edify never
32 // uses this value.
33 void* cookie;
34
Doug Zongkerd9c9d102009-06-12 12:24:39 -070035 // The error message (if any) returned if the evaluation aborts.
Tao Bao59dcb9c2016-10-03 18:06:46 -070036 // Should be empty initially, will be either empty or a string that
37 // Evaluate() returns.
38 std::string errmsg;
Tianjie Xu16255832016-04-30 11:49:59 -070039
40 // error code indicates the type of failure (e.g. failure to update system image)
41 // during the OTA process.
42 ErrorCode error_code = kNoError;
43
44 // cause code provides more detailed reason of an OTA failure (e.g. fsync error)
45 // in addition to the error code.
46 CauseCode cause_code = kNoCause;
47
Tianjie Xu7ce287d2016-05-31 09:29:49 -070048 bool is_retry = false;
Tao Bao59dcb9c2016-10-03 18:06:46 -070049};
Doug Zongkerd9c9d102009-06-12 12:24:39 -070050
Doug Zongker512536a2010-02-17 16:11:44 -080051#define VAL_STRING 1 // data will be NULL-terminated; size doesn't count null
52#define VAL_BLOB 2
53
Tao Bao39119ad2016-10-10 22:52:18 -070054struct Value {
Doug Zongker512536a2010-02-17 16:11:44 -080055 int type;
56 ssize_t size;
57 char* data;
Tao Bao39119ad2016-10-10 22:52:18 -070058};
Doug Zongker512536a2010-02-17 16:11:44 -080059
Tao Bao39119ad2016-10-10 22:52:18 -070060struct Expr;
61
62using Function = Value* (*)(const char* name, State* state, int argc, Expr* argv[]);
Doug Zongker37bee622009-06-08 17:35:39 -070063
64struct Expr {
Doug Zongkerd9c9d102009-06-12 12:24:39 -070065 Function fn;
Tao Bao2a5a49d2015-08-20 12:10:46 -070066 const char* name;
Doug Zongkerd9c9d102009-06-12 12:24:39 -070067 int argc;
68 Expr** argv;
69 int start, end;
Doug Zongker37bee622009-06-08 17:35:39 -070070};
71
Doug Zongker512536a2010-02-17 16:11:44 -080072// Take one of the Expr*s passed to the function as an argument,
73// evaluate it, return the resulting Value. The caller takes
74// ownership of the returned Value.
75Value* EvaluateValue(State* state, Expr* expr);
76
77// Take one of the Expr*s passed to the function as an argument,
78// evaluate it, assert that it is a string, and return the resulting
79// char*. The caller takes ownership of the returned char*. This is
80// a convenience function for older functions that want to deal only
81// with strings.
Doug Zongkerd9c9d102009-06-12 12:24:39 -070082char* Evaluate(State* state, Expr* expr);
Doug Zongker37bee622009-06-08 17:35:39 -070083
84// Glue to make an Expr out of a literal.
Doug Zongker512536a2010-02-17 16:11:44 -080085Value* Literal(const char* name, State* state, int argc, Expr* argv[]);
Doug Zongker37bee622009-06-08 17:35:39 -070086
87// Functions corresponding to various syntactic sugar operators.
88// ("concat" is also available as a builtin function, to concatenate
89// more than two strings.)
Doug Zongker512536a2010-02-17 16:11:44 -080090Value* ConcatFn(const char* name, State* state, int argc, Expr* argv[]);
91Value* LogicalAndFn(const char* name, State* state, int argc, Expr* argv[]);
92Value* LogicalOrFn(const char* name, State* state, int argc, Expr* argv[]);
93Value* LogicalNotFn(const char* name, State* state, int argc, Expr* argv[]);
94Value* SubstringFn(const char* name, State* state, int argc, Expr* argv[]);
95Value* EqualityFn(const char* name, State* state, int argc, Expr* argv[]);
96Value* InequalityFn(const char* name, State* state, int argc, Expr* argv[]);
97Value* SequenceFn(const char* name, State* state, int argc, Expr* argv[]);
Doug Zongker37bee622009-06-08 17:35:39 -070098
Doug Zongker37bee622009-06-08 17:35:39 -070099// Global builtins, registered by RegisterBuiltins().
Doug Zongker512536a2010-02-17 16:11:44 -0800100Value* IfElseFn(const char* name, State* state, int argc, Expr* argv[]);
101Value* AssertFn(const char* name, State* state, int argc, Expr* argv[]);
102Value* AbortFn(const char* name, State* state, int argc, Expr* argv[]);
Doug Zongker37bee622009-06-08 17:35:39 -0700103
Doug Zongker37bee622009-06-08 17:35:39 -0700104// Register a new function. The same Function may be registered under
105// multiple names, but a given name should only be used once.
Tao Bao39119ad2016-10-10 22:52:18 -0700106void RegisterFunction(const std::string& name, Function fn);
Doug Zongker37bee622009-06-08 17:35:39 -0700107
108// Register all the builtins.
109void RegisterBuiltins();
110
Doug Zongker37bee622009-06-08 17:35:39 -0700111// Find the Function for a given name; return NULL if no such function
112// exists.
Tao Bao39119ad2016-10-10 22:52:18 -0700113Function FindFunction(const std::string& name);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700114
115// --- convenience functions for use in functions ---
116
117// Evaluate the expressions in argv, giving 'count' char* (the ... is
118// zero or more char** to put them in). If any expression evaluates
119// to NULL, free the rest and return -1. Return 0 on success.
Doug Zongkerd9c9d102009-06-12 12:24:39 -0700120int ReadArgs(State* state, Expr* argv[], int count, ...);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700121
Doug Zongker512536a2010-02-17 16:11:44 -0800122// Evaluate the expressions in argv, giving 'count' Value* (the ... is
123// zero or more Value** to put them in). If any expression evaluates
124// to NULL, free the rest and return -1. Return 0 on success.
125int ReadValueArgs(State* state, Expr* argv[], int count, ...);
126
Doug Zongker9931f7f2009-06-10 14:11:53 -0700127// Evaluate the expressions in argv, returning an array of char*
128// results. If any evaluate to NULL, free the rest and return NULL.
129// The caller is responsible for freeing the returned array and the
130// strings it contains.
Doug Zongkerd9c9d102009-06-12 12:24:39 -0700131char** ReadVarArgs(State* state, int argc, Expr* argv[]);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700132
Doug Zongker512536a2010-02-17 16:11:44 -0800133// Evaluate the expressions in argv, returning an array of Value*
134// results. If any evaluate to NULL, free the rest and return NULL.
135// The caller is responsible for freeing the returned array and the
136// Values it contains.
137Value** ReadValueVarArgs(State* state, int argc, Expr* argv[]);
138
Doug Zongker47cace92009-06-18 10:11:50 -0700139// Use printf-style arguments to compose an error message to put into
140// *state. Returns NULL.
Tianjie Xu16255832016-04-30 11:49:59 -0700141Value* ErrorAbort(State* state, const char* format, ...)
142 __attribute__((format(printf, 2, 3), deprecated));
143
144// ErrorAbort has an optional (but recommended) argument 'cause_code'. If the cause code
145// is set, it will be logged into last_install and provides reason of OTA failures.
146Value* ErrorAbort(State* state, CauseCode cause_code, const char* format, ...)
147 __attribute__((format(printf, 3, 4)));
Doug Zongker47cace92009-06-18 10:11:50 -0700148
Doug Zongker512536a2010-02-17 16:11:44 -0800149// Wrap a string into a Value, taking ownership of the string.
150Value* StringValue(char* str);
151
152// Free a Value object.
153void FreeValue(Value* v);
Doug Zongker9931f7f2009-06-10 14:11:53 -0700154
Doug Zongker0d32f252014-02-13 15:07:56 -0800155int parse_string(const char* str, Expr** root, int* error_count);
156
Doug Zongker37bee622009-06-08 17:35:39 -0700157#endif // _EXPRESSION_H