Skip to content

Move .NET Core unmanaged profiling APIs to "core" folder #37206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Sep 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions .openpublishing.redirection.framework.json
Original file line number Diff line number Diff line change
Expand Up @@ -2228,6 +2228,186 @@
"redirect_url": "/dotnet/core/unmanaged-api/debugging/unregisterforruntimestartup-function",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-event-data-structure.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-event-data-structure",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-eventpipe-level-enumeration.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-eventpipe-level-enumeration",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-eventpipe-param-desc-structure.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-eventpipe-param-desc-structure",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-eventpipe-param-type-enumeration.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-eventpipe-param-type-enumeration",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-eventpipe-provider-config-structure.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-eventpipe-provider-config-structure",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-handle-type-enumeration.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-handle-type-enumeration",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilercallback10-eventpipeeventdelivered-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilercallback10-eventpipeeventdelivered-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilercallback10-eventpipeprovidercreated-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilercallback10-eventpipeprovidercreated-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilercallback10-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilercallback10-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-enumerateobjectreferences-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-enumerateobjectreferences-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-getlohobjectsizethreshold-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-getlohobjectsizethreshold-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-isfrozenobject-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-isfrozenobject-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-requestrejitwithinliners-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-requestrejitwithinliners-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-resumeruntime-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-resumeruntime-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo10-suspendruntime-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo10-suspendruntime-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo11-getenvironmentvariable-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo11-getenvironmentvariable-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo11-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo11-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo11-setenvironmentvariable-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo11-setenvironmentvariable-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipeaddprovidertosession-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipeaddprovidertosession-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipecreateprovider-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipecreateprovider-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipedefineevent-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipedefineevent-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipegetproviderinfo-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipegetproviderinfo-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipestartsession-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipestartsession-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipestopsession-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipestopsession-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-eventpipewriteevent-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-eventpipewriteevent-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo12-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo12-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo13-createhandle-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo13-createhandle-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo13-destroyhandle-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo13-destroyhandle-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo13-getobjectidfromhandle-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo13-getobjectidfromhandle-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo13-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo13-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo9-getcodeinfo4-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo9-getcodeinfo4-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo9-getnativecodestartaddresses-method.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo9-getnativecodestartaddresses-method",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/unmanaged-api/profiling/icorprofilerinfo9-interface.md",
"redirect_url": "/dotnet/core/unmanaged-api/profiling/icorprofilerinfo9-interface",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/framework/wcf/diagnostics/etw/monitoring-service-operation-failures.md",
"redirect_url": "/previous-versions/dotnet/netframework-4.0/ff468239(v=vs.100)"
Expand Down
8 changes: 7 additions & 1 deletion docs/breadcrumb/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ items:
- name: Advanced concepts
tocHref: /dotnet/csharp/advanced-topics/
topicHref: /dotnet/csharp/advanced-topics/reflection-and-attributes/index

- name: Tutorials
tocHref: /dotnet/csharp/tutorials/
topicHref: /dotnet/csharp/tutorials/index
Expand Down Expand Up @@ -606,6 +606,12 @@ items:
- name: Memory management
tocHref: /dotnet/standard/garbage-collection/
topicHref: /dotnet/standard/managed-code
- name: Unmanaged API reference (debugging)
tocHref: /dotnet/core/unmanaged-api/debugging/
topicHref: /dotnet/core/unmanaged-api/debugging/index
- name: Unmanaged API reference (profiling)
tocHref: /dotnet/core/unmanaged-api/profiling/
topicHref: /dotnet/core/unmanaged-api/profiling/index
- name: Data access
tocHref: /dotnet/navigate/data-access/
topicHref: /dotnet/navigate/data-access/index
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ HRESULT CreateDebuggingInterfaceFromVersion2 (

**Library:** dbgshim.dll, libdbgshim.so, libdbgshim.dylib

**.NET Versions:** [!INCLUDE[net_core_31](../../../../includes/net-core-31-md.md)]
**.NET Versions:** Available since .NET Core 3.1
6 changes: 2 additions & 4 deletions docs/core/unmanaged-api/debugging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ ms.date: 09/19/2023

The articles in this section describe the unmanaged APIs that the common language runtime (CLR) provides to support debugging .NET applications that are running on Windows, Linux, or macOS operating systems.

These articles describe APIs that were introduced in .NET Core 2.0 and later versions. For .NET Framework-era unmanaged APIs, most of which can also be used to debug .NET (Core) apps, see [.NET Framework debugging](../../../framework/unmanaged-api/debugging/index.md).

## Functions

[CloseCLREnumeration function](closeclrenumeration-function.md)\
Expand Down Expand Up @@ -74,7 +76,3 @@ Includes the [ProvideLibrary2](iclrdebugginglibraryprovider2-providelibrary2-met

[ICLRDebuggingLibraryProvider3 interface](iclrdebugginglibraryprovider3-interface.md)\
Includes callback methods that allow common language runtime version-specific debugging libraries to be located and loaded on demand for .NET regular and single-file applications.

## See also

- [.NET Framework debugging (unmanaged API reference)](../../../framework/unmanaged-api/debugging/index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,49 @@
description: "Learn more about: COR_PRF_EVENT_DATA structure"
title: "COR_PRF_EVENT_DATA structure"
ms.date: "03/19/2021"
api_name:
api_name:
- "COR_PRF_EVENT_DATA"
api_location:
api_location:
- "coreclr.dll"
- "corprof.idl"
api_type:
api_type:
- "COM"
---
# COR_PRF_EVENT_DATA structure

Describes the event data for an EventPipe event being written.
## Syntax
```cpp

## Syntax

```cpp
typedef struct
{
UINT64 ptr;
UINT32 size;
UINT32 reserved;
} COR_PRF_EVENT_DATA;
```
## Members
|Member|Description|
|------------|-----------------|
|`ptr`|A pointer to the data.|
|`size`|The size of the data pointed to by `ptr`.|
|`reserved`|An reserved implementation specific field.|
## Remarks
```

## Members

|Member|Description|
|------------|-----------------|
|`ptr`|A pointer to the data.|
|`size`|The size of the data pointed to by `ptr`.|
|`reserved`|An reserved implementation specific field.|

## Remarks

The `COR_PRF_EVENT_DATA` structure is used by the [ICorProfilerInfo12::EventPipeWriteEvent](icorprofilerinfo12-eventpipewriteevent-method.md) method to provide the data payload for the event being written.

## Requirements

**Platforms:** See [.NET Core supported operating systems](../../../core/install/windows.md?pivots=os-windows).
## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorProf.idl, CorProf.h
**.NET Versions:** [!INCLUDE[net_core](../../../../includes/net-core-50-md.md)]


**.NET Versions:** Available since .NET 5.0

## See also

- [Profiling Enumerations](profiling-enumerations.md)
- [ICorProfilerInfo12::EventPipeWriteEvent](icorprofilerinfo12-eventpipewriteevent-method.md)
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
description: "Learn more about: COR_PRF_EVENTPIPE_LEVEL Enumeration"
title: "COR_PRF_EVENTPIPE_LEVEL Enumeration"
ms.date: "03/19/2021"
api_name:
api_name:
- "COR_PRF_EVENTPIPE_LEVEL"
api_location:
api_location:
- "coreclr.dll"
- "corprof.idl"
api_type:
api_type:
- "COM"
---
# COR_PRF_EVENTPIPE_LEVEL Enumeration
# COR_PRF_EVENTPIPE_LEVEL enumeration

Describes the level of an EventPipe event.
## Syntax
```cpp

## Syntax

```cpp
typedef enum
{
COR_PRF_EVENTPIPE_LOGALWAYS = 0,
Expand All @@ -26,30 +26,31 @@ typedef enum
COR_PRF_EVENTPIPE_INFORMATIONAL = 4,
COR_PRF_EVENTPIPE_VERBOSE = 5
} COR_PRF_EVENTPIPE_LEVEL;
```
## Members
|Member|Description|
|------------|-----------------|
```

## Members

|Member|Description|
|------------|-----------------|
|`COR_PRF_EVENTPIPE_LOGALWAYS`|The event is always logged.|
|`COR_PRF_EVENTPIPE_CRITICAL`|The event represents a critical message.|
|`COR_PRF_EVENTPIPE_ERROR`|The event represents an error message.|
|`COR_PRF_EVENTPIPE_WARNING`|The event represents a warning message.|
|`COR_PRF_EVENTPIPE_INFORMATIONAL`|The event represents an informational message.|
|`COR_PRF_EVENTPIPE_VERBOSE`|The event represents a verbose message.|
## Remarks

## Remarks

The `COR_PRF_EVENTPIPE_LEVEL` enumeration is used by the [ICorProfilerInfo12::EventPipeDefineEvent](icorprofilerinfo12-eventpipedefineevent-method.md) method to indicate the level of the event being defined.

## Requirements

**Platforms:** See [.NET Core supported operating systems](../../../core/install/windows.md?pivots=os-windows).
## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorProf.idl, CorProf.h
**.NET Versions:** [!INCLUDE[net_core](../../../../includes/net-core-50-md.md)]


**.NET Versions:** Available since .NET 5.0

## See also

- [Profiling Enumerations](profiling-enumerations.md)
- [ICorProfilerInfo12::EventPipeDefineEvent](icorprofilerinfo12-eventpipedefineevent-method.md)
Loading