|
| 1 | +%feature("docstring", |
| 2 | +"A container to specify how to save a core file. |
| 3 | +
|
| 4 | +SBSaveCoreOptions includes API's to specify the memory regions and threads to include |
| 5 | +when generating a core file. It extends the existing SaveCoreStyle option. |
| 6 | +
|
| 7 | +* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in |
| 8 | +the options object. |
| 9 | +
|
| 10 | +* eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified |
| 11 | +in the options object if they are not already captured. |
| 12 | +
|
| 13 | +* eSaveCoreStackOnly will capture all threads, but no memory regions unless specified. |
| 14 | +
|
| 15 | +* eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified. |
| 16 | + Picking custom and specifying nothing will result in an error being returned. |
| 17 | +
|
| 18 | +Note that currently ELF Core files are not supported. |
| 19 | +") |
| 20 | + |
| 21 | +%feature("docstring", " |
| 22 | + Set the plugin name to save a Core file with. Only plugins registered with Plugin manager will be accepted |
| 23 | + Examples are Minidump and Mach-O." |
| 24 | +) lldb::SBSaveCoreOptions::SetPluginName |
| 25 | + |
| 26 | +%feature("docstring", " |
| 27 | + Get the specified plugin name, or None if the name is not set." |
| 28 | +) lldb::SBSaveCoreOptions::GetPluginName |
| 29 | + |
| 30 | +%feature("docstring", " |
| 31 | + Set the lldb.SaveCoreStyle." |
| 32 | +) lldb::SBSaveCoreOptions::SetStyle |
| 33 | + |
| 34 | +%feature("docstring", " |
| 35 | + Get the specified lldb.SaveCoreStyle, or eSaveCoreUnspecified if not set." |
| 36 | +) lldb::SBSaveCoreOptions::GetStyle |
| 37 | + |
| 38 | +%feature("docstring", " |
| 39 | + Set the file path to save the Core file at." |
| 40 | +) lldb::SBSaveCoreOptions::SetOutputFile |
| 41 | + |
| 42 | +%feature("docstring", " |
| 43 | + Get an SBFileSpec corresponding to the specified output path, or none if not set." |
| 44 | +) lldb::SBSaveCoreOptions::GetOutputFile |
| 45 | + |
| 46 | +%feature("docstring", " |
| 47 | + Set the process to save, or unset a process by providing a default SBProcess. |
| 48 | + Resetting will result in the reset of all process specific options, such as Threads to save." |
| 49 | +) lldb::SBSaveCoreOptions::SetProcess |
| 50 | + |
| 51 | +%feature("docstring", " |
| 52 | + Add an SBThread to be saved, an error will be returned if an SBThread from a different process is specified. |
| 53 | + The process is set either by the first SBThread added to the options container, or explicitly by the SetProcess call." |
| 54 | +) lldb::SBSaveCoreOptions::AddThread |
| 55 | + |
| 56 | +%feature("docstring", " |
| 57 | + Remove an SBthread if present in the container, returns true if a matching thread was found and removed." |
| 58 | +) lldb::SBSaveCoreOptions::RemoveThread |
| 59 | + |
| 60 | +%feature("docstring", " |
| 61 | + Add a memory region to save, an error will be returned in the region is invalid. |
| 62 | + Ranges that overlap will be unioned into a single region." |
| 63 | +) lldb::SBSaveCoreOptions::AddMemoryRegionToSave |
| 64 | + |
| 65 | +%feature("docstring", " |
| 66 | + Get an SBThreadCollection of all threads marked to be saved. This collection is not sorted according to insertion order." |
| 67 | +) lldb::SBSaveCoreOptions::GetThreadsToSave |
| 68 | + |
| 69 | +%feature("docstring", " |
| 70 | + Unset all options." |
| 71 | +) lldb::SBSaveCoreOptions::Clear |
0 commit comments