Merge pull request #10675 from xavierleroy/runtime-macro-deprecation

Add "deprecated" warnings for uses of old C runtime function names.

.gitattributes

@@ -102,6 +102,7 @@ otherlibs/win32unix/stat.c        typo.long-line
 otherlibs/win32unix/symlink.c     typo.long-line
 
 runtime/sak.c            typo.non-ascii
+runtime/caml/compatibility.h    typo.very-long-line
 
 stdlib/hashbang     typo.white-at-eol typo.missing-lf
 

Changes

@@ -23,6 +23,11 @@ Working version
 - #10549: Stack overflow detection and naked pointers checking for ARM64
   (Xavier Leroy, review by Stephen Dolan)
 
+* #10675: Emit deprecation warnings when old C runtime function names
+  are used.  This will break C stub code that uses these old names and
+  treats warnings as errors.  The workaround is to use the new names.
+  (Xavier Leroy and David Allsopp, review by Sébastien Hinderer and
+   Damien Doligez)
 
 ### Code generation and optimizations:
 

runtime/array.c

@@ -94,7 +94,7 @@ CAMLprim value caml_array_set_addr(value array, value index, value newval)
 {
   intnat idx = Long_val(index);
   if (idx < 0 || idx >= Wosize_val(array)) caml_array_bound_error();
-  Modify(&Field(array, idx), newval);
+  caml_modify(&Field(array, idx), newval);
   return Val_unit;
 }
 
@@ -156,7 +156,7 @@ CAMLprim value caml_array_unsafe_get(value array, value index)
 static value caml_array_unsafe_set_addr(value array, value index,value newval)
 {
   intnat idx = Long_val(index);
-  Modify(&Field(array, idx), newval);
+  caml_modify(&Field(array, idx), newval);
   return Val_unit;
 }
 

runtime/caml/major_gc.h

@@ -31,7 +31,7 @@ typedef struct {
 
 typedef struct {
   void *block;           /* address of the malloced block this chunk lives in */
-  asize_t alloc;         /* in bytes, used for compaction */
+  asize_t allocated;     /* in bytes, used for compaction */
   asize_t size;          /* in bytes */
   char *next;
   mark_entry redarken_first;  /* first block in chunk to redarken */
@@ -40,7 +40,7 @@ typedef struct {
 
 #define Chunk_head(c) (((heap_chunk_head *) (c)) - 1)
 #define Chunk_size(c) Chunk_head(c)->size
-#define Chunk_alloc(c) Chunk_head(c)->alloc
+#define Chunk_alloc(c) Chunk_head(c)->allocated
 #define Chunk_next(c) Chunk_head(c)->next
 #define Chunk_block(c) Chunk_head(c)->block
 

runtime/caml/memory.h

@@ -244,7 +244,9 @@ extern void caml_alloc_small_dispatch (intnat wosize, int flags,
 
 /* Deprecated alias for [caml_modify] */
 
-#define Modify(fp,val) caml_modify((fp), (val))
+#define Modify(fp,val) \
+  CAML_DEPRECATED("Modify", "caml_modify") \
+  caml_modify((fp), (val))
 
 #endif /* CAML_INTERNALS */
 

runtime/caml/misc.h

@@ -29,9 +29,7 @@
 #include <stdlib.h>
 #include <stdarg.h>
 
-/* Basic types and constants */
-
-typedef size_t asize_t;
+/* Deprecation warnings */
 
 #if defined(__GNUC__) || defined(__clang__)
   /* Supported since at least GCC 3.1 */
@@ -45,6 +43,34 @@ typedef size_t asize_t;
   #define CAMLdeprecated_typedef(name, type) typedef type name
 #endif
 
+#if defined(__GNUC__) && __STDC_VERSION__ >= 199901L || _MSC_VER >= 1925
+
+#define CAML_STRINGIFY(x) #x
+#ifdef _MSC_VER
+#define CAML_MAKEWARNING1(x) CAML_STRINGIFY(message(x))
+#else
+#define CAML_MAKEWARNING1(x) CAML_STRINGIFY(GCC warning x)
+#endif
+#define CAML_MAKEWARNING2(y) CAML_MAKEWARNING1(#y)
+#define CAML_PREPROWARNING(x) _Pragma(CAML_MAKEWARNING2(x))
+#define CAML_DEPRECATED(name1,name2) \
+  CAML_PREPROWARNING(name1 is deprecated: use name2 instead)
+
+#else
+
+#define CAML_PREPROWARNING(msg)
+#define CAML_DEPRECATED(name1,name2)
+
+#endif
+
+/* Basic types and constants */
+
+typedef size_t asize_t;
+
+#ifndef NULL
+#define NULL 0
+#endif
+
 #ifdef CAML_INTERNALS
 CAMLdeprecated_typedef(addr, char *);
 #endif /* CAML_INTERNALS */
@@ -378,9 +404,15 @@ CAMLextern int caml_read_directory(char_os * dirname,
                                    struct ext_table * contents);
 
 /* Deprecated aliases */
-#define caml_aligned_malloc caml_stat_alloc_aligned_noexc
-#define caml_strdup caml_stat_strdup
-#define caml_strconcat caml_stat_strconcat
+#define caml_aligned_malloc \
+   CAML_DEPRECATED("caml_aligned_malloc", "caml_stat_alloc_aligned_noexc") \
+   caml_stat_alloc_aligned_noexc
+#define caml_strdup \
+   CAML_DEPRECATED("caml_strdup", "caml_stat_strdup") \
+   caml_stat_strdup
+#define caml_strconcat \
+   CAML_DEPRECATED("caml_strconcat", "caml_stat_strconcat") \
+   caml_stat_strconcat
 
 #ifdef CAML_INTERNALS