Add GC heap limit settings #19423

gewarren · 2020-07-11T01:06:05Z

Fixes #19356

Preview link.

gewarren · 2020-07-11T01:12:55Z

Couple of questions:

These were introduced in .NET 5.0, correct?
Are there runtimeconfig.json options as well?
If you specify one Percent option, do you have to specify the others as well?

cshung · 2020-07-13T16:12:47Z

Couple of questions:

These were introduced in .NET 5.0, correct?

Yes.

Are there runtimeconfig.json options as well?

No.

If you specify one Percent option, do you have to specify the others as well?

Yes.

docs/core/run-time-config/garbage-collector.md

gewarren · 2020-07-15T21:40:02Z

Ping for review @IEvangelist.

docs/core/run-time-config/garbage-collector.md

Maoni0 · 2020-07-15T22:37:26Z

to be clear, all the places in this PR that say per-heap should be changed to per-object-heap.

IEvangelist

A few minor nits, otherwise this is shippable.

docs/core/run-time-config/garbage-collector.md

IEvangelist · 2020-07-16T12:55:42Z

docs/core/run-time-config/garbage-collector.md

+| **Environment variable** | `COMPLUS_GCHeapHardLimitPOH` | *hexadecimal value* | .NET 5.0 |
+
+> [!TIP]
+> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to specify a heap hard limit of 200 mebibytes (MiB), the value would be 0xC800000 or C800000.


Suggested change

> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to specify a heap hard limit of 200 mebibytes (MiB), the value would be 0xC800000 or C800000.

> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to specify a heap hard limit of 200 mebibytes (MiB), the value would be `0xC800000` or `C800000`.

IEvangelist · 2020-07-16T12:56:07Z

docs/core/run-time-config/garbage-collector.md

+#### COMPLUS_GCHeapHardLimitSOH, COMPLUS_GCHeapHardLimitLOH, COMPLUS_GCHeapHardLimitPOH
+
+- If you specify a value for any of `COMPLUS_GCHeapHardLimitSOH`, `COMPLUS_GCHeapHardLimitLOH`, or `COMPLUS_GCHeapHardLimitPOH`, you must also specify a value for `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH`. If you don't, the runtime will fail to initialize.
+- The default value for `COMPLUS_GCHeapHardLimitPOH` is 0. `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH` don't have default values.


Suggested change

- The default value for `COMPLUS_GCHeapHardLimitPOH` is 0. `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH` don't have default values.

- The default value for `COMPLUS_GCHeapHardLimitPOH` is `0`. `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH` don't have default values.

I have not typically put numeric values in code fencing since they don't get localized. I would also need to make this change throughout this article.

docs/core/run-time-config/garbage-collector.md

IEvangelist · 2020-07-16T12:56:48Z

docs/core/run-time-config/garbage-collector.md

+
+- If you specify a value for any of `COMPLUS_GCHeapHardLimitSOHPercent`, `COMPLUS_GCHeapHardLimitLOHPercent`, or `COMPLUS_GCHeapHardLimitPOHPercent`, you must also specify a value for `COMPLUS_GCHeapHardLimitSOHPercent` and `COMPLUS_GCHeapHardLimitLOHPercent`. If you don't, the runtime will fail to initialize.
+- These settings are ignored if `COMPLUS_GCHeapHardLimitSOH`, `COMPLUS_GCHeapHardLimitLOH`, and `COMPLUS_GCHeapHardLimitPOH` are specified.
+- A value of 1 means that GC uses 1% of total physical memory for that object heap.


Suggested change

- A value of 1 means that GC uses 1% of total physical memory for that object heap.

- A value of `1` means that GC uses 1% of total physical memory for that object heap.

IEvangelist · 2020-07-16T12:58:15Z

docs/core/run-time-config/garbage-collector.md

+- If you specify a value for any of `COMPLUS_GCHeapHardLimitSOHPercent`, `COMPLUS_GCHeapHardLimitLOHPercent`, or `COMPLUS_GCHeapHardLimitPOHPercent`, you must also specify a value for `COMPLUS_GCHeapHardLimitSOHPercent` and `COMPLUS_GCHeapHardLimitLOHPercent`. If you don't, the runtime will fail to initialize.
+- These settings are ignored if `COMPLUS_GCHeapHardLimitSOH`, `COMPLUS_GCHeapHardLimitLOH`, and `COMPLUS_GCHeapHardLimitPOH` are specified.
+- A value of 1 means that GC uses 1% of total physical memory for that object heap.
+- Each value must be greater than zero and less than 100. Additionally, the sum of the three percentage values must be less than 100. Otherwise, the runtime will fail to initialize.


Suggested change

- Each value must be greater than zero and less than 100. Additionally, the sum of the three percentage values must be less than 100. Otherwise, the runtime will fail to initialize.

- Each value must be greater than zero and less than `100`. Additionally, the sum of the three percentage values must be less than `100`. Otherwise, the runtime will fail to initialize.

IEvangelist · 2020-07-16T12:59:09Z

docs/core/run-time-config/garbage-collector.md

+| **Environment variable** | `COMPLUS_GCHeapHardLimitPOHPercent` | *hexadecimal value* | .NET 5.0 |
+
+> [!TIP]
+> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to limit the heap usage to 30%, the value would be 0x1E or 1E.


Suggested change

> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to limit the heap usage to 30%, the value would be 0x1E or 1E.

> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to limit the heap usage to 30%, the value would be `0x1E` or `1E`.

Co-authored-by: David Pine <david.pine@microsoft.com>

fixes dotnet#19356

62c72cf

dotnet-bot added this to the July 2020 milestone Jul 11, 2020

dotnet-bot added the 📚 Area - .NET Core Guide label Jul 11, 2020

gewarren requested review from Maoni0 and cshung July 11, 2020 01:11

cshung reviewed Jul 13, 2020

View reviewed changes

docs/core/run-time-config/garbage-collector.md Outdated Show resolved Hide resolved

cshung reviewed Jul 13, 2020

View reviewed changes

docs/core/run-time-config/garbage-collector.md Outdated Show resolved Hide resolved

feedback from andrew

31f054a

gewarren requested a review from IEvangelist July 13, 2020 23:55

gewarren commented Jul 15, 2020

View reviewed changes

docs/core/run-time-config/garbage-collector.md Outdated Show resolved Hide resolved

Update docs/core/run-time-config/garbage-collector.md

5c8be13

per object heap - all

6c0ebfd

Maoni0 approved these changes Jul 16, 2020

View reviewed changes

IEvangelist approved these changes Jul 16, 2020

View reviewed changes

Apply suggestions from David

3a4ed20

Co-authored-by: David Pine <david.pine@microsoft.com>

gewarren merged commit e34a21e into dotnet:master Jul 16, 2020

gewarren deleted the gc-options-0710 branch July 16, 2020 16:52

BillWagner added dotnet-core/prod and removed 📚 Area - .NET Core Guide labels Feb 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add GC heap limit settings #19423

Add GC heap limit settings #19423

Uh oh!

gewarren commented Jul 11, 2020 •

edited

Loading

Uh oh!

gewarren commented Jul 11, 2020

Uh oh!

cshung commented Jul 13, 2020

Uh oh!

Uh oh!

Uh oh!

gewarren commented Jul 15, 2020

Uh oh!

Uh oh!

Maoni0 commented Jul 15, 2020

Uh oh!

IEvangelist left a comment

Uh oh!

Uh oh!

Uh oh!

IEvangelist Jul 16, 2020

Uh oh!

IEvangelist Jul 16, 2020

Uh oh!

gewarren Jul 16, 2020

Uh oh!

Uh oh!

IEvangelist Jul 16, 2020

Uh oh!

IEvangelist Jul 16, 2020

Uh oh!

IEvangelist Jul 16, 2020

Uh oh!

Uh oh!

	> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to specify a heap hard limit of 200 mebibytes (MiB), the value would be 0xC800000 or C800000.
	> If you're setting the option as an environment variable, specify a hexadecimal value. For example, to specify a heap hard limit of 200 mebibytes (MiB), the value would be `0xC800000` or `C800000`.

	- The default value for `COMPLUS_GCHeapHardLimitPOH` is 0. `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH` don't have default values.
	- The default value for `COMPLUS_GCHeapHardLimitPOH` is `0`. `COMPLUS_GCHeapHardLimitSOH` and `COMPLUS_GCHeapHardLimitLOH` don't have default values.

	- A value of 1 means that GC uses 1% of total physical memory for that object heap.
	- A value of `1` means that GC uses 1% of total physical memory for that object heap.

	- Each value must be greater than zero and less than 100. Additionally, the sum of the three percentage values must be less than 100. Otherwise, the runtime will fail to initialize.
	- Each value must be greater than zero and less than `100`. Additionally, the sum of the three percentage values must be less than `100`. Otherwise, the runtime will fail to initialize.

Add GC heap limit settings #19423

Add GC heap limit settings #19423

Uh oh!

Conversation

gewarren commented Jul 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gewarren commented Jul 11, 2020

Uh oh!

cshung commented Jul 13, 2020

Uh oh!

Uh oh!

Uh oh!

gewarren commented Jul 15, 2020

Uh oh!

Uh oh!

Maoni0 commented Jul 15, 2020

Uh oh!

IEvangelist left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

IEvangelist Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

IEvangelist Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

gewarren Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IEvangelist Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

IEvangelist Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

IEvangelist Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gewarren commented Jul 11, 2020 •

edited

Loading