/ src / common / solaris / file_id.h
file_id.h
 1  // Copyright 2007 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  // file_id.h: Return a unique identifier for a file
30  //
31  // Author: Alfred Peng
32  
33  #ifndef COMMON_SOLARIS_FILE_ID_H__
34  #define COMMON_SOLARIS_FILE_ID_H__
35  
36  #include <limits.h>
37  
38  namespace google_breakpad {
39  namespace elf {
40  
41  class 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  }  // elf
65  }  // namespace google_breakpad
66  
67  #endif  // COMMON_SOLARIS_FILE_ID_H__