1 //===- HotnessThresholdParser.h - Parser for hotness threshold --*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file implements a simple parser to decode commandline option for
11 /// remarks hotness threshold that supports both int and a special 'auto' value.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_REMARKS_HOTNESSTHRESHOLDPARSER_H
16 #define LLVM_REMARKS_HOTNESSTHRESHOLDPARSER_H
17 
18 #include "llvm/Support/CommandLine.h"
19 #include <optional>
20 
21 namespace llvm {
22 namespace remarks {
23 
24 // Parse remarks hotness threshold argument value.
25 // Valid option values are
26 // 1. integer: manually specified threshold; or
27 // 2. string 'auto': automatically get threshold from profile summary.
28 //
29 // Return std::nullopt Optional if 'auto' is specified, indicating the value
30 // will be filled later during PSI.
31 inline Expected<std::optional<uint64_t>> parseHotnessThresholdOption(StringRef Arg) {
32   if (Arg == "auto")
33     return std::nullopt;
34 
35   int64_t Val;
36   if (Arg.getAsInteger(10, Val))
37     return createStringError(llvm::inconvertibleErrorCode(),
38                              "Not an integer: %s", Arg.data());
39 
40   // Negative integer effectively means no threshold
41   return Val < 0 ? 0 : Val;
42 }
43 
44 // A simple CL parser for '*-remarks-hotness-threshold='
45 class HotnessThresholdParser : public cl::parser<std::optional<uint64_t>> {
46 public:
47   HotnessThresholdParser(cl::Option &O) : cl::parser<std::optional<uint64_t>>(O) {}
48 
49   bool parse(cl::Option &O, StringRef ArgName, StringRef Arg,
50              std::optional<uint64_t> &V) {
51     auto ResultOrErr = parseHotnessThresholdOption(Arg);
52     if (!ResultOrErr)
53       return O.error("Invalid argument '" + Arg +
54                      "', only integer or 'auto' is supported.");
55 
56     V = *ResultOrErr;
57     return false;
58   }
59 };
60 
61 } // namespace remarks
62 } // namespace llvm
63 #endif // LLVM_REMARKS_HOTNESSTHRESHOLDPARSER_H
64