/thirdparty/breakpad/common/linux/file_id.h

http://github.com/tomahawk-player/tomahawk · C++ Header · 77 lines · 20 code · 12 blank · 45 comment · 0 complexity · 8520a2088bf0957847e13a7c2676f0b5 MD5 · raw file

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