File: device_fbuff.jf90

package info (click to toggle)
devicexlib 0.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,528 kB
  • sloc: fortran: 15,429; f90: 7,388; sh: 3,287; makefile: 229; python: 108; ansic: 62
file content (506 lines) | stat: -rw-r--r-- 15,277 bytes parent folder | download
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
! This file is part of FBUF - Fortran BUFfers For Accelerators
! Copyright 2018 Pietro Bonfa'
! License: GPLv2

!!!!! DO NOT EDIT THIS FILE, IT'S AUTOGENERATED !!!!!

!> The **FBUF** module.

module {{modulename}}
#if defined(__CUDA)
  {{cudamod}}
#endif
  implicit none
  integer, parameter :: DP = selected_real_kind(14,200)
  integer, parameter :: LLI = selected_int_kind(15)

  TYPE :: Node
#if defined(__CUDA)
     BYTE, POINTER {% if (attributes) %}, {{attributes}} {% endif %} :: space(:)
#else
     BYTE, POINTER                 :: space(:)
#endif
     LOGICAL             :: locked
     TYPE(Node), POINTER :: Next
  END TYPE Node
  !
  private
  !
  TYPE(Node), POINTER  :: Head => null()
  !
  public :: {{typename}}
  !

!> The main **fbuf** class.
  type :: {{typename}}
     logical :: verbose = .false.
     !
   contains
     procedure :: init                     !< Initialize the class selecting buffers dimension and number per type.\
     final :: clean

     procedure :: reinit
     procedure :: dealloc

     generic, public :: lock_buffer => &
{%- for item in interfaces %}
                        lock_buffer_{{item.subname}}{% if not loop.last %}, &{% endif %}           !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor%}
     !
{%- for item in interfaces %}
     procedure, private :: lock_buffer_{{item.subname}}           !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor %}
     !
     generic, public :: release_buffer => &
{%- for item in interfaces %}
                        release_buffer_{{item.subname}}{% if not loop.last %}, &{% endif %}        !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor %}
     !
{%- for item in interfaces %}
     procedure, private :: release_buffer_{{item.subname}}           !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor %}
     !
     generic, public :: prepare_buffer => &
{%- for item in interfaces %}
                        prepare_buffer_{{item.subname}}{% if not loop.last %}, &{% endif %}        !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor %}
     !
{%- for item in interfaces %}
     procedure, private :: prepare_buffer_{{item.subname}}           !< Releases a {{item.vtype}} {{item.vrankname}} buffer
{%- endfor %}
     !
     procedure, private :: lock_space
     procedure, private :: prepare_space
     procedure, private :: release_space
     procedure, public  :: dump_status
     procedure, public  :: print_report
  end type

  
  
contains
  !> Initialize the class selecting the device type.
  subroutine init(this, info, verbose)
    use iso_c_binding
    implicit none
    class({{typename}}),  intent(inout) :: this     !< The class.
    integer,       intent(out) :: info    !< Error reporting.
                                          !<  0: ok
                                          !< -1: generic error
    logical, optional, intent(in) :: verbose
    !
    this%verbose = .false.
    if (present(verbose)) this%verbose = verbose

    if (this%verbose) write (*, *) "[{{modulename}}] Initializing buffers"
    NULLIFY (Head)
    info = 0
    !
  end subroutine init
  !
  subroutine clean(this)
    implicit none
    type({{typename}}) :: this     !< The class.
    call this%dealloc()
  end subroutine clean
  !
  subroutine dealloc(this)
    use iso_c_binding
    implicit none
    class({{typename}}) :: this     !< The class.
    integer :: i, info
    TYPE(Node), POINTER  :: temp
    i = 0
    DO WHILE (ASSOCIATED(head))
#if defined (__CUDA)
{% if attributes == 'device' %}
        IF ( ASSOCIATED(head%space) ) DEALLOCATE(head%space)
{% else %}
        IF ( ASSOCIATED(head%space) ) info = cudaFreeHost(c_loc(head%space))
{% endif %}
#else
        IF ( ASSOCIATED(head%space) ) DEALLOCATE(head%space)
#endif
        temp => head
        head => head%next
        DEALLOCATE(temp)
        i = i + 1
    END DO
    NULLIFY (Head)
    if (this%verbose) write (*, '("[{{modulename}}] Cleaned ", I2, " buffers")') i
  end subroutine dealloc
  !
  subroutine reinit(this, info)
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)  :: this     !< The class.
    integer, intent(out) :: info !< 0 -> ok ; -n -> failed, n buffers still allocated
    integer :: l
    TYPE(Node), POINTER  :: temp

    temp => Head
    l = 0
    DO WHILE (ASSOCIATED(temp))
        if (temp%locked) l = l + 1
        temp => temp%Next
    END DO
    IF ( l > 0 ) THEN
        info = -l
        return
    ELSE
        CALL this%dealloc()
        info = 0
    END IF
    !
  end subroutine reinit
  !
  subroutine dump_status(this)
    class({{typename}}), intent(inout)     :: this     !< The class.
    TYPE(Node), POINTER  :: temp
    integer :: i
    i = 1
    temp => Head
    write (*, *) "Buffer status ================="
    write (*, *) "          n        size Locked"
    DO WHILE (ASSOCIATED(temp))
        write (*,'(I12, I12, L7)') i, SIZE(TemP%space, kind=LLI), TemP%locked
        TemP => TemP%Next
        i = i + 1
    END DO
    write (*, *) "-------------------------------"
  end subroutine dump_status
  !
  subroutine print_report(this, unit)
    class({{typename}}), intent(inout)     :: this     !< The class.
    INTEGER, OPTIONAL, intent(in)          :: unit
    !
    TYPE(Node), POINTER  :: temp
    integer(kind=LLI) :: tsz
    integer :: i, l
    i = 0
    l = 0
    tsz = 0
    temp => Head
    DO WHILE (ASSOCIATED(temp))
        tsz = tsz + SIZE(temp%space, kind=LLI)
        if (temp%locked) l = l + 1
        temp => temp%Next
        i = i + 1
    END DO
    if ( present (unit) ) then
        write (unit, '("[{{modulename}}] Currently allocated ", (es12.2), " Mbytes, locked: ", (I4), " /", (I4) )') REAL(tsz)/1048576, l, i
    else
        write (*   , '("[{{modulename}}] Currently allocated ", (es12.2), " Mbytes, locked: ", (I4), " /", (I4) )') REAL(tsz)/1048576, l, i
    end if
  end subroutine print_report
  !
  subroutine lock_space(this, d, cloc, info)
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)     :: this     !< The class.
    integer(kind=LLI), intent(in)          :: d
#if defined(__CUDA)
    type({{pointer_type}}), intent(inout)  :: cloc
#else
    type(c_ptr), intent(inout)             :: cloc
#endif
    integer, intent(out)                   :: info
    !
    integer(kind=LLI) :: r, tsz, sz
    TYPE(Node), POINTER  :: temp, good
    INTEGER :: i, good_one_idx
    !
    r   = 0
    tsz = 0
    i   = 1
    !
    ! Find the smallest usable buffer
    good_one_idx = 0
    temp => Head
    NULLIFY(good)
    DO WHILE (ASSOCIATED(temp))
        sz = SIZE(TemP%space, kind=LLI)
        IF ( ( sz >= d ) .and. (TemP%locked .eqv. .false.) ) THEN
            IF ( good_one_idx >= 1 ) THEN
                IF ( sz - d < r) THEN
                    good => temp
                    r = SIZE(TemP%space, kind=LLI) - d
                    good_one_idx = i
                END IF
            ELSE
                good_one_idx = i
                good => temp
                r = sz - d
            END IF
            info = 0
        END IF
        !
        tsz = tsz + sz
        i = i + 1
        !
        TemP => TemP%Next
    END DO
    !
    ! Allocate a new buffer
    IF ( good_one_idx == 0 ) THEN
        ALLOCATE (good)
#if defined(__CUDA)
{%- if attributes == 'device' %}
        ALLOCATE (good%space(d), stat=info)
{%- else %}
        info = cudaMallocHost(cloc, int(d))
        CALL c_f_pointer( cloc, good%space, [ d ] )
        !ALLOCATE (good%space(d), stat=info)
{%- endif %}
#else
        ALLOCATE (good%space(d), stat=info)
#endif
        good%Next   => Head
        Head        => good
        tsz         = tsz + d
        if (this%verbose) write (*, '("[{{modulename}}] Created new buffer")')
    ELSE
        if (this%verbose) write (*, '("[{{modulename}}] Locked buffer", I4)') good_one_idx
    END IF
    !
    if (this%verbose) &
         write (*, '("[{{modulename}}] Currently allocated ", (es12.2), " Mbytes")') REAL(tsz)/1048576 ! 1024/1024
    !
    good%locked = .true.
#if defined(__CUDA)
{%- if attributes == 'device' %}
    cloc = c_devloc(good%space)
{%- else %}
    cloc = c_loc(good%space)
{%- endif %}
#else
    cloc = c_loc(good%space(1))
#endif
    !
  end subroutine lock_space
  !
  subroutine prepare_space(this, d, info)
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)     :: this     !< The class.
    integer(kind=LLI), intent(in)          :: d
    integer, intent(out)                   :: info
    !
#if defined(__CUDA)
    type({{pointer_type}}) :: cloc
#endif
    integer(kind=LLI) :: r, tsz, sz
    TYPE(Node), POINTER  :: temp, good
    INTEGER :: i, good_one_idx
    !
    r   = 0
    tsz = 0
    i   = 1
    !
    ! Find the smallest usable buffer
    good_one_idx = 0
    temp => Head
    NULLIFY(good)
    DO WHILE (ASSOCIATED(temp))
        sz = SIZE(TemP%space, kind=LLI)
        IF ( ( sz >= d ) .and. (TemP%locked .eqv. .false.) ) THEN
            good_one_idx = i
            info = 0
        END IF
        !
        tsz = tsz + sz
        i = i + 1
        !
        TemP => TemP%Next
    END DO
    !
    ! Allocate a new buffer if needed
    IF ( good_one_idx == 0 ) THEN
        ALLOCATE (good)
#if defined(__CUDA)
{%- if attributes == 'device' %}
        ALLOCATE (good%space(d), stat=info)
{%- else %}
        info = cudaMallocHost(cloc, int(d))
        CALL c_f_pointer( cloc, good%space, [ d ] )
{%- endif %}
#else
        ALLOCATE (good%space(d), stat=info)
#endif
        good%locked = .false.
        good%Next   => Head
        Head        => good
        tsz         = tsz + d
        if (this%verbose) write (*, '("[{{modulename}}] Created new buffer")')
    ELSE
        if (this%verbose) write (*, '("[{{modulename}}] Good buffer found: ", I4)') good_one_idx
    END IF
    !
    if (this%verbose) &
         write (*, '("[{{modulename}}] Currently allocated ", (es12.2), " Mbytes")') REAL(tsz)/1048576 ! 1024/1024
    !
  end subroutine prepare_space
  !
  subroutine release_space(this, cloc, info)
#if defined(__CUDA)
    {{cudamod}}
#endif
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)  :: this     !< The class.
#if defined(__CUDA)
    type({{pointer_type}}), intent(in) :: cloc
#else
    type(c_ptr), intent(in) :: cloc
#endif
    integer, intent(out)            :: info    
    !
    TYPE(Node), POINTER  :: temp
#if defined(__CUDA)
    type({{pointer_type}}) :: clocint
#else
    type(c_ptr)            :: clocint
#endif
    !
    integer :: i
    info = -1
    i = 1
    temp => head
    DO WHILE (ASSOCIATED(temp))
#if defined(__CUDA)
{%- if attributes == 'device' %}
        IF ( cloc == c_devloc(TemP%space) ) THEN
{%- else %}
        clocint = c_loc(TemP%space(1))
        IF ( C_ASSOCIATED(cloc, clocint) ) THEN
{%- endif %}
#else
        clocint = c_loc(TemP%space(1))
        IF ( C_ASSOCIATED(cloc, clocint) ) THEN
#endif
            TemP%locked=.false.
            info = 0
            EXIT
        END IF
        i = i + 1
        TemP => TemP%Next
    END DO
    if (this%verbose) write (*, '("[{{modulename}}] Released buffer ", I4)') i
  end subroutine release_space
  !
{% for item in interfaces %}
  !> Get or allocate a buffer for an {{ item.vtype }} {{ item.vrankname }}.
  subroutine lock_buffer_{{ item.subname }}(this, p, {{ item.vsize }}{% if item.rank == 1%}_{% endif %}, info)
#if defined(__CUDA)
    {{cudamod}}
#endif
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)  :: this     !< The class.
    {{ item.vtype }}, pointer, intent(out) :: p({{ item.ranks }})   !< Pointer possibly set to access buffer
    integer,       intent(in) :: {{ item.vsize }}{% if item.rank > 1%}{{ item.vsizedims }}{% else %}_{% endif %}   !< {{ item.vrankname }} dimension
    integer,       intent(out) :: info    !<  0: ok
                                          !< -1: no buffers left, allocating space
                                          !< -2: unexpected error, no memory left
                                          !< other values come form allocate stat
#if defined(__CUDA)
{%- if (attributes) %}
    attributes({{attributes}}) :: p
{%- endif %}
#endif
    integer(kind=LLI) :: d
#if defined(__CUDA)
    type({{pointer_type}}) :: cloc
#else
    type(c_ptr) :: cloc
#endif
    !
    {{ item.vtype }} :: dummy
    {%- if item.rank == 1%}
    integer :: {{ item.vsize }}(1)
    {{ item.vsize }}(1) = {{ item.vsize }}_
    {%- endif %}
    !
    d = PRODUCT({{ item.vsize }})
    d = d*SIZEOF(dummy)
    !
    ! Free and simple compatibility with zero dimension buffers.
    IF ( d == 0 ) d = 1
    !
    CALL this%lock_space(d, cloc, info)
    CALL c_f_pointer( cloc, p, {{ item.vsize }} )

  end subroutine lock_buffer_{{ item.subname }}
{% endfor %}
  !
{% for item in interfaces %}
  !> Release the buffer corresponding to pointer p, if associated with a buffer. Otherwise just deallocates.
  subroutine release_buffer_{{ item.subname }}(this, p, info)
#if defined(__CUDA)
    {{cudamod}}
#endif
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)  :: this     !< The class.
    {{ item.vtype }}, pointer, intent(inout) :: p({{ item.ranks }})   !< Pointer possibly pointing to buffer space
    integer, intent(out)            :: info
#if defined(__CUDA)
{%- if (attributes) %}
    attributes({{attributes}}) :: p
{%- endif %}
#endif

#if defined(__CUDA)
{% if attributes == 'device' %}
    CALL this%release_space(c_devloc(p), info)
{% else %}
    CALL this%release_space(c_loc(p), info)
{% endif %}
#else
    CALL this%release_space(c_loc(p({% for i in range(item.rank) %} lbound(p, {{ i+1 }}){% if not loop.last %}, {% endif %}{% endfor %})), info)
#endif
  end subroutine release_buffer_{{ item.subname }}
{% endfor %}
  !
{% for item in interfaces %}
  !> 
  subroutine prepare_buffer_{{ item.subname }}(this, p, {{ item.vsize }}{% if item.rank == 1%}_{% endif %}, info)
#if defined(__CUDA)
    {{cudamod}}
#endif
    use iso_c_binding
    implicit none
    class({{typename}}), intent(inout)  :: this     !< The class.
    {{ item.vtype }}, pointer, intent(out) :: p({{ item.ranks }})   !< Pointer (only used for assesing type)
    integer,       intent(in) :: {{ item.vsize }}{% if item.rank > 1%}{{ item.vsizedims }}{% else %}_{% endif %}   !< {{ item.vrankname }} dimension
    integer,       intent(out) :: info    !<  0: ok
                                          !< -1: no buffers left, allocating space
                                          !< -2: unexpected error, no memory left
                                          !< other values come form allocate stat
#if defined(__CUDA)
{%- if (attributes) %}
    attributes({{attributes}}) :: p
{%- endif %}
#endif
    integer(kind=LLI) :: d
#if defined(__CUDA)
    type({{pointer_type}}) :: cloc
#else
    type(c_ptr) :: cloc
#endif
    !
    {{ item.vtype }} :: dummy
    {%- if item.rank == 1%}
    integer :: {{ item.vsize }}(1)
    {{ item.vsize }}(1) = {{ item.vsize }}_
    {%- endif %}
    !
    d = PRODUCT({{ item.vsize }})
    d = d*SIZEOF(dummy)
    !
    CALL this%prepare_space(d, info)
    !
  end subroutine prepare_buffer_{{ item.subname }}
{% endfor %}

end module {{modulename}}