xref: /aosp_15_r20/external/google-breakpad/src/common/linux/symbol_collector_client.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2019 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_LINUX_SYMBOL_COLLECTOR_CLIENT_H_
30 #define COMMON_LINUX_SYMBOL_COLLECTOR_CLIENT_H_
31 
32 #include <string>
33 
34 #include "common/linux/libcurl_wrapper.h"
35 #include "common/using_std_string.h"
36 
37 namespace google_breakpad {
38 namespace sym_upload {
39 
40 struct UploadUrlResponse {
41   string upload_url;
42   string upload_key;
43 };
44 
45 enum SymbolStatus {
46   Found,
47   Missing,
48   Unknown
49 };
50 
51 enum CompleteUploadResult {
52   Ok,
53   DuplicateData,
54   Error
55 };
56 
57 // Helper class to communicate with a sym-upload-v2 service over HTTP/REST,
58 // via libcurl.
59 class SymbolCollectorClient {
60  public:
61   static bool CreateUploadUrl(
62       LibcurlWrapper* libcurl_wrapper,
63       const string& api_url,
64       const string& api_key,
65       UploadUrlResponse* uploadUrlResponse);
66 
67   static CompleteUploadResult CompleteUpload(
68       LibcurlWrapper* libcurl_wrapper,
69       const string& api_url,
70       const string& api_key,
71       const string& upload_key,
72       const string& debug_file,
73       const string& debug_id,
74       const string& type);
75 
76   static SymbolStatus CheckSymbolStatus(
77       LibcurlWrapper* libcurl_wrapper,
78       const string& api_url,
79       const string& api_key,
80       const string& debug_file,
81       const string& debug_id);
82 };
83 
84 }  // namespace sym_upload
85 }  // namespace google_breakpad
86 
87 #endif  // COMMON_LINUX_SYMBOL_COLLECTOR_CLIENT_H_
88