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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
|
/*@@
@file GHExtensions.c
@date Fri Jan 15 13:22:47 1999
@author Tom Goodale
@desc
Functions to deal with GH extensions
@enddesc
@version $Header$
@@*/
/*#define DEBUG*/
#include <stdio.h>
#include <stdlib.h>
#include "cctk_Flesh.h"
#include "cctk_FortranString.h"
#include "cctk_GHExtensions.h"
#include "StoreHandledData.h"
#include "cctk_WarnLevel.h"
#include "cctk_Schedule.h"
#include "cctki_GHExtensions.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(main_GHExtensions_c)
/********************************************************************
********************* Local Data Types ***********************
********************************************************************/
/* The GH extension structure.
* This contains pointers to functions which the extension requires.
*
* To add a new function, you must:
*
* a) Add it to this structure
* b) Initialise it to NULL in CCTK_RegisterGHExtension
* c) Check its value in CheckAllExtensionsSetup
* d) Provide a dummy function for CheckAllExtensionsSetup to use
* e) Provide a registration function.
* f) Add a prototype for the registration function to cctk_GHExtensions.h
*/
struct GHExtension
{
void *(*SetupGH)(tFleshConfig *, int, cGH *);
int (*InitGH)(cGH *);
int (*ScheduleTraverseGH)(cGH *, const char *);
};
/********************************************************************
********************* Local Routine Prototypes *********************
********************************************************************/
/* Function which checks that all the functions on all extensions have been
* filled in.
*/
static int CheckAllExtensionsSetup(void);
/* Dummy function prototypes. */
static void *DummySetupGH(tFleshConfig *config,
int convergence_level,
cGH *GH);
static int DummyInitGH(cGH *GH);
static int DummyScheduleTraverseGH(cGH *GH,
const char *where);
/********************************************************************
********************* Other Routine Prototypes *********************
********************************************************************/
void CCTK_FCALL CCTK_FNAME (CCTK_GHExtensionHandle)
(int *handle, ONE_FORTSTRING_ARG);
/********************************************************************
********************* Local Data *****************************
********************************************************************/
/* Local data holding info on extensions..*/
static cHandledData *GHExtensions = NULL;
static int num_extensions = 0;
/********************************************************************
********************* External Routines **********************
********************************************************************/
/**************************************************************************
**************************************************************************
**************************************************************************/
/*@@
@routine CCTK_RegisterGHExtension
@date Wed Feb 3 13:33:09 1999
@author Tom Goodale
@desc
Registers a new GH extension.
@enddesc
@calls
@calledby
@history
@endhistory
@var name
@vdesc Name of the extension
@vtype const char *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0+ - the handle
-1 - extension already exists
-2 - out of memory
@endreturndesc
@@*/
int CCTK_RegisterGHExtension(const char *name)
{
int handle;
struct GHExtension *new_extension;
/* Check that the extension hasn't already been registered */
handle = Util_GetHandle(GHExtensions, name, NULL);
if(handle < 0)
{
/* New extension. */
new_extension = (struct GHExtension *)malloc(sizeof(struct GHExtension));
if(new_extension)
{
/* Get a handle for it. */
handle = Util_NewHandle(&GHExtensions, name, new_extension);
#ifdef DEBUG
printf("CCTK_RegisterGHExtension: Extension %s gets handle %d\n",name,handle);
#endif
/* Initialise the extension structure. */
new_extension->InitGH = NULL;
new_extension->SetupGH = NULL;
new_extension->ScheduleTraverseGH = NULL;
/* Remember how many extensions there are */
num_extensions++;
}
else
{
/* Memory failure. */
handle = -2;
}
}
else
{
/* Extension already exists. */
handle = -1;
}
return handle;
}
/*@@
@routine CCTK_UnregisterGHExtension
@date Tue May 09 2000
@author Thomas Radke
@desc
Unregisters a GH extension.
@enddesc
@calls
@calledby
@history
@endhistory
@var name
@vdesc The name of the GH extension to unregister
@vtype const char *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0 - success
-1 - failure
@endreturndesc
@@*/
int CCTK_UnregisterGHExtension(const char *name)
{
int handle, ret_val = -1;
void *extension;
/* Check that the extension exists */
handle = Util_GetHandle(GHExtensions, name, &extension);
if(handle >= 0)
{
/* Delete extension handle and free its associated structure */
if (Util_DeleteHandle(GHExtensions, handle) == 0)
{
free (extension);
/* Remember how many extensions there are left */
num_extensions--;
ret_val = 0;
#ifdef DEBUG
printf("CCTK_UnregisterGHExtension: unregistered extension %s with "
"handle %d\n", name, handle);
#endif
}
}
return ret_val;
}
/***************************************************************************
*
* Function Registration Routines.
*
***************************************************************************/
/*@@
@routine CCTK_RegisterGHExtensionSetupGH
@date Wed Feb 3 13:34:12 1999
@author Tom Goodale
@desc
Registers a function to setup a GH extension.
@enddesc
@calls
@calledby
@history
@endhistory
@var handle
@vdesc The extension handle
@vtype int
@vio in
@vcomment
@endvar
@var func
@vdesc the function used to setup the GH extension
@vtype void *(*)(tFleshConfig *, int, cGH *)
@vio in
@vcomment
@endvar
@returntype int
@returndesc
1 - success
0 - extension doesn't exist
@endreturndesc
@@*/
int CCTK_RegisterGHExtensionSetupGH(int handle,
void *(*func)(tFleshConfig *, int, cGH *))
{
int return_code;
struct GHExtension *extension;
/* Get the extension. */
extension = Util_GetHandledData(GHExtensions, handle);
if(extension)
{
extension->SetupGH = func;
return_code = 1;
}
else
{
return_code = 0;
}
return return_code;
}
/*@@
@routine CCTK_RegisterGHExtensionInitGH
@date Wed Feb 3 13:33:36 1999
@author Tom Goodale
@desc
Registers a GH extension initialisation routine.
@enddesc
@calls
@calledby
@history
@endhistory
@var handle
@vdesc The extension handle
@vtype int
@vio in
@vcomment
@endvar
@var func
@vdesc the function used to initialise the GH extension
@vtype void *(*)(cGH *)
@vio in
@vcomment
@endvar
@returntype int
@returndesc
1 - success
0 - extension doesn't exist
@endreturndesc
@@*/
int CCTK_RegisterGHExtensionInitGH(int handle,
int (*func)(cGH *))
{
int return_code;
struct GHExtension *extension;
/* Get the extension. */
extension = Util_GetHandledData(GHExtensions, handle);
if(extension)
{
extension->InitGH = func;
return_code = 1;
}
else
{
return_code = 0;
}
return return_code;
}
/*@@
@routine CCTK_RegisterGHExtensionScheduleTraverseGH
@date Thu Jan 27 14:37:09 2000
@author Tom Goodale
@desc
Registers a GH extension Schedule traversal routine routine.
@enddesc
@calls
@calledby
@history
@endhistory
@var handle
@vdesc The extension handle
@vtype int
@vio in
@vcomment
@endvar
@var func
@vdesc the function used to perform a schedule traverse
@vtype void *(*)(cGH *, const char *)
@vio in
@vcomment
@endvar
@returntype int
@returndesc
1 - success
0 - extension doesn't exist
@endreturndesc
@@*/
int CCTK_RegisterGHExtensionScheduleTraverseGH(int handle,
int (*func)(cGH *, const char *))
{
int return_code;
struct GHExtension *extension;
/* Get the extension. */
extension = Util_GetHandledData(GHExtensions, handle);
if(extension)
{
extension->ScheduleTraverseGH = func;
return_code = 1;
}
else
{
return_code = 0;
}
return return_code;
}
/***************************************************************************
*
* Function Calling Routines.
*
***************************************************************************/
/*@@
@routine CCTKi_SetupGHExtensions
@date Wed Feb 3 13:32:26 1999
@author Tom Goodale
@desc
Sets up all registered GH extensions on a GH.
@enddesc
@calls
@calledby
@history
@endhistory
@var config
@vdesc Flesh config data
@vtype tFleshConfig
@vio in
@vcomment
@endvar
@var convergence_level
@vdesc The convergence level
@vtype int
@vio in
@vcomment
@endvar
@var GH
@vdesc the cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0 - success
1 - memory failure
2 - not all extensions properly setup
@endreturndesc
@@*/
int CCTKi_SetupGHExtensions(tFleshConfig *config,
int convergence_level,
cGH *GH)
{
int return_code;
int handle;
struct GHExtension *extension;
if(CheckAllExtensionsSetup())
{
/* Create GHExtension array on the GH. */
if(num_extensions)
{
GH->extensions = (void **)malloc(num_extensions*sizeof(void *));
}
else
{
GH->extensions = NULL;
}
if(GH->extensions || ! num_extensions)
{
for(handle = 0; handle < num_extensions; handle++)
{
/* Call the SetupGH routines for each extension. */
extension = (struct GHExtension *)Util_GetHandledData(GHExtensions, handle);
GH->extensions[handle] = extension->SetupGH(config,
convergence_level,
GH);
#ifdef DEBUG
printf("CCTKi_SetupGHExtensions: Set up extension for handle %d\n",handle);
#endif
}
return_code = 0;
}
else
{
return_code = 1;
}
}
else
{
return_code = 2;
}
return return_code;
}
/*@@
@routine CCTKi_InitGHExtensions
@date Wed Feb 3 14:12:18 1999
@author Tom Goodale
@desc
Calls the initialisation routine for a GH extension.
@enddesc
@calls
@calledby
@history
@endhistory
@var GH
@vdesc The cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0 - success
@endreturndesc
@@*/
int CCTKi_InitGHExtensions(cGH *GH)
{
int handle;
struct GHExtension *extension;
for(handle = 0; handle < num_extensions; handle++)
{
extension = (struct GHExtension *)Util_GetHandledData(GHExtensions, handle);
if(extension)
{
extension->InitGH(GH);
}
}
return 0;
}
/*@@
@routine CCTKi_ScheduleTraverseGHExtensions
@date Thu Jan 27 14:47:06 2000
@author Tom Goodale
@desc
Calls the routines which an extension needs called at a schedule traversal.
@enddesc
@calls
@calledby
@history
@endhistory
@var GH
@vdesc The cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@var where
@vdesc Schedule point to traverse
@vtype const char *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
return code of @seeroutine CCTK_ScheduleTraverse, or
0 - success
@endreturndesc
@@*/
int CCTKi_ScheduleTraverseGHExtensions(cGH *GH,
const char *where)
{
int handle, retval;
struct GHExtension *extension;
if (num_extensions <= 0)
{
retval = CCTK_ScheduleTraverse(where, GH, NULL);
}
else
{
for(handle = 0; handle < num_extensions; handle++)
{
extension = (struct GHExtension *)Util_GetHandledData(GHExtensions, handle);
if(extension)
{
extension->ScheduleTraverseGH(GH, where);
}
}
retval = 0;
}
return (retval);
}
/************************************************************************
*
* Query functions.
*
************************************************************************/
/*@@
@routine CCTK_GHExtensionHandle
@date Tue Feb 9 18:23:41 1999
@author Tom Goodale
@desc
Gets the handle to the GH extension.
@enddesc
@calls
@calledby
@history
@endhistory
@var name
@vdesc Name of the GH extension
@vtype const char *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
The GH extension handle
@endreturndesc
@@*/
int CCTK_GHExtensionHandle(const char *name)
{
return Util_GetHandle(GHExtensions, name, NULL);
}
void CCTK_FCALL CCTK_FNAME (CCTK_GHExtensionHandle)
(int *handle, ONE_FORTSTRING_ARG)
{
ONE_FORTSTRING_CREATE (name)
*handle = CCTK_GHExtensionHandle (name);
free (name);
}
/*@@
@routine CCTK_GHExtension
@date Sun Oct 8 2000
@author Thomas Radke
@desc
Gets the pointer to the GH extension.
@enddesc
@calls Util_GetHandle
@var GH
@vdesc The cctk GH
@vtype const cGH *
@vio in
@endvar
@var name
@vdesc Name of the GH extension
@vtype const char *
@vio in
@endvar
@returntype void *
@returndesc
The GH extension,
or NULL if no extension was registered under "name"
@endreturndesc
@@*/
void *CCTK_GHExtension(const cGH *GH, const char *name)
{
int handle;
handle = Util_GetHandle(GHExtensions, name, NULL);
return ((handle >= 0 && GH->extensions) ? GH->extensions[handle] : NULL);
}
/********************************************************************
********************* Local Routines *************************
********************************************************************/
/***************************************************************************
*
* Checking routines
*
***************************************************************************/
/*@@
@routine CheckAllExtensionsSetup
@date Wed Feb 3 13:34:58 1999
@author Tom Goodale
@desc
Checks the state of all extensions.
@enddesc
@calls
@calledby
@history
@endhistory
@returntype int
@returndesc
1 - all ok
@endreturndesc
@@*/
static int CheckAllExtensionsSetup(void)
{
int return_code;
int handle;
struct GHExtension *extension;
return_code = 1;
/* Check all registered extensions. */
for(handle = 0; handle < num_extensions; handle++)
{
extension = (struct GHExtension *)Util_GetHandledData(GHExtensions, handle);
if(extension)
{
/* Check that each function has been registered.
* Print a warning if not, and then register a dummy function.
*/
/* SetupGH */
if(!extension->SetupGH)
{
CCTK_VWarn(4,__LINE__,__FILE__,"Cactus",
"GH Extension '%s' has not registered a SetupGH routine",
Util_GetHandleName(GHExtensions, handle));
extension->SetupGH=DummySetupGH;
}
/* InitGH */
if(!extension->InitGH)
{
CCTK_VWarn(4,__LINE__,__FILE__,"Cactus",
"GH Extension '%s' has not registered a InitGH routine",
Util_GetHandleName(GHExtensions, handle));
extension->InitGH=DummyInitGH;
}
/* ScheduleTraverse */
if(!extension->ScheduleTraverseGH)
{
CCTK_VWarn(4,__LINE__,__FILE__,"Cactus",
"GH Extension '%s' has not registered a ScheduleTraverse routine",
Util_GetHandleName(GHExtensions, handle));
extension->ScheduleTraverseGH=DummyScheduleTraverseGH;
}
}
}
return return_code;
}
/************************************************************************
*
* Dummy functions. Registered if no real function registered.
*
************************************************************************/
/*@@
@routine DummySetupGH
@date Wed Feb 3 13:36:52 1999
@author Tom Goodale
@desc
Dummy for SetupGH functions.
@enddesc
@calls
@calledby
@history
@endhistory
@var config
@vdesc Flesh config data
@vtype tFleshConfig
@vio in
@vcomment
@endvar
@var convergence_level
@vdesc The convergence level
@vtype int
@vio in
@vcomment
@endvar
@var GH
@vdesc the cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@returntype void *
@returndesc
NULL
@endreturndesc
@@*/
static void *DummySetupGH(tFleshConfig *config,
int convergence_level,
cGH *GH)
{
config = config;
convergence_level = convergence_level;
GH = GH;
return NULL;
}
/*@@
@routine DummyInitGH
@date Wed Feb 3 13:37:31 1999
@author Tom Goodale
@desc
Dummy for InitGH functions.
@enddesc
@calls
@calledby
@history
@endhistory
@var GH
@vdesc the cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0
@endreturndesc
@@*/
static int DummyInitGH(cGH *GH)
{
GH = GH;
return 0;
}
/*@@
@routine DummyScheduleTraverseGH
@date Thu Jan 27 14:34:41 2000
@author Tom Goodale
@desc
@enddesc
@calls
@calledby
@history
@endhistory
@var GH
@vdesc the cctk GH
@vtype cGH *
@vio in
@vcomment
@endvar
@var where
@vdesc Schedule point to traverse
@vtype const char *
@vio in
@vcomment
@endvar
@returntype int
@returndesc
0
@endreturndesc
@@*/
static int DummyScheduleTraverseGH(cGH *GH,
const char *where)
{
GH = GH;
where = where;
return 0;
}
|