Blame view

lib/strnlen_user.c 3.34 KB
b24413180   Greg Kroah-Hartman   License cleanup: ...
1
  // SPDX-License-Identifier: GPL-2.0
a08c5356a   Linus Torvalds   lib: add generic ...
2
3
4
  #include <linux/kernel.h>
  #include <linux/export.h>
  #include <linux/uaccess.h>
903f433f8   Andrey Konovalov   lib: untag user p...
5
  #include <linux/mm.h>
f5a1a536f   Aleksa Sarai   lib: introduce co...
6
  #include <linux/bitops.h>
a08c5356a   Linus Torvalds   lib: add generic ...
7
8
  
  #include <asm/word-at-a-time.h>
a08c5356a   Linus Torvalds   lib: add generic ...
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  /*
   * Do a strnlen, return length of string *with* final '\0'.
   * 'count' is the user-supplied count, while 'max' is the
   * address space maximum.
   *
   * Return 0 for exceptions (which includes hitting the address
   * space maximum), or 'count+1' if hitting the user-supplied
   * maximum count.
   *
   * NOTE! We can sometimes overshoot the user-supplied maximum
   * if it fits in a aligned 'long'. The caller needs to check
   * the return value against "> max".
   */
  static inline long do_strnlen_user(const char __user *src, unsigned long count, unsigned long max)
  {
  	const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
29da93fea   Peter Zijlstra   mm/uaccess: Use '...
25
  	unsigned long align, res = 0;
a08c5356a   Linus Torvalds   lib: add generic ...
26
27
28
  	unsigned long c;
  
  	/*
a08c5356a   Linus Torvalds   lib: add generic ...
29
30
31
  	 * Do everything aligned. But that means that we
  	 * need to also expand the maximum..
  	 */
29da93fea   Peter Zijlstra   mm/uaccess: Use '...
32
  	align = (sizeof(unsigned long) - 1) & (unsigned long)src;
a08c5356a   Linus Torvalds   lib: add generic ...
33
34
  	src -= align;
  	max += align;
1bd4403d8   Linus Torvalds   unsafe_[get|put]_...
35
  	unsafe_get_user(c, (unsigned long __user *)src, efault);
a08c5356a   Linus Torvalds   lib: add generic ...
36
37
38
39
40
41
42
43
44
45
  	c |= aligned_byte_mask(align);
  
  	for (;;) {
  		unsigned long data;
  		if (has_zero(c, &data, &constants)) {
  			data = prep_zero_mask(c, data, &constants);
  			data = create_zero_mask(data);
  			return res + find_zero(data) + 1 - align;
  		}
  		res += sizeof(unsigned long);
f18c34e48   Jan Kara   lib: Fix strnlen_...
46
47
  		/* We already handled 'unsigned long' bytes. Did we do it all ? */
  		if (unlikely(max <= sizeof(unsigned long)))
a08c5356a   Linus Torvalds   lib: add generic ...
48
49
  			break;
  		max -= sizeof(unsigned long);
1bd4403d8   Linus Torvalds   unsafe_[get|put]_...
50
  		unsafe_get_user(c, (unsigned long __user *)(src+res), efault);
a08c5356a   Linus Torvalds   lib: add generic ...
51
52
53
54
55
56
57
58
59
60
61
62
63
64
  	}
  	res -= align;
  
  	/*
  	 * Uhhuh. We hit 'max'. But was that the user-specified maximum
  	 * too? If so, return the marker for "too long".
  	 */
  	if (res >= count)
  		return count+1;
  
  	/*
  	 * Nope: we hit the address space limit, and we still had more
  	 * characters the caller would have wanted. That's 0.
  	 */
1bd4403d8   Linus Torvalds   unsafe_[get|put]_...
65
  efault:
a08c5356a   Linus Torvalds   lib: add generic ...
66
67
68
69
70
71
72
73
  	return 0;
  }
  
  /**
   * strnlen_user: - Get the size of a user string INCLUDING final NUL.
   * @str: The string to measure.
   * @count: Maximum count (including NUL character)
   *
b3c395ef5   David Hildenbrand   mm/uaccess, mm/fa...
74
75
   * Context: User context only. This function may sleep if pagefaults are
   *          enabled.
a08c5356a   Linus Torvalds   lib: add generic ...
76
77
78
79
   *
   * Get the size of a NUL-terminated string in user space.
   *
   * Returns the size of the string INCLUDING the terminating NUL.
226a07ef0   Jan Kara   lib: Clarify the ...
80
81
   * If the string is too long, returns a number larger than @count. User
   * has to check the return value against "> count".
a08c5356a   Linus Torvalds   lib: add generic ...
82
   * On exception (or invalid count), returns 0.
226a07ef0   Jan Kara   lib: Clarify the ...
83
84
85
86
87
88
   *
   * NOTE! You should basically never use this function. There is
   * almost never any valid case for using the length of a user space
   * string, since the string can be changed at any time by other
   * threads. Use "strncpy_from_user()" instead to get a stable copy
   * of the string.
a08c5356a   Linus Torvalds   lib: add generic ...
89
90
91
92
93
94
95
96
97
   */
  long strnlen_user(const char __user *str, long count)
  {
  	unsigned long max_addr, src_addr;
  
  	if (unlikely(count <= 0))
  		return 0;
  
  	max_addr = user_addr_max();
903f433f8   Andrey Konovalov   lib: untag user p...
98
  	src_addr = (unsigned long)untagged_addr(str);
a08c5356a   Linus Torvalds   lib: add generic ...
99
100
  	if (likely(src_addr < max_addr)) {
  		unsigned long max = max_addr - src_addr;
9fd4470ff   Linus Torvalds   Use the new batch...
101
  		long retval;
9f6216862   Christophe Leroy   lib: Reduce user_...
102
103
104
105
106
107
  		/*
  		 * Truncate 'max' to the user-specified limit, so that
  		 * we only have one limit we need to check in the loop
  		 */
  		if (max > count)
  			max = count;
594cc251f   Linus Torvalds   make 'user_access...
108
109
110
111
112
  		if (user_access_begin(str, max)) {
  			retval = do_strnlen_user(str, count, max);
  			user_access_end();
  			return retval;
  		}
a08c5356a   Linus Torvalds   lib: add generic ...
113
114
115
116
  	}
  	return 0;
  }
  EXPORT_SYMBOL(strnlen_user);