summaryrefslogtreecommitdiff
path: root/src/mongo/util/pin_code_segments_params.idl
blob: 2686a22a60acfbe51c89761eceed130f80ad8ebf (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
#    Copyright (C) 2023-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"

server_parameters:
  lockCodeSegmentsInMemory:
    description: >-
      When enabled, the server will attempt to call mlock() on all memory ranges corresponding
      to the process code segments (including shared libraries) on startup. If any call to mlock()
      fails, the server will terminate. When disabled, the server will not attempt to pin any code
      segments in memory. This feature is only available on Linux.
    set_at: startup
    cpp_vartype: bool
    cpp_varname: gLockCodeSegmentsInMemory
    default: false