Add lh_new() inlining

[openssl.git] / util / mkstack.pl

diff --git a/util/mkstack.pl b/util/mkstack.pl
index 30f1722312fc92b29abbb9c8b5133f5bbc471b6d..e188840595a3d371fc38caa93615441b0302e502 100755 (executable)
--- a/util/mkstack.pl
+++ b/util/mkstack.pl
@@ -1,112 +1,302 @@
 #!/usr/local/bin/perl -w
 #!/usr/local/bin/perl -w

-#
-# This is a utility that searches out "DECLARE_STACK_OF()"
-# declarations in header files, and updates/creates/replaces
-# the corresponding macro declarations that follow it. The
-# reason is that with "DEBUG_SAFESTACK" defined, each type
-# will generate 19 functions, all type-safe variants of the
-# base "sk_***" functions for the general STACK type. Without
-# DEBUG_SAFESTACK defined, we need to macro define all the
-# "type'd sk_##type##_***" functions as mapping directly to
-# the standard sk_*** equivalents. As it's not generally
-# possible to have macros that generate macros, we need to
-# control this from the "outside", here in this script.
-#
-# Geoff Thorpe, June, 2000 (with massive Perl-hacking
-#                           help from Steve Robb)

 
 

-my $type_thing;
-my $recurse = 0;
-my @files = @ARGV;
-
-while (@ARGV) {
-       my $arg = $ARGV[0];
-       if($arg eq "-recurse") {
-               $recurse = 1;
-               shift @ARGV;
-       } else {
-               last;
-       }
-}
+my $safestack = "include/openssl/safestack.h";
+my $do_write = 0;

 
 

-if($recurse) {
-       @source = (<crypto/*.[ch]>, <crypto/*/*.[ch]>, <rsaref/*.[ch]>, <ssl/*.[ch]>);
-} else {
-       @source = @ARGV;
+foreach ( @ARGV ) {
+    $do_write = 1 if $_ eq "-write";

 }
 
 }
 

+my @asn1setlst;
+my @p12stklst;
+my @lhashlst;
+my @source = (<include/openssl/*.h>, <crypto/include/internal/*.h>, <crypto/*.[ch]>, <crypto/*/*.[ch]>, <ssl/*.[ch]>, <apps/*.[ch]>);

 foreach $file (@source) {
 foreach $file (@source) {

-       # After "Configure" has been run, we need to make sure we don't
-       # overwrite symbollic links with new header files!
-       next if -l $file;
+    next if -l $file;
+
+    # Open the .c/.h file for reading
+    open(IN, "< $file") || die "Can't open $file for reading, $!";
+
+    while(<IN>) {
+        next unless /^DECLARE_/;
+        if (/^DECLARE_LHASH_OF\(([^)]+)\)/) {
+            push @lhashlst, $1;
+        }
+    }
+    close(IN);
+}
+
+my $new_stackfile = <<'EOF';
+/* automatically generated by util/mkstack.pl */
+/* ====================================================================
+ * Copyright (c) 1999-2015 The OpenSSL Project.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this
+ *    software must display the following acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please contact
+ *    openssl-core@openssl.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ *    nor may "OpenSSL" appear in their names without prior written
+ *    permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com).  This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
+ *
+ */
+
+#ifndef HEADER_SAFESTACK_H
+# define HEADER_SAFESTACK_H
+
+# include <openssl/stack.h>
+# include <openssl/e_os2.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+# ifndef CHECKED_PTR_OF
+#  define CHECKED_PTR_OF(type, p) ((void*) (1 ? p : (type*)0))
+# endif
+
+/*
+ * In C++ we get problems because an explicit cast is needed from (void *) we
+ * use CHECKED_STACK_OF to ensure the correct type is passed in the macros
+ * below.
+ */
+
+# define CHECKED_STACK_OF(type, p) \
+    ((_STACK*) (1 ? p : (STACK_OF(type)*)0))
+
+# define CHECKED_SK_COPY_FUNC(type, p) \
+    ((void *(*)(void *)) ((1 ? p : (type *(*)(const type *))0)))
+
+# define CHECKED_SK_FREE_FUNC(type, p) \
+    ((void (*)(void *)) ((1 ? p : (void (*)(type *))0)))
+
+# define CHECKED_SK_CMP_FUNC(type, p) \
+    ((int (*)(const void *, const void *)) \
+        ((1 ? p : (int (*)(const type * const *, const type * const *))0)))
+
+# define STACK_OF(type) struct stack_st_##type
+
+# define SKM_DEFINE_STACK_OF(t1, t2, t3) \
+    STACK_OF(t1); \
+    static ossl_inline int sk_##t1##_num(const STACK_OF(t1) *sk) \
+    { \
+        return sk_num((_STACK *)sk); \
+    } \
+    static ossl_inline t2 *sk_##t1##_value(const STACK_OF(t1) *sk, int idx) \
+    { \
+        return (t2 *)sk_value((_STACK *)sk, idx); \
+    } \
+    static ossl_inline STACK_OF(t1) *sk_##t1##_new(int (*cmpf)(const t3 * const *a, const t3 * const *b)) \
+    { \
+        return (STACK_OF(t1) *)sk_new((int (*)(const void *a, const void *b))cmpf); \
+    } \
+    static ossl_inline STACK_OF(t1) *sk_##t1##_new_null(void) \
+    { \
+        return (STACK_OF(t1) *)sk_new_null(); \
+    } \
+    static ossl_inline void sk_##t1##_free(const STACK_OF(t1) *sk) \
+    { \
+        sk_free((_STACK *)sk); \
+    } \
+    static ossl_inline void sk_##t1##_zero(const STACK_OF(t1) *sk) \
+    { \
+        sk_zero((_STACK *)sk); \
+    } \
+    static ossl_inline t2 *sk_##t1##_delete(STACK_OF(t1) *sk, int i) \
+    { \
+        return (t2 *)sk_delete((_STACK *)sk, i); \
+    } \
+    static ossl_inline t2 *sk_##t1##_delete_ptr(STACK_OF(t1) *sk, t2 *ptr) \
+    { \
+        return (t2 *)sk_delete_ptr((_STACK *)sk, (void *)ptr); \
+    } \
+    static ossl_inline int sk_##t1##_push(STACK_OF(t1) *sk, t2 *ptr) \
+    { \
+        return sk_push((_STACK *)sk, (void *)ptr); \
+    } \
+    static ossl_inline int sk_##t1##_unshift(STACK_OF(t1) *sk, t2 *ptr) \
+    { \
+        return sk_unshift((_STACK *)sk, (void *)ptr); \
+    } \
+    static ossl_inline t2 *sk_##t1##_pop(STACK_OF(t1) *sk) \
+    { \
+        return (t2 *)sk_pop((_STACK *)sk); \
+    } \
+    static ossl_inline t2 *sk_##t1##_shift(STACK_OF(t1) *sk) \
+    { \
+        return (t2 *)sk_shift((_STACK *)sk); \
+    } \
+    static ossl_inline void sk_##t1##_pop_free(STACK_OF(t1) *sk, void (*func)(t3 *a)) \
+    { \
+        sk_pop_free((_STACK *)sk, (void (*)(void *))func); \
+    } \
+    static ossl_inline int sk_##t1##_insert(STACK_OF(t1) *sk, t2 *ptr, int idx) \
+    { \
+        return sk_insert((_STACK *)sk, (void *)ptr, idx); \
+    } \
+    static ossl_inline t2 *sk_##t1##_set(STACK_OF(t1) *sk, int idx, t2 *ptr) \
+    { \
+        return (t2 *)sk_set((_STACK *)sk, idx, (void *)ptr); \
+    } \
+    static ossl_inline int sk_##t1##_find(STACK_OF(t1) *sk, t2 *ptr) \
+    { \
+        return sk_find((_STACK *)sk, (void *)ptr); \
+    } \
+    static ossl_inline int sk_##t1##_find_ex(STACK_OF(t1) *sk, t2 *ptr) \
+    { \
+        return sk_find_ex((_STACK *)sk, (void *)ptr); \
+    } \
+    static ossl_inline void sk_##t1##_sort(const STACK_OF(t1) *sk) \
+    { \
+        sk_sort((_STACK *)sk); \
+    } \
+    static ossl_inline int sk_##t1##_is_sorted(const STACK_OF(t1) *sk) \
+    { \
+        return sk_is_sorted((_STACK *)sk); \
+    } \
+    static ossl_inline STACK_OF(t1) * sk_##t1##_dup(STACK_OF(t1) *sk) \
+    { \
+        return (STACK_OF(t1) *)sk_dup((_STACK *)sk); \
+    } \
+    static ossl_inline STACK_OF(t1) *sk_##t1##_deep_copy(STACK_OF(t1) *sk, \
+                                                    t3 *(*copyfn)(const t3 *), \
+                                                    void (*freefn)(t3 *)) \
+    { \
+        return (STACK_OF(t1) *)sk_deep_copy((_STACK *)sk, \
+                                            (void * (*)(void *a))copyfn, \
+                                            (void (*)(void *a))freefn); \
+    } \
+    static ossl_inline int (*sk_##t1##_set_cmp_func(STACK_OF(t1) *sk, int (*cmpf)(const t3 * const *a, const t3 * const *b)))(const t3 * const *, const t3 * const *) \
+    { \
+        return (int (*)(const t3 * const *,const t3 * const *))sk_set_cmp_func((_STACK *)sk, (int (*)(const void *a, const void *b))cmpf); \
+    }

 
 

-       # Open the .c/.h file for reading
-       open(IN, "< $file") || die "Can't open $file for reading: $!";
-       open(OUT, "> $file.tmp") || die "Can't open $file.tmp for writing: $!";
+# define DEFINE_SPECIAL_STACK_OF(t1, t2) SKM_DEFINE_STACK_OF(t1, t2, t2)
+# define DEFINE_STACK_OF(t) SKM_DEFINE_STACK_OF(t, t, t)
+# define DEFINE_STACK_OF_CONST(t) SKM_DEFINE_STACK_OF(t, const t, t)

 
 

-       select(OUT);
-       process_the_file();
+/*-
+ * Strings are special: normally an lhash entry will point to a single
+ * (somewhat) mutable object. In the case of strings:
+ *
+ * a) Instead of a single char, there is an array of chars, NUL-terminated.
+ * b) The string may have be immutable.
+ *
+ * So, they need their own declarations. Especially important for
+ * type-checking tools, such as Deputy.
+ *
+ * In practice, however, it appears to be hard to have a const
+ * string. For now, I'm settling for dealing with the fact it is a
+ * string at all.
+ */
+typedef char *OPENSSL_STRING;
+typedef const char *OPENSSL_CSTRING;

 
 

-       close(OUT);
-       close(IN);
+/*-
+ * Confusingly, LHASH_OF(STRING) deals with char ** throughout, but
+ * STACK_OF(STRING) is really more like STACK_OF(char), only, as mentioned
+ * above, instead of a single char each entry is a NUL-terminated array of
+ * chars. So, we have to implement STRING specially for STACK_OF. This is
+ * dealt with in the autogenerated macros below.
+ */
+DEFINE_SPECIAL_STACK_OF(OPENSSL_STRING, char)

 
 

-       unlink($file);
-       rename("$file.tmp", $file);
+/*
+ * Similarly, we sometimes use a block of characters, NOT nul-terminated.
+ * These should also be distinguished from "normal" stacks.
+ */
+typedef void *OPENSSL_BLOCK;
+DEFINE_SPECIAL_STACK_OF(OPENSSL_BLOCK, void)
+
+/*
+ * This file is automatically generated by util/mkstack.pl
+ * Do not edit!
+ */
+
+/*
+ * SKM_sk_... stack macros are internal to safestack.h: never use them
+ * directly, use sk_<type>_... instead
+ */
+
+EOF
+
+my $old_stackfile;
+{
+    local $/ = undef;
+    open(IN, "$safestack") || die "Can't open $safestack, $!";
+    $old_stackfile = <IN>;
+    close(IN);
+}
+
+my $type_thing;
+
+foreach $type_thing (sort @lhashlst) {
+    my $lc_tt = lc $type_thing;
+    $new_stackfile .= <<EOF;
+
+# define lh_${type_thing}_doall(lh,fn) LHM_lh_doall(${type_thing},lh,fn)
+# define lh_${type_thing}_doall_arg(lh,fn,arg_type,arg) \\
+  LHM_lh_doall_arg(${type_thing},lh,fn,arg_type,arg)
+EOF

 }
 
 }
 

-sub process_the_file {
-
-       my $inside_block = 0;
-       my $output_defines = 0;
-
-       while(<IN>) {
-               if (/^DECLARE_STACK_OF\(([^)]+)\)/) {
-                       $type_thing = $1;
-                       $output_defines = 1;
-               }
-               if (m|^/\* This block of defines is updated by a perl script, please do not touch! \*/|) {
-                       $inside_block = 1;
-               }
-               if (m|^/\* End of perl script block, you may now edit :-\) \*/|) {
-                       $inside_block = 0;
-               } elsif ($inside_block == 0) {
-                       print;
-               }
-               if($output_defines == 1) {
-                       print <<EOF;
-/* This block of defines is updated by a perl script, please do not touch! */
-#ifndef DEBUG_SAFESTACK
-       #define sk_${type_thing}_new(a) sk_new((int (*) \\
-               (const char * const *, const char * const *))(a))
-       #define sk_${type_thing}_new_null() sk_new_null()
-       #define sk_${type_thing}_free(a) sk_free(a)
-       #define sk_${type_thing}_num(a) sk_num(a)
-       #define sk_${type_thing}_value(a,b) ((${type_thing} *) \\
-               sk_value((a),(b)))
-       #define sk_${type_thing}_set(a,b,c) ((${type_thing} *) \\
-               sk_set((a),(b),(char *)(c)))
-       #define sk_${type_thing}_zero(a) sk_zero(a)
-       #define sk_${type_thing}_push(a,b) sk_push((a),(char *)(b))
-       #define sk_${type_thing}_unshift(a,b) sk_unshift((a),(b))
-       #define sk_${type_thing}_find(a,b) sk_find((a), (char *)(b))
-       #define sk_${type_thing}_delete(a,b) ((${type_thing} *) \\
-               sk_delete((a),(b)))
-       #define sk_${type_thing}_delete_ptr(a,b) ((${type_thing} *) \\
-               sk_delete_ptr((a),(char *)(b)))
-       #define sk_${type_thing}_insert(a,b,c) sk_insert((a),(char *)(b),(c))
-       #define sk_${type_thing}_set_cmp_func(a,b) ((int (*) \\
-               (const ${type_thing} * const *,const ${type_thing} * const *)) \\
-               sk_set_cmp_func((a),(int (*) \\
-               (const char * const *, const char * const *))(b)))
-       #define sk_${type_thing}_dup(a) sk_dup(a)
-       #define sk_${type_thing}_pop_free(a,b) sk_pop_free((a),(void (*)(void *))(b))
-       #define sk_${type_thing}_shift(a) ((${type_thing} *)sk_shift(a))
-       #define sk_${type_thing}_pop(a) ((${type_thing} *)sk_pop(a))
-       #define sk_${type_thing}_sort(a) sk_sort(a)
-#endif /* !DEBUG_SAFESTACK */
-/* End of perl script block, you may now edit :-) */
+$new_stackfile .= <<'EOF';
+
+# ifdef  __cplusplus
+}
+# endif
+#endif

 EOF
 EOF

-                       $output_defines = 0;
-               }
-       }
+
+if ($new_stackfile eq $old_stackfile) {
+    print "No changes to $safestack.\n";

 }
 }

+elsif ($do_write) {
+    print "Writing new $safestack.\n";
+    open OUT, ">$safestack" || die "Can't open $safestack for writing, $!";
+    print OUT $new_stackfile;
+    close OUT;
+}
+
+exit 0;