Commit 411abf2d authored by Dr. Stephen Henson's avatar Dr. Stephen Henson
Browse files

Change STACK_OF to use inline functions. 



Change DECLARE_STACK_OF into inline functions. This avoids the need for
auto generated mkstack.pl macros and now handles const properly.

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
parent 249d9719

include/openssl/safestack.h

+100 −2057

File changed.

Preview size limit exceeded, changes collapsed.

util/mkstack.pl

+102 −145
Original line number Diff line number Diff line 
#!/usr/local/bin/perl -w



# Search out "DECLARE_STACK_OF()" # declarations in .h and .c files,

# and create corresponding macro declarations for crypto/stack/safestack.h.



my $safestack = "include/openssl/safestack.h";

my $do_write = 0;
@@ -10,8 +7,6 @@ foreach ( @ARGV ) { 
    $do_write = 1 if $_ eq "-write";

}



my @stacklst;

my @sstacklst;

my @asn1setlst;

my @p12stklst;

my @lhashlst;
@@ -24,13 +19,7 @@ foreach $file (@source) { 


    while(<IN>) {

        next unless /^DECLARE_/;

        if (/^DECLARE_STACK_OF\(([^)]+)\)/) {

            push @stacklst, $1;

        }

        elsif (/^DECLARE_SPECIAL_STACK_OF\(([^,\s]+)\s*,\s*([^>\s]+)\)/) {

            push @sstacklst, [$1, $2];

        }

        elsif (/^DECLARE_LHASH_OF\(([^)]+)\)/) {

        if (/^DECLARE_LHASH_OF\(([^)]+)\)/) {

            push @lhashlst, $1;

        }

    }
@@ -40,7 +29,7 @@ foreach $file (@source) { 
my $new_stackfile = <<'EOF';

/* automatically generated by util/mkstack.pl */

/* ====================================================================

 * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.

 * 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
@@ -97,6 +86,7 @@ my $new_stackfile = <<'EOF'; 
# define HEADER_SAFESTACK_H



# include <openssl/stack.h>

# include <openssl/e_os2.h>



#ifdef __cplusplus

extern "C" {
@@ -128,8 +118,104 @@ extern "C" { 
# define STACK_OF(type) struct stack_st_##type

# define PREDECLARE_STACK_OF(type) STACK_OF(type);



# define DECLARE_STACK_OF(type) STACK_OF(type);

# define DECLARE_SPECIAL_STACK_OF(type, type2) STACK_OF(type);

# define SKM_DECLARE_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 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 sk_delete((_STACK *)sk, i); \

    } \

    static ossl_inline t2 *sk_##t1##_delete_ptr(STACK_OF(t1) *sk, t2 *ptr) \

    { \

        return 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 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); \

    }



# define DECLARE_SPECIAL_STACK_OF(t1, t2) SKM_DECLARE_STACK_OF(t1, t2, t2)

# define DECLARE_STACK_OF(t) SKM_DECLARE_STACK_OF(t, t, t)

# define DECLARE_CONST_STACK_OF(t) SKM_DECLARE_STACK_OF(t, const t, t)



/*-

 * Strings are special: normally an lhash entry will point to a single
@@ -173,77 +259,7 @@ DECLARE_SPECIAL_STACK_OF(OPENSSL_BLOCK, void) 
 * SKM_sk_... stack macros are internal to safestack.h: never use them

 * directly, use sk_<type>_... instead

 */

# define SKM_sk_new(type, cmp) \

        ((STACK_OF(type) *)sk_new(CHECKED_SK_CMP_FUNC(type, cmp)))

# define SKM_sk_new_null(type) \

        ((STACK_OF(type) *)sk_new_null())

# define SKM_sk_free(type, st) \

        sk_free(CHECKED_STACK_OF(type, st))

# define SKM_sk_num(type, st) \

        sk_num(CHECKED_STACK_OF(type, st))

# define SKM_sk_value(type, st,i) \

        ((type *)sk_value(CHECKED_STACK_OF(type, st), i))

# define SKM_sk_set(type, st,i,val) \

        sk_set(CHECKED_STACK_OF(type, st), i, CHECKED_PTR_OF(type, val))

# define SKM_sk_zero(type, st) \

        sk_zero(CHECKED_STACK_OF(type, st))

# define SKM_sk_push(type, st, val) \

        sk_push(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val))

# define SKM_sk_unshift(type, st, val) \

        sk_unshift(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val))

# define SKM_sk_find(type, st, val) \

        sk_find(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val))

# define SKM_sk_find_ex(type, st, val) \

        sk_find_ex(CHECKED_STACK_OF(type, st), \

                   CHECKED_PTR_OF(type, val))

# define SKM_sk_delete(type, st, i) \

        (type *)sk_delete(CHECKED_STACK_OF(type, st), i)

# define SKM_sk_delete_ptr(type, st, ptr) \

        (type *)sk_delete_ptr(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, ptr))

# define SKM_sk_insert(type, st,val, i) \

        sk_insert(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val), i)

# define SKM_sk_set_cmp_func(type, st, cmp) \

        ((int (*)(const type * const *,const type * const *)) \

        sk_set_cmp_func(CHECKED_STACK_OF(type, st), CHECKED_SK_CMP_FUNC(type, cmp)))

# define SKM_sk_dup(type, st) \

        (STACK_OF(type) *)sk_dup(CHECKED_STACK_OF(type, st))

# define SKM_sk_pop_free(type, st, free_func) \

        sk_pop_free(CHECKED_STACK_OF(type, st), CHECKED_SK_FREE_FUNC(type, free_func))

# define SKM_sk_deep_copy(type, st, copy_func, free_func) \

        (STACK_OF(type) *)sk_deep_copy(CHECKED_STACK_OF(type, st), CHECKED_SK_COPY_FUNC(type, copy_func), CHECKED_SK_FREE_FUNC(type, free_func))

# define SKM_sk_shift(type, st) \

        (type *)sk_shift(CHECKED_STACK_OF(type, st))

# define SKM_sk_pop(type, st) \

        (type *)sk_pop(CHECKED_STACK_OF(type, st))

# define SKM_sk_sort(type, st) \

        sk_sort(CHECKED_STACK_OF(type, st))

# define SKM_sk_is_sorted(type, st) \

        sk_is_sorted(CHECKED_STACK_OF(type, st))



# define SKM_ASN1_SET_OF_d2i(type, st, pp, length, d2i_func, free_func, ex_tag, ex_class) \

  (STACK_OF(type) *)d2i_ASN1_SET( \

                                (STACK_OF(OPENSSL_BLOCK) **)CHECKED_PTR_OF(STACK_OF(type)*, st), \

                                pp, length, \

                                CHECKED_D2I_OF(type, d2i_func), \

                                CHECKED_SK_FREE_FUNC(type, free_func), \

                                ex_tag, ex_class)

# define SKM_ASN1_SET_OF_i2d(type, st, pp, i2d_func, ex_tag, ex_class, is_set) \

        i2d_ASN1_SET(CHECKED_STACK_OF(type, st), pp, \

                                CHECKED_I2D_OF(type, i2d_func), \

                                ex_tag, ex_class, is_set)



# define SKM_ASN1_seq_pack(type, st, i2d_func, buf, len) \

        ASN1_seq_pack(CHECKED_PTR_OF(STACK_OF(type), st), \

                        CHECKED_I2D_OF(type, i2d_func), buf, len)

# define SKM_ASN1_seq_unpack(type, buf, len, d2i_func, free_func) \

        (STACK_OF(type) *)ASN1_seq_unpack(buf, \

                              len, CHECKED_D2I_OF(type, d2i_func), \

                              CHECKED_SK_FREE_FUNC(type, free_func))

# define SKM_PKCS12_decrypt_d2i(type, algor, d2i_func, free_func, pass, passlen, oct, seq) \

        (STACK_OF(type) *)PKCS12_decrypt_d2i(algor, \

                                CHECKED_D2I_OF(type, d2i_func), \

                                CHECKED_SK_FREE_FUNC(type, free_func), \

                                pass, passlen, oct, seq)



EOF



my $old_stackfile;
@@ -255,65 +271,6 @@ my $old_stackfile; 
}



my $type_thing;

foreach $type_thing (sort @stacklst) {

    $new_stackfile .= <<EOF;



# define sk_${type_thing}_new(cmp) SKM_sk_new($type_thing, (cmp))

# define sk_${type_thing}_new_null() SKM_sk_new_null($type_thing)

# define sk_${type_thing}_free(st) SKM_sk_free($type_thing, (st))

# define sk_${type_thing}_num(st) SKM_sk_num($type_thing, (st))

# define sk_${type_thing}_value(st, i) SKM_sk_value($type_thing, (st), (i))

# define sk_${type_thing}_set(st, i, val) SKM_sk_set($type_thing, (st), (i), (val))

# define sk_${type_thing}_zero(st) SKM_sk_zero($type_thing, (st))

# define sk_${type_thing}_push(st, val) SKM_sk_push($type_thing, (st), (val))

# define sk_${type_thing}_unshift(st, val) SKM_sk_unshift($type_thing, (st), (val))

# define sk_${type_thing}_find(st, val) SKM_sk_find($type_thing, (st), (val))

# define sk_${type_thing}_find_ex(st, val) SKM_sk_find_ex($type_thing, (st), (val))

# define sk_${type_thing}_delete(st, i) SKM_sk_delete($type_thing, (st), (i))

# define sk_${type_thing}_delete_ptr(st, ptr) SKM_sk_delete_ptr($type_thing, (st), (ptr))

# define sk_${type_thing}_insert(st, val, i) SKM_sk_insert($type_thing, (st), (val), (i))

# define sk_${type_thing}_set_cmp_func(st, cmp) SKM_sk_set_cmp_func($type_thing, (st), (cmp))

# define sk_${type_thing}_dup(st) SKM_sk_dup($type_thing, st)

# define sk_${type_thing}_pop_free(st, free_func) SKM_sk_pop_free($type_thing, (st), (free_func))

# define sk_${type_thing}_deep_copy(st, copy_func, free_func) SKM_sk_deep_copy($type_thing, (st), (copy_func), (free_func))

# define sk_${type_thing}_shift(st) SKM_sk_shift($type_thing, (st))

# define sk_${type_thing}_pop(st) SKM_sk_pop($type_thing, (st))

# define sk_${type_thing}_sort(st) SKM_sk_sort($type_thing, (st))

# define sk_${type_thing}_is_sorted(st) SKM_sk_is_sorted($type_thing, (st))

EOF

}



foreach $type_thing (sort { $a->[0] cmp $b->[0]} @sstacklst) {

    my $t1 = $type_thing->[0];

    my $t2 = $type_thing->[1];

    $new_stackfile .= <<EOF;



# define sk_${t1}_new(cmp) ((STACK_OF($t1) *)sk_new(CHECKED_SK_CMP_FUNC($t2, cmp)))

# define sk_${t1}_new_null() ((STACK_OF($t1) *)sk_new_null())

# define sk_${t1}_push(st, val) sk_push(CHECKED_STACK_OF($t1, st), CHECKED_PTR_OF($t2, val))

# define sk_${t1}_find(st, val) sk_find(CHECKED_STACK_OF($t1, st), CHECKED_PTR_OF($t2, val))

# define sk_${t1}_value(st, i) (($t1)sk_value(CHECKED_STACK_OF($t1, st), i))

# define sk_${t1}_num(st) SKM_sk_num($t1, st)

# define sk_${t1}_pop_free(st, free_func) sk_pop_free(CHECKED_STACK_OF($t1, st), CHECKED_SK_FREE_FUNC($t2, free_func))

# define sk_${t1}_deep_copy(st, copy_func, free_func) ((STACK_OF($t1) *)sk_deep_copy(CHECKED_STACK_OF($t1, st), CHECKED_SK_COPY_FUNC($t2, copy_func), CHECKED_SK_FREE_FUNC($t2, free_func)))

# define sk_${t1}_insert(st, val, i) sk_insert(CHECKED_STACK_OF($t1, st), CHECKED_PTR_OF($t2, val), i)

# define sk_${t1}_free(st) SKM_sk_free(${t1}, st)

# define sk_${t1}_set(st, i, val) sk_set(CHECKED_STACK_OF($t1, st), i, CHECKED_PTR_OF($t2, val))

# define sk_${t1}_zero(st) SKM_sk_zero($t1, (st))

# define sk_${t1}_unshift(st, val) sk_unshift(CHECKED_STACK_OF($t1, st), CHECKED_PTR_OF($t2, val))

# define sk_${t1}_find_ex(st, val) sk_find_ex((_STACK *)CHECKED_CONST_PTR_OF(STACK_OF($t1), st), CHECKED_CONST_PTR_OF($t2, val))

# define sk_${t1}_delete(st, i) SKM_sk_delete($t1, (st), (i))

# define sk_${t1}_delete_ptr(st, ptr) ($t1 *)sk_delete_ptr(CHECKED_STACK_OF($t1, st), CHECKED_PTR_OF($t2, ptr))

# define sk_${t1}_set_cmp_func(st, cmp)  \\

        ((int (*)(const $t2 * const *,const $t2 * const *)) \\

        sk_set_cmp_func(CHECKED_STACK_OF($t1, st), CHECKED_SK_CMP_FUNC($t2, cmp)))

# define sk_${t1}_dup(st) SKM_sk_dup($t1, st)

# define sk_${t1}_shift(st) SKM_sk_shift($t1, (st))

# define sk_${t1}_pop(st) ($t2 *)sk_pop(CHECKED_STACK_OF($t1, st))

# define sk_${t1}_sort(st) SKM_sk_sort($t1, (st))

# define sk_${t1}_is_sorted(st) SKM_sk_is_sorted($t1, (st))

EOF

}



foreach $type_thing (sort @lhashlst) {

    my $lc_tt = lc $type_thing;