xref: /aosp_15_r20/external/google-breakpad/src/common/windows/sym_upload_v2_protocol.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2022 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 COMMON_WINDOWS_SYM_UPLOAD_V2_PROTOCOL_H_
30 #define COMMON_WINDOWS_SYM_UPLOAD_V2_PROTOCOL_H_
31 
32 #include <string>
33 
34 namespace google_breakpad {
35 
36 // Sends file at |symbol_filename| using the sym-upload-v2 protocol to
37 // |api_url| using key |api_key|, and using identifiers |debug_file| and
38 // |debug_id|. |timeout_ms| is the number of milliseconds to wait before
39 // terminating the upload attempt. |symbol_type| is the type of the symbol
40 // file, which is one of:
41 //   "BREAKPAD"
42 //   "ELF"
43 //   "PE"
44 //   "MACHO"
45 //   "DEBUG_ONLY"
46 //   "DWP"
47 //   "DSYM"
48 //   "PDB"
49 //   "SOURCE_MAP"
50 // If |product_name| is non-empty then it will be sent as part of the symbol
51 // metadata.
52 // If |force| is set then it will overwrite an existing file with the
53 // same |debug_file| and |debug_id| in the store.
54 bool SymUploadV2ProtocolSend(const wchar_t* api_url,
55                              const wchar_t* api_key,
56                              int* timeout_ms,
57                              const std::wstring& debug_file,
58                              const std::wstring& debug_id,
59                              const std::wstring& symbol_filename,
60                              const std::wstring& symbol_type,
61                              const std::wstring& product_name,
62                              bool force);
63 
64 }  // namespace google_breakpad
65 
66 #endif  // COMMON_WINDOWS_SYM_UPLOAD_V2_PROTOCOL_H_