53d301c29b
There are no libbase users that require thread safety for SetLogger, SetAborter, or SetDefaultTag and the equivalent liblog symbols are unreleased, thus have effectively no users. It is hard to imagine a scenario where a user would need to use these functions in a multi-threaded program, and it is unreasonable for all users to pay for thread safety for a vast minority of potential scenarios. Thread safety implies less efficiency and necessarily means that these functions are neither fork safe nor async-signal safe, and we do have users who depend on those characteristics. It is always possible for users of the non-thread safe versions of these functions to build thread safe versions on top of them. For example, if a user needs a thread safe SetLogger(), they can use the non-thread safe SetLogger at the start of their program to register a logger that has its own lock and pointer to a logger function. Bug: 119867234 Test: logging unit tests Change-Id: I8afffec1a6957d3bda95502a4c59493e0c5049ce |
||
|---|---|---|
| .. | ||
| include/android-base | ||
| tidy | ||
| .clang-format | ||
| abi_compatibility.cpp | ||
| Android.bp | ||
| chrono_utils.cpp | ||
| chrono_utils_test.cpp | ||
| cmsg.cpp | ||
| cmsg_test.cpp | ||
| CPPLINT.cfg | ||
| endian_test.cpp | ||
| errors_test.cpp | ||
| errors_unix.cpp | ||
| errors_windows.cpp | ||
| expected_test.cpp | ||
| file.cpp | ||
| file_test.cpp | ||
| format_benchmark.cpp | ||
| liblog_symbols.cpp | ||
| liblog_symbols.h | ||
| logging.cpp | ||
| logging_test.cpp | ||
| macros_test.cpp | ||
| mapped_file.cpp | ||
| mapped_file_test.cpp | ||
| no_destructor_test.cpp | ||
| OWNERS | ||
| parsebool.cpp | ||
| parsebool_test.cpp | ||
| parsedouble_test.cpp | ||
| parseint_test.cpp | ||
| parsenetaddress.cpp | ||
| parsenetaddress_test.cpp | ||
| process.cpp | ||
| process_test.cpp | ||
| properties.cpp | ||
| properties_test.cpp | ||
| README.md | ||
| result_test.cpp | ||
| scopeguard_test.cpp | ||
| stringprintf.cpp | ||
| stringprintf_test.cpp | ||
| strings.cpp | ||
| strings_test.cpp | ||
| test_main.cpp | ||
| test_utils.cpp | ||
| test_utils_test.cpp | ||
| threads.cpp | ||
| utf8.cpp | ||
| utf8_test.cpp | ||
libbase
Who is this library for?
This library is a collection of convenience functions to make common tasks easier and less error-prone.
In this context, "error-prone" covers both "hard to do correctly" and "hard to do with good performance", but as a general purpose library, libbase's primary focus is on making it easier to do things easily and correctly when a compromise has to be made between "simplest API" on the one hand and "fastest implementation" on the other. Though obviously the ideal is to have both.
Should my routine be added?
The intention is to cover the 80% use cases, not be all things to all users.
If you have a routine that's really useful in your project, congratulations. But that doesn't mean it should be here rather than just in your project.
The question for libbase is "should everyone be doing this?"/"does this make everyone's code cleaner/safer?". Historically we've considered the bar for inclusion to be "are there at least three unrelated projects that would be cleaned up by doing so".
If your routine is actually something from a future C++ standard (that isn't yet in libc++), or it's widely used in another library, that helps show that there's precedent. Being able to say "so-and-so has used this API for n years" is a good way to reduce concerns about API choices.
Any other restrictions?
Unlike most Android code, code in libbase has to build for Mac and Windows too.
Code here is also expected to have good test coverage.
By its nature, it's difficult to change libbase API. It's often best to start using your routine just in your project, and let it "graduate" after you're certain that the API is solid.