/ src / common / linux / symbol_upload.h
symbol_upload.h
 1  // -*- mode: c++ -*-
 2  
 3  // Copyright 2011 Google LLC
 4  //
 5  // Redistribution and use in source and binary forms, with or without
 6  // modification, are permitted provided that the following conditions are
 7  // met:
 8  //
 9  //     * Redistributions of source code must retain the above copyright
10  // notice, this list of conditions and the following disclaimer.
11  //     * Redistributions in binary form must reproduce the above
12  // copyright notice, this list of conditions and the following disclaimer
13  // in the documentation and/or other materials provided with the
14  // distribution.
15  //     * Neither the name of Google LLC nor the names of its
16  // contributors may be used to endorse or promote products derived from
17  // this software without specific prior written permission.
18  //
19  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  
31  // symbol_upload.h: helper functions for linux symbol upload tool.
32  
33  #ifndef COMMON_LINUX_SYMBOL_UPLOAD_H_
34  #define COMMON_LINUX_SYMBOL_UPLOAD_H_
35  
36  #include <string>
37  
38  #include "common/using_std_string.h"
39  
40  namespace google_breakpad {
41  namespace sym_upload {
42  
43  enum class UploadProtocol {
44    SYM_UPLOAD_V1,
45    SYM_UPLOAD_V2,
46  };
47  
48  constexpr char kBreakpadSymbolType[] = "BREAKPAD";
49  
50  struct Options {
51    Options() : upload_protocol(UploadProtocol::SYM_UPLOAD_V1), force(false) {}
52  
53    string symbolsPath;
54    string uploadURLStr;
55    string proxy;
56    string proxy_user_pwd;
57    string version;
58    bool success;
59    UploadProtocol upload_protocol;
60    bool force;
61    string api_key;
62  
63    // These only need to be set for native symbol uploads.
64    string code_file;
65    string debug_id;
66    string type;
67  };
68  
69  // Starts upload to symbol server with options.
70  void Start(Options* options);
71  
72  }  // namespace sym_upload
73  }  // namespace google_breakpad
74  
75  #endif  // COMMON_LINUX_SYMBOL_UPLOAD_H_