Skip to content

Commit

Permalink
Cleanup the duplicates of logs rotation functions
Browse files Browse the repository at this point in the history 
Bug: 32067516
Test: Logs rotated successfully on angler, recovery-refresh/persist tests
passed on an a/b device.

Change-Id: Ie80adf0fa958ad3d7869d2d17f49489666b86c29
  • Loading branch information
Tianjie Xu committed Nov 4, 2016
1 parent 4011bb1 commit e113e4d
Show file tree
Hide file tree
Showing 6 changed files with 178 additions and 182 deletions.
11 changes: 8 additions & 3 deletions Android.mk
View file
Expand Up @@ -46,6 +46,7 @@ LOCAL_SRC_FILES := \
install.cpp \
recovery.cpp \
roots.cpp \
rotate_logs.cpp \
screen_ui.cpp \
ui.cpp \
verifier.cpp \
Expand Down Expand Up @@ -119,7 +120,9 @@ include $(BUILD_EXECUTABLE)
# recovery-persist (system partition dynamic executable run after /data mounts)
# ===============================
include $(CLEAR_VARS)
LOCAL_SRC_FILES := recovery-persist.cpp
LOCAL_SRC_FILES := \
recovery-persist.cpp \
rotate_logs.cpp
LOCAL_MODULE := recovery-persist
LOCAL_SHARED_LIBRARIES := liblog libbase
LOCAL_CFLAGS := -Werror
Expand All @@ -129,9 +132,11 @@ include $(BUILD_EXECUTABLE)
# recovery-refresh (system partition dynamic executable run at init)
# ===============================
include $(CLEAR_VARS)
LOCAL_SRC_FILES := recovery-refresh.cpp
LOCAL_SRC_FILES := \
recovery-refresh.cpp \
rotate_logs.cpp
LOCAL_MODULE := recovery-refresh
LOCAL_SHARED_LIBRARIES := liblog
LOCAL_SHARED_LIBRARIES := liblog libbase
LOCAL_CFLAGS := -Werror
LOCAL_INIT_RC := recovery-refresh.rc
include $(BUILD_EXECUTABLE)
Expand Down
42 changes: 4 additions & 38 deletions recovery-persist.cpp
View file
Expand Up @@ -30,7 +30,6 @@
// --force-persist ignore /cache mount, always rotate in the contents.
//

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
Expand All @@ -40,17 +39,16 @@

#include <android-base/file.h>
#include <android-base/logging.h>

#include <private/android_logger.h> /* private pmsg functions */

#include "rotate_logs.h"

static const char *LAST_LOG_FILE = "/data/misc/recovery/last_log";
static const char *LAST_PMSG_FILE = "/sys/fs/pstore/pmsg-ramoops-0";
static const char *LAST_KMSG_FILE = "/data/misc/recovery/last_kmsg";
static const char *LAST_CONSOLE_FILE = "/sys/fs/pstore/console-ramoops-0";
static const char *ALT_LAST_CONSOLE_FILE = "/sys/fs/pstore/console-ramoops";

static const int KEEP_LOG_COUNT = 10;

// close a file, log an error if the error indicator is set
static void check_and_fclose(FILE *fp, const char *name) {
fflush(fp);
Expand Down Expand Up @@ -80,39 +78,6 @@ static void copy_file(const char* source, const char* destination) {

static bool rotated = false;

// Rename last_log -> last_log.1 -> last_log.2 -> ... -> last_log.$max.
// Similarly rename last_kmsg -> last_kmsg.1 -> ... -> last_kmsg.$max.
// Overwrite any existing last_log.$max and last_kmsg.$max.
static void rotate_logs(int max) {
// Logs should only be rotated once.

if (rotated) {
return;
}
rotated = true;

for (int i = max-1; i >= 0; --i) {
std::string old_log(LAST_LOG_FILE);
if (i > 0) {
old_log += "." + std::to_string(i);
}
std::string new_log(LAST_LOG_FILE);
new_log += "." + std::to_string(i+1);

// Ignore errors if old_log doesn't exist.
rename(old_log.c_str(), new_log.c_str());

std::string old_kmsg(LAST_KMSG_FILE);
if (i > 0) {
old_kmsg += "." + std::to_string(i);
}
std::string new_kmsg(LAST_KMSG_FILE);
new_kmsg += "." + std::to_string(i+1);

rename(old_kmsg.c_str(), new_kmsg.c_str());
}
}

ssize_t logsave(
log_id_t /* logId */,
char /* prio */,
Expand All @@ -138,7 +103,8 @@ ssize_t logsave(
// already-rotated files? Algorithm thus far is KISS: one file,
// one rotation allowed.

rotate_logs(KEEP_LOG_COUNT);
rotate_logs(LAST_LOG_FILE, LAST_KMSG_FILE);
rotated = true;

return android::base::WriteStringToFile(buffer, destination.c_str());
}
Expand Down
58 changes: 1 addition & 57 deletions recovery-refresh.cpp
View file
Expand Up @@ -14,8 +14,6 @@
* limitations under the License.
*/

#define LOG_TAG "recovery-refresh"

//
// Strictly to deal with reboot into system after OTA, then
// reboot while in system before boot complete landing us back
Expand All @@ -40,72 +38,18 @@
//

#include <string.h>

#include <string>

#include <android/log.h> /* Android Log Priority Tags */
#include <private/android_logger.h> /* private pmsg functions */

static const char LAST_KMSG_FILE[] = "recovery/last_kmsg";
static const char LAST_LOG_FILE[] = "recovery/last_log";

static ssize_t logbasename(
log_id_t /* logId */,
char /* prio */,
const char *filename,
const char * /* buf */, size_t len,
void *arg) {
if (strstr(LAST_KMSG_FILE, filename) ||
strstr(LAST_LOG_FILE, filename)) {
bool *doRotate = reinterpret_cast<bool *>(arg);
*doRotate = true;
}
return len;
}

static ssize_t logrotate(
log_id_t logId,
char prio,
const char *filename,
const char *buf, size_t len,
void *arg) {
bool *doRotate = reinterpret_cast<bool *>(arg);
if (!*doRotate) {
return __android_log_pmsg_file_write(logId, prio, filename, buf, len);
}

std::string name(filename);
size_t dot = name.find_last_of('.');
std::string sub = name.substr(0, dot);

if (!strstr(LAST_KMSG_FILE, sub.c_str()) &&
!strstr(LAST_LOG_FILE, sub.c_str())) {
return __android_log_pmsg_file_write(logId, prio, filename, buf, len);
}

// filename rotation
if (dot == std::string::npos) {
name += ".1";
} else {
std::string number = name.substr(dot + 1);
if (!isdigit(number.data()[0])) {
name += ".1";
} else {
auto i = std::stoull(number);
name = sub + "." + std::to_string(i + 1);
}
}

return __android_log_pmsg_file_write(logId, prio, name.c_str(), buf, len);
}
#include "rotate_logs.h"

int main(int argc, char **argv) {
static const char filter[] = "recovery/";
static const char force_rotate_flag[] = "--force-rotate";
static const char rotate_flag[] = "--rotate";
ssize_t ret;
bool doRotate = false;

// Take last pmsg contents and rewrite it to the current pmsg session.
if ((argc <= 1) || !argv[1] ||
(((doRotate = strcmp(argv[1], rotate_flag))) &&
Expand Down
90 changes: 6 additions & 84 deletions recovery.cpp
View file
Expand Up @@ -66,8 +66,9 @@
#include "minui/minui.h"
#include "otautil/DirUtil.h"
#include "roots.h"
#include "ui.h"
#include "rotate_logs.h"
#include "screen_ui.h"
#include "ui.h"

struct selabel_handle *sehandle;

Expand Down Expand Up @@ -110,7 +111,6 @@ static const char *TEMPORARY_LOG_FILE = "/tmp/recovery.log";
static const char *TEMPORARY_INSTALL_FILE = "/tmp/last_install";
static const char *LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
static const char *LAST_LOG_FILE = "/cache/recovery/last_log";
static const int KEEP_LOG_COUNT = 10;
// We will try to apply the update package 5 times at most in case of an I/O error.
static const int EIO_RETRY_COUNT = 4;
static const int BATTERY_READ_TIMEOUT_IN_SEC = 10;
Expand Down Expand Up @@ -447,37 +447,6 @@ static void copy_log_file(const char* source, const char* destination, bool appe
}
}

// Rename last_log -> last_log.1 -> last_log.2 -> ... -> last_log.$max.
// Similarly rename last_kmsg -> last_kmsg.1 -> ... -> last_kmsg.$max.
// Overwrite any existing last_log.$max and last_kmsg.$max.
static void rotate_logs(int max) {
// Logs should only be rotated once.
static bool rotated = false;
if (rotated) {
return;
}
rotated = true;
ensure_path_mounted(LAST_LOG_FILE);
ensure_path_mounted(LAST_KMSG_FILE);

for (int i = max-1; i >= 0; --i) {
std::string old_log = android::base::StringPrintf("%s", LAST_LOG_FILE);
if (i > 0) {
old_log += "." + std::to_string(i);
}
std::string new_log = android::base::StringPrintf("%s.%d", LAST_LOG_FILE, i+1);
// Ignore errors if old_log doesn't exist.
rename(old_log.c_str(), new_log.c_str());

std::string old_kmsg = android::base::StringPrintf("%s", LAST_KMSG_FILE);
if (i > 0) {
old_kmsg += "." + std::to_string(i);
}
std::string new_kmsg = android::base::StringPrintf("%s.%d", LAST_KMSG_FILE, i+1);
rename(old_kmsg.c_str(), new_kmsg.c_str());
}
}

static void copy_logs() {
// We only rotate and record the log of the current session if there are
// actual attempts to modify the flash, such as wipes, installs from BCB
Expand All @@ -496,7 +465,9 @@ static void copy_logs() {
return;
}

rotate_logs(KEEP_LOG_COUNT);
ensure_path_mounted(LAST_LOG_FILE);
ensure_path_mounted(LAST_KMSG_FILE);
rotate_logs(LAST_LOG_FILE, LAST_KMSG_FILE);

// Copy logs to cache so the system can find out what happened.
copy_log_file(TEMPORARY_LOG_FILE, LOG_FILE, true);
Expand Down Expand Up @@ -1428,56 +1399,6 @@ static void log_failure_code(ErrorCode code, const char *update_package) {
LOG(INFO) << log_content;
}

static ssize_t logbasename(
log_id_t /* logId */,
char /* prio */,
const char *filename,
const char * /* buf */, size_t len,
void *arg) {
if (strstr(LAST_KMSG_FILE, filename) ||
strstr(LAST_LOG_FILE, filename)) {
bool *doRotate = reinterpret_cast<bool *>(arg);
*doRotate = true;
}
return len;
}

static ssize_t logrotate(
log_id_t logId,
char prio,
const char *filename,
const char *buf, size_t len,
void *arg) {
bool *doRotate = reinterpret_cast<bool *>(arg);
if (!*doRotate) {
return __android_log_pmsg_file_write(logId, prio, filename, buf, len);
}

std::string name(filename);
size_t dot = name.find_last_of('.');
std::string sub = name.substr(0, dot);

if (!strstr(LAST_KMSG_FILE, sub.c_str()) &&
!strstr(LAST_LOG_FILE, sub.c_str())) {
return __android_log_pmsg_file_write(logId, prio, filename, buf, len);
}

// filename rotation
if (dot == std::string::npos) {
name += ".1";
} else {
std::string number = name.substr(dot + 1);
if (!isdigit(number.data()[0])) {
name += ".1";
} else {
auto i = std::stoull(number);
name = sub + "." + std::to_string(i + 1);
}
}

return __android_log_pmsg_file_write(logId, prio, name.c_str(), buf, len);
}

int main(int argc, char **argv) {
// We don't have logcat yet under recovery; so we'll print error on screen and
// log to stdout (which is redirected to recovery.log) as we used to do.
Expand All @@ -1487,6 +1408,7 @@ int main(int argc, char **argv) {
static const char filter[] = "recovery/";
// Do we need to rotate?
bool doRotate = false;

__android_log_pmsg_file_read(
LOG_ID_SYSTEM, ANDROID_LOG_INFO, filter,
logbasename, &doRotate);
Expand Down

0 comments on commit e113e4d

Please sign in to comment.