/ src / client / linux / log / log.h
log.h
 1  // Copyright 2012 Google LLC
 2  //
 3  // Redistribution and use in source and binary forms, with or without
 4  // modification, are permitted provided that the following conditions are
 5  // met:
 6  //
 7  //     * Redistributions of source code must retain the above copyright
 8  // notice, this list of conditions and the following disclaimer.
 9  //     * Redistributions in binary form must reproduce the above
10  // copyright notice, this list of conditions and the following disclaimer
11  // in the documentation and/or other materials provided with the
12  // distribution.
13  //     * Neither the name of Google LLC nor the names of its
14  // contributors may be used to endorse or promote products derived from
15  // this software without specific prior written permission.
16  //
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  
29  #ifndef CLIENT_LINUX_LOG_LOG_H_
30  #define CLIENT_LINUX_LOG_LOG_H_
31  
32  #include <stddef.h>
33  
34  namespace logger {
35  
36  int write(const char* buf, size_t nbytes);
37  
38  // In the case of Android the log can be written to the default system log
39  // (default behavior of write() above, or to the crash log (see
40  // writeToCrashLog() below).
41  #if defined(__ANDROID__)
42  
43  // The logger must be initialized in a non-compromised context.
44  void initializeCrashLogWriter();
45  
46  // Once initialized, writeToCrashLog is safe to use in a compromised context,
47  // even if the initialization failed, in which case this will silently fall
48  // back on write().
49  int writeToCrashLog(const char* buf);
50  #endif
51  
52  }  // namespace logger
53  
54  #endif  // CLIENT_LINUX_LOG_LOG_H_