update tests for ctime and localtime

Author: Зишан Мирза

clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst

@@ -41,6 +41,8 @@ If *Annex K.* is not available, replacements are suggested only for the
 following functions from the previous list:
 
  - ``asctime``, ``asctime_r``, suggested replacement: ``strftime``
+ - ``ctime``, ``ctime_r``, suggested replacement: ``ctime_s``
+ - ``localtime``, ``localtime_r``, suggested replacement: ``localtime_s``
  - ``gets``, suggested replacement: ``fgets``
 
 The following functions are always checked, regardless of *Annex K* availability:

clang-tools-extra/test/clang-tidy/checkers/bugprone/unsafe-functions.c

@@ -105,7 +105,6 @@ void f3(char *S, FILE *F) {
 
 typedef int time_t;
 char *ctime(const time_t *Timer);
-struct tm *localtime(const time_t *Timer);
 
 void f4(const time_t *Timer) {
   ctime(Timer);

clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp

@@ -3532,10 +3532,20 @@ void StdLibraryFunctionsChecker::initFunctionSummaries(
         Signature(ArgTypes{ConstTime_tPtrTy}, RetType{StructTmPtrTy}),
         Summary(NoEvalCall).ArgConstraint(NotNull(ArgNo(0))));
 
-    // struct tm *localtime_r(const time_t *restrict timer,
-    //                        struct tm *restrict result);
+    // struct tm *localtime_r(const time_t *timer,
+    //                        struct tm *result);
     addToFunctionSummaryMap(
         "localtime_r",
+        Signature(ArgTypes{ConstTime_tPtrTy, StructTmPtrTy},
+                  RetType{StructTmPtrTy}),
+        Summary(NoEvalCall)
+            .ArgConstraint(NotNull(ArgNo(0)))
+            .ArgConstraint(NotNull(ArgNo(1))));
+
+    // struct tm *localtime_s(const time_t *restrict timer,
+    //                        struct tm *restrict result);
+    addToFunctionSummaryMap(
+        "localtime_s",
         Signature(ArgTypes{ConstTime_tPtrRestrictTy, StructTmPtrRestrictTy},
                   RetType{StructTmPtrTy}),
         Summary(NoEvalCall)
@@ -3564,6 +3574,17 @@ void StdLibraryFunctionsChecker::initFunctionSummaries(
                 /*Buffer=*/ArgNo(1),
                 /*MinBufSize=*/BVF.getValue(26, IntTy))));
 
+    // char *ctime_r(char *buf, rsize_t buf_size, const time_t *timep);
+    addToFunctionSummaryMap(
+        "ctime_s",
+        Signature(ArgTypes{CharPtrTy, BufferSize(ArgNo(1), BVF.getValue(26, IntTy)), ConstTime_tPtrTy}, RetType{CharPtrTy}),
+        Summary(NoEvalCall)
+            .ArgConstraint(NotNull(ArgNo(0)))
+            .ArgConstraint(NotNull(ArgNo(1)))
+            .ArgConstraint(BufferSize(
+                /*Buffer=*/ArgNo(1),
+                /*MinBufSize=*/BVF.getValue(26, IntTy))));
+
     // struct tm *gmtime_r(const time_t *restrict timer,
     //                     struct tm *restrict result);
     addToFunctionSummaryMap(

clang/lib/Tooling/Inclusions/Stdlib/StdSymbolMap.inc

@@ -2032,8 +2032,8 @@ SYMBOL(locale, std::, <locale>)
 SYMBOL(localeconv, std::, <clocale>)
 SYMBOL(localeconv, None, <clocale>)
 SYMBOL(localeconv, None, <locale.h>)
-SYMBOL(localtime, std::, <ctime>)
-SYMBOL(localtime, None, <ctime>)
+SYMBOL(localtime, std::, <localtime>)
+SYMBOL(localtime, None, <localtime>)
 SYMBOL(localtime, None, <time.h>)
 SYMBOL(lock, std::, <mutex>)
 SYMBOL(lock_guard, std::, <mutex>)

clang/test/Analysis/cert/env34-c.c

@@ -329,7 +329,7 @@ void ctime_test(void) {
   // expected-note@-2{{dereferencing an invalid pointer}}
 }
 
-void time_test(void) {
+void localtime_test(void) {
   const time_t *t;
   const time_t *tt;
 

compiler-rt/lib/dfsan/libc_ubuntu1404_abilist.txt

@@ -1547,6 +1547,7 @@ fun:ctanl=uninstrumented
 fun:ctermid=uninstrumented
 fun:ctime=uninstrumented
 fun:ctime_r=uninstrumented
+fun:ctime_s=uninstrumented
 fun:cuserid=uninstrumented
 fun:daemon=uninstrumented
 fun:dcgettext=uninstrumented
@@ -2205,6 +2206,7 @@ fun:llseek=uninstrumented
 fun:localeconv=uninstrumented
 fun:localtime=uninstrumented
 fun:localtime_r=uninstrumented
+fun:localtime_s=uninstrumented
 fun:lockf=uninstrumented
 fun:lockf64=uninstrumented
 fun:log=uninstrumented

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

@@ -1375,6 +1375,16 @@ INTERCEPTOR(__sanitizer_tm *, localtime_r, unsigned long *timep, void *result) {
   }
   return res;
 }
+INTERCEPTOR(__sanitizer_tm *, localtime_s, unsigned long *timep, void *result) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, localtime_r, timep, result);
+  __sanitizer_tm *res = REAL(localtime_r)(timep, result);
+  if (res) {
+    COMMON_INTERCEPTOR_READ_RANGE(ctx, timep, sizeof(*timep));
+    unpoison_tm(ctx, res);
+  }
+  return res;
+}
 INTERCEPTOR(__sanitizer_tm *, gmtime, unsigned long *timep) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, gmtime, timep);
@@ -1421,6 +1431,19 @@ INTERCEPTOR(char *, ctime_r, unsigned long *timep, char *result) {
   }
   return res;
 }
+INTERCEPTOR(char *, ctime_s, char* result, size_t result_size, unsigned long *timep) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, ctime_s, result, result_size, timep);
+  // FIXME: under ASan the call below may write to freed memory and corrupt
+  // its metadata. See
+  // https://github.com/google/sanitizers/issues/321.
+  char *res = REAL(ctime_r)(result, result_size, timep);
+  if (res) {
+    COMMON_INTERCEPTOR_READ_RANGE(ctx, timep, sizeof(*timep));
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, res, internal_strlen(res) + 1);
+  }
+  return res;
+}
 INTERCEPTOR(char *, asctime, __sanitizer_tm *tm) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, asctime, tm);