File: CommonFunctions.cmake

package info (click to toggle)
ga 5.9.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,472 kB
  • sloc: ansic: 192,963; fortran: 53,761; f90: 11,218; cpp: 5,784; makefile: 2,248; sh: 1,945; python: 1,734; perl: 534; csh: 134; asm: 106
file content (294 lines) | stat: -rw-r--r-- 10,930 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
#==================================================================
#   Copyright (c) 2018 The Regents of the University of California,
#   through Lawrence Berkeley National Laboratory.  
#
#   Author: David Williams-Young
#   
#   This file is part of cmake-modules. 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) Neither the name of the University of California, Lawrence Berkeley
#   National Laboratory, U.S. Dept. of Energy nor the names of its contributors may
#   be used to endorse or promote products derived from this software without
#   specific prior written permission.
#   
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
#   ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
#   
#   You are under no obligation whatsoever to provide any bug fixes, patches, or
#   upgrades to the features, functionality or performance of the source code
#   ("Enhancements") to anyone; however, if you choose to make your Enhancements
#   available either publicly, or directly to Lawrence Berkeley National
#   Laboratory, without imposing a separate written license agreement for such
#   Enhancements, then you hereby grant the following license: a non-exclusive,
#   royalty-free perpetual license to install, use, modify, prepare derivative
#   works, incorporate into other computer software, distribute, and sublicense
#   such enhancements or derivative works thereof, in binary and source code form.
#
#==================================================================

set( COMMON_UTILITY_CMAKE_FILE_DIR ${CMAKE_CURRENT_LIST_DIR} )

function( emulate_kitware_linalg_modules name )

  if( DEFINED BLA_STATIC AND NOT DEFINED ${name}_PREFERS_STATIC )
    if( DEFINED CACHE{BLA_STATIC} )
      set( ${name}_PREFERS_STATIC ${BLA_STATIC} CACHE BOOL 
        "Use Static ${name} LIBRARIES" )
    else()
      set( ${name}_PREFERS_STATIC ${BLA_STATIC} PARENT_SCOPE )
    endif()
  endif()

  if( DEFINED BLA_VENDOR AND NOT DEFINED ${name}_PREFERENCE_LIST )
    if( DEFINED CACHE{BLA_VENDOR} )
      set( ${name}_PREFERENCE_LIST ${BLA_VENDOR} CACHE BOOL 
        "Use Static ${name} LIBRARIES" )
    else()
      set( ${name}_PREFERENCE_LIST ${BLA_VENDOR} PARENT_SCOPE )
    endif()
  endif()

endfunction()

function( fill_out_prefix name )

  #if( ${name}_PREFIX AND NOT ${name}_INCLUDE_DIR )
  #  set( ${name}_INCLUDE_DIR ${${name}_PREFIX}/include PARENT_SCOPE )
  #endif()

  if( ${name}_PREFIX AND NOT ${name}_LIBRARY_DIR )
    set( ${name}_LIBRARY_DIR 
         "${${name}_PREFIX}/lib;${${name}_PREFIX}/lib32;${${name}_PREFIX}/lib64"
         PARENT_SCOPE
    )
  endif()

endfunction()

function( copy_meta_data _src _dest )

	#if( ${_src}_LIBRARIES AND NOT ${_dest}_LIBRARIES )
  	#  set( ${_dest}_LIBRARIES ${${_src}_LIBRARIES} PARENT_SCOPE )
  	#endif()

  if( ${_src}_PREFIX AND NOT ${_dest}_PREFIX )
    set( ${_dest}_PREFIX ${${_src}_PREFIX} PARENT_SCOPE )
  endif()

  if( ${_src}_INCLUDE_DIR AND NOT ${_dest}_INCLUDE_DIR )
    set( ${_dest}_INCLUDE_DIR ${${_src}_INCLUDE_DIR} PARENT_SCOPE )
  endif()

  if( ${_src}_LIBRARY_DIR AND NOT ${_dest}_LIBRARY_DIR )
    set( ${_dest}_LIBRARY_DIR ${${_src}_LIBRARY_DIR} PARENT_SCOPE )
  endif()

  if( ${_src}_PREFERS_STATIC AND NOT ${_dest}_PREFERS_STATIC )
    set( ${_dest}_PREFERS_STATIC  ${${_src}_PREFERS_STATIC} PARENT_SCOPE )
  endif()

  if( ${_src}_THREAD_LAYER AND NOT ${_dest}_THREAD_LAYER )
    set( ${_dest}_THREAD_LAYER  ${${_src}_THREAD_LAYER} PARENT_SCOPE )
  endif()

endfunction()


function( get_true_target_property _out _target _property )

  if( TARGET ${_target} )
    get_property( _${_target}_imported TARGET ${_target} PROPERTY IMPORTED )

    if( NOT ${_property} MATCHES "INTERFACE_LINK_LIBRARIES" )
      get_property( _${_target}_property TARGET ${_target} PROPERTY ${_property} )
    endif()

    if( _${_target}_imported )

      #message( STATUS "${_target} is IMPORTED" )

      get_property( _${_target}_link TARGET ${_target} PROPERTY INTERFACE_LINK_LIBRARIES )
      foreach( _lib ${_${_target}_link} )
        #message( STATUS "Checking ${_lib}")
        if( TARGET ${_lib} )
          get_true_target_property( _${_lib}_property ${_lib} ${_property} )
          #message( STATUS "${_lib} is a TARGET with ${_${_lib}_property}" )
          if( _${_lib}_property )
            list( APPEND _${_target}_property_imported ${_${_lib}_property} )
          endif()
        elseif( ${_property} MATCHES "INTERFACE_LINK_LIBRARIES" )
          list( APPEND _${_target}_property_imported ${_lib} )
        endif()
      endforeach()
      if(_${_target}_property_imported)
        list(APPEND _${_target}_property ${_${_target}_property_imported} )
      endif()
      set( ${_out} ${_${_target}_property} PARENT_SCOPE )
    else()
      #message( STATUS "${_target} is NOT IMPORTED" )
      #message( STATUS "Setting ${_out} to ${_${_target}_property} " )
      set( ${_out} ${_${_target}_property} PARENT_SCOPE )
    endif()
  endif()

endfunction()



function( check_function_exists_w_results _libs _func _output _result )

  try_compile( ${_result} ${CMAKE_CURRENT_BINARY_DIR}
                 SOURCES ${COMMON_UTILITY_CMAKE_FILE_DIR}/func_check.c
                 COMPILE_DEFINITIONS "-DFUNC_NAME=${_func}"
                 LINK_LIBRARIES ${_libs} 
                 OUTPUT_VARIABLE ${_output} )

  set( ${_output} "${${_output}}" PARENT_SCOPE )
  set( ${_result} "${${_result}}" PARENT_SCOPE )

endfunction()

function( append_possibly_missing_libs _linker_test __compile_output _orig_libs __new_libs )


  set( _tmp_libs )
  # Check for missing Fortran symbols
  if( ${__compile_output} MATCHES "fortran" OR ${__compile_output} MATCHES "Fortran" OR ${__compile_output} MATCHES "f90_" )
    message( STATUS 
      "  * Missing Standard Fortran Libs - Adding to ${_linker_test} linker" )
    # Check for Standard Fortran Libraries
    if(NOT STANDARDFORTRAN_LIBRARIES)
      include(CMakeFindDependencyMacro)
      find_dependency( StandardFortran )
    endif()
    list( APPEND _tmp_libs "${STANDARDFORTRAN_LIBRARIES}" )
  endif()
  
  
  if( ${__compile_output} MATCHES "omp_" )
    message( STATUS 
      "  * Missing OpenMP                - Adding to ${_linker_test} linker" )
    if( NOT TARGET OpenMP::OpenMP_C )
      find_dependency( OpenMP )
    endif()
    list( APPEND _tmp_libs OpenMP::OpenMP_C )
  endif()
  
  if( ${__compile_output} MATCHES "pthread_" )
    message( STATUS 
      "  * Missing PThreads              - Adding to ${_linker_test} linker" )
    if( NOT TARGET Threads::Threads )
      find_dependency( Threads )
      # Threads::Threads by default is not GLOBAL, so to allow users of LINALG_LIBRARIES to safely use it we need to make it global
      # more discussion here: https://gitlab.kitware.com/cmake/cmake/-/issues/17256
      set_target_properties(Threads::Threads PROPERTIES IMPORTED_GLOBAL TRUE)
    endif()
    list( APPEND _tmp_libs Threads::Threads )
  endif()
  
  if( ${__compile_output} MATCHES "logf" OR ${__compile_output} MATCHES "sqrt" )
    message( STATUS 
            "  * Missing LIBM            - Adding to ${_linker_test} linker" )
    list( APPEND _tmp_libs "m" )
  endif()
  
  set( ${__new_libs} "${_tmp_libs}" PARENT_SCOPE )

endfunction()

# _funcs = LIST of lowercase symbol name
# _namespace = namespace (BLAS, LAPACK, etc.)
function( check_fortran_functions_exist _funcs _namespace _libs _link_ok _uses_lower _uses_underscore )

  set( ${_link_ok} FALSE )
  set( ${_uses_lower} )
  set( ${_uses_underscore} )

  foreach( _uplo LOWER UPPER )

    foreach( _under UNDERSCORE NO_UNDERSCORE )

      set( _item ${_namespace}_${_uplo}_${_under} )
      message( STATUS "Performing Test ${_item}" )

      # ask linker for each symbol in _funcs, exit early if any fail
      foreach( _func IN LISTS _funcs)

        set( _${_func}_name_template "${_func}" )
        string( TO${_uplo} ${_${_func}_name_template} _${_func}_name_uplo )
        if( _under EQUAL "UNDERSCORE" )
          set( _${_func}_name "${_${_func}_name_uplo}_" )
        else()
          set( _${_func}_name "${_${_func}_name_uplo}_" )
        endif()

        check_function_exists_w_results(
              "${${_libs}}" ${_${_func}_name} _compile_output _compile_result
        )

        if( NOT _compile_result )

          append_possibly_missing_libs( ${_namespace} _compile_output ${_libs} _new_libs )
          list( APPEND ${_libs} ${_new_libs} )
          set( ${_libs} ${${_libs}} PARENT_SCOPE )

          # try linking again
          check_function_exists_w_results(
                "${${_libs}}" ${_${_func}_name} _compile_output _compile_result
          )

        endif()

        unset( _${_func}_name_template )
        unset( _${_func}_name_uplo     )

        file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
          "FUNCTION CHECK: ${_item}\n ${_compile_output}") 

        if( _compile_result )
          set( ${_link_ok} TRUE )
          string( COMPARE EQUAL "${_uplo}"  "LOWER"      ${_uses_lower}      )
          string( COMPARE EQUAL "${_under}" "UNDERSCORE" ${_uses_underscore} )
        else()
          break()  # early exit foreach if linking failed for any symbol even with extra libs
        endif()

      endforeach()  # _funcs

      if( ${${_link_ok}} )
        message( STATUS "Performing Test ${_item} -- found" )
        break()
      else ()
        message( STATUS "Performing Test ${_item} -- not found" )
      endif()

    endforeach()  # underscore

    if( ${${_link_ok}} )
      break()
    endif()

  endforeach()  # lowerupper


  set( ${_link_ok}         ${${_link_ok}}         PARENT_SCOPE )
  set( ${_uses_lower}      ${${_uses_lower}}      PARENT_SCOPE )
  set( ${_uses_underscore} ${${_uses_underscore}} PARENT_SCOPE )

endfunction()