xref: /petsc/src/sys/classes/viewer/impls/socket/send.c (revision d71ae5a4db6382e7f06317b8d368875286fe9008)
15c6c1daeSBarry Smith 
25c6c1daeSBarry Smith #include <petscsys.h>
35c6c1daeSBarry Smith 
45c6c1daeSBarry Smith #if defined(PETSC_NEEDS_UTYPE_TYPEDEFS)
55c6c1daeSBarry Smith /* Some systems have inconsistent include files that use but do not
65c6c1daeSBarry Smith    ensure that the following definitions are made */
75c6c1daeSBarry Smith typedef unsigned char  u_char;
85c6c1daeSBarry Smith typedef unsigned short u_short;
95c6c1daeSBarry Smith typedef unsigned short ushort;
105c6c1daeSBarry Smith typedef unsigned int   u_int;
115c6c1daeSBarry Smith typedef unsigned long  u_long;
125c6c1daeSBarry Smith #endif
135c6c1daeSBarry Smith 
145c6c1daeSBarry Smith #include <errno.h>
155c6c1daeSBarry Smith #include <ctype.h>
165c6c1daeSBarry Smith #if defined(PETSC_HAVE_MACHINE_ENDIAN_H)
175c6c1daeSBarry Smith   #include <machine/endian.h>
185c6c1daeSBarry Smith #endif
195c6c1daeSBarry Smith #if defined(PETSC_HAVE_UNISTD_H)
205c6c1daeSBarry Smith   #include <unistd.h>
215c6c1daeSBarry Smith #endif
225c6c1daeSBarry Smith #if defined(PETSC_HAVE_SYS_SOCKET_H)
235c6c1daeSBarry Smith   #include <sys/socket.h>
245c6c1daeSBarry Smith #endif
255c6c1daeSBarry Smith #if defined(PETSC_HAVE_SYS_WAIT_H)
265c6c1daeSBarry Smith   #include <sys/wait.h>
275c6c1daeSBarry Smith #endif
285c6c1daeSBarry Smith #if defined(PETSC_HAVE_NETINET_IN_H)
295c6c1daeSBarry Smith   #include <netinet/in.h>
305c6c1daeSBarry Smith #endif
315c6c1daeSBarry Smith #if defined(PETSC_HAVE_NETDB_H)
325c6c1daeSBarry Smith   #include <netdb.h>
335c6c1daeSBarry Smith #endif
345c6c1daeSBarry Smith #if defined(PETSC_HAVE_FCNTL_H)
355c6c1daeSBarry Smith   #include <fcntl.h>
365c6c1daeSBarry Smith #endif
375c6c1daeSBarry Smith #if defined(PETSC_HAVE_IO_H)
385c6c1daeSBarry Smith   #include <io.h>
395c6c1daeSBarry Smith #endif
405c6c1daeSBarry Smith #if defined(PETSC_HAVE_WINSOCK2_H)
415c6c1daeSBarry Smith   #include <Winsock2.h>
425c6c1daeSBarry Smith #endif
435c6c1daeSBarry Smith #include <sys/stat.h>
445c6c1daeSBarry Smith #include <../src/sys/classes/viewer/impls/socket/socket.h>
455c6c1daeSBarry Smith 
465c6c1daeSBarry Smith #if defined(PETSC_NEED_CLOSE_PROTO)
478cc058d9SJed Brown PETSC_EXTERN int close(int);
485c6c1daeSBarry Smith #endif
495c6c1daeSBarry Smith #if defined(PETSC_NEED_SOCKET_PROTO)
508cc058d9SJed Brown PETSC_EXTERN int socket(int, int, int);
515c6c1daeSBarry Smith #endif
525c6c1daeSBarry Smith #if defined(PETSC_NEED_SLEEP_PROTO)
538cc058d9SJed Brown PETSC_EXTERN int sleep(unsigned);
545c6c1daeSBarry Smith #endif
555c6c1daeSBarry Smith #if defined(PETSC_NEED_CONNECT_PROTO)
568cc058d9SJed Brown PETSC_EXTERN int connect(int, struct sockaddr *, int);
575c6c1daeSBarry Smith #endif
585c6c1daeSBarry Smith 
595c6c1daeSBarry Smith /*--------------------------------------------------------------*/
60*d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerDestroy_Socket(PetscViewer viewer)
61*d71ae5a4SJacob Faibussowitsch {
625c6c1daeSBarry Smith   PetscViewer_Socket *vmatlab = (PetscViewer_Socket *)viewer->data;
635c6c1daeSBarry Smith   PetscErrorCode      ierr;
645c6c1daeSBarry Smith 
655c6c1daeSBarry Smith   PetscFunctionBegin;
665c6c1daeSBarry Smith   if (vmatlab->port) {
675c6c1daeSBarry Smith #if defined(PETSC_HAVE_CLOSESOCKET)
685c6c1daeSBarry Smith     ierr = closesocket(vmatlab->port);
695c6c1daeSBarry Smith #else
705c6c1daeSBarry Smith     ierr = close(vmatlab->port);
715c6c1daeSBarry Smith #endif
7228b400f6SJacob Faibussowitsch     PetscCheck(!ierr, PETSC_COMM_SELF, PETSC_ERR_SYS, "System error closing socket");
735c6c1daeSBarry Smith   }
749566063dSJacob Faibussowitsch   PetscCall(PetscFree(vmatlab));
752e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinarySetSkipHeader_C", NULL));
762e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinaryGetSkipHeader_C", NULL));
772e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinaryGetFlowControl_C", NULL));
785c6c1daeSBarry Smith   PetscFunctionReturn(0);
795c6c1daeSBarry Smith }
805c6c1daeSBarry Smith 
815c6c1daeSBarry Smith /*--------------------------------------------------------------*/
824683183fSBarry Smith /*@C
835c6c1daeSBarry Smith     PetscSocketOpen - handles connected to an open port where someone is waiting.
845c6c1daeSBarry Smith 
854683183fSBarry Smith     Input Parameters:
864683183fSBarry Smith +    url - for example www.mcs.anl.gov
874683183fSBarry Smith -    portnum - for example 80
884683183fSBarry Smith 
8901d2d390SJose E. Roman     Output Parameter:
904683183fSBarry Smith .    t - the socket number
914683183fSBarry Smith 
9295452b02SPatrick Sanan     Notes:
9395452b02SPatrick Sanan     Use close() to close the socket connection
944683183fSBarry Smith 
95811af0c4SBarry Smith     Use read() or `PetscHTTPRequest()` to read from the socket
964683183fSBarry Smith 
974683183fSBarry Smith     Level: advanced
984683183fSBarry Smith 
99db781477SPatrick Sanan .seealso: `PetscSocketListen()`, `PetscSocketEstablish()`, `PetscHTTPRequest()`, `PetscHTTPSConnect()`
1004683183fSBarry Smith @*/
101*d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscOpenSocket(const char hostname[], int portnum, int *t)
102*d71ae5a4SJacob Faibussowitsch {
1035c6c1daeSBarry Smith   struct sockaddr_in sa;
1045c6c1daeSBarry Smith   struct hostent    *hp;
1055c6c1daeSBarry Smith   int                s      = 0;
1065c6c1daeSBarry Smith   PetscBool          flg    = PETSC_TRUE;
1074a285bdaSBarry Smith   static int         refcnt = 0;
1085c6c1daeSBarry Smith 
1095c6c1daeSBarry Smith   PetscFunctionBegin;
1105c6c1daeSBarry Smith   if (!(hp = gethostbyname(hostname))) {
1115c6c1daeSBarry Smith     perror("SEND: error gethostbyname: ");
11298921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error open connection to %s", hostname);
1135c6c1daeSBarry Smith   }
1149566063dSJacob Faibussowitsch   PetscCall(PetscMemzero(&sa, sizeof(sa)));
1159566063dSJacob Faibussowitsch   PetscCall(PetscMemcpy(&sa.sin_addr, hp->h_addr_list[0], hp->h_length));
1165c6c1daeSBarry Smith 
1175c6c1daeSBarry Smith   sa.sin_family = hp->h_addrtype;
1185c6c1daeSBarry Smith   sa.sin_port   = htons((u_short)portnum);
1195c6c1daeSBarry Smith   while (flg) {
1205c6c1daeSBarry Smith     if ((s = socket(hp->h_addrtype, SOCK_STREAM, 0)) < 0) {
1219371c9d4SSatish Balay       perror("SEND: error socket");
1229371c9d4SSatish Balay       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error");
1235c6c1daeSBarry Smith     }
1245c6c1daeSBarry Smith     if (connect(s, (struct sockaddr *)&sa, sizeof(sa)) < 0) {
1255c6c1daeSBarry Smith #if defined(PETSC_HAVE_WSAGETLASTERROR)
1265c6c1daeSBarry Smith       ierr = WSAGetLastError();
127a297a907SKarl Rupp       if (ierr == WSAEADDRINUSE) (*PetscErrorPrintf)("SEND: address is in use\n");
128a297a907SKarl Rupp       else if (ierr == WSAEALREADY) (*PetscErrorPrintf)("SEND: socket is non-blocking \n");
129a297a907SKarl Rupp       else if (ierr == WSAEISCONN) {
1305c6c1daeSBarry Smith         (*PetscErrorPrintf)("SEND: socket already connected\n");
1315c6c1daeSBarry Smith         Sleep((unsigned)1);
1325c6c1daeSBarry Smith       } else if (ierr == WSAECONNREFUSED) {
1335c6c1daeSBarry Smith         /* (*PetscErrorPrintf)("SEND: forcefully rejected\n"); */
1345c6c1daeSBarry Smith         Sleep((unsigned)1);
1355c6c1daeSBarry Smith       } else {
1369371c9d4SSatish Balay         perror(NULL);
1379371c9d4SSatish Balay         SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error");
1385c6c1daeSBarry Smith       }
1395c6c1daeSBarry Smith #else
140a297a907SKarl Rupp       if (errno == EADDRINUSE) (*PetscErrorPrintf)("SEND: address is in use\n");
141a297a907SKarl Rupp       else if (errno == EALREADY) (*PetscErrorPrintf)("SEND: socket is non-blocking \n");
142a297a907SKarl Rupp       else if (errno == EISCONN) {
1435c6c1daeSBarry Smith         (*PetscErrorPrintf)("SEND: socket already connected\n");
1445c6c1daeSBarry Smith         sleep((unsigned)1);
1455c6c1daeSBarry Smith       } else if (errno == ECONNREFUSED) {
1464a285bdaSBarry Smith         refcnt++;
14708401ef6SPierre Jolivet         PetscCheck(refcnt <= 5, PETSC_COMM_SELF, PETSC_ERR_SYS, "Connection refused by remote host %s port %d", hostname, portnum);
1489566063dSJacob Faibussowitsch         PetscCall(PetscInfo(NULL, "Connection refused in attaching socket, trying again\n"));
1495c6c1daeSBarry Smith         sleep((unsigned)1);
1505c6c1daeSBarry Smith       } else {
1519371c9d4SSatish Balay         perror(NULL);
1529371c9d4SSatish Balay         SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error");
1535c6c1daeSBarry Smith       }
1545c6c1daeSBarry Smith #endif
1555c6c1daeSBarry Smith       flg = PETSC_TRUE;
1565c6c1daeSBarry Smith #if defined(PETSC_HAVE_CLOSESOCKET)
1575c6c1daeSBarry Smith       closesocket(s);
1585c6c1daeSBarry Smith #else
1595c6c1daeSBarry Smith       close(s);
1605c6c1daeSBarry Smith #endif
161a297a907SKarl Rupp     } else flg = PETSC_FALSE;
1625c6c1daeSBarry Smith   }
1635c6c1daeSBarry Smith   *t = s;
1645c6c1daeSBarry Smith   PetscFunctionReturn(0);
1655c6c1daeSBarry Smith }
1665c6c1daeSBarry Smith 
1674683183fSBarry Smith /*@C
1685c6c1daeSBarry Smith    PetscSocketEstablish - starts a listener on a socket
1695c6c1daeSBarry Smith 
1704683183fSBarry Smith    Input Parameters:
1714683183fSBarry Smith .    portnumber - the port to wait at
1724683183fSBarry Smith 
1734683183fSBarry Smith    Output Parameters:
174811af0c4SBarry Smith .     ss - the socket to be used with `PetscSocketListen()`
1754683183fSBarry Smith 
1764683183fSBarry Smith     Level: advanced
1774683183fSBarry Smith 
178db781477SPatrick Sanan .seealso: `PetscSocketListen()`, `PetscOpenSocket()`
1794683183fSBarry Smith @*/
180*d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscSocketEstablish(int portnum, int *ss)
181*d71ae5a4SJacob Faibussowitsch {
182589a23caSBarry Smith   static size_t      MAXHOSTNAME = 100;
1835c6c1daeSBarry Smith   char               myname[MAXHOSTNAME + 1];
1845c6c1daeSBarry Smith   int                s;
1855c6c1daeSBarry Smith   struct sockaddr_in sa;
1865c6c1daeSBarry Smith   struct hostent    *hp;
1875c6c1daeSBarry Smith 
1885c6c1daeSBarry Smith   PetscFunctionBegin;
1899566063dSJacob Faibussowitsch   PetscCall(PetscGetHostName(myname, sizeof(myname)));
1905c6c1daeSBarry Smith 
1919566063dSJacob Faibussowitsch   PetscCall(PetscMemzero(&sa, sizeof(struct sockaddr_in)));
1925c6c1daeSBarry Smith 
1935c6c1daeSBarry Smith   hp = gethostbyname(myname);
19428b400f6SJacob Faibussowitsch   PetscCheck(hp, PETSC_COMM_SELF, PETSC_ERR_SYS, "Unable to get hostent information from system");
1955c6c1daeSBarry Smith 
1965c6c1daeSBarry Smith   sa.sin_family = hp->h_addrtype;
1975c6c1daeSBarry Smith   sa.sin_port   = htons((u_short)portnum);
1985c6c1daeSBarry Smith 
199cc73adaaSBarry Smith   PetscCheck((s = socket(AF_INET, SOCK_STREAM, 0)) >= 0, PETSC_COMM_SELF, PETSC_ERR_SYS, "Error running socket() command");
2005c6c1daeSBarry Smith #if defined(PETSC_HAVE_SO_REUSEADDR)
2015c6c1daeSBarry Smith   {
2025c6c1daeSBarry Smith     int optval = 1; /* Turn on the option */
2039566063dSJacob Faibussowitsch     PetscCall(setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (char *)&optval, sizeof(optval)));
2045c6c1daeSBarry Smith   }
2055c6c1daeSBarry Smith #endif
2065c6c1daeSBarry Smith 
2075c6c1daeSBarry Smith   while (bind(s, (struct sockaddr *)&sa, sizeof(sa)) < 0) {
2085c6c1daeSBarry Smith #if defined(PETSC_HAVE_WSAGETLASTERROR)
2095c6c1daeSBarry Smith     ierr = WSAGetLastError();
2105c6c1daeSBarry Smith     if (ierr != WSAEADDRINUSE) {
2115c6c1daeSBarry Smith #else
2125c6c1daeSBarry Smith     if (errno != EADDRINUSE) {
2135c6c1daeSBarry Smith #endif
2145c6c1daeSBarry Smith       close(s);
2155c6c1daeSBarry Smith       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "Error from bind()");
2165c6c1daeSBarry Smith     }
2175c6c1daeSBarry Smith   }
2185c6c1daeSBarry Smith   listen(s, 0);
2195c6c1daeSBarry Smith   *ss = s;
2205c6c1daeSBarry Smith   return (0);
2215c6c1daeSBarry Smith }
2225c6c1daeSBarry Smith 
2234683183fSBarry Smith /*@C
224811af0c4SBarry Smith    PetscSocketListen - Listens at a socket created with `PetscSocketEstablish()`
2254683183fSBarry Smith 
2264683183fSBarry Smith    Input Parameter:
227811af0c4SBarry Smith .    listenport - obtained with `PetscSocketEstablish()`
2284683183fSBarry Smith 
2294683183fSBarry Smith    Output Parameter:
2304683183fSBarry Smith .     t - pass this to read() to read what is passed to this connection
2314683183fSBarry Smith 
2324683183fSBarry Smith     Level: advanced
2335c6c1daeSBarry Smith 
234db781477SPatrick Sanan .seealso: `PetscSocketEstablish()`
2354683183fSBarry Smith @*/
236*d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscSocketListen(int listenport, int *t)
237*d71ae5a4SJacob Faibussowitsch {
2385c6c1daeSBarry Smith   struct sockaddr_in isa;
2395c6c1daeSBarry Smith #if defined(PETSC_HAVE_ACCEPT_SIZE_T)
2405c6c1daeSBarry Smith   size_t i;
2415c6c1daeSBarry Smith #else
2425c6c1daeSBarry Smith   int i;
2435c6c1daeSBarry Smith #endif
2445c6c1daeSBarry Smith 
2455c6c1daeSBarry Smith   PetscFunctionBegin;
2465c6c1daeSBarry Smith   /* wait for someone to try to connect */
2475c6c1daeSBarry Smith   i = sizeof(struct sockaddr_in);
248cc73adaaSBarry Smith   PetscCheck((*t = accept(listenport, (struct sockaddr *)&isa, (socklen_t *)&i)) >= 0, PETSC_COMM_SELF, PETSC_ERR_SYS, "error from accept()");
2495c6c1daeSBarry Smith   PetscFunctionReturn(0);
2505c6c1daeSBarry Smith }
2515c6c1daeSBarry Smith 
2525c6c1daeSBarry Smith /*@C
253a30fc760SBarry Smith    PetscViewerSocketOpen - Opens a connection to a MATLAB or other socket based server.
2545c6c1daeSBarry Smith 
255d083f849SBarry Smith    Collective
2565c6c1daeSBarry Smith 
2575c6c1daeSBarry Smith    Input Parameters:
2585c6c1daeSBarry Smith +  comm - the MPI communicator
259750b007cSBarry Smith .  machine - the machine the server is running on, use NULL for the local machine, use "server" to passively wait for
2605c6c1daeSBarry Smith              a connection from elsewhere
261811af0c4SBarry Smith -  port - the port to connect to, use `PETSC_DEFAULT` for the default
2625c6c1daeSBarry Smith 
2635c6c1daeSBarry Smith    Output Parameter:
2645c6c1daeSBarry Smith .  lab - a context to use when communicating with the server
2655c6c1daeSBarry Smith 
266811af0c4SBarry Smith    Options Database Keys:
267811af0c4SBarry Smith    For use with  `PETSC_VIEWER_SOCKET_WORLD`, `PETSC_VIEWER_SOCKET_SELF`,
268811af0c4SBarry Smith    `PETSC_VIEWER_SOCKET_()` or if
269811af0c4SBarry Smith     NULL is passed for machine or PETSC_DEFAULT is passed for port
270811af0c4SBarry Smith $    -viewer_socket_machine <machine>
271811af0c4SBarry Smith $    -viewer_socket_port <port>
272811af0c4SBarry Smith 
273811af0c4SBarry Smith    Environmental variables:
274811af0c4SBarry Smith +   `PETSC_VIEWER_SOCKET_PORT` - portnumber
275811af0c4SBarry Smith -   `PETSC_VIEWER_SOCKET_MACHINE` - machine name
276811af0c4SBarry Smith 
2775c6c1daeSBarry Smith    Level: intermediate
2785c6c1daeSBarry Smith 
2795c6c1daeSBarry Smith    Notes:
2805c6c1daeSBarry Smith    Most users should employ the following commands to access the
281811af0c4SBarry Smith    MATLAB `PetscViewer`
2825c6c1daeSBarry Smith $
2835c6c1daeSBarry Smith $    PetscViewerSocketOpen(MPI_Comm comm, char *machine,int port,PetscViewer &viewer)
2845c6c1daeSBarry Smith $    MatView(Mat matrix,PetscViewer viewer)
2855c6c1daeSBarry Smith $
2865c6c1daeSBarry Smith $                or
2875c6c1daeSBarry Smith $
2885c6c1daeSBarry Smith $    PetscViewerSocketOpen(MPI_Comm comm,char *machine,int port,PetscViewer &viewer)
2895c6c1daeSBarry Smith $    VecView(Vec vector,PetscViewer viewer)
2905c6c1daeSBarry Smith 
291750b007cSBarry Smith      Currently the only socket client available is MATLAB, PETSc must be configured with --with-matlab for this client. See
292c4762a1bSJed Brown      src/dm/tests/ex12.c and ex12.m for an example of usage.
2935c6c1daeSBarry Smith 
29495452b02SPatrick Sanan     The socket viewer is in some sense a subclass of the binary viewer, to read and write to the socket
295811af0c4SBarry Smith     use `PetscViewerBinaryRead()`, `PetscViewerBinaryWrite()`, `PetscViewerBinarWriteStringArray()`, `PetscViewerBinaryGetDescriptor()`.
296a30fc760SBarry Smith 
297811af0c4SBarry Smith      Use this for communicating with an interactive MATLAB session, see `PETSC_VIEWER_MATLAB_()` for writing output to a
298811af0c4SBarry Smith      .mat file. Use `PetscMatlabEngineCreate()` or `PETSC_MATLAB_ENGINE_()`, `PETSC_MATLAB_ENGINE_SELF`, or `PETSC_MATLAB_ENGINE_WORLD`
299a30fc760SBarry Smith      for communicating with a MATLAB Engine
3005c6c1daeSBarry Smith 
301811af0c4SBarry Smith .seealso: `PETSCVIEWERBINARY`, `PETSCVIEWERSOCKET`, `MatView()`, `VecView()`, `PetscViewerDestroy()`, `PetscViewerCreate()`, `PetscViewerSetType()`,
302db781477SPatrick Sanan           `PetscViewerSocketSetConnection()`, `PETSC_VIEWER_SOCKET_`, `PETSC_VIEWER_SOCKET_WORLD`,
303db781477SPatrick Sanan           `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`, `PetscViewerBinaryWriteStringArray()`,
304db781477SPatrick Sanan           `PetscBinaryViewerGetDescriptor()`, `PetscMatlabEngineCreate()`
3055c6c1daeSBarry Smith @*/
306*d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscViewerSocketOpen(MPI_Comm comm, const char machine[], int port, PetscViewer *lab)
307*d71ae5a4SJacob Faibussowitsch {
3085c6c1daeSBarry Smith   PetscFunctionBegin;
3099566063dSJacob Faibussowitsch   PetscCall(PetscViewerCreate(comm, lab));
3109566063dSJacob Faibussowitsch   PetscCall(PetscViewerSetType(*lab, PETSCVIEWERSOCKET));
3119566063dSJacob Faibussowitsch   PetscCall(PetscViewerSocketSetConnection(*lab, machine, port));
3125c6c1daeSBarry Smith   PetscFunctionReturn(0);
3135c6c1daeSBarry Smith }
3145c6c1daeSBarry Smith 
315*d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerSetFromOptions_Socket(PetscViewer v, PetscOptionItems *PetscOptionsObject)
316*d71ae5a4SJacob Faibussowitsch {
3175c6c1daeSBarry Smith   PetscInt  def = -1;
3185c6c1daeSBarry Smith   char      sdef[256];
3195c6c1daeSBarry Smith   PetscBool tflg;
3205c6c1daeSBarry Smith 
3215c6c1daeSBarry Smith   PetscFunctionBegin;
3225c6c1daeSBarry Smith   /*
3235c6c1daeSBarry Smith        These options are not processed here, they are processed in PetscViewerSocketSetConnection(), they
3245c6c1daeSBarry Smith     are listed here for the GUI to display
3255c6c1daeSBarry Smith   */
326d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "Socket PetscViewer Options");
3279566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_PORT", sdef, 16, &tflg));
3285c6c1daeSBarry Smith   if (tflg) {
3299566063dSJacob Faibussowitsch     PetscCall(PetscOptionsStringToInt(sdef, &def));
330a297a907SKarl Rupp   } else def = PETSCSOCKETDEFAULTPORT;
3319566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-viewer_socket_port", "Port number to use for socket", "PetscViewerSocketSetConnection", def, NULL, NULL));
3325c6c1daeSBarry Smith 
3339566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-viewer_socket_machine", "Machine to use for socket", "PetscViewerSocketSetConnection", sdef, NULL, sizeof(sdef), NULL));
3349566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_MACHINE", sdef, sizeof(sdef), &tflg));
33548a46eb9SPierre Jolivet   if (!tflg) PetscCall(PetscGetHostName(sdef, sizeof(sdef)));
336d0609cedSBarry Smith   PetscOptionsHeadEnd();
3375c6c1daeSBarry Smith   PetscFunctionReturn(0);
3385c6c1daeSBarry Smith }
3395c6c1daeSBarry Smith 
340*d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerBinaryGetSkipHeader_Socket(PetscViewer viewer, PetscBool *skip)
341*d71ae5a4SJacob Faibussowitsch {
3424c9f2355SSatish Balay   PetscViewer_Socket *vsocket = (PetscViewer_Socket *)viewer->data;
3434c9f2355SSatish Balay 
3444c9f2355SSatish Balay   PetscFunctionBegin;
3454c9f2355SSatish Balay   *skip = vsocket->skipheader;
3464c9f2355SSatish Balay   PetscFunctionReturn(0);
3474c9f2355SSatish Balay }
3484c9f2355SSatish Balay 
349*d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerBinarySetSkipHeader_Socket(PetscViewer viewer, PetscBool skip)
350*d71ae5a4SJacob Faibussowitsch {
3514c9f2355SSatish Balay   PetscViewer_Socket *vsocket = (PetscViewer_Socket *)viewer->data;
3524c9f2355SSatish Balay 
3534c9f2355SSatish Balay   PetscFunctionBegin;
3544c9f2355SSatish Balay   vsocket->skipheader = skip;
3554c9f2355SSatish Balay   PetscFunctionReturn(0);
3564c9f2355SSatish Balay }
3574c9f2355SSatish Balay 
358*d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerBinaryGetFlowControl_Socket(PetscViewer viewer, PetscInt *fc)
359*d71ae5a4SJacob Faibussowitsch {
3604c9f2355SSatish Balay   PetscFunctionBegin;
3614c9f2355SSatish Balay   *fc = 0;
3624c9f2355SSatish Balay   PetscFunctionReturn(0);
3634c9f2355SSatish Balay }
3644c9f2355SSatish Balay 
3658556b5ebSBarry Smith /*MC
3668556b5ebSBarry Smith    PETSCVIEWERSOCKET - A viewer that writes to a Unix socket
3678556b5ebSBarry Smith 
368811af0c4SBarry Smith   Level: beginner
369811af0c4SBarry Smith 
370811af0c4SBarry Smith .seealso: `PETSC_VIEWERBINARY`, `PetscViewerSocketOpen()`, `PetscViewerDrawOpen()`, `PETSC_VIEWER_DRAW_()`, `PETSC_VIEWER_DRAW_SELF`, `PETSC_VIEWER_DRAW_WORLD`,
371db781477SPatrick Sanan           `PetscViewerCreate()`, `PetscViewerASCIIOpen()`, `PetscViewerBinaryOpen()`, `PETSCVIEWERBINARY`, `PETSCVIEWERDRAW`,
372db781477SPatrick Sanan           `PetscViewerMatlabOpen()`, `VecView()`, `DMView()`, `PetscViewerMatlabPutArray()`, `PETSCVIEWERASCII`, `PETSCVIEWERMATLAB`,
373db781477SPatrick Sanan           `PetscViewerFileSetName()`, `PetscViewerFileSetMode()`, `PetscViewerFormat`, `PetscViewerType`, `PetscViewerSetType()`
3748556b5ebSBarry Smith M*/
3758556b5ebSBarry Smith 
376*d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscViewerCreate_Socket(PetscViewer v)
377*d71ae5a4SJacob Faibussowitsch {
3785c6c1daeSBarry Smith   PetscViewer_Socket *vmatlab;
3795c6c1daeSBarry Smith 
3805c6c1daeSBarry Smith   PetscFunctionBegin;
3814dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&vmatlab));
3825c6c1daeSBarry Smith   vmatlab->port          = 0;
3835c6c1daeSBarry Smith   v->data                = (void *)vmatlab;
3845c6c1daeSBarry Smith   v->ops->destroy        = PetscViewerDestroy_Socket;
38502c9f0b5SLisandro Dalcin   v->ops->flush          = NULL;
3865c6c1daeSBarry Smith   v->ops->setfromoptions = PetscViewerSetFromOptions_Socket;
3875c6c1daeSBarry Smith 
3885c6c1daeSBarry Smith   /* lie and say this is a binary viewer; then all the XXXView_Binary() methods will work correctly on it */
3899566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)v, PETSCVIEWERBINARY));
3909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinarySetSkipHeader_C", PetscViewerBinarySetSkipHeader_Socket));
3919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinaryGetSkipHeader_C", PetscViewerBinaryGetSkipHeader_Socket));
3929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinaryGetFlowControl_C", PetscViewerBinaryGetFlowControl_Socket));
3934c9f2355SSatish Balay 
3945c6c1daeSBarry Smith   PetscFunctionReturn(0);
3955c6c1daeSBarry Smith }
3965c6c1daeSBarry Smith 
3975c6c1daeSBarry Smith /*@C
3985c6c1daeSBarry Smith       PetscViewerSocketSetConnection - Sets the machine and port that a PETSc socket
3995c6c1daeSBarry Smith              viewer is to use
4005c6c1daeSBarry Smith 
401811af0c4SBarry Smith   Logically Collective on v
4025c6c1daeSBarry Smith 
4035c6c1daeSBarry Smith   Input Parameters:
4045c6c1daeSBarry Smith +   v - viewer to connect
4050298fd71SBarry Smith .   machine - host to connect to, use NULL for the local machine,use "server" to passively wait for
4065c6c1daeSBarry Smith              a connection from elsewhere
407811af0c4SBarry Smith -   port - the port on the machine one is connecting to, use `PETSC_DEFAULT` for default
4085c6c1daeSBarry Smith 
4095c6c1daeSBarry Smith     Level: advanced
4105c6c1daeSBarry Smith 
411811af0c4SBarry Smith .seealso: `PETSCVIEWERMATLAB`, `PETSCVIEWERSOCKET`, `PetscViewerSocketOpen()`
4125c6c1daeSBarry Smith @*/
413*d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscViewerSocketSetConnection(PetscViewer v, const char machine[], int port)
414*d71ae5a4SJacob Faibussowitsch {
4155c6c1daeSBarry Smith   PetscMPIInt         rank;
4165c6c1daeSBarry Smith   char                mach[256];
4175c6c1daeSBarry Smith   PetscBool           tflg;
4183ca90d2dSJacob Faibussowitsch   PetscViewer_Socket *vmatlab;
4195c6c1daeSBarry Smith 
4205c6c1daeSBarry Smith   PetscFunctionBegin;
4213ca90d2dSJacob Faibussowitsch   PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 1);
4223ca90d2dSJacob Faibussowitsch   if (machine) PetscValidCharPointer(machine, 2);
4233ca90d2dSJacob Faibussowitsch   vmatlab = (PetscViewer_Socket *)v->data;
4245c6c1daeSBarry Smith   /* PetscValidLogicalCollectiveInt(v,port,3); not a PetscInt */
4255c6c1daeSBarry Smith   if (port <= 0) {
4265c6c1daeSBarry Smith     char portn[16];
4279566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_PORT", portn, 16, &tflg));
4285c6c1daeSBarry Smith     if (tflg) {
4295c6c1daeSBarry Smith       PetscInt pport;
4309566063dSJacob Faibussowitsch       PetscCall(PetscOptionsStringToInt(portn, &pport));
4315c6c1daeSBarry Smith       port = (int)pport;
432a297a907SKarl Rupp     } else port = PETSCSOCKETDEFAULTPORT;
4335c6c1daeSBarry Smith   }
4345c6c1daeSBarry Smith   if (!machine) {
4359566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_MACHINE", mach, sizeof(mach), &tflg));
43648a46eb9SPierre Jolivet     if (!tflg) PetscCall(PetscGetHostName(mach, sizeof(mach)));
4375c6c1daeSBarry Smith   } else {
4389566063dSJacob Faibussowitsch     PetscCall(PetscStrncpy(mach, machine, sizeof(mach)));
4395c6c1daeSBarry Smith   }
4405c6c1daeSBarry Smith 
4419566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)v), &rank));
442dd400576SPatrick Sanan   if (rank == 0) {
4439566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(mach, "server", &tflg));
4445c6c1daeSBarry Smith     if (tflg) {
4455c6c1daeSBarry Smith       int listenport;
4469566063dSJacob Faibussowitsch       PetscCall(PetscInfo(v, "Waiting for connection from socket process on port %d\n", port));
4479566063dSJacob Faibussowitsch       PetscCall(PetscSocketEstablish(port, &listenport));
4489566063dSJacob Faibussowitsch       PetscCall(PetscSocketListen(listenport, &vmatlab->port));
4495c6c1daeSBarry Smith       close(listenport);
4505c6c1daeSBarry Smith     } else {
4519566063dSJacob Faibussowitsch       PetscCall(PetscInfo(v, "Connecting to socket process on port %d machine %s\n", port, mach));
4529566063dSJacob Faibussowitsch       PetscCall(PetscOpenSocket(mach, port, &vmatlab->port));
4535c6c1daeSBarry Smith     }
4545c6c1daeSBarry Smith   }
4555c6c1daeSBarry Smith   PetscFunctionReturn(0);
4565c6c1daeSBarry Smith }
4575c6c1daeSBarry Smith 
4585c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/
4595c6c1daeSBarry Smith /*
4605c6c1daeSBarry Smith     The variable Petsc_Viewer_Socket_keyval is used to indicate an MPI attribute that
4615c6c1daeSBarry Smith   is attached to a communicator, in this case the attribute is a PetscViewer.
4625c6c1daeSBarry Smith */
463d4c7638eSBarry Smith PetscMPIInt Petsc_Viewer_Socket_keyval = MPI_KEYVAL_INVALID;
4645c6c1daeSBarry Smith 
4655c6c1daeSBarry Smith /*@C
4665c6c1daeSBarry Smith      PETSC_VIEWER_SOCKET_ - Creates a socket viewer shared by all processors in a communicator.
4675c6c1daeSBarry Smith 
468d083f849SBarry Smith      Collective
4695c6c1daeSBarry Smith 
4705c6c1daeSBarry Smith      Input Parameter:
471811af0c4SBarry Smith .    comm - the MPI communicator to share the  `PETSCVIEWERSOCKET` `PetscViewer`
4725c6c1daeSBarry Smith 
4735c6c1daeSBarry Smith      Level: intermediate
4745c6c1daeSBarry Smith 
4755c6c1daeSBarry Smith    Options Database Keys:
476811af0c4SBarry Smith    For use with the default `PETSC_VIEWER_SOCKET_WORLD` or if
477811af0c4SBarry Smith     NULL is passed for machine or `PETSC_DEFAULT` is passed for port
4785c6c1daeSBarry Smith $    -viewer_socket_machine <machine>
4795c6c1daeSBarry Smith $    -viewer_socket_port <port>
4805c6c1daeSBarry Smith 
4815c6c1daeSBarry Smith    Environmental variables:
482811af0c4SBarry Smith +   `PETSC_VIEWER_SOCKET_PORT` - portnumber
483811af0c4SBarry Smith -   `PETSC_VIEWER_SOCKET_MACHINE` - machine name
4845c6c1daeSBarry Smith 
4855c6c1daeSBarry Smith      Notes:
486811af0c4SBarry Smith      Unlike almost all other PETSc routines, `PETSC_VIEWER_SOCKET_()` does not return
487811af0c4SBarry Smith      an error code, it returns NULL if it fails. The  `PETSCVIEWERSOCKET`  `PetscViewer` is usually used in the form
4885c6c1daeSBarry Smith $       XXXView(XXX object,PETSC_VIEWER_SOCKET_(comm));
4895c6c1daeSBarry Smith 
4905c6c1daeSBarry Smith      Currently the only socket client available is MATLAB. See
491c4762a1bSJed Brown      src/dm/tests/ex12.c and ex12.m for an example of usage.
4925c6c1daeSBarry Smith 
493811af0c4SBarry Smith      Connects to a waiting socket and stays connected until `PetscViewerDestroy()` is called.
4945c6c1daeSBarry Smith 
495811af0c4SBarry Smith      Use this for communicating with an interactive MATLAB session, see `PETSC_VIEWER_MATLAB_()` for writing output to a
496811af0c4SBarry Smith      .mat file. Use `PetscMatlabEngineCreate()` or `PETSC_MATLAB_ENGINE_()`, `PETSC_MATLAB_ENGINE_SELF`, or `PETSC_MATLAB_ENGINE_WORLD`
497a30fc760SBarry Smith      for communicating with a MATLAB Engine
4985c6c1daeSBarry Smith 
499811af0c4SBarry Smith .seealso: `PETSCVIEWERMATLAB`, `PETSCVIEWERSOCKET`, `PETSC_VIEWER_SOCKET_WORLD`, `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerSocketOpen()`, `PetscViewerCreate()`,
500db781477SPatrick Sanan           `PetscViewerSocketSetConnection()`, `PetscViewerDestroy()`, `PETSC_VIEWER_SOCKET_()`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`,
501db781477SPatrick Sanan           `PetscViewerBinaryWriteStringArray()`, `PetscViewerBinaryGetDescriptor()`, `PETSC_VIEWER_MATLAB_()`
5025c6c1daeSBarry Smith @*/
503*d71ae5a4SJacob Faibussowitsch PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm comm)
504*d71ae5a4SJacob Faibussowitsch {
5055c6c1daeSBarry Smith   PetscErrorCode ierr;
5065c6c1daeSBarry Smith   PetscBool      flg;
5075c6c1daeSBarry Smith   PetscViewer    viewer;
5085c6c1daeSBarry Smith   MPI_Comm       ncomm;
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith   PetscFunctionBegin;
5119371c9d4SSatish Balay   ierr = PetscCommDuplicate(comm, &ncomm, NULL);
5129371c9d4SSatish Balay   if (ierr) {
5139371c9d4SSatish Balay     PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " ");
5149371c9d4SSatish Balay     PetscFunctionReturn(NULL);
5159371c9d4SSatish Balay   }
5165c6c1daeSBarry Smith   if (Petsc_Viewer_Socket_keyval == MPI_KEYVAL_INVALID) {
51702c9f0b5SLisandro Dalcin     ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, MPI_COMM_NULL_DELETE_FN, &Petsc_Viewer_Socket_keyval, NULL);
5189371c9d4SSatish Balay     if (ierr) {
5199371c9d4SSatish Balay       PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " ");
5209371c9d4SSatish Balay       PetscFunctionReturn(NULL);
5219371c9d4SSatish Balay     }
5225c6c1daeSBarry Smith   }
52347435625SJed Brown   ierr = MPI_Comm_get_attr(ncomm, Petsc_Viewer_Socket_keyval, (void **)&viewer, (int *)&flg);
5249371c9d4SSatish Balay   if (ierr) {
5259371c9d4SSatish Balay     PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " ");
5269371c9d4SSatish Balay     PetscFunctionReturn(NULL);
5279371c9d4SSatish Balay   }
5285c6c1daeSBarry Smith   if (!flg) { /* PetscViewer not yet created */
52902c9f0b5SLisandro Dalcin     ierr = PetscViewerSocketOpen(ncomm, NULL, 0, &viewer);
5309371c9d4SSatish Balay     if (ierr) {
5319371c9d4SSatish Balay       PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " ");
5329371c9d4SSatish Balay       PetscFunctionReturn(NULL);
5339371c9d4SSatish Balay     }
5345c6c1daeSBarry Smith     ierr = PetscObjectRegisterDestroy((PetscObject)viewer);
5359371c9d4SSatish Balay     if (ierr) {
5369371c9d4SSatish Balay       PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " ");
5379371c9d4SSatish Balay       PetscFunctionReturn(NULL);
5389371c9d4SSatish Balay     }
53947435625SJed Brown     ierr = MPI_Comm_set_attr(ncomm, Petsc_Viewer_Socket_keyval, (void *)viewer);
5409371c9d4SSatish Balay     if (ierr) {
5419371c9d4SSatish Balay       PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " ");
5429371c9d4SSatish Balay       PetscFunctionReturn(NULL);
5439371c9d4SSatish Balay     }
5445c6c1daeSBarry Smith   }
5455c6c1daeSBarry Smith   ierr = PetscCommDestroy(&ncomm);
5469371c9d4SSatish Balay   if (ierr) {
5479371c9d4SSatish Balay     PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " ");
5489371c9d4SSatish Balay     PetscFunctionReturn(NULL);
5499371c9d4SSatish Balay   }
5505c6c1daeSBarry Smith   PetscFunctionReturn(viewer);
5515c6c1daeSBarry Smith }
552