blob: 23e900d90e1fc3826d228ba0eecc6776f27d5d8b [file] [log] [blame]
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ANDROID_UTILS_PRIORITYDUMP_H
#define ANDROID_UTILS_PRIORITYDUMP_H
#include <utils/String16.h>
#include <utils/Vector.h>
namespace android {
constexpr const char16_t PRIORITY_ARG[] = u"--dump-priority";
constexpr const char16_t PRIORITY_ARG_CRITICAL[] = u"CRITICAL";
constexpr const char16_t PRIORITY_ARG_HIGH[] = u"HIGH";
constexpr const char16_t PRIORITY_ARG_NORMAL[] = u"NORMAL";
// Helper class to split dumps into various priority buckets.
class PriorityDumper {
public:
// Dumps CRITICAL priority sections.
virtual void dumpCritical(int fd, const Vector<String16>& args) {}
// Dumps HIGH priority sections.
virtual void dumpHigh(int fd, const Vector<String16>& args) {}
// Dumps normal priority sections.
virtual void dumpNormal(int fd, const Vector<String16>& args) {}
// Dumps all sections.
// This method is called when priorityDump is called without priority
// arguments. By default, it calls all three dump methods.
virtual void dump(int fd, const Vector<String16>& args) {
dumpCritical(fd, args);
dumpHigh(fd, args);
dumpNormal(fd, args);
}
virtual ~PriorityDumper() = default;
};
// Parses the argument list checking if the first argument is --dump_priority and
// the second argument is the priority type (HIGH, CRITICAL or NORMAL). If the
// arguments are found, they are stripped and the appropriate PriorityDumper
// method is called.
// If --dump_priority argument is not passed, all supported sections are dumped.
void priorityDump(PriorityDumper& dumper, int fd, const Vector<String16>& args);
}; // namespace android
#endif // ANDROID_UTILS_PRIORITYDUMP_H