1 /*
2  * Copyright (C) 2017 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 #ifndef CHRE_UTIL_SYSTEM_DEBUG_DUMP_H_
18 #define CHRE_UTIL_SYSTEM_DEBUG_DUMP_H_
19 
20 #include <cstddef>
21 #include <stdarg.h>
22 
23 namespace chre {
24 
25 /**
26  * Prints a formatted string into a string buffer. If the log message does not
27  * fit into the remaining space of the buffer, the error is logged and the
28  * buffer is null-terminated. Subsequent calls to this function will do nothing.
29  *
30  * @param buffer Pointer to the start of the buffer.
31  * @param bufferPos Pointer to buffer position to start the print (in-out).
32  * @param bufferSize Size of the buffer in bytes.
33  * @param formatStr Formatted string.
34  */
35 void debugDumpPrint(char *buffer, size_t *bufferPos, size_t bufferSize,
36                     const char *formatStr, ...);
37 
38 }  // namespace chre
39 
40 #endif  // CHRE_UTIL_SYSTEM_DEBUG_DUMP_H_
41