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 41 namespace google_breakpad { 42 43 static const size_t kMDGUIDSize = sizeof(MDGUID); 44 45 class FileID { 46 public: 47 explicit FileID(const char* path); 48 ~FileID() {} 49 50 // Load the identifier for the elf file path specified in the constructor into 51 // |identifier|. Return false if the identifier could not be created for the 52 // file. 53 // The current implementation will look for a .note.gnu.build-id 54 // section and use that as the file id, otherwise it falls back to 55 // XORing the first 4096 bytes of the .text section to generate an identifier. 56 bool ElfFileIdentifier(uint8_t identifier[kMDGUIDSize]); 57 58 // Load the identifier for the elf file mapped into memory at |base| into 59 // |identifier|. Return false if the identifier could not be created for the 60 // file. 61 static bool ElfFileIdentifierFromMappedFile(const void* base, 62 uint8_t identifier[kMDGUIDSize]); 63 64 // Convert the |identifier| data to a NULL terminated string. The string will 65 // be formatted as a UUID (e.g., 22F065BB-FC9C-49F7-80FE-26A7CEBD7BCE). 66 // The |buffer| should be at least 37 bytes long to receive all of the data 67 // and termination. Shorter buffers will contain truncated data. 68 static void ConvertIdentifierToString(const uint8_t identifier[kMDGUIDSize], 69 char* buffer, int buffer_length); 70 71 private: 72 // Storage for the path specified 73 std::string path_; 74 }; 75 76 } // namespace google_breakpad 77 78 #endif // COMMON_LINUX_FILE_ID_H__ 79
