diff options
| author | Kshama Pawar <kspawa@microsoft.com> | 2016-06-09 15:47:35 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-09 15:47:35 -0700 |
| commit | c72236d05d814b4f88240d5277f755cb81ab2bcb (patch) | |
| tree | 3edd0370a3e2af8770824c54ee8d06465b15c826 | |
| parent | ef0cd3fb766e9bb7a03d0426bf4ad409f0dd19a1 (diff) | |
| download | coreclr-c72236d05d814b4f88240d5277f755cb81ab2bcb.tar.gz coreclr-c72236d05d814b4f88240d5277f755cb81ab2bcb.tar.bz2 coreclr-c72236d05d814b4f88240d5277f755cb81ab2bcb.zip | |
Update profiling-api-status.md
| -rw-r--r-- | Documentation/project-docs/profiling-api-status.md | 87 |
1 files changed, 46 insertions, 41 deletions
diff --git a/Documentation/project-docs/profiling-api-status.md b/Documentation/project-docs/profiling-api-status.md index 83805d6665..a48b249299 100644 --- a/Documentation/project-docs/profiling-api-status.md +++ b/Documentation/project-docs/profiling-api-status.md @@ -1,41 +1,46 @@ -APIs Internally Microsoft Tested: -1. Windows - -ICorProfilerCallback: - Initialize - ModuleLoadFinished - ModuleUnloadStarted - ModuleUnloadFinished - ModuleAttachedToAssembly - JITCompilationStarted - -ICorProfilerInfo: - GetModuleInfo - GetModuleMetaData - GetModuleInfo - GetModuleInfo2 - GetModuleMetaData - GetFunctionInfo - SetILFunctionBody - SetILInstrumentedCodeMap - GetILFunctionBodyAllocator - GetRuntimeInformation - SetEventMask - -The flags tested for SetEventMask are: - COR_PRF_MONITOR_MODULE_LOADS - COR_PRF_MONITOR_JIT_COMPILATION - COR_PRF_DISABLE_INLINING - -2. Linux -3. OSX - -APIs known to work; tested by other contributors (please mention your github handle in case someone wants to reach out for further clarification) -1. Windows -2. Linux -3. OSX - -APIs definitely known not to work yet -1. Windows -2. Linux -3. OSX +#Status of Coreclr Profiler APIs + +The notes below will help you determine what profiling APIs are safe to use. The .Net Core project started with the codebase from the desktop CoreCLR/Silverlight so all the profiler APIs present there are also present in the code here. However that doesn't automatically imply that they are all working or being actively tested right now. Our goal is to eventually have everything tested and working across all the supported OSes. As we make progress we'll document it here. If you want to use APIs that we haven't tested yet you are welcome to do so, but you need to do your own testing to determine if it works. If you do test APIs we haven't gotten to yet, we hope you'll add a note below in the Community Tested API section so that everyone can benefit. + +##Microsoft Tested APIs: + +###Windows + +* ICorProfilerCallback: + * `Initialize` + * `ModuleLoadFinished` + * `ModuleUnloadStarted` + * `ModuleUnloadFinished` + * `ModuleAttachedToAssembly` + * `JITCompilationStarted` + +* ICorProfilerInfo: + * `GetModuleInfo` + * `GetModuleMetaData` + * `GetModuleInfo` + * `GetModuleInfo2` + * `GetModuleMetaData` + * `GetFunctionInfo` + * `SetILFunctionBody` + * `SetILInstrumentedCodeMap` + * `GetILFunctionBodyAllocator` + * `GetRuntimeInformation` + * `SetEventMask` + +* The flags tested for SetEventMask are: + * `COR_PRF_MONITOR_MODULE_LOADS` + * `COR_PRF_MONITOR_JIT_COMPILATION` + * `COR_PRF_DISABLE_INLINING` + +###Linux +###OSX + +##Community Tested APIs (please include GitHub handle) +###Windows +###Linux +###OSX + +##APIs definitely known not to work yet +###Windows +###Linux +###OSX |