Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 1 | /* |
| 2 | ** Copyright 2013-2014, 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 | #include <errno.h> |
| 18 | #include <fcntl.h> |
| 19 | #include <pthread.h> |
| 20 | #include <sched.h> |
| 21 | #include <stddef.h> |
| 22 | #include <stdlib.h> |
| 23 | #include <string.h> |
| 24 | #include <unistd.h> |
| 25 | |
| 26 | #include <cutils/list.h> |
| 27 | #include <log/log.h> |
| 28 | #include <log/logger.h> |
Mark Salyzyn | b3db3cf | 2016-03-28 16:20:29 -0700 | [diff] [blame] | 29 | #include <private/android_filesystem_config.h> |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 30 | |
| 31 | #include "config_read.h" |
| 32 | #include "log_portability.h" |
| 33 | #include "logger.h" |
| 34 | |
| 35 | /* android_logger_alloc unimplemented, no use case */ |
| 36 | /* android_logger_free not exported */ |
| 37 | static void android_logger_free(struct logger *logger) |
| 38 | { |
| 39 | struct android_log_logger *logger_internal = |
| 40 | (struct android_log_logger *)logger; |
| 41 | |
| 42 | if (!logger_internal) { |
| 43 | return; |
| 44 | } |
| 45 | |
| 46 | list_remove(&logger_internal->node); |
| 47 | |
| 48 | free(logger_internal); |
| 49 | } |
| 50 | |
| 51 | /* android_logger_alloc unimplemented, no use case */ |
| 52 | |
| 53 | /* method for getting the associated sublog id */ |
| 54 | LIBLOG_ABI_PUBLIC log_id_t android_logger_get_id(struct logger *logger) |
| 55 | { |
| 56 | return ((struct android_log_logger *)logger)->logId; |
| 57 | } |
| 58 | |
| 59 | static int init_transport_context(struct android_log_logger_list *logger_list) |
| 60 | { |
| 61 | struct android_log_transport_read *transport; |
| 62 | struct listnode *node; |
| 63 | |
| 64 | if (!logger_list) { |
| 65 | return -EINVAL; |
| 66 | } |
| 67 | |
| 68 | if (list_empty(&logger_list->logger)) { |
| 69 | return -EINVAL; |
| 70 | } |
| 71 | |
| 72 | if (!list_empty(&logger_list->transport)) { |
| 73 | return 0; |
| 74 | } |
| 75 | |
| 76 | __android_log_lock(); |
| 77 | /* mini __write_to_log_initialize() to populate transports */ |
| 78 | if (list_empty(&__android_log_transport_read) && |
| 79 | list_empty(&__android_log_persist_read)) { |
| 80 | __android_log_config_read(); |
| 81 | } |
| 82 | __android_log_unlock(); |
| 83 | |
| 84 | node = (logger_list->mode & ANDROID_LOG_PSTORE) ? |
| 85 | &__android_log_persist_read : &__android_log_transport_read; |
| 86 | |
| 87 | read_transport_for_each(transport, node) { |
| 88 | struct android_log_transport_context *transp; |
| 89 | struct android_log_logger *logger; |
| 90 | unsigned logMask = 0; |
| 91 | |
| 92 | logger_for_each(logger, logger_list) { |
| 93 | log_id_t logId = logger->logId; |
| 94 | |
Mark Salyzyn | b3db3cf | 2016-03-28 16:20:29 -0700 | [diff] [blame] | 95 | if ((logId == LOG_ID_SECURITY) && |
| 96 | (__android_log_uid() != AID_SYSTEM)) { |
| 97 | continue; |
| 98 | } |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 99 | if (transport->read && |
| 100 | (!transport->available || |
| 101 | (transport->available(logId) >= 0))) { |
| 102 | logMask |= 1 << logId; |
| 103 | } |
| 104 | } |
| 105 | if (!logMask) { |
| 106 | continue; |
| 107 | } |
| 108 | transp = calloc(1, sizeof(*transp)); |
| 109 | if (!transp) { |
| 110 | return -ENOMEM; |
| 111 | } |
| 112 | transp->parent = logger_list; |
| 113 | transp->transport = transport; |
| 114 | transp->logMask = logMask; |
| 115 | transp->ret = 1; |
| 116 | list_add_tail(&logger_list->transport, &transp->node); |
| 117 | } |
| 118 | if (list_empty(&logger_list->transport)) { |
| 119 | return -ENODEV; |
| 120 | } |
| 121 | return 0; |
| 122 | } |
| 123 | |
| 124 | #define LOGGER_FUNCTION(logger, def, func, args...) \ |
| 125 | ssize_t ret = -EINVAL; \ |
| 126 | struct android_log_transport_context *transp; \ |
| 127 | struct android_log_logger *logger_internal = \ |
| 128 | (struct android_log_logger *)logger; \ |
| 129 | \ |
| 130 | if (!logger_internal) { \ |
| 131 | return ret; \ |
| 132 | } \ |
| 133 | ret = init_transport_context(logger_internal->parent); \ |
| 134 | if (ret < 0) { \ |
| 135 | return ret; \ |
| 136 | } \ |
| 137 | \ |
| 138 | ret = (def); \ |
| 139 | transport_context_for_each(transp, logger_internal->parent) { \ |
| 140 | if ((transp->logMask & (1 << logger_internal->logId)) && \ |
| 141 | transp->transport && transp->transport->func) { \ |
| 142 | ssize_t retval = (transp->transport->func)(logger_internal, \ |
| 143 | transp, ## args); \ |
| 144 | if ((ret >= 0) || (ret == (def))) { \ |
| 145 | ret = retval; \ |
| 146 | } \ |
| 147 | } \ |
| 148 | } \ |
| 149 | return ret |
| 150 | |
| 151 | LIBLOG_ABI_PUBLIC int android_logger_clear(struct logger *logger) |
| 152 | { |
| 153 | LOGGER_FUNCTION(logger, -ENODEV, clear); |
| 154 | } |
| 155 | |
| 156 | /* returns the total size of the log's ring buffer */ |
| 157 | LIBLOG_ABI_PUBLIC long android_logger_get_log_size(struct logger *logger) |
| 158 | { |
| 159 | LOGGER_FUNCTION(logger, -ENODEV, getSize); |
| 160 | } |
| 161 | |
| 162 | LIBLOG_ABI_PUBLIC int android_logger_set_log_size(struct logger *logger, |
| 163 | unsigned long size) |
| 164 | { |
| 165 | LOGGER_FUNCTION(logger, -ENODEV, setSize, size); |
| 166 | } |
| 167 | |
| 168 | /* |
| 169 | * returns the readable size of the log's ring buffer (that is, amount of the |
| 170 | * log consumed) |
| 171 | */ |
| 172 | LIBLOG_ABI_PUBLIC long android_logger_get_log_readable_size( |
| 173 | struct logger *logger) |
| 174 | { |
| 175 | LOGGER_FUNCTION(logger, -ENODEV, getReadableSize); |
| 176 | } |
| 177 | |
| 178 | /* |
| 179 | * returns the logger version |
| 180 | */ |
| 181 | LIBLOG_ABI_PUBLIC int android_logger_get_log_version(struct logger *logger) |
| 182 | { |
| 183 | LOGGER_FUNCTION(logger, 4, version); |
| 184 | } |
| 185 | |
| 186 | #define LOGGER_LIST_FUNCTION(logger_list, def, func, args...) \ |
| 187 | struct android_log_transport_context *transp; \ |
| 188 | struct android_log_logger_list *logger_list_internal = \ |
| 189 | (struct android_log_logger_list *)logger_list; \ |
| 190 | \ |
| 191 | ssize_t ret = init_transport_context(logger_list_internal); \ |
| 192 | if (ret < 0) { \ |
| 193 | return ret; \ |
| 194 | } \ |
| 195 | \ |
| 196 | ret = (def); \ |
| 197 | transport_context_for_each(transp, logger_list_internal) { \ |
| 198 | if (transp->transport && (transp->transport->func)) { \ |
| 199 | ssize_t retval = (transp->transport->func)(logger_list_internal, \ |
| 200 | transp, ## args); \ |
| 201 | if ((ret >= 0) || (ret == (def))) { \ |
| 202 | ret = retval; \ |
| 203 | } \ |
| 204 | } \ |
| 205 | } \ |
| 206 | return ret |
| 207 | |
| 208 | /* |
| 209 | * returns statistics |
| 210 | */ |
| 211 | LIBLOG_ABI_PUBLIC ssize_t android_logger_get_statistics( |
| 212 | struct logger_list *logger_list, |
| 213 | char *buf, size_t len) |
| 214 | { |
| 215 | LOGGER_LIST_FUNCTION(logger_list, -ENODEV, getStats, buf, len); |
| 216 | } |
| 217 | |
| 218 | LIBLOG_ABI_PUBLIC ssize_t android_logger_get_prune_list( |
| 219 | struct logger_list *logger_list, |
| 220 | char *buf, size_t len) |
| 221 | { |
| 222 | LOGGER_LIST_FUNCTION(logger_list, -ENODEV, getPrune, buf, len); |
| 223 | } |
| 224 | |
| 225 | LIBLOG_ABI_PUBLIC int android_logger_set_prune_list( |
| 226 | struct logger_list *logger_list, |
| 227 | char *buf, size_t len) |
| 228 | { |
| 229 | LOGGER_LIST_FUNCTION(logger_list, -ENODEV, setPrune, buf, len); |
| 230 | } |
| 231 | |
| 232 | LIBLOG_ABI_PUBLIC struct logger_list *android_logger_list_alloc( |
| 233 | int mode, |
| 234 | unsigned int tail, |
| 235 | pid_t pid) |
| 236 | { |
| 237 | struct android_log_logger_list *logger_list; |
| 238 | |
| 239 | logger_list = calloc(1, sizeof(*logger_list)); |
| 240 | if (!logger_list) { |
| 241 | return NULL; |
| 242 | } |
| 243 | |
| 244 | list_init(&logger_list->logger); |
| 245 | list_init(&logger_list->transport); |
| 246 | logger_list->mode = mode; |
| 247 | logger_list->tail = tail; |
| 248 | logger_list->pid = pid; |
| 249 | |
| 250 | return (struct logger_list *)logger_list; |
| 251 | } |
| 252 | |
| 253 | LIBLOG_ABI_PUBLIC struct logger_list *android_logger_list_alloc_time( |
| 254 | int mode, |
| 255 | log_time start, |
| 256 | pid_t pid) |
| 257 | { |
| 258 | struct android_log_logger_list *logger_list; |
| 259 | |
| 260 | logger_list = calloc(1, sizeof(*logger_list)); |
| 261 | if (!logger_list) { |
| 262 | return NULL; |
| 263 | } |
| 264 | |
| 265 | list_init(&logger_list->logger); |
| 266 | list_init(&logger_list->transport); |
| 267 | logger_list->mode = mode; |
| 268 | logger_list->start = start; |
| 269 | logger_list->pid = pid; |
| 270 | |
| 271 | return (struct logger_list *)logger_list; |
| 272 | } |
| 273 | |
| 274 | /* android_logger_list_register unimplemented, no use case */ |
| 275 | /* android_logger_list_unregister unimplemented, no use case */ |
| 276 | |
| 277 | /* Open the named log and add it to the logger list */ |
| 278 | LIBLOG_ABI_PUBLIC struct logger *android_logger_open( |
| 279 | struct logger_list *logger_list, |
| 280 | log_id_t logId) |
| 281 | { |
| 282 | struct android_log_logger_list *logger_list_internal = |
| 283 | (struct android_log_logger_list *)logger_list; |
| 284 | struct android_log_logger *logger; |
| 285 | |
| 286 | if (!logger_list_internal || (logId >= LOG_ID_MAX)) { |
| 287 | goto err; |
| 288 | } |
| 289 | |
| 290 | logger_for_each(logger, logger_list_internal) { |
| 291 | if (logger->logId == logId) { |
| 292 | goto ok; |
| 293 | } |
| 294 | } |
| 295 | |
| 296 | logger = calloc(1, sizeof(*logger)); |
| 297 | if (!logger) { |
| 298 | goto err; |
| 299 | } |
| 300 | |
| 301 | logger->logId = logId; |
| 302 | list_add_tail(&logger_list_internal->logger, &logger->node); |
| 303 | logger->parent = logger_list_internal; |
| 304 | |
| 305 | /* Reset known transports to re-evaluate, we just added one */ |
| 306 | while (!list_empty(&logger_list_internal->transport)) { |
| 307 | struct listnode *node = list_head(&logger_list_internal->transport); |
| 308 | struct android_log_transport_context *transp = |
| 309 | node_to_item(node, struct android_log_transport_context, node); |
| 310 | |
| 311 | list_remove(&transp->node); |
| 312 | free(transp); |
| 313 | } |
| 314 | goto ok; |
| 315 | |
| 316 | err: |
| 317 | logger = NULL; |
| 318 | ok: |
| 319 | return (struct logger *)logger; |
| 320 | } |
| 321 | |
| 322 | /* Open the single named log and make it part of a new logger list */ |
| 323 | LIBLOG_ABI_PUBLIC struct logger_list *android_logger_list_open( |
| 324 | log_id_t logId, |
| 325 | int mode, |
| 326 | unsigned int tail, |
| 327 | pid_t pid) |
| 328 | { |
| 329 | struct logger_list *logger_list = |
| 330 | android_logger_list_alloc(mode, tail, pid); |
| 331 | |
| 332 | if (!logger_list) { |
| 333 | return NULL; |
| 334 | } |
| 335 | |
| 336 | if (!android_logger_open(logger_list, logId)) { |
| 337 | android_logger_list_free(logger_list); |
| 338 | return NULL; |
| 339 | } |
| 340 | |
| 341 | return logger_list; |
| 342 | } |
| 343 | |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 344 | /* Validate log_msg packet, read function has already been null checked */ |
| 345 | static int android_transport_read(struct android_log_logger_list *logger_list, |
| 346 | struct android_log_transport_context *transp, |
| 347 | struct log_msg *log_msg) |
| 348 | { |
| 349 | int ret = (*transp->transport->read)(logger_list, transp, log_msg); |
| 350 | |
| 351 | if (ret > (int)sizeof(*log_msg)) { |
| 352 | ret = sizeof(*log_msg); |
| 353 | } |
| 354 | |
| 355 | transp->ret = ret; |
| 356 | |
| 357 | /* propagate errors, or make sure len & hdr_size members visible */ |
| 358 | if (ret < (int)(sizeof(log_msg->entry.len) + |
| 359 | sizeof(log_msg->entry.hdr_size))) { |
| 360 | if (ret >= (int)sizeof(log_msg->entry.len)) { |
| 361 | log_msg->entry.len = 0; |
| 362 | } |
| 363 | return ret; |
| 364 | } |
| 365 | |
| 366 | /* hdr_size correction (logger_entry -> logger_entry_v2+ conversion) */ |
| 367 | if (log_msg->entry_v2.hdr_size == 0) { |
| 368 | log_msg->entry_v2.hdr_size = sizeof(struct logger_entry); |
| 369 | } |
| 370 | |
| 371 | /* len validation */ |
| 372 | if (ret <= log_msg->entry_v2.hdr_size) { |
| 373 | log_msg->entry.len = 0; |
| 374 | } else { |
| 375 | log_msg->entry.len = ret - log_msg->entry_v2.hdr_size; |
| 376 | } |
| 377 | |
| 378 | return ret; |
| 379 | } |
| 380 | |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 381 | /* Read from the selected logs */ |
| 382 | LIBLOG_ABI_PUBLIC int android_logger_list_read(struct logger_list *logger_list, |
| 383 | struct log_msg *log_msg) |
| 384 | { |
| 385 | struct android_log_transport_context *transp; |
| 386 | struct android_log_logger_list *logger_list_internal = |
| 387 | (struct android_log_logger_list *)logger_list; |
| 388 | |
| 389 | int ret = init_transport_context(logger_list_internal); |
| 390 | if (ret < 0) { |
| 391 | return ret; |
| 392 | } |
| 393 | |
| 394 | /* at least one transport */ |
| 395 | transp = node_to_item(logger_list_internal->transport.next, |
| 396 | struct android_log_transport_context, node); |
| 397 | |
| 398 | /* more than one transport? */ |
| 399 | if (transp->node.next != &logger_list_internal->transport) { |
| 400 | /* Poll and merge sort the entries if from multiple transports */ |
| 401 | struct android_log_transport_context *oldest = NULL; |
| 402 | int ret; |
| 403 | int polled = 0; |
| 404 | do { |
| 405 | if (polled) { |
| 406 | sched_yield(); |
| 407 | } |
| 408 | ret = -1000; |
| 409 | polled = 0; |
| 410 | do { |
| 411 | int retval = transp->ret; |
| 412 | if ((retval > 0) && !transp->logMsg.entry.len) { |
| 413 | if (!transp->transport->read) { |
| 414 | retval = transp->ret = 0; |
| 415 | } else if ((logger_list_internal->mode & |
| 416 | ANDROID_LOG_NONBLOCK) || |
| 417 | !transp->transport->poll) { |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 418 | retval = android_transport_read( |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 419 | logger_list_internal, |
| 420 | transp, |
| 421 | &transp->logMsg); |
| 422 | } else { |
| 423 | int pollval = (*transp->transport->poll)( |
| 424 | logger_list_internal, transp); |
| 425 | if (pollval <= 0) { |
| 426 | sched_yield(); |
| 427 | pollval = (*transp->transport->poll)( |
| 428 | logger_list_internal, transp); |
| 429 | } |
| 430 | polled = 1; |
| 431 | if (pollval < 0) { |
| 432 | if ((pollval == -EINTR) || (pollval == -EAGAIN)) { |
| 433 | return -EAGAIN; |
| 434 | } |
| 435 | retval = transp->ret = pollval; |
| 436 | } else if (pollval > 0) { |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 437 | retval = android_transport_read( |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 438 | logger_list_internal, |
| 439 | transp, |
| 440 | &transp->logMsg); |
| 441 | } |
| 442 | } |
| 443 | } |
| 444 | if (ret < retval) { |
| 445 | ret = retval; |
| 446 | } |
| 447 | if ((transp->ret > 0) && transp->logMsg.entry.len && |
| 448 | (!oldest || |
| 449 | (oldest->logMsg.entry.sec > |
| 450 | transp->logMsg.entry.sec) || |
| 451 | ((oldest->logMsg.entry.sec == |
| 452 | transp->logMsg.entry.sec) && |
| 453 | (oldest->logMsg.entry.nsec > |
| 454 | transp->logMsg.entry.nsec)))) { |
| 455 | oldest = transp; |
| 456 | } |
| 457 | transp = node_to_item(transp->node.next, |
| 458 | struct android_log_transport_context, |
| 459 | node); |
| 460 | } while (transp != node_to_item( |
| 461 | &logger_list_internal->transport, |
| 462 | struct android_log_transport_context, |
| 463 | node)); |
| 464 | if (!oldest && |
| 465 | (logger_list_internal->mode & ANDROID_LOG_NONBLOCK)) { |
| 466 | return (ret < 0) ? ret : -EAGAIN; |
| 467 | } |
| 468 | transp = node_to_item(logger_list_internal->transport.next, |
| 469 | struct android_log_transport_context, node); |
| 470 | } while (!oldest && (ret > 0)); |
| 471 | if (!oldest) { |
| 472 | return ret; |
| 473 | } |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 474 | // ret is a positive value less than sizeof(struct log_msg) |
| 475 | ret = oldest->ret; |
| 476 | if (ret < oldest->logMsg.entry.hdr_size) { |
| 477 | // zero truncated header fields. |
| 478 | memset(log_msg, 0, |
| 479 | (oldest->logMsg.entry.hdr_size > sizeof(oldest->logMsg) ? |
| 480 | sizeof(oldest->logMsg) : |
| 481 | oldest->logMsg.entry.hdr_size)); |
| 482 | } |
| 483 | memcpy(log_msg, &oldest->logMsg, ret); |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 484 | oldest->logMsg.entry.len = 0; /* Mark it as copied */ |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 485 | return ret; |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 486 | } |
| 487 | |
| 488 | /* if only one, no need to copy into transport_context and merge-sort */ |
Mark Salyzyn | baff8aa | 2016-05-13 12:25:55 -0700 | [diff] [blame^] | 489 | return android_transport_read(logger_list_internal, transp, log_msg); |
Mark Salyzyn | dd9094a | 2016-03-01 13:45:42 -0800 | [diff] [blame] | 490 | } |
| 491 | |
| 492 | /* Close all the logs */ |
| 493 | LIBLOG_ABI_PUBLIC void android_logger_list_free(struct logger_list *logger_list) |
| 494 | { |
| 495 | struct android_log_logger_list *logger_list_internal = |
| 496 | (struct android_log_logger_list *)logger_list; |
| 497 | |
| 498 | if (logger_list_internal == NULL) { |
| 499 | return; |
| 500 | } |
| 501 | |
| 502 | while (!list_empty(&logger_list_internal->transport)) { |
| 503 | struct listnode *node = list_head(&logger_list_internal->transport); |
| 504 | struct android_log_transport_context *transp = |
| 505 | node_to_item(node, struct android_log_transport_context, node); |
| 506 | |
| 507 | if (transp->transport && transp->transport->close) { |
| 508 | (*transp->transport->close)(logger_list_internal, transp); |
| 509 | } |
| 510 | list_remove(&transp->node); |
| 511 | free(transp); |
| 512 | } |
| 513 | |
| 514 | while (!list_empty(&logger_list_internal->logger)) { |
| 515 | struct listnode *node = list_head(&logger_list_internal->logger); |
| 516 | struct android_log_logger *logger = |
| 517 | node_to_item(node, struct android_log_logger, node); |
| 518 | android_logger_free((struct logger *)logger); |
| 519 | } |
| 520 | |
| 521 | free(logger_list_internal); |
| 522 | } |