Skip to content

Commit

Permalink
[proguard] Change proguard warnings to TRACE statements
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Zimmerman committed Jul 29, 2020
1 parent f56d9bc commit 5889197
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 65 deletions.
127 changes: 63 additions & 64 deletions libredex/ProguardParser.cpp
View file
Expand Up @@ -12,6 +12,7 @@
#include "ProguardMap.h"
#include "ProguardParser.h"
#include "ProguardRegex.h"
#include "Trace.h"

namespace keep_rules {
namespace proguard_parser {
Expand All @@ -34,6 +35,16 @@ void skip_to_next_command(std::vector<unique_ptr<Token>>::iterator* it) {
}
}

static void trace_expecting(const char* expected,
const std::unique_ptr<Token>& tok) {
TRACE(PROGUARD,
1,
"Expected %s but got %s at %u",
expected,
tok->show().c_str(),
tok->line);
}

bool parse_single_filepath_command(std::vector<unique_ptr<Token>>::iterator* it,
token filepath_command_token,
std::string* filepath) {
Expand All @@ -42,21 +53,17 @@ bool parse_single_filepath_command(std::vector<unique_ptr<Token>>::iterator* it,
++(*it); // Consume the command token.
// Fail without consumption if this is an end of file token.
if ((**it)->type == token::eof_token) {
cerr << "Expecting at least one file as an argument but found end of "
"file at line "
<< line_number << endl;
trace_expecting("at least one file as an argument", **it);
return true;
}
// Fail without consumption if this is a command token.
if ((**it)->is_command()) {
cerr << "Expecting a file path argument but got command "
<< (**it)->show() << " at line " << (**it)->line << endl;
trace_expecting("a file path argument", **it);
return true;
}
// Parse the filename.
if ((**it)->type != token::filepath) {
cerr << "Expected a filepath but got " << (**it)->show() << " at line "
<< (**it)->line << endl;
trace_expecting("a filepath", **it);
return true;
}
*filepath = static_cast<Filepath*>((*it)->get())->path;
Expand All @@ -70,8 +77,7 @@ std::vector<std::string> parse_filepaths(
std::vector<unique_ptr<Token>>::iterator* it) {
std::vector<std::string> filepaths;
if ((**it)->type != token::filepath) {
cerr << "Expected filepath but got " << (**it)->show() << " at line "
<< (**it)->line << endl;
trace_expecting("a filepath", **it);
return filepaths;
}
while ((**it)->type == token::filepath) {
Expand All @@ -90,21 +96,17 @@ bool parse_filepath_command(std::vector<unique_ptr<Token>>::iterator* it,
++(*it); // Consume the command token.
// Fail without consumption if this is an end of file token.
if ((**it)->type == token::eof_token) {
cerr << "Expecting at least one file as an argument but found end of "
"file at line "
<< line_number << endl;
trace_expecting("at least one file as an argument", **it);
return true;
}
// Fail without consumption if this is a command token.
if ((**it)->is_command()) {
cerr << "Expecting a file path argument but got command "
<< (**it)->show() << " at line " << (**it)->line << endl;
trace_expecting("a file path argument", **it);
return true;
}
// Parse the filename.
if ((**it)->type != token::filepath) {
cerr << "Expected a filepath but got " << (**it)->show() << " at line "
<< (**it)->line << endl;
trace_expecting("a filepath", **it);
return true;
}
for (const auto& filepath : parse_filepaths(it)) {
Expand Down Expand Up @@ -140,9 +142,7 @@ bool parse_jars(std::vector<unique_ptr<Token>>::iterator* it,
++(*it); // Consume the jar token.
// Fail without consumption if this is an end of file token.
if ((**it)->type == token::eof_token) {
cerr << "Expecting at least one file as an argument but found end of "
"file at line "
<< line_number << endl;
trace_expecting("at least one file as an argument", **it);
return true;
}
// Parse the list of filenames.
Expand Down Expand Up @@ -204,8 +204,10 @@ bool parse_repackageclasses(std::vector<unique_ptr<Token>>::iterator* it) {
// Ignore repackageclasses.
++(*it);
if ((**it)->type == token::identifier) {
cerr << "Ignoring -repackageclasses "
<< static_cast<Identifier*>((*it)->get())->ident << endl;
TRACE(PROGUARD,
1,
"Ignoring -repackageclasses %s",
static_cast<Identifier*>((*it)->get())->ident.c_str());
++(*it);
}
return true;
Expand All @@ -217,8 +219,7 @@ bool parse_target(std::vector<unique_ptr<Token>>::iterator* it,
++(*it); // Consume the target command token.
// Check to make sure the next token is a version token.
if ((**it)->type != token::target_version_token) {
cerr << "Expected a target version but got " << (**it)->show()
<< " at line " << (**it)->line << endl;
trace_expecting("a target version", **it);
return true;
}
*target_version = static_cast<TargetVersion*>((*it)->get())->target_version;
Expand Down Expand Up @@ -276,8 +277,7 @@ bool parse_modifiers(std::vector<unique_ptr<Token>>::iterator* it,
while ((**it)->type == token::comma) {
++(*it);
if (!is_modifier((**it)->type)) {
cerr << "Expected keep option modifier but found : " << (**it)->show()
<< " at line number " << (**it)->line << endl;
trace_expecting("keep option modifier", **it);
return false;
}
switch ((**it)->type) {
Expand Down Expand Up @@ -356,8 +356,7 @@ std::string parse_annotation_type(
}
++(*it);
if ((**it)->type != token::identifier) {
cerr << "Expecting a class identifier after @ but got " << (**it)->show()
<< " at line " << (**it)->line << endl;
trace_expecting("a class identifier after @", **it);
return "";
}
auto typ = static_cast<Identifier*>((*it)->get())->ident;
Expand Down Expand Up @@ -394,18 +393,22 @@ bool parse_access_flags(std::vector<unique_ptr<Token>>::iterator* it,
*it = ++access_it;
if (negated) {
if (is_access_flag_set(setFlags_, access_flag)) {
cerr << "Access flag " << (**it)->show()
<< " occurs with conflicting settings at line " << (**it)->line
<< endl;
TRACE(PROGUARD,
1,
"Access flag %s occurs with conflicting settings at line %u",
(**it)->show().c_str(),
(**it)->line);
return false;
}
set_access_flag(unsetFlags_, access_flag);
negated = false;
} else {
if (is_access_flag_set(unsetFlags_, access_flag)) {
cerr << "Access flag " << (**it)->show()
<< " occurs with conflicting settings at line " << (**it)->line
<< endl;
TRACE(PROGUARD,
1,
"Access flag %s occurs with conflicting settings at line %u",
(**it)->show().c_str(),
(**it)->line);
return false;
}
set_access_flag(setFlags_, access_flag);
Expand Down Expand Up @@ -443,8 +446,7 @@ bool parse_class_token(std::vector<unique_ptr<Token>>::iterator* it,
case token::classToken:
break;
default:
cerr << "Expected interface, class or enum but got " << (**it)->show()
<< " at line number " << (**it)->line << endl;
trace_expecting("interface, class or enum", **it);
return false;
}
++(*it);
Expand All @@ -457,7 +459,7 @@ bool parse_class_token(std::vector<unique_ptr<Token>>::iterator* it,
bool consume_token(std::vector<unique_ptr<Token>>::iterator* it,
const token& tok) {
if ((**it)->type != tok) {
cerr << "Unexpected token " << (**it)->show() << std::endl;
TRACE(PROGUARD, 1, "Unexpected token %s", (**it)->show().c_str());
return false;
}
++(*it);
Expand All @@ -468,8 +470,7 @@ bool consume_token(std::vector<unique_ptr<Token>>::iterator* it,
void gobble_semicolon(std::vector<unique_ptr<Token>>::iterator* it, bool* ok) {
*ok = consume_token(it, token::semiColon);
if (!*ok) {
cerr << "Expecting a semicolon but found " << (**it)->show() << " at line "
<< (**it)->line << std::endl;
trace_expecting("a semicolon", **it);
return;
}
}
Expand All @@ -495,15 +496,15 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
member_specification.requiredUnsetAccessFlags)) {
// There was a problem parsing the access flags. Return an empty class spec
// for now.
cerr << "Problem parsing access flags for member specification.\n";
TRACE(
PROGUARD, 1, "Problem parsing access flags for member specification.");
*ok = false;
skip_to_semicolon(it);
return;
}
// The next token better be an identifier.
if ((**it)->type != token::identifier) {
cerr << "Expecting field or member specification but got " << (**it)->show()
<< " at line " << (**it)->line << endl;
trace_expecting("field or member specification", **it);
*ok = false;
skip_to_semicolon(it);
return;
Expand Down Expand Up @@ -547,8 +548,7 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
} else {
// This token is the type for the member specification.
if ((**it)->type != token::identifier) {
cerr << "Expecting type identifier but got " << (**it)->show()
<< " at line " << (**it)->line << endl;
trace_expecting("type identifier", **it);
*ok = false;
skip_to_semicolon(it);
return;
Expand All @@ -557,8 +557,7 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
++(*it);
member_specification.descriptor = convert_wildcard_type(typ);
if ((**it)->type != token::identifier) {
cerr << "Expecting identifier name for class member but got "
<< (**it)->show() << " at line " << (**it)->line << endl;
trace_expecting("identifier name for class member", **it);
*ok = false;
skip_to_semicolon(it);
return;
Expand All @@ -577,8 +576,7 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
break;
}
if ((**it)->type != token::identifier) {
std::cerr << "Expecting type identifier but got " << (**it)->show()
<< " at line " << (**it)->line << std::endl;
trace_expecting("type identifier", **it);
*ok = false;
return;
}
Expand All @@ -587,8 +585,7 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
arg += convert_wildcard_type(typ);
// The next token better be a comma or a closing bracket.
if ((**it)->type != token::comma && (**it)->type != token::closeBracket) {
std::cerr << "Expecting comma or ) but got " << (**it)->show()
<< " at line " << (**it)->line << std::endl;
trace_expecting("comma or )", **it);
*ok = false;
return;
}
Expand All @@ -597,9 +594,7 @@ void parse_member_specification(std::vector<unique_ptr<Token>>::iterator* it,
if ((**it)->type == token::comma) {
consume_token(it, token::comma);
if ((**it)->type != token::identifier) {
std::cerr << "Expecting type identifier after comma but got "
<< (**it)->show() << " at line " << (**it)->line
<< std::endl;
trace_expecting("type identifier after comma", **it);
*ok = false;
return;
}
Expand Down Expand Up @@ -655,7 +650,8 @@ ClassSpecification parse_class_specification(
it, class_spec.setAccessFlags, class_spec.unsetAccessFlags)) {
// There was a problem parsing the access flags. Return an empty class spec
// for now.
std::cerr << "Problem parsing access flags for class specification.\n";
TRACE(
PROGUARD, 1, "Problem parsing access flags for class specification.\n");
*ok = false;
return class_spec;
}
Expand All @@ -666,8 +662,7 @@ ClassSpecification parse_class_specification(
}
// Parse the class name.
if ((**it)->type != token::identifier) {
cerr << "Expected class name but got " << (**it)->show() << " at line "
<< (**it)->line << endl;
trace_expecting("class name", **it);
*ok = false;
return class_spec;
}
Expand All @@ -678,8 +673,7 @@ ClassSpecification parse_class_specification(
++(*it);
class_spec.extendsAnnotationType = parse_annotation_type(it);
if ((**it)->type != token::identifier) {
cerr << "Expecting a class name after extends/implements but got "
<< (**it)->show() << " at line " << (**it)->line << endl;
trace_expecting("class name after extends/implements", **it);
*ok = false;
class_spec.extendsClassName = "";
} else {
Expand Down Expand Up @@ -752,8 +746,7 @@ void parse(std::vector<unique_ptr<Token>>::iterator it,
}
uint32_t line = (*it)->line;
if (!(*it)->is_command()) {
cerr << "Expecting command but found " << (*it)->show() << " at line "
<< (*it)->line << endl;
trace_expecting("command", *it);
++it;
skip_to_next_command(&it);
continue;
Expand Down Expand Up @@ -962,12 +955,18 @@ void parse(std::vector<unique_ptr<Token>>::iterator it,
auto cmd = static_cast<Command*>(it->get());
// It is benign to drop -dontnote
if (cmd->name() != "dontnote") {
cerr << "Unimplemented command (skipping): " << cmd->show()
<< " at line " << (*it)->line << endl;
TRACE(PROGUARD,
1,
"Unimplemented command (skipping): %s at line %u",
cmd->show().c_str(),
(*it)->line);
}
} else {
cerr << "Unexpected token " << (*it)->show() << " at line " << (*it)->line
<< endl;
TRACE(PROGUARD,
1,
"Unexpected token %s at line %u",
(*it)->show().c_str(),
(*it)->line);
(*parse_errors)++;
}
++it;
Expand Down Expand Up @@ -998,7 +997,7 @@ void parse(istream& config,
pg_config->ok = ok;
} else {
pg_config->ok = false;
cerr << "Found " << parse_errors << " parse errors\n";
TRACE(PROGUARD, 1, "Found %u parse errors", parse_errors);
}
}

Expand Down
4 changes: 3 additions & 1 deletion libredex/Trace.cpp
View file
Expand Up @@ -36,6 +36,8 @@ struct Tracer {
const char* show_timestamps = getenv("SHOW_TIMESTAMPS");
const char* show_tracemodule = getenv("SHOW_TRACEMODULE");
m_method_filter = getenv("TRACE_METHOD_FILTER");
// By default enable Proguard warnings.
m_traces[PROGUARD] = 1;
if (!traceenv) {
return;
}
Expand Down Expand Up @@ -129,7 +131,7 @@ struct Tracer {
for (const char* tok = strtok(tracespec, sep); tok != nullptr;
tok = strtok(nullptr, sep)) {
auto level = strtol(tok, nullptr, 10);
if (level) {
if (level || strcmp(tok, "0") == 0) {
if (module) {
if (module_id_map.count(module) == 0) {
if (strcmp(module, "REDEX") == 0) {
Expand Down
1 change: 1 addition & 0 deletions libredex/Trace.h
View file
Expand Up @@ -91,6 +91,7 @@
TM(PGR) \
TM(PM) \
TM(POST_LOWERING) \
TM(PROGUARD) \
TM(PTA) \
TM(QUICK) \
TM(RAL) \
Expand Down

0 comments on commit 5889197

Please sign in to comment.