bpf: Introduce bpf_strtol and bpf_strtoul helpers

Add bpf_strtol and bpf_strtoul to convert a string to long and unsigned
long correspondingly. It's similar to user space strtol(3) and
strtoul(3) with a few changes to the API:

* instead of NUL-terminated C string the helpers expect buffer and
  buffer length;

* resulting long or unsigned long is returned in a separate
  result-argument;

* return value is used to indicate success or failure, on success number
  of consumed bytes is returned that can be used to identify position to
  read next if the buffer is expected to contain multiple integers;

* instead of *base* argument, *flags* is used that provides base in 5
  LSB, other bits are reserved for future use;

* number of supported bases is limited.

Documentation for the new helpers is provided in bpf.h UAPI.

The helpers are made available to BPF_PROG_TYPE_CGROUP_SYSCTL programs to
be able to convert string input to e.g. "ulongvec" output.

E.g. "net/ipv4/tcp_mem" consists of three ulong integers. They can be
parsed by calling to bpf_strtoul three times.

Implementation notes:

Implementation includes "../../lib/kstrtox.h" to reuse integer parsing
functions. It's done exactly same way as fs/proc/base.c already does.

Unfortunately existing kstrtoX function can't be used directly since
they fail if any invalid character is present right after integer in the
string. Existing simple_strtoX functions can't be used either since
they're obsolete and don't handle overflow properly.

Signed-off-by: Andrey Ignatov <rdna@fb.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>

diff --git a/include/linux/bpf.h b/include/linux/bpf.h
index fd06ada941ad3f54ef3992f64e96dca2aadb29f4..f15432d907281861af7f65c29f5248f6ed940bc9 100644 (file)
--- a/include/linux/bpf.h
+++ b/include/linux/bpf.h
@@ -989,6 +989,8 @@ extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
 extern const struct bpf_func_proto bpf_spin_lock_proto;
 extern const struct bpf_func_proto bpf_spin_unlock_proto;
 extern const struct bpf_func_proto bpf_get_local_storage_proto;
+extern const struct bpf_func_proto bpf_strtol_proto;
+extern const struct bpf_func_proto bpf_strtoul_proto;
 
 /* Shared helpers among cBPF and eBPF. */
 void bpf_user_rnd_init_once(void);

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 89976de909af61f21c6570eaf75ac202b031a760..c26be24fd5e21956dea03ec48b0f7bc485b6e1d2 100644 (file)
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -2575,6 +2575,53 @@ union bpf_attr {
  *             **-E2BIG** if the *buf_len* is too big.
  *
  *             **-EINVAL** if sysctl is being read.
+ *
+ * int bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res)
+ *     Description
+ *             Convert the initial part of the string from buffer *buf* of
+ *             size *buf_len* to a long integer according to the given base
+ *             and save the result in *res*.
+ *
+ *             The string may begin with an arbitrary amount of white space
+ *             (as determined by isspace(3)) followed by a single optional '-'
+ *             sign.
+ *
+ *             Five least significant bits of *flags* encode base, other bits
+ *             are currently unused.
+ *
+ *             Base must be either 8, 10, 16 or 0 to detect it automatically
+ *             similar to user space strtol(3).
+ *     Return
+ *             Number of characters consumed on success. Must be positive but
+ *             no more than buf_len.
+ *
+ *             **-EINVAL** if no valid digits were found or unsupported base
+ *             was provided.
+ *
+ *             **-ERANGE** if resulting value was out of range.
+ *
+ * int bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res)
+ *     Description
+ *             Convert the initial part of the string from buffer *buf* of
+ *             size *buf_len* to an unsigned long integer according to the
+ *             given base and save the result in *res*.
+ *
+ *             The string may begin with an arbitrary amount of white space
+ *             (as determined by isspace(3)).
+ *
+ *             Five least significant bits of *flags* encode base, other bits
+ *             are currently unused.
+ *
+ *             Base must be either 8, 10, 16 or 0 to detect it automatically
+ *             similar to user space strtoul(3).
+ *     Return
+ *             Number of characters consumed on success. Must be positive but
+ *             no more than buf_len.
+ *
+ *             **-EINVAL** if no valid digits were found or unsupported base
+ *             was provided.
+ *
+ *             **-ERANGE** if resulting value was out of range.
  */
 #define __BPF_FUNC_MAPPER(FN)          \
        FN(unspec),                     \
@@ -2681,7 +2728,9 @@ union bpf_attr {
        FN(sysctl_get_name),            \
        FN(sysctl_get_current_value),   \
        FN(sysctl_get_new_value),       \
-       FN(sysctl_set_new_value),
+       FN(sysctl_set_new_value),       \
+       FN(strtol),                     \
+       FN(strtoul),
 
 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
  * function eBPF program intends to call

diff --git a/kernel/bpf/cgroup.c b/kernel/bpf/cgroup.c
index b2adf22139b30dc113c5a59783ec60ff96550544..789d4ab2336efcc3cad2eaed9bfe2bb31fd9b2ae 100644 (file)
--- a/kernel/bpf/cgroup.c
+++ b/kernel/bpf/cgroup.c
@@ -1016,6 +1016,10 @@ static const struct bpf_func_proto *
 sysctl_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
 {
        switch (func_id) {
+       case BPF_FUNC_strtol:
+               return &bpf_strtol_proto;
+       case BPF_FUNC_strtoul:
+               return &bpf_strtoul_proto;
        case BPF_FUNC_sysctl_get_name:
                return &bpf_sysctl_get_name_proto;
        case BPF_FUNC_sysctl_get_current_value:

diff --git a/kernel/bpf/helpers.c b/kernel/bpf/helpers.c
index a411fc17d265e1c7809d263df74d8881ff0d006b..4266ffde07caed42a2c704355665a4f5f7948007 100644 (file)
--- a/kernel/bpf/helpers.c
+++ b/kernel/bpf/helpers.c
@@ -18,6 +18,9 @@
 #include <linux/sched.h>
 #include <linux/uidgid.h>
 #include <linux/filter.h>
+#include <linux/ctype.h>
+
+#include "../../lib/kstrtox.h"
 
 /* If kernel subsystem is allowing eBPF programs to call this function,
  * inside its own verifier_ops->get_func_proto() callback it should return
@@ -363,4 +366,132 @@ const struct bpf_func_proto bpf_get_local_storage_proto = {
        .arg2_type      = ARG_ANYTHING,
 };
 #endif
+
+#define BPF_STRTOX_BASE_MASK 0x1F
+
+static int __bpf_strtoull(const char *buf, size_t buf_len, u64 flags,
+                         unsigned long long *res, bool *is_negative)
+{
+       unsigned int base = flags & BPF_STRTOX_BASE_MASK;
+       const char *cur_buf = buf;
+       size_t cur_len = buf_len;
+       unsigned int consumed;
+       size_t val_len;
+       char str[64];
+
+       if (!buf || !buf_len || !res || !is_negative)
+               return -EINVAL;
+
+       if (base != 0 && base != 8 && base != 10 && base != 16)
+               return -EINVAL;
+
+       if (flags & ~BPF_STRTOX_BASE_MASK)
+               return -EINVAL;
+
+       while (cur_buf < buf + buf_len && isspace(*cur_buf))
+               ++cur_buf;
+
+       *is_negative = (cur_buf < buf + buf_len && *cur_buf == '-');
+       if (*is_negative)
+               ++cur_buf;
+
+       consumed = cur_buf - buf;
+       cur_len -= consumed;
+       if (!cur_len)
+               return -EINVAL;
+
+       cur_len = min(cur_len, sizeof(str) - 1);
+       memcpy(str, cur_buf, cur_len);
+       str[cur_len] = '\0';
+       cur_buf = str;
+
+       cur_buf = _parse_integer_fixup_radix(cur_buf, &base);
+       val_len = _parse_integer(cur_buf, base, res);
+
+       if (val_len & KSTRTOX_OVERFLOW)
+               return -ERANGE;
+
+       if (val_len == 0)
+               return -EINVAL;
+
+       cur_buf += val_len;
+       consumed += cur_buf - str;
+
+       return consumed;
+}
+
+static int __bpf_strtoll(const char *buf, size_t buf_len, u64 flags,
+                        long long *res)
+{
+       unsigned long long _res;
+       bool is_negative;
+       int err;
+
+       err = __bpf_strtoull(buf, buf_len, flags, &_res, &is_negative);
+       if (err < 0)
+               return err;
+       if (is_negative) {
+               if ((long long)-_res > 0)
+                       return -ERANGE;
+               *res = -_res;
+       } else {
+               if ((long long)_res < 0)
+                       return -ERANGE;
+               *res = _res;
+       }
+       return err;
+}
+
+BPF_CALL_4(bpf_strtol, const char *, buf, size_t, buf_len, u64, flags,
+          long *, res)
+{
+       long long _res;
+       int err;
+
+       err = __bpf_strtoll(buf, buf_len, flags, &_res);
+       if (err < 0)
+               return err;
+       if (_res != (long)_res)
+               return -ERANGE;
+       *res = _res;
+       return err;
+}
+
+const struct bpf_func_proto bpf_strtol_proto = {
+       .func           = bpf_strtol,
+       .gpl_only       = false,
+       .ret_type       = RET_INTEGER,
+       .arg1_type      = ARG_PTR_TO_MEM,
+       .arg2_type      = ARG_CONST_SIZE,
+       .arg3_type      = ARG_ANYTHING,
+       .arg4_type      = ARG_PTR_TO_LONG,
+};
+
+BPF_CALL_4(bpf_strtoul, const char *, buf, size_t, buf_len, u64, flags,
+          unsigned long *, res)
+{
+       unsigned long long _res;
+       bool is_negative;
+       int err;
+
+       err = __bpf_strtoull(buf, buf_len, flags, &_res, &is_negative);
+       if (err < 0)
+               return err;
+       if (is_negative)
+               return -EINVAL;
+       if (_res != (unsigned long)_res)
+               return -ERANGE;
+       *res = _res;
+       return err;
+}
+
+const struct bpf_func_proto bpf_strtoul_proto = {
+       .func           = bpf_strtoul,
+       .gpl_only       = false,
+       .ret_type       = RET_INTEGER,
+       .arg1_type      = ARG_PTR_TO_MEM,
+       .arg2_type      = ARG_CONST_SIZE,
+       .arg3_type      = ARG_ANYTHING,
+       .arg4_type      = ARG_PTR_TO_LONG,
+};
 #endif