Line data    Source code

       1             : // Copyright (c) 2006, 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             : 
      33             : #ifndef COMMON_LINUX_FILE_ID_H__
      34             : #define COMMON_LINUX_FILE_ID_H__
      35             : 
      36             : #include <limits.h>
      37             : #include <string>
      38             : 
      39             : #include "common/linux/guid_creator.h"
      40             : #include "common/memory.h"
      41             : 
      42             : namespace google_breakpad {
      43             : 
      44             : // GNU binutils' ld defaults to 'sha1', which is 160 bits == 20 bytes,
      45             : // so this is enough to fit that, which most binaries will use.
      46             : // This is just a sensible default for auto_wasteful_vector so most
      47             : // callers can get away with stack allocation.
      48             : static const size_t kDefaultBuildIdSize = 20;
      49             : 
      50             : class FileID {
      51             :  public:
      52             :   explicit FileID(const char* path);
      53           0 :   ~FileID() {}
      54             : 
      55             :   // Load the identifier for the elf file path specified in the constructor into
      56             :   // |identifier|.
      57             :   //
      58             :   // The current implementation will look for a .note.gnu.build-id
      59             :   // section and use that as the file id, otherwise it falls back to
      60             :   // XORing the first 4096 bytes of the .text section to generate an identifier.
      61             :   bool ElfFileIdentifier(wasteful_vector<uint8_t>& identifier);
      62             : 
      63             :   // Load the identifier for the elf file mapped into memory at |base| into
      64             :   // |identifier|. Return false if the identifier could not be created for this
      65             :   // file.
      66             :   static bool ElfFileIdentifierFromMappedFile(
      67             :       const void* base,
      68             :       wasteful_vector<uint8_t>& identifier);
      69             : 
      70             :   // Convert the |identifier| data to a string.  The string will
      71             :   // be formatted as a UUID in all uppercase without dashes.
      72             :   // (e.g., 22F065BBFC9C49F780FE26A7CEBD7BCE).
      73             :   static std::string ConvertIdentifierToUUIDString(
      74             :       const wasteful_vector<uint8_t>& identifier);
      75             : 
      76             :   // Convert the entire |identifier| data to a hex string.
      77             :   static std::string ConvertIdentifierToString(
      78             :       const wasteful_vector<uint8_t>& identifier);
      79             : 
      80             :  private:
      81             :   // Storage for the path specified
      82             :   std::string path_;
      83             : };
      84             : 
      85             : }  // namespace google_breakpad
      86             : 
      87             : #endif  // COMMON_LINUX_FILE_ID_H__