xref: /petsc/src/sys/ams/pams.c (revision f05ece33fd483fcf0ae47f3ecf85fefd993a83b6)
1 
2 #include <petsc-private/petscimpl.h>        /*I    "petscsys.h"   I*/
3 #include <petscviewerams.h>
4 #include <petscsys.h>
5 
6 #undef __FUNCT__
7 #define __FUNCT__ "PetscObjectAMSTakeAccess"
8 /*@C
9    PetscObjectAMSTakeAccess - Take access of the data fields that have been published to AMS so they may be changed locally
10 
11    Collective on PetscObject
12 
13    Input Parameters:
14 .  obj - the Petsc variable
15          Thus must be cast with a (PetscObject), for example,
16          PetscObjectSetName((PetscObject)mat,name);
17 
18    Level: advanced
19 
20    Concepts: publishing object
21 
22 .seealso: PetscObjectSetName(), PetscObjectAMSViewOff(), PetscObjectAMSGrantAccess()
23 
24 @*/
25 PetscErrorCode  PetscObjectAMSTakeAccess(PetscObject obj)
26 {
27   PetscFunctionBegin;
28   if (obj->amsmem != -1) {
29     PetscStackCallAMS(AMS_Memory_take_access,(obj->amsmem));
30   }
31   PetscFunctionReturn(0);
32 }
33 
34 #undef __FUNCT__
35 #define __FUNCT__ "PetscObjectAMSGrantAccess"
36 /*@C
37    PetscObjectAMSGrantAccess - Grants access of the data fields that have been published to AMS to the memory snooper to change
38 
39    Collective on PetscObject
40 
41    Input Parameters:
42 .  obj - the Petsc variable
43          Thus must be cast with a (PetscObject), for example,
44          PetscObjectSetName((PetscObject)mat,name);
45 
46    Level: advanced
47 
48    Concepts: publishing object
49 
50 .seealso: PetscObjectSetName(), PetscObjectAMSViewOff(), PetscObjectAMSTakeAccess()
51 
52 @*/
53 PetscErrorCode  PetscObjectAMSGrantAccess(PetscObject obj)
54 {
55   PetscFunctionBegin;
56   if (obj->amsmem != -1) {
57     PetscStackCallAMS(AMS_Memory_grant_access,(obj->amsmem));
58   }
59   PetscFunctionReturn(0);
60 }
61 
62 #undef __FUNCT__
63 #define __FUNCT__ "PetscObjectAMSBlock"
64 /*@C
65    PetscObjectAMSBlock - Blocks the object if PetscObjectAMSSetBlock() has been called
66 
67    Collective on PetscObject
68 
69    Input Parameters:
70 .  obj - the Petsc variable
71          Thus must be cast with a (PetscObject), for example,
72          PetscObjectSetName((PetscObject)mat,name);
73 
74 
75    Level: advanced
76 
77    Concepts: publishing object
78 
79 .seealso: PetscObjectSetName(), PetscObjectAMSViewOff(), PetscObjectAMSSetBlock()
80 
81 @*/
82 PetscErrorCode  PetscObjectAMSBlock(PetscObject obj)
83 {
84   PetscFunctionBegin;
85   PetscValidHeader(obj,1);
86 
87   if (!obj->amspublishblock) PetscFunctionReturn(0);
88   /* Eventually this will be fixed to check if the AMS client has changed the lock */
89   while (1);
90   PetscFunctionReturn(0);
91 }
92 
93 #undef __FUNCT__
94 #define __FUNCT__ "PetscObjectAMSSetBlock"
95 /*@C
96    PetscObjectAMSSetBlock - Sets whether an object will block at PetscObjectAMSBlock()
97 
98    Collective on PetscObject
99 
100    Input Parameters:
101 +  obj - the Petsc variable
102          Thus must be cast with a (PetscObject), for example,
103          PetscObjectSetName((PetscObject)mat,name);
104 -  flg - whether it should block
105 
106    Level: advanced
107 
108    Concepts: publishing object
109 
110 .seealso: PetscObjectSetName(), PetscObjectAMSViewOff(), PetscObjectAMSBlock()
111 
112 @*/
113 PetscErrorCode  PetscObjectAMSSetBlock(PetscObject obj,PetscBool flg)
114 {
115   PetscFunctionBegin;
116   PetscValidHeader(obj,1);
117   obj->amspublishblock = flg;
118   PetscFunctionReturn(0);
119 }
120 
121 #undef __FUNCT__
122 #define __FUNCT__ "PetscObjectAMSViewOff"
123 PetscErrorCode PetscObjectAMSViewOff(PetscObject obj)
124 {
125   PetscErrorCode ierr;
126 
127   PetscFunctionBegin;
128   if (obj->classid == PETSC_VIEWER_CLASSID) PetscFunctionReturn(0);
129   if (obj->amsmem == -1) PetscFunctionReturn(0);
130   ierr        = AMS_Memory_destroy(obj->amsmem);CHKERRQ(ierr);
131   obj->amsmem = -1;
132   PetscFunctionReturn(0);
133 }
134 
135