michael@0: // Copyright (c) 2006, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: //
michael@0: // file_id.h: Return a unique identifier for a file
michael@0: //
michael@0: 
michael@0: #ifndef COMMON_LINUX_FILE_ID_H__
michael@0: #define COMMON_LINUX_FILE_ID_H__
michael@0: 
michael@0: #include <limits.h>
michael@0: 
michael@0: #include "common/linux/guid_creator.h"
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: static const size_t kMDGUIDSize = sizeof(MDGUID);
michael@0: 
michael@0: class FileID {
michael@0:  public:
michael@0:   explicit FileID(const char* path);
michael@0:   ~FileID() {}
michael@0: 
michael@0:   // Load the identifier for the elf file path specified in the constructor into
michael@0:   // |identifier|.  Return false if the identifier could not be created for the
michael@0:   // file.
michael@0:   // The current implementation will look for a .note.gnu.build-id
michael@0:   // section and use that as the file id, otherwise it falls back to
michael@0:   // XORing the first 4096 bytes of the .text section to generate an identifier.
michael@0:   bool ElfFileIdentifier(uint8_t identifier[kMDGUIDSize]);
michael@0: 
michael@0:   // Load the identifier for the elf file mapped into memory at |base| into
michael@0:   // |identifier|.  Return false if the identifier could not be created for the
michael@0:   // file.
michael@0:   static bool ElfFileIdentifierFromMappedFile(const void* base,
michael@0:                                               uint8_t identifier[kMDGUIDSize]);
michael@0: 
michael@0:   // Convert the |identifier| data to a NULL terminated string.  The string will
michael@0:   // be formatted as a UUID (e.g., 22F065BB-FC9C-49F7-80FE-26A7CEBD7BCE).
michael@0:   // The |buffer| should be at least 37 bytes long to receive all of the data
michael@0:   // and termination.  Shorter buffers will contain truncated data.
michael@0:   static void ConvertIdentifierToString(const uint8_t identifier[kMDGUIDSize],
michael@0:                                         char* buffer, int buffer_length);
michael@0: 
michael@0:  private:
michael@0:   // Storage for the path specified
michael@0:   char path_[PATH_MAX];
michael@0: };
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: #endif  // COMMON_LINUX_FILE_ID_H__