xref: /petsc/src/sys/utils/pdisplay.c (revision 0298fd7132830bec7daee99a80be0eddb2b310a5)
1e5c89e4eSSatish Balay 
2c6db04a5SJed Brown #include <petscsys.h>
3e5c89e4eSSatish Balay #include <stdarg.h>
4e5c89e4eSSatish Balay #if defined(PETSC_HAVE_STDLIB_H)
5e5c89e4eSSatish Balay #include <stdlib.h>
6e5c89e4eSSatish Balay #endif
7e5c89e4eSSatish Balay 
8e5c89e4eSSatish Balay #undef __FUNCT__
9e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsGetenv"
10e5c89e4eSSatish Balay /*@C
11e5c89e4eSSatish Balay      PetscOptionsGetenv - Gets an environmental variable, broadcasts to all
12e5c89e4eSSatish Balay           processors in communicator from first.
13e5c89e4eSSatish Balay 
14e5c89e4eSSatish Balay      Collective on MPI_Comm
15e5c89e4eSSatish Balay 
16e5c89e4eSSatish Balay    Input Parameters:
17e5c89e4eSSatish Balay +    comm - communicator to share variable
18e5c89e4eSSatish Balay .    name - name of environmental variable
19e5c89e4eSSatish Balay -    len - amount of space allocated to hold variable
20e5c89e4eSSatish Balay 
21e5c89e4eSSatish Balay    Output Parameters:
22*0298fd71SBarry Smith +    flag - if not NULL tells if variable found or not
23e5c89e4eSSatish Balay -    env - value of variable
24e5c89e4eSSatish Balay 
25e5c89e4eSSatish Balay   Level: advanced
26e5c89e4eSSatish Balay 
27e5c89e4eSSatish Balay    Notes:
28e5c89e4eSSatish Balay     You can also "set" the environmental variable by setting the options database value
29e5c89e4eSSatish Balay     -name "stringvalue" (with name in lower case). If name begins with PETSC_ this is
30e5c89e4eSSatish Balay     discarded before checking the database. For example, PETSC_VIEWER_SOCKET_PORT would
31e5c89e4eSSatish Balay     be given as -viewer_socket_port 9000
32e5c89e4eSSatish Balay 
33f98cea2cSBarry Smith     If comm does not contain the 0th process in the MPIEXEC it is likely on
34e5c89e4eSSatish Balay     many systems that the environmental variable will not be set unless you
35e5c89e4eSSatish Balay     put it in a universal location like a .chsrc file
36e5c89e4eSSatish Balay 
37e5c89e4eSSatish Balay @*/
387087cfbeSBarry Smith PetscErrorCode  PetscOptionsGetenv(MPI_Comm comm,const char name[],char env[],size_t len,PetscBool  *flag)
39e5c89e4eSSatish Balay {
40e5c89e4eSSatish Balay   PetscErrorCode ierr;
41e5c89e4eSSatish Balay   PetscMPIInt    rank;
42e5c89e4eSSatish Balay   char           *str,work[256];
43ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE,spetsc;
44e5c89e4eSSatish Balay 
45e5c89e4eSSatish Balay   PetscFunctionBegin;
46e5c89e4eSSatish Balay   /* first check options database */
47e5c89e4eSSatish Balay   ierr = PetscStrncmp(name,"PETSC_",6,&spetsc);CHKERRQ(ierr);
48e5c89e4eSSatish Balay 
49e5c89e4eSSatish Balay   ierr = PetscStrcpy(work,"-");CHKERRQ(ierr);
50e5c89e4eSSatish Balay   if (spetsc) {
51e5c89e4eSSatish Balay     ierr = PetscStrcat(work,name+6);CHKERRQ(ierr);
52e5c89e4eSSatish Balay   } else {
53e5c89e4eSSatish Balay     ierr = PetscStrcat(work,name);CHKERRQ(ierr);
54e5c89e4eSSatish Balay   }
55e5c89e4eSSatish Balay   ierr = PetscStrtolower(work);CHKERRQ(ierr);
56e5c89e4eSSatish Balay   if (env) {
57*0298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,work,env,len,&flg);CHKERRQ(ierr);
58e5c89e4eSSatish Balay     if (flg) {
59e5c89e4eSSatish Balay       if (flag) *flag = PETSC_TRUE;
60e5c89e4eSSatish Balay     } else { /* now check environment */
61e5c89e4eSSatish Balay       ierr = PetscMemzero(env,len*sizeof(char));CHKERRQ(ierr);
62e5c89e4eSSatish Balay 
63e5c89e4eSSatish Balay       ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
64e5c89e4eSSatish Balay       if (!rank) {
65e5c89e4eSSatish Balay         str = getenv(name);
66e5c89e4eSSatish Balay         if (str) flg = PETSC_TRUE;
67e5c89e4eSSatish Balay         if (str && env) {ierr = PetscStrncpy(env,str,len);CHKERRQ(ierr);}
68e5c89e4eSSatish Balay       }
69c3aae356SJed Brown       ierr = MPI_Bcast(&flg,1,MPIU_BOOL,0,comm);CHKERRQ(ierr);
70e5c89e4eSSatish Balay       ierr = MPI_Bcast(env,len,MPI_CHAR,0,comm);CHKERRQ(ierr);
71e5c89e4eSSatish Balay       if (flag) *flag = flg;
72e5c89e4eSSatish Balay     }
73e5c89e4eSSatish Balay   } else {
74*0298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,work,flag);CHKERRQ(ierr);
75e5c89e4eSSatish Balay   }
76e5c89e4eSSatish Balay   PetscFunctionReturn(0);
77e5c89e4eSSatish Balay }
78e5c89e4eSSatish Balay 
79e5c89e4eSSatish Balay /*
80e5c89e4eSSatish Balay      PetscSetDisplay - Tries to set the X windows display variable for all processors.
81e5c89e4eSSatish Balay                        The variable PetscDisplay contains the X windows display variable.
82e5c89e4eSSatish Balay 
83e5c89e4eSSatish Balay */
84e5c89e4eSSatish Balay static char PetscDisplay[256];
85e5c89e4eSSatish Balay 
86e5c89e4eSSatish Balay #undef __FUNCT__
8789c53ad2SJed Brown #define __FUNCT__ "PetscWorldIsSingleHost"
88ace3abfcSBarry Smith static PetscErrorCode PetscWorldIsSingleHost(PetscBool  *onehost)
8989c53ad2SJed Brown {
9089c53ad2SJed Brown   PetscErrorCode ierr;
91d64e9277SJed Brown   char           hostname[256],roothostname[256];
92d64e9277SJed Brown   PetscMPIInt    localmatch,allmatch;
93ace3abfcSBarry Smith   PetscBool      flag;
9489c53ad2SJed Brown 
9589c53ad2SJed Brown   PetscFunctionBegin;
9689c53ad2SJed Brown   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
9789c53ad2SJed Brown   ierr = PetscMemcpy(roothostname,hostname,256);CHKERRQ(ierr);
9889c53ad2SJed Brown   ierr = MPI_Bcast(roothostname,256,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
9989c53ad2SJed Brown   ierr = PetscStrcmp(hostname,roothostname,&flag);CHKERRQ(ierr);
100a297a907SKarl Rupp 
10189c53ad2SJed Brown   localmatch = (PetscMPIInt)flag;
102a297a907SKarl Rupp 
10389c53ad2SJed Brown   ierr = MPI_Allreduce(&localmatch,&allmatch,1,MPI_INT,MPI_LAND,PETSC_COMM_WORLD);CHKERRQ(ierr);
104a297a907SKarl Rupp 
105ace3abfcSBarry Smith   *onehost = (PetscBool)allmatch;
10689c53ad2SJed Brown   PetscFunctionReturn(0);
10789c53ad2SJed Brown }
10889c53ad2SJed Brown 
10989c53ad2SJed Brown 
11089c53ad2SJed Brown #undef __FUNCT__
111e5c89e4eSSatish Balay #define __FUNCT__ "PetscSetDisplay"
1127087cfbeSBarry Smith PetscErrorCode  PetscSetDisplay(void)
113e5c89e4eSSatish Balay {
114e5c89e4eSSatish Balay   PetscErrorCode ierr;
115e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
116ace3abfcSBarry Smith   PetscBool      flag,singlehost=PETSC_FALSE;
1178caf3d72SBarry Smith   char           display[sizeof(PetscDisplay)];
11889c53ad2SJed Brown   const char     *str;
119e5c89e4eSSatish Balay 
120e5c89e4eSSatish Balay   PetscFunctionBegin;
121*0298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-display",PetscDisplay,sizeof(PetscDisplay),&flag);CHKERRQ(ierr);
122e5c89e4eSSatish Balay   if (flag) PetscFunctionReturn(0);
123e5c89e4eSSatish Balay 
124e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
125e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
12689c53ad2SJed Brown 
12789c53ad2SJed Brown   ierr = PetscWorldIsSingleHost(&singlehost);CHKERRQ(ierr);
12889c53ad2SJed Brown 
129e5c89e4eSSatish Balay   str = getenv("DISPLAY");
13089c53ad2SJed Brown   if (!str) str = ":0.0";
13189c53ad2SJed Brown   if (str[0] != ':' || singlehost) {
1328caf3d72SBarry Smith     ierr = PetscStrncpy(display,str,sizeof(display));CHKERRQ(ierr);
133a297a907SKarl Rupp   } else if (!rank) {
13413f021ebSJed Brown     size_t len;
1358caf3d72SBarry Smith     ierr = PetscGetHostName(display,sizeof(display));CHKERRQ(ierr);
13613f021ebSJed Brown     ierr = PetscStrlen(display,&len);CHKERRQ(ierr);
1378caf3d72SBarry Smith     ierr = PetscStrncat(display,str,sizeof(display)-len-1);CHKERRQ(ierr);
138e5c89e4eSSatish Balay   }
1398caf3d72SBarry Smith   ierr = MPI_Bcast(display,sizeof(display),MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1408caf3d72SBarry Smith   ierr = PetscMemcpy(PetscDisplay,display,sizeof(PetscDisplay));CHKERRQ(ierr);
141a297a907SKarl Rupp 
1428caf3d72SBarry Smith   PetscDisplay[sizeof(PetscDisplay)-1] = 0;
143e5c89e4eSSatish Balay   PetscFunctionReturn(0);
144e5c89e4eSSatish Balay }
145e5c89e4eSSatish Balay 
146e5c89e4eSSatish Balay #undef __FUNCT__
147e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetDisplay"
148e5c89e4eSSatish Balay /*
149e5c89e4eSSatish Balay      PetscGetDisplay - Gets the display variable for all processors.
150e5c89e4eSSatish Balay 
151e5c89e4eSSatish Balay   Input Parameters:
152e5c89e4eSSatish Balay .   n - length of string display
153e5c89e4eSSatish Balay 
154e5c89e4eSSatish Balay   Output Parameters:
155e5c89e4eSSatish Balay .   display - the display string
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay */
1587087cfbeSBarry Smith PetscErrorCode  PetscGetDisplay(char display[],size_t n)
159e5c89e4eSSatish Balay {
160e5c89e4eSSatish Balay   PetscErrorCode ierr;
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay   PetscFunctionBegin;
163e5c89e4eSSatish Balay   ierr = PetscStrncpy(display,PetscDisplay,n);CHKERRQ(ierr);
164e5c89e4eSSatish Balay   PetscFunctionReturn(0);
165e5c89e4eSSatish Balay }
166