strnlen_user.c 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. #include <linux/kernel.h>
  2. #include <linux/export.h>
  3. #include <linux/uaccess.h>
  4. #include <asm/word-at-a-time.h>
  5. /* Set bits in the first 'n' bytes when loaded from memory */
  6. #ifdef __LITTLE_ENDIAN
  7. # define aligned_byte_mask(n) ((1ul << 8*(n))-1)
  8. #else
  9. # define aligned_byte_mask(n) (~0xfful << (BITS_PER_LONG - 8 - 8*(n)))
  10. #endif
  11. /*
  12. * Do a strnlen, return length of string *with* final '\0'.
  13. * 'count' is the user-supplied count, while 'max' is the
  14. * address space maximum.
  15. *
  16. * Return 0 for exceptions (which includes hitting the address
  17. * space maximum), or 'count+1' if hitting the user-supplied
  18. * maximum count.
  19. *
  20. * NOTE! We can sometimes overshoot the user-supplied maximum
  21. * if it fits in a aligned 'long'. The caller needs to check
  22. * the return value against "> max".
  23. */
  24. static inline long do_strnlen_user(const char __user *src, unsigned long count, unsigned long max)
  25. {
  26. const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
  27. long align, res = 0;
  28. unsigned long c;
  29. /*
  30. * Truncate 'max' to the user-specified limit, so that
  31. * we only have one limit we need to check in the loop
  32. */
  33. if (max > count)
  34. max = count;
  35. /*
  36. * Do everything aligned. But that means that we
  37. * need to also expand the maximum..
  38. */
  39. align = (sizeof(long) - 1) & (unsigned long)src;
  40. src -= align;
  41. max += align;
  42. if (unlikely(__get_user(c,(unsigned long __user *)src)))
  43. return 0;
  44. c |= aligned_byte_mask(align);
  45. for (;;) {
  46. unsigned long data;
  47. if (has_zero(c, &data, &constants)) {
  48. data = prep_zero_mask(c, data, &constants);
  49. data = create_zero_mask(data);
  50. return res + find_zero(data) + 1 - align;
  51. }
  52. res += sizeof(unsigned long);
  53. /* We already handled 'unsigned long' bytes. Did we do it all ? */
  54. if (unlikely(max <= sizeof(unsigned long)))
  55. break;
  56. max -= sizeof(unsigned long);
  57. if (unlikely(__get_user(c,(unsigned long __user *)(src+res))))
  58. return 0;
  59. }
  60. res -= align;
  61. /*
  62. * Uhhuh. We hit 'max'. But was that the user-specified maximum
  63. * too? If so, return the marker for "too long".
  64. */
  65. if (res >= count)
  66. return count+1;
  67. /*
  68. * Nope: we hit the address space limit, and we still had more
  69. * characters the caller would have wanted. That's 0.
  70. */
  71. return 0;
  72. }
  73. /**
  74. * strnlen_user: - Get the size of a user string INCLUDING final NUL.
  75. * @str: The string to measure.
  76. * @count: Maximum count (including NUL character)
  77. *
  78. * Context: User context only. This function may sleep.
  79. *
  80. * Get the size of a NUL-terminated string in user space.
  81. *
  82. * Returns the size of the string INCLUDING the terminating NUL.
  83. * If the string is too long, returns 'count+1'.
  84. * On exception (or invalid count), returns 0.
  85. */
  86. long strnlen_user(const char __user *str, long count)
  87. {
  88. unsigned long max_addr, src_addr;
  89. if (unlikely(count <= 0))
  90. return 0;
  91. max_addr = user_addr_max();
  92. src_addr = (unsigned long)str;
  93. if (likely(src_addr < max_addr)) {
  94. unsigned long max = max_addr - src_addr;
  95. return do_strnlen_user(str, count, max);
  96. }
  97. return 0;
  98. }
  99. EXPORT_SYMBOL(strnlen_user);
  100. /**
  101. * strlen_user: - Get the size of a user string INCLUDING final NUL.
  102. * @str: The string to measure.
  103. *
  104. * Context: User context only. This function may sleep.
  105. *
  106. * Get the size of a NUL-terminated string in user space.
  107. *
  108. * Returns the size of the string INCLUDING the terminating NUL.
  109. * On exception, returns 0.
  110. *
  111. * If there is a limit on the length of a valid string, you may wish to
  112. * consider using strnlen_user() instead.
  113. */
  114. long strlen_user(const char __user *str)
  115. {
  116. unsigned long max_addr, src_addr;
  117. max_addr = user_addr_max();
  118. src_addr = (unsigned long)str;
  119. if (likely(src_addr < max_addr)) {
  120. unsigned long max = max_addr - src_addr;
  121. return do_strnlen_user(str, ~0ul, max);
  122. }
  123. return 0;
  124. }
  125. EXPORT_SYMBOL(strlen_user);