lldb/Core/Module.h

5 // This file is distributed under the University of Illinois Open Source
34 /// accessors are called. For example the object file (ObjectFile)
35 /// representation will only be parsed if the object file is requested
65     /// Construct with file specification and architecture.
71     ///     The file specification for the on disk repesentation of
106     /// file address plus \a slide.
111     /// section file address + offset.
118     ///     apply to all file addresses for all top level sections in
119     ///     the object file as each section load address is being set.
125     ///     file address of each top level section.
167     /// is simple and would return the path to the file:
171     /// Modules can be .o files inside of a BSD archive (.a file). In
211     /// Find a symbol in the object file's symbol table.
241     /// Find a funciton symbols in the object file's symbol table.
359     /// Find addresses by file/line
364     /// @param[in] file
365     ///     Source file to locate.
380                                const FileSpec &file, uint32_t line,
537     /// Get const accessor for the module file specification.
539     /// This function returns the file for the module on the host system
544     ///     A const reference to the file specification object.
553     /// Get accessor for the module platform file specification.
555     /// Platform file refers to the path of the module as it is known on
558     /// remote debugging might mention a file "/usr/lib/liba.dylib"
560     /// platform file could be something like:
562     /// The file could also be cached in a local developer kit directory.
565     ///     A const reference to the file specification object.
576     SetPlatformFileSpec (const FileSpec &file)
578         m_platform_file = file;
588     SetRemoteInstallFileSpec (const FileSpec &file)
590         m_remote_install_file = file;
600     SetSymbolFileFileSpec (const FileSpec &file);
672     /// Get the object file representation for the current architecture.
674     /// If the object file has not been located or parsed yet, this
680     ///     that can parse the file, or the object file doesn't contain
682     ///     returned, else a valid object file interface will be
691     /// list created by the module's object file and any debug info and
695     /// will return the section list for the object file.
706     // Load an object file from memory.
714     /// If the symbol vendor file has not been located yet, this
716     /// use the current object file.
719     ///     If this module does not have a valid object file, or no
720     ///     plug-in can be found that can use the object file, NULL will
742     /// If the executable image file doesn't not have a UUID value built
743     /// into the file format, an MD5 checksum of the entire file, or
744     /// slice of the file for the current architecture should be used.
818     /// Resolve items in the symbol context for a given file and line.
831     ///     A path to a source file to match. If \a file_path does not
834     ///     a directory, the fullpath to the file must match.
841     ///     Check for inline file and line number matches. This option
844     ///     matching inline file entries.
863     /// Resolve items in the symbol context for a given file and line.
876     ///     A file spec to a source file to match. If \a file_path does
879     ///     specify a directory, the fullpath to the file must match.
886     ///     Check for inline file and line number matches. This option
889     ///     matching inline file entries.
910     SetFileSpecAndObjectName (const FileSpec &file,
950     // Return true if the file backing this module has changed since the
951     // module was originally created  since we saved the intial file
980     /// Finds a source file given a file spec using the module source
984     /// remappings. It makes sure the file exists, so this call can be
985     /// expensive if the remappings are on a network file system, so
990     ///     The original source file path to try and remap.
997     ///     \a new_spec is filled in with an existing file spec,
1004     /// Remaps a source file given \a path into \a new_path.
1007     /// does NOT stat the file system so it can be used in tight loops
1011     ///     The original source file path to try and remap.
1081     FileSpec                    m_file;         ///< The file representation on disk for this module (if there is one).
1084     FileSpec                    m_symfile_spec; ///< If this path is valid, then this is the file that _will_ be used as the symbol file for this module
1088     lldb::ObjectFileSP          m_objfile_sp;   ///< A shared pointer to the object file parser for this module as it may or may not be shared with the SymbolFile
1103     /// Resolve a file or load virtual address.
1105     /// Tries to resolve \a vm_addr as a file address (if \a
1115     ///     If \b true, \a vm_addr is a file address, else \a vm_addr