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 /*--------------------------------------------------------------*/ 609371c9d4SSatish Balay static PetscErrorCode PetscViewerDestroy_Socket(PetscViewer viewer) { 615c6c1daeSBarry Smith PetscViewer_Socket *vmatlab = (PetscViewer_Socket *)viewer->data; 625c6c1daeSBarry Smith PetscErrorCode ierr; 635c6c1daeSBarry Smith 645c6c1daeSBarry Smith PetscFunctionBegin; 655c6c1daeSBarry Smith if (vmatlab->port) { 665c6c1daeSBarry Smith #if defined(PETSC_HAVE_CLOSESOCKET) 675c6c1daeSBarry Smith ierr = closesocket(vmatlab->port); 685c6c1daeSBarry Smith #else 695c6c1daeSBarry Smith ierr = close(vmatlab->port); 705c6c1daeSBarry Smith #endif 7128b400f6SJacob Faibussowitsch PetscCheck(!ierr, PETSC_COMM_SELF, PETSC_ERR_SYS, "System error closing socket"); 725c6c1daeSBarry Smith } 739566063dSJacob Faibussowitsch PetscCall(PetscFree(vmatlab)); 742e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinarySetSkipHeader_C", NULL)); 752e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinaryGetSkipHeader_C", NULL)); 762e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerBinaryGetFlowControl_C", NULL)); 775c6c1daeSBarry Smith PetscFunctionReturn(0); 785c6c1daeSBarry Smith } 795c6c1daeSBarry Smith 805c6c1daeSBarry Smith /*--------------------------------------------------------------*/ 814683183fSBarry Smith /*@C 825c6c1daeSBarry Smith PetscSocketOpen - handles connected to an open port where someone is waiting. 835c6c1daeSBarry Smith 844683183fSBarry Smith Input Parameters: 854683183fSBarry Smith + url - for example www.mcs.anl.gov 864683183fSBarry Smith - portnum - for example 80 874683183fSBarry Smith 8801d2d390SJose E. Roman Output Parameter: 894683183fSBarry Smith . t - the socket number 904683183fSBarry Smith 9195452b02SPatrick Sanan Notes: 9295452b02SPatrick Sanan Use close() to close the socket connection 934683183fSBarry Smith 944683183fSBarry Smith Use read() or PetscHTTPRequest() to read from the socket 954683183fSBarry Smith 964683183fSBarry Smith Level: advanced 974683183fSBarry Smith 98db781477SPatrick Sanan .seealso: `PetscSocketListen()`, `PetscSocketEstablish()`, `PetscHTTPRequest()`, `PetscHTTPSConnect()` 994683183fSBarry Smith @*/ 1009371c9d4SSatish Balay PetscErrorCode PetscOpenSocket(const char hostname[], int portnum, int *t) { 1015c6c1daeSBarry Smith struct sockaddr_in sa; 1025c6c1daeSBarry Smith struct hostent *hp; 1035c6c1daeSBarry Smith int s = 0; 1045c6c1daeSBarry Smith PetscBool flg = PETSC_TRUE; 1054a285bdaSBarry Smith static int refcnt = 0; 1065c6c1daeSBarry Smith 1075c6c1daeSBarry Smith PetscFunctionBegin; 1085c6c1daeSBarry Smith if (!(hp = gethostbyname(hostname))) { 1095c6c1daeSBarry Smith perror("SEND: error gethostbyname: "); 11098921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error open connection to %s", hostname); 1115c6c1daeSBarry Smith } 1129566063dSJacob Faibussowitsch PetscCall(PetscMemzero(&sa, sizeof(sa))); 1139566063dSJacob Faibussowitsch PetscCall(PetscMemcpy(&sa.sin_addr, hp->h_addr_list[0], hp->h_length)); 1145c6c1daeSBarry Smith 1155c6c1daeSBarry Smith sa.sin_family = hp->h_addrtype; 1165c6c1daeSBarry Smith sa.sin_port = htons((u_short)portnum); 1175c6c1daeSBarry Smith while (flg) { 1185c6c1daeSBarry Smith if ((s = socket(hp->h_addrtype, SOCK_STREAM, 0)) < 0) { 1199371c9d4SSatish Balay perror("SEND: error socket"); 1209371c9d4SSatish Balay SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error"); 1215c6c1daeSBarry Smith } 1225c6c1daeSBarry Smith if (connect(s, (struct sockaddr *)&sa, sizeof(sa)) < 0) { 1235c6c1daeSBarry Smith #if defined(PETSC_HAVE_WSAGETLASTERROR) 1245c6c1daeSBarry Smith ierr = WSAGetLastError(); 125a297a907SKarl Rupp if (ierr == WSAEADDRINUSE) (*PetscErrorPrintf)("SEND: address is in use\n"); 126a297a907SKarl Rupp else if (ierr == WSAEALREADY) (*PetscErrorPrintf)("SEND: socket is non-blocking \n"); 127a297a907SKarl Rupp else if (ierr == WSAEISCONN) { 1285c6c1daeSBarry Smith (*PetscErrorPrintf)("SEND: socket already connected\n"); 1295c6c1daeSBarry Smith Sleep((unsigned)1); 1305c6c1daeSBarry Smith } else if (ierr == WSAECONNREFUSED) { 1315c6c1daeSBarry Smith /* (*PetscErrorPrintf)("SEND: forcefully rejected\n"); */ 1325c6c1daeSBarry Smith Sleep((unsigned)1); 1335c6c1daeSBarry Smith } else { 1349371c9d4SSatish Balay perror(NULL); 1359371c9d4SSatish Balay SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error"); 1365c6c1daeSBarry Smith } 1375c6c1daeSBarry Smith #else 138a297a907SKarl Rupp if (errno == EADDRINUSE) (*PetscErrorPrintf)("SEND: address is in use\n"); 139a297a907SKarl Rupp else if (errno == EALREADY) (*PetscErrorPrintf)("SEND: socket is non-blocking \n"); 140a297a907SKarl Rupp else if (errno == EISCONN) { 1415c6c1daeSBarry Smith (*PetscErrorPrintf)("SEND: socket already connected\n"); 1425c6c1daeSBarry Smith sleep((unsigned)1); 1435c6c1daeSBarry Smith } else if (errno == ECONNREFUSED) { 1444a285bdaSBarry Smith refcnt++; 14508401ef6SPierre Jolivet PetscCheck(refcnt <= 5, PETSC_COMM_SELF, PETSC_ERR_SYS, "Connection refused by remote host %s port %d", hostname, portnum); 1469566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL, "Connection refused in attaching socket, trying again\n")); 1475c6c1daeSBarry Smith sleep((unsigned)1); 1485c6c1daeSBarry Smith } else { 1499371c9d4SSatish Balay perror(NULL); 1509371c9d4SSatish Balay SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "system error"); 1515c6c1daeSBarry Smith } 1525c6c1daeSBarry Smith #endif 1535c6c1daeSBarry Smith flg = PETSC_TRUE; 1545c6c1daeSBarry Smith #if defined(PETSC_HAVE_CLOSESOCKET) 1555c6c1daeSBarry Smith closesocket(s); 1565c6c1daeSBarry Smith #else 1575c6c1daeSBarry Smith close(s); 1585c6c1daeSBarry Smith #endif 159a297a907SKarl Rupp } else flg = PETSC_FALSE; 1605c6c1daeSBarry Smith } 1615c6c1daeSBarry Smith *t = s; 1625c6c1daeSBarry Smith PetscFunctionReturn(0); 1635c6c1daeSBarry Smith } 1645c6c1daeSBarry Smith 1654683183fSBarry Smith /*@C 1665c6c1daeSBarry Smith PetscSocketEstablish - starts a listener on a socket 1675c6c1daeSBarry Smith 1684683183fSBarry Smith Input Parameters: 1694683183fSBarry Smith . portnumber - the port to wait at 1704683183fSBarry Smith 1714683183fSBarry Smith Output Parameters: 1724683183fSBarry Smith . ss - the socket to be used with PetscSocketListen() 1734683183fSBarry Smith 1744683183fSBarry Smith Level: advanced 1754683183fSBarry Smith 176db781477SPatrick Sanan .seealso: `PetscSocketListen()`, `PetscOpenSocket()` 1774683183fSBarry Smith 1784683183fSBarry Smith @*/ 1799371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscSocketEstablish(int portnum, int *ss) { 180589a23caSBarry Smith static size_t MAXHOSTNAME = 100; 1815c6c1daeSBarry Smith char myname[MAXHOSTNAME + 1]; 1825c6c1daeSBarry Smith int s; 1835c6c1daeSBarry Smith struct sockaddr_in sa; 1845c6c1daeSBarry Smith struct hostent *hp; 1855c6c1daeSBarry Smith 1865c6c1daeSBarry Smith PetscFunctionBegin; 1879566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(myname, sizeof(myname))); 1885c6c1daeSBarry Smith 1899566063dSJacob Faibussowitsch PetscCall(PetscMemzero(&sa, sizeof(struct sockaddr_in))); 1905c6c1daeSBarry Smith 1915c6c1daeSBarry Smith hp = gethostbyname(myname); 19228b400f6SJacob Faibussowitsch PetscCheck(hp, PETSC_COMM_SELF, PETSC_ERR_SYS, "Unable to get hostent information from system"); 1935c6c1daeSBarry Smith 1945c6c1daeSBarry Smith sa.sin_family = hp->h_addrtype; 1955c6c1daeSBarry Smith sa.sin_port = htons((u_short)portnum); 1965c6c1daeSBarry Smith 197cc73adaaSBarry Smith PetscCheck((s = socket(AF_INET, SOCK_STREAM, 0)) >= 0, PETSC_COMM_SELF, PETSC_ERR_SYS, "Error running socket() command"); 1985c6c1daeSBarry Smith #if defined(PETSC_HAVE_SO_REUSEADDR) 1995c6c1daeSBarry Smith { 2005c6c1daeSBarry Smith int optval = 1; /* Turn on the option */ 2019566063dSJacob Faibussowitsch PetscCall(setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (char *)&optval, sizeof(optval))); 2025c6c1daeSBarry Smith } 2035c6c1daeSBarry Smith #endif 2045c6c1daeSBarry Smith 2055c6c1daeSBarry Smith while (bind(s, (struct sockaddr *)&sa, sizeof(sa)) < 0) { 2065c6c1daeSBarry Smith #if defined(PETSC_HAVE_WSAGETLASTERROR) 2075c6c1daeSBarry Smith ierr = WSAGetLastError(); 2085c6c1daeSBarry Smith if (ierr != WSAEADDRINUSE) { 2095c6c1daeSBarry Smith #else 2105c6c1daeSBarry Smith if (errno != EADDRINUSE) { 2115c6c1daeSBarry Smith #endif 2125c6c1daeSBarry Smith close(s); 2135c6c1daeSBarry Smith SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SYS, "Error from bind()"); 2145c6c1daeSBarry Smith } 2155c6c1daeSBarry Smith } 2165c6c1daeSBarry Smith listen(s, 0); 2175c6c1daeSBarry Smith *ss = s; 2185c6c1daeSBarry Smith return (0); 2195c6c1daeSBarry Smith } 2205c6c1daeSBarry Smith 2214683183fSBarry Smith /*@C 2224683183fSBarry Smith PetscSocketListen - Listens at a socket created with PetscSocketEstablish() 2234683183fSBarry Smith 2244683183fSBarry Smith Input Parameter: 2254683183fSBarry Smith . listenport - obtained with PetscSocketEstablish() 2264683183fSBarry Smith 2274683183fSBarry Smith Output Parameter: 2284683183fSBarry Smith . t - pass this to read() to read what is passed to this connection 2294683183fSBarry Smith 2304683183fSBarry Smith Level: advanced 2315c6c1daeSBarry Smith 232db781477SPatrick Sanan .seealso: `PetscSocketEstablish()` 2334683183fSBarry Smith @*/ 2349371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscSocketListen(int listenport, int *t) { 2355c6c1daeSBarry Smith struct sockaddr_in isa; 2365c6c1daeSBarry Smith #if defined(PETSC_HAVE_ACCEPT_SIZE_T) 2375c6c1daeSBarry Smith size_t i; 2385c6c1daeSBarry Smith #else 2395c6c1daeSBarry Smith int i; 2405c6c1daeSBarry Smith #endif 2415c6c1daeSBarry Smith 2425c6c1daeSBarry Smith PetscFunctionBegin; 2435c6c1daeSBarry Smith /* wait for someone to try to connect */ 2445c6c1daeSBarry Smith i = sizeof(struct sockaddr_in); 245cc73adaaSBarry Smith PetscCheck((*t = accept(listenport, (struct sockaddr *)&isa, (socklen_t *)&i)) >= 0, PETSC_COMM_SELF, PETSC_ERR_SYS, "error from accept()"); 2465c6c1daeSBarry Smith PetscFunctionReturn(0); 2475c6c1daeSBarry Smith } 2485c6c1daeSBarry Smith 2495c6c1daeSBarry Smith /*@C 250a30fc760SBarry Smith PetscViewerSocketOpen - Opens a connection to a MATLAB or other socket based server. 2515c6c1daeSBarry Smith 252d083f849SBarry Smith Collective 2535c6c1daeSBarry Smith 2545c6c1daeSBarry Smith Input Parameters: 2555c6c1daeSBarry Smith + comm - the MPI communicator 2560298fd71SBarry Smith . machine - the machine the server is running on,, use NULL for the local machine, use "server" to passively wait for 2575c6c1daeSBarry Smith a connection from elsewhere 2585c6c1daeSBarry Smith - port - the port to connect to, use PETSC_DEFAULT for the default 2595c6c1daeSBarry Smith 2605c6c1daeSBarry Smith Output Parameter: 2615c6c1daeSBarry Smith . lab - a context to use when communicating with the server 2625c6c1daeSBarry Smith 2635c6c1daeSBarry Smith Level: intermediate 2645c6c1daeSBarry Smith 2655c6c1daeSBarry Smith Notes: 2665c6c1daeSBarry Smith Most users should employ the following commands to access the 2675c6c1daeSBarry Smith MATLAB PetscViewers 2685c6c1daeSBarry Smith $ 2695c6c1daeSBarry Smith $ PetscViewerSocketOpen(MPI_Comm comm, char *machine,int port,PetscViewer &viewer) 2705c6c1daeSBarry Smith $ MatView(Mat matrix,PetscViewer viewer) 2715c6c1daeSBarry Smith $ 2725c6c1daeSBarry Smith $ or 2735c6c1daeSBarry Smith $ 2745c6c1daeSBarry Smith $ PetscViewerSocketOpen(MPI_Comm comm,char *machine,int port,PetscViewer &viewer) 2755c6c1daeSBarry Smith $ VecView(Vec vector,PetscViewer viewer) 2765c6c1daeSBarry Smith 2775c6c1daeSBarry Smith Options Database Keys: 2785c6c1daeSBarry Smith For use with PETSC_VIEWER_SOCKET_WORLD, PETSC_VIEWER_SOCKET_SELF, 2795c6c1daeSBarry Smith PETSC_VIEWER_SOCKET_() or if 2800298fd71SBarry Smith NULL is passed for machine or PETSC_DEFAULT is passed for port 2815c6c1daeSBarry Smith $ -viewer_socket_machine <machine> 2825c6c1daeSBarry Smith $ -viewer_socket_port <port> 2835c6c1daeSBarry Smith 2845c6c1daeSBarry Smith Environmental variables: 285a2b725a8SWilliam Gropp + PETSC_VIEWER_SOCKET_PORT - portnumber 286a2b725a8SWilliam Gropp - PETSC_VIEWER_SOCKET_MACHINE - machine name 2875c6c1daeSBarry Smith 2885c6c1daeSBarry Smith Currently the only socket client available is MATLAB. See 289c4762a1bSJed Brown src/dm/tests/ex12.c and ex12.m for an example of usage. 2905c6c1daeSBarry Smith 29195452b02SPatrick Sanan Notes: 29295452b02SPatrick Sanan The socket viewer is in some sense a subclass of the binary viewer, to read and write to the socket 293a30fc760SBarry Smith use PetscViewerBinaryRead(), PetscViewerBinaryWrite(), PetscViewerBinarWriteStringArray(), PetscViewerBinaryGetDescriptor(). 294a30fc760SBarry Smith 295a30fc760SBarry Smith Use this for communicating with an interactive MATLAB session, see PETSC_VIEWER_MATLAB_() for writing output to a 296a30fc760SBarry Smith .mat file. Use PetscMatlabEngineCreate() or PETSC_MATLAB_ENGINE_(), PETSC_MATLAB_ENGINE_SELF, or PETSC_MATLAB_ENGINE_WORLD 297a30fc760SBarry Smith for communicating with a MATLAB Engine 2985c6c1daeSBarry Smith 299db781477SPatrick Sanan .seealso: `MatView()`, `VecView()`, `PetscViewerDestroy()`, `PetscViewerCreate()`, `PetscViewerSetType()`, 300db781477SPatrick Sanan `PetscViewerSocketSetConnection()`, `PETSC_VIEWER_SOCKET_`, `PETSC_VIEWER_SOCKET_WORLD`, 301db781477SPatrick Sanan `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`, `PetscViewerBinaryWriteStringArray()`, 302db781477SPatrick Sanan `PetscBinaryViewerGetDescriptor()`, `PetscMatlabEngineCreate()` 3035c6c1daeSBarry Smith @*/ 3049371c9d4SSatish Balay PetscErrorCode PetscViewerSocketOpen(MPI_Comm comm, const char machine[], int port, PetscViewer *lab) { 3055c6c1daeSBarry Smith PetscFunctionBegin; 3069566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(comm, lab)); 3079566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(*lab, PETSCVIEWERSOCKET)); 3089566063dSJacob Faibussowitsch PetscCall(PetscViewerSocketSetConnection(*lab, machine, port)); 3095c6c1daeSBarry Smith PetscFunctionReturn(0); 3105c6c1daeSBarry Smith } 3115c6c1daeSBarry Smith 3129371c9d4SSatish Balay static PetscErrorCode PetscViewerSetFromOptions_Socket(PetscViewer v, PetscOptionItems *PetscOptionsObject) { 3135c6c1daeSBarry Smith PetscInt def = -1; 3145c6c1daeSBarry Smith char sdef[256]; 3155c6c1daeSBarry Smith PetscBool tflg; 3165c6c1daeSBarry Smith 3175c6c1daeSBarry Smith PetscFunctionBegin; 3185c6c1daeSBarry Smith /* 3195c6c1daeSBarry Smith These options are not processed here, they are processed in PetscViewerSocketSetConnection(), they 3205c6c1daeSBarry Smith are listed here for the GUI to display 3215c6c1daeSBarry Smith */ 322d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject, "Socket PetscViewer Options"); 3239566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_PORT", sdef, 16, &tflg)); 3245c6c1daeSBarry Smith if (tflg) { 3259566063dSJacob Faibussowitsch PetscCall(PetscOptionsStringToInt(sdef, &def)); 326a297a907SKarl Rupp } else def = PETSCSOCKETDEFAULTPORT; 3279566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-viewer_socket_port", "Port number to use for socket", "PetscViewerSocketSetConnection", def, NULL, NULL)); 3285c6c1daeSBarry Smith 3299566063dSJacob Faibussowitsch PetscCall(PetscOptionsString("-viewer_socket_machine", "Machine to use for socket", "PetscViewerSocketSetConnection", sdef, NULL, sizeof(sdef), NULL)); 3309566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_MACHINE", sdef, sizeof(sdef), &tflg)); 331*48a46eb9SPierre Jolivet if (!tflg) PetscCall(PetscGetHostName(sdef, sizeof(sdef))); 332d0609cedSBarry Smith PetscOptionsHeadEnd(); 3335c6c1daeSBarry Smith PetscFunctionReturn(0); 3345c6c1daeSBarry Smith } 3355c6c1daeSBarry Smith 3369371c9d4SSatish Balay static PetscErrorCode PetscViewerBinaryGetSkipHeader_Socket(PetscViewer viewer, PetscBool *skip) { 3374c9f2355SSatish Balay PetscViewer_Socket *vsocket = (PetscViewer_Socket *)viewer->data; 3384c9f2355SSatish Balay 3394c9f2355SSatish Balay PetscFunctionBegin; 3404c9f2355SSatish Balay *skip = vsocket->skipheader; 3414c9f2355SSatish Balay PetscFunctionReturn(0); 3424c9f2355SSatish Balay } 3434c9f2355SSatish Balay 3449371c9d4SSatish Balay static PetscErrorCode PetscViewerBinarySetSkipHeader_Socket(PetscViewer viewer, PetscBool skip) { 3454c9f2355SSatish Balay PetscViewer_Socket *vsocket = (PetscViewer_Socket *)viewer->data; 3464c9f2355SSatish Balay 3474c9f2355SSatish Balay PetscFunctionBegin; 3484c9f2355SSatish Balay vsocket->skipheader = skip; 3494c9f2355SSatish Balay PetscFunctionReturn(0); 3504c9f2355SSatish Balay } 3514c9f2355SSatish Balay 3529371c9d4SSatish Balay static PetscErrorCode PetscViewerBinaryGetFlowControl_Socket(PetscViewer viewer, PetscInt *fc) { 3534c9f2355SSatish Balay PetscFunctionBegin; 3544c9f2355SSatish Balay *fc = 0; 3554c9f2355SSatish Balay PetscFunctionReturn(0); 3564c9f2355SSatish Balay } 3574c9f2355SSatish Balay 3588556b5ebSBarry Smith /*MC 3598556b5ebSBarry Smith PETSCVIEWERSOCKET - A viewer that writes to a Unix socket 3608556b5ebSBarry Smith 361c2e3fba1SPatrick Sanan .seealso: `PetscViewerSocketOpen()`, `PetscViewerDrawOpen()`, `PETSC_VIEWER_DRAW_()`, `PETSC_VIEWER_DRAW_SELF`, `PETSC_VIEWER_DRAW_WORLD`, 362db781477SPatrick Sanan `PetscViewerCreate()`, `PetscViewerASCIIOpen()`, `PetscViewerBinaryOpen()`, `PETSCVIEWERBINARY`, `PETSCVIEWERDRAW`, 363db781477SPatrick Sanan `PetscViewerMatlabOpen()`, `VecView()`, `DMView()`, `PetscViewerMatlabPutArray()`, `PETSCVIEWERASCII`, `PETSCVIEWERMATLAB`, 364db781477SPatrick Sanan `PetscViewerFileSetName()`, `PetscViewerFileSetMode()`, `PetscViewerFormat`, `PetscViewerType`, `PetscViewerSetType()` 3658556b5ebSBarry Smith 3661b266c99SBarry Smith Level: beginner 3678556b5ebSBarry Smith M*/ 3688556b5ebSBarry Smith 3699371c9d4SSatish Balay PETSC_EXTERN PetscErrorCode PetscViewerCreate_Socket(PetscViewer v) { 3705c6c1daeSBarry Smith PetscViewer_Socket *vmatlab; 3715c6c1daeSBarry Smith 3725c6c1daeSBarry Smith PetscFunctionBegin; 3739566063dSJacob Faibussowitsch PetscCall(PetscNewLog(v, &vmatlab)); 3745c6c1daeSBarry Smith vmatlab->port = 0; 3755c6c1daeSBarry Smith v->data = (void *)vmatlab; 3765c6c1daeSBarry Smith v->ops->destroy = PetscViewerDestroy_Socket; 37702c9f0b5SLisandro Dalcin v->ops->flush = NULL; 3785c6c1daeSBarry Smith v->ops->setfromoptions = PetscViewerSetFromOptions_Socket; 3795c6c1daeSBarry Smith 3805c6c1daeSBarry Smith /* lie and say this is a binary viewer; then all the XXXView_Binary() methods will work correctly on it */ 3819566063dSJacob Faibussowitsch PetscCall(PetscObjectChangeTypeName((PetscObject)v, PETSCVIEWERBINARY)); 3829566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinarySetSkipHeader_C", PetscViewerBinarySetSkipHeader_Socket)); 3839566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinaryGetSkipHeader_C", PetscViewerBinaryGetSkipHeader_Socket)); 3849566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerBinaryGetFlowControl_C", PetscViewerBinaryGetFlowControl_Socket)); 3854c9f2355SSatish Balay 3865c6c1daeSBarry Smith PetscFunctionReturn(0); 3875c6c1daeSBarry Smith } 3885c6c1daeSBarry Smith 3895c6c1daeSBarry Smith /*@C 3905c6c1daeSBarry Smith PetscViewerSocketSetConnection - Sets the machine and port that a PETSc socket 3915c6c1daeSBarry Smith viewer is to use 3925c6c1daeSBarry Smith 3935c6c1daeSBarry Smith Logically Collective on PetscViewer 3945c6c1daeSBarry Smith 3955c6c1daeSBarry Smith Input Parameters: 3965c6c1daeSBarry Smith + v - viewer to connect 3970298fd71SBarry Smith . machine - host to connect to, use NULL for the local machine,use "server" to passively wait for 3985c6c1daeSBarry Smith a connection from elsewhere 3995c6c1daeSBarry Smith - port - the port on the machine one is connecting to, use PETSC_DEFAULT for default 4005c6c1daeSBarry Smith 4015c6c1daeSBarry Smith Level: advanced 4025c6c1daeSBarry Smith 403db781477SPatrick Sanan .seealso: `PetscViewerSocketOpen()` 4045c6c1daeSBarry Smith @*/ 4059371c9d4SSatish Balay PetscErrorCode PetscViewerSocketSetConnection(PetscViewer v, const char machine[], int port) { 4065c6c1daeSBarry Smith PetscMPIInt rank; 4075c6c1daeSBarry Smith char mach[256]; 4085c6c1daeSBarry Smith PetscBool tflg; 4093ca90d2dSJacob Faibussowitsch PetscViewer_Socket *vmatlab; 4105c6c1daeSBarry Smith 4115c6c1daeSBarry Smith PetscFunctionBegin; 4123ca90d2dSJacob Faibussowitsch PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 1); 4133ca90d2dSJacob Faibussowitsch if (machine) PetscValidCharPointer(machine, 2); 4143ca90d2dSJacob Faibussowitsch vmatlab = (PetscViewer_Socket *)v->data; 4155c6c1daeSBarry Smith /* PetscValidLogicalCollectiveInt(v,port,3); not a PetscInt */ 4165c6c1daeSBarry Smith if (port <= 0) { 4175c6c1daeSBarry Smith char portn[16]; 4189566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_PORT", portn, 16, &tflg)); 4195c6c1daeSBarry Smith if (tflg) { 4205c6c1daeSBarry Smith PetscInt pport; 4219566063dSJacob Faibussowitsch PetscCall(PetscOptionsStringToInt(portn, &pport)); 4225c6c1daeSBarry Smith port = (int)pport; 423a297a907SKarl Rupp } else port = PETSCSOCKETDEFAULTPORT; 4245c6c1daeSBarry Smith } 4255c6c1daeSBarry Smith if (!machine) { 4269566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v), "PETSC_VIEWER_SOCKET_MACHINE", mach, sizeof(mach), &tflg)); 427*48a46eb9SPierre Jolivet if (!tflg) PetscCall(PetscGetHostName(mach, sizeof(mach))); 4285c6c1daeSBarry Smith } else { 4299566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(mach, machine, sizeof(mach))); 4305c6c1daeSBarry Smith } 4315c6c1daeSBarry Smith 4329566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)v), &rank)); 433dd400576SPatrick Sanan if (rank == 0) { 4349566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(mach, "server", &tflg)); 4355c6c1daeSBarry Smith if (tflg) { 4365c6c1daeSBarry Smith int listenport; 4379566063dSJacob Faibussowitsch PetscCall(PetscInfo(v, "Waiting for connection from socket process on port %d\n", port)); 4389566063dSJacob Faibussowitsch PetscCall(PetscSocketEstablish(port, &listenport)); 4399566063dSJacob Faibussowitsch PetscCall(PetscSocketListen(listenport, &vmatlab->port)); 4405c6c1daeSBarry Smith close(listenport); 4415c6c1daeSBarry Smith } else { 4429566063dSJacob Faibussowitsch PetscCall(PetscInfo(v, "Connecting to socket process on port %d machine %s\n", port, mach)); 4439566063dSJacob Faibussowitsch PetscCall(PetscOpenSocket(mach, port, &vmatlab->port)); 4445c6c1daeSBarry Smith } 4455c6c1daeSBarry Smith } 4465c6c1daeSBarry Smith PetscFunctionReturn(0); 4475c6c1daeSBarry Smith } 4485c6c1daeSBarry Smith 4495c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/ 4505c6c1daeSBarry Smith /* 4515c6c1daeSBarry Smith The variable Petsc_Viewer_Socket_keyval is used to indicate an MPI attribute that 4525c6c1daeSBarry Smith is attached to a communicator, in this case the attribute is a PetscViewer. 4535c6c1daeSBarry Smith */ 454d4c7638eSBarry Smith PetscMPIInt Petsc_Viewer_Socket_keyval = MPI_KEYVAL_INVALID; 4555c6c1daeSBarry Smith 4565c6c1daeSBarry Smith /*@C 4575c6c1daeSBarry Smith PETSC_VIEWER_SOCKET_ - Creates a socket viewer shared by all processors in a communicator. 4585c6c1daeSBarry Smith 459d083f849SBarry Smith Collective 4605c6c1daeSBarry Smith 4615c6c1daeSBarry Smith Input Parameter: 4625c6c1daeSBarry Smith . comm - the MPI communicator to share the socket PetscViewer 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith Level: intermediate 4655c6c1daeSBarry Smith 4665c6c1daeSBarry Smith Options Database Keys: 4675c6c1daeSBarry Smith For use with the default PETSC_VIEWER_SOCKET_WORLD or if 4680298fd71SBarry Smith NULL is passed for machine or PETSC_DEFAULT is passed for port 4695c6c1daeSBarry Smith $ -viewer_socket_machine <machine> 4705c6c1daeSBarry Smith $ -viewer_socket_port <port> 4715c6c1daeSBarry Smith 4725c6c1daeSBarry Smith Environmental variables: 473a2b725a8SWilliam Gropp + PETSC_VIEWER_SOCKET_PORT - portnumber 474a2b725a8SWilliam Gropp - PETSC_VIEWER_SOCKET_MACHINE - machine name 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Notes: 477fa131761SBarry Smith Unlike almost all other PETSc routines, Petsc_VIEWER_SOCKET_ does not return 478fa131761SBarry Smith an error code, it returns NULL if it fails. The socket PetscViewer is usually used in the form 4795c6c1daeSBarry Smith $ XXXView(XXX object,PETSC_VIEWER_SOCKET_(comm)); 4805c6c1daeSBarry Smith 4815c6c1daeSBarry Smith Currently the only socket client available is MATLAB. See 482c4762a1bSJed Brown src/dm/tests/ex12.c and ex12.m for an example of usage. 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith Connects to a waiting socket and stays connected until PetscViewerDestroy() is called. 4855c6c1daeSBarry Smith 486a30fc760SBarry Smith Use this for communicating with an interactive MATLAB session, see PETSC_VIEWER_MATLAB_() for writing output to a 487a30fc760SBarry Smith .mat file. Use PetscMatlabEngineCreate() or PETSC_MATLAB_ENGINE_(), PETSC_MATLAB_ENGINE_SELF, or PETSC_MATLAB_ENGINE_WORLD 488a30fc760SBarry Smith for communicating with a MATLAB Engine 4895c6c1daeSBarry Smith 490db781477SPatrick Sanan .seealso: `PETSC_VIEWER_SOCKET_WORLD`, `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerSocketOpen()`, `PetscViewerCreate()`, 491db781477SPatrick Sanan `PetscViewerSocketSetConnection()`, `PetscViewerDestroy()`, `PETSC_VIEWER_SOCKET_()`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`, 492db781477SPatrick Sanan `PetscViewerBinaryWriteStringArray()`, `PetscViewerBinaryGetDescriptor()`, `PETSC_VIEWER_MATLAB_()` 4935c6c1daeSBarry Smith @*/ 4949371c9d4SSatish Balay PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm comm) { 4955c6c1daeSBarry Smith PetscErrorCode ierr; 4965c6c1daeSBarry Smith PetscBool flg; 4975c6c1daeSBarry Smith PetscViewer viewer; 4985c6c1daeSBarry Smith MPI_Comm ncomm; 4995c6c1daeSBarry Smith 5005c6c1daeSBarry Smith PetscFunctionBegin; 5019371c9d4SSatish Balay ierr = PetscCommDuplicate(comm, &ncomm, NULL); 5029371c9d4SSatish Balay if (ierr) { 5039371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " "); 5049371c9d4SSatish Balay PetscFunctionReturn(NULL); 5059371c9d4SSatish Balay } 5065c6c1daeSBarry Smith if (Petsc_Viewer_Socket_keyval == MPI_KEYVAL_INVALID) { 50702c9f0b5SLisandro Dalcin ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, MPI_COMM_NULL_DELETE_FN, &Petsc_Viewer_Socket_keyval, NULL); 5089371c9d4SSatish Balay if (ierr) { 5099371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " "); 5109371c9d4SSatish Balay PetscFunctionReturn(NULL); 5119371c9d4SSatish Balay } 5125c6c1daeSBarry Smith } 51347435625SJed Brown ierr = MPI_Comm_get_attr(ncomm, Petsc_Viewer_Socket_keyval, (void **)&viewer, (int *)&flg); 5149371c9d4SSatish Balay if (ierr) { 5159371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " "); 5169371c9d4SSatish Balay PetscFunctionReturn(NULL); 5179371c9d4SSatish Balay } 5185c6c1daeSBarry Smith if (!flg) { /* PetscViewer not yet created */ 51902c9f0b5SLisandro Dalcin ierr = PetscViewerSocketOpen(ncomm, NULL, 0, &viewer); 5209371c9d4SSatish Balay if (ierr) { 5219371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " "); 5229371c9d4SSatish Balay PetscFunctionReturn(NULL); 5239371c9d4SSatish Balay } 5245c6c1daeSBarry Smith ierr = PetscObjectRegisterDestroy((PetscObject)viewer); 5259371c9d4SSatish Balay if (ierr) { 5269371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " "); 5279371c9d4SSatish Balay PetscFunctionReturn(NULL); 5289371c9d4SSatish Balay } 52947435625SJed Brown ierr = MPI_Comm_set_attr(ncomm, Petsc_Viewer_Socket_keyval, (void *)viewer); 5309371c9d4SSatish Balay if (ierr) { 5319371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " "); 5329371c9d4SSatish Balay PetscFunctionReturn(NULL); 5339371c9d4SSatish Balay } 5345c6c1daeSBarry Smith } 5355c6c1daeSBarry Smith ierr = PetscCommDestroy(&ncomm); 5369371c9d4SSatish Balay if (ierr) { 5379371c9d4SSatish Balay PetscError(PETSC_COMM_SELF, __LINE__, "PETSC_VIEWER_SOCKET_", __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_REPEAT, " "); 5389371c9d4SSatish Balay PetscFunctionReturn(NULL); 5399371c9d4SSatish Balay } 5405c6c1daeSBarry Smith PetscFunctionReturn(viewer); 5415c6c1daeSBarry Smith } 542