summaryrefslogtreecommitdiff
path: root/src/mongo/util/tcmalloc_parameters.idl
blob: 70586cda5e3a54dac960481a1adcca4ccddfe964 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
  cpp_namespace: "mongo"
  cpp_includes:
    - "mongo/config.h"

server_parameters:

  tcmallocMaxTotalThreadCacheBytes:
    description: "Configure tcmalloc's max_total_thread_cache_bytes"
    set_at: [startup, runtime]
    cpp_class:
      name: TCMallocMaxTotalThreadCacheBytesServerParameter
      override_set: true

  tcmallocAggressiveMemoryDecommit:
    description: "Configure tcmalloc's aggressive_memory_decommit"
    set_at: [startup, runtime]
    cpp_class:
      name: TCMallocAggressiveMemoryDecommitServerParameter
      override_set: true

  heapProfilingEnabled:
    description: "Enable Heap Profiling"
    set_at: startup
    cpp_vartype: bool
    cpp_varname: HeapProfilingEnabled
    default: false
    condition:
      preprocessor: defined(_POSIX_VERSION) && (defined(MONGO_CONFIG_HAVE_EXECINFO_BACKTRACE) || defined(MONGO_CONFIG_USE_LIBUNWIND))

  heapProfilingSampleIntervalBytes:
    description: "Configure heap profiling sample interval bytes"
    set_at: startup
    cpp_vartype: long long
    cpp_varname: HeapProfilingSampleIntervalBytes
    # 256kb
    default: 262144
    condition:
      preprocessor: defined(_POSIX_VERSION) && (defined(MONGO_CONFIG_HAVE_EXECINFO_BACKTRACE) || defined(MONGO_CONFIG_USE_LIBUNWIND))

  tcmallocEnableMarkThreadTemporarilyIdle:
    description: 'REMOVED: Setting this parameter has no effect and it will be removed in a future version of MongoDB.'
    set_at: [ startup, runtime ]
    cpp_class: TCMallocEnableMarkThreadTemporarilyIdle

  tcmallocReleaseRate:
    description: "Configure tcmalloc_release_rate"
    set_at: [startup, runtime]
    cpp_class:
      name: TCMallocReleaseRateServerParameter
      override_set: false