summaryrefslogtreecommitdiff
path: root/src/mongo/util/memory_util.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/util/memory_util.h')
-rw-r--r--src/mongo/util/memory_util.h59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/mongo/util/memory_util.h b/src/mongo/util/memory_util.h
new file mode 100644
index 00000000000..2612c491060
--- /dev/null
+++ b/src/mongo/util/memory_util.h
@@ -0,0 +1,59 @@
+/**
+ * Copyright (C) 2021-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.
+ */
+
+#pragma once
+
+#include <string>
+
+#include "mongo/base/status_with.h"
+
+namespace mongo::memory_util {
+
+/**
+ * Defines units of memory consumption.
+ */
+enum class MemoryUnits {
+ kPercent,
+ kMB,
+ kGB,
+};
+
+StatusWith<MemoryUnits> parseUnitString(const std::string& strUnit);
+
+/**
+ * Represents parsed memory size parameter.
+ */
+struct MemorySize {
+ static StatusWith<MemorySize> parse(const std::string& str);
+
+ const double size;
+ const MemoryUnits units;
+};
+
+} // namespace mongo::memory_util