/thirdparty/breakpad/common/solaris/file_id.h

 1// Copyright (c) 2007, Google Inc.
 2// All rights reserved.
 3//
 4// Redistribution and use in source and binary forms, with or without
 5// modification, are permitted provided that the following conditions are
 6// met:
 7//
 8//     * Redistributions of source code must retain the above copyright
 9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// file_id.h: Return a unique identifier for a file
31//
32// Author: Alfred Peng
33
34#ifndef COMMON_SOLARIS_FILE_ID_H__
35#define COMMON_SOLARIS_FILE_ID_H__
36
37#include <limits.h>
38
39namespace google_breakpad {
40
41class FileID {
42 public:
43  FileID(const char *path);
44  ~FileID() {};
45
46  // Load the identifier for the elf file path specified in the constructor into
47  // |identifier|.  Return false if the identifier could not be created for the
48  // file.
49  // The current implementation will return the MD5 hash of the file's bytes.
50  bool ElfFileIdentifier(unsigned char identifier[16]);
51
52  // Convert the |identifier| data to a NULL terminated string.  The string will
53  // be formatted as a MDCVInfoPDB70 struct.
54  // The |buffer| should be at least 34 bytes long to receive all of the data
55  // and termination. Shorter buffers will return false.
56  static bool ConvertIdentifierToString(const unsigned char identifier[16],
57                                        char *buffer, int buffer_length);
58
59 private:
60  // Storage for the path specified
61  char path_[PATH_MAX];
62};
63
64}  // namespace google_breakpad
65
66#endif  // COMMON_SOLARIS_FILE_ID_H__