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 /*--------------------------------------------------------------*/ 605c6c1daeSBarry Smith static PetscErrorCode PetscViewerDestroy_Socket(PetscViewer viewer) 615c6c1daeSBarry Smith { 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)); 75*2e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerBinarySetSkipHeader_C",NULL)); 76*2e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerBinaryGetSkipHeader_C",NULL)); 77*2e956fe4SStefano 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 954683183fSBarry 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 @*/ 101e2fc02c1SBarry Smith PetscErrorCode PetscOpenSocket(const char hostname[],int portnum,int *t) 1025c6c1daeSBarry Smith { 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) { 1215c6c1daeSBarry Smith perror("SEND: error socket"); SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"system error"); 1225c6c1daeSBarry Smith } 1235c6c1daeSBarry Smith if (connect(s,(struct sockaddr*)&sa,sizeof(sa)) < 0) { 1245c6c1daeSBarry Smith #if defined(PETSC_HAVE_WSAGETLASTERROR) 1255c6c1daeSBarry Smith ierr = WSAGetLastError(); 126a297a907SKarl Rupp if (ierr == WSAEADDRINUSE) (*PetscErrorPrintf)("SEND: address is in use\n"); 127a297a907SKarl Rupp else if (ierr == WSAEALREADY) (*PetscErrorPrintf)("SEND: socket is non-blocking \n"); 128a297a907SKarl Rupp else if (ierr == WSAEISCONN) { 1295c6c1daeSBarry Smith (*PetscErrorPrintf)("SEND: socket already connected\n"); 1305c6c1daeSBarry Smith Sleep((unsigned) 1); 1315c6c1daeSBarry Smith } else if (ierr == WSAECONNREFUSED) { 1325c6c1daeSBarry Smith /* (*PetscErrorPrintf)("SEND: forcefully rejected\n"); */ 1335c6c1daeSBarry Smith Sleep((unsigned) 1); 1345c6c1daeSBarry Smith } else { 1355c6c1daeSBarry Smith perror(NULL); 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 { 1495c6c1daeSBarry Smith perror(NULL); SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"system error"); 1505c6c1daeSBarry Smith } 1515c6c1daeSBarry Smith #endif 1525c6c1daeSBarry Smith flg = PETSC_TRUE; 1535c6c1daeSBarry Smith #if defined(PETSC_HAVE_CLOSESOCKET) 1545c6c1daeSBarry Smith closesocket(s); 1555c6c1daeSBarry Smith #else 1565c6c1daeSBarry Smith close(s); 1575c6c1daeSBarry Smith #endif 158a297a907SKarl Rupp } else flg = PETSC_FALSE; 1595c6c1daeSBarry Smith } 1605c6c1daeSBarry Smith *t = s; 1615c6c1daeSBarry Smith PetscFunctionReturn(0); 1625c6c1daeSBarry Smith } 1635c6c1daeSBarry Smith 1644683183fSBarry Smith /*@C 1655c6c1daeSBarry Smith PetscSocketEstablish - starts a listener on a socket 1665c6c1daeSBarry Smith 1674683183fSBarry Smith Input Parameters: 1684683183fSBarry Smith . portnumber - the port to wait at 1694683183fSBarry Smith 1704683183fSBarry Smith Output Parameters: 1714683183fSBarry Smith . ss - the socket to be used with PetscSocketListen() 1724683183fSBarry Smith 1734683183fSBarry Smith Level: advanced 1744683183fSBarry Smith 175db781477SPatrick Sanan .seealso: `PetscSocketListen()`, `PetscOpenSocket()` 1764683183fSBarry Smith 1774683183fSBarry Smith @*/ 1785847ff97SBarry Smith PETSC_INTERN PetscErrorCode PetscSocketEstablish(int portnum,int *ss) 1795c6c1daeSBarry Smith { 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 @*/ 2345847ff97SBarry Smith PETSC_INTERN PetscErrorCode PetscSocketListen(int listenport,int *t) 2355c6c1daeSBarry Smith { 2365c6c1daeSBarry Smith struct sockaddr_in isa; 2375c6c1daeSBarry Smith #if defined(PETSC_HAVE_ACCEPT_SIZE_T) 2385c6c1daeSBarry Smith size_t i; 2395c6c1daeSBarry Smith #else 2405c6c1daeSBarry Smith int i; 2415c6c1daeSBarry Smith #endif 2425c6c1daeSBarry Smith 2435c6c1daeSBarry Smith PetscFunctionBegin; 2445c6c1daeSBarry Smith /* wait for someone to try to connect */ 2455c6c1daeSBarry Smith i = sizeof(struct sockaddr_in); 246cc73adaaSBarry Smith PetscCheck((*t = accept(listenport,(struct sockaddr*)&isa,(socklen_t*)&i)) >= 0,PETSC_COMM_SELF,PETSC_ERR_SYS,"error from accept()"); 2475c6c1daeSBarry Smith PetscFunctionReturn(0); 2485c6c1daeSBarry Smith } 2495c6c1daeSBarry Smith 2505c6c1daeSBarry Smith /*@C 251a30fc760SBarry Smith PetscViewerSocketOpen - Opens a connection to a MATLAB or other socket based server. 2525c6c1daeSBarry Smith 253d083f849SBarry Smith Collective 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith Input Parameters: 2565c6c1daeSBarry Smith + comm - the MPI communicator 2570298fd71SBarry Smith . machine - the machine the server is running on,, use NULL for the local machine, use "server" to passively wait for 2585c6c1daeSBarry Smith a connection from elsewhere 2595c6c1daeSBarry Smith - port - the port to connect to, use PETSC_DEFAULT for the default 2605c6c1daeSBarry Smith 2615c6c1daeSBarry Smith Output Parameter: 2625c6c1daeSBarry Smith . lab - a context to use when communicating with the server 2635c6c1daeSBarry Smith 2645c6c1daeSBarry Smith Level: intermediate 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith Notes: 2675c6c1daeSBarry Smith Most users should employ the following commands to access the 2685c6c1daeSBarry Smith MATLAB PetscViewers 2695c6c1daeSBarry Smith $ 2705c6c1daeSBarry Smith $ PetscViewerSocketOpen(MPI_Comm comm, char *machine,int port,PetscViewer &viewer) 2715c6c1daeSBarry Smith $ MatView(Mat matrix,PetscViewer viewer) 2725c6c1daeSBarry Smith $ 2735c6c1daeSBarry Smith $ or 2745c6c1daeSBarry Smith $ 2755c6c1daeSBarry Smith $ PetscViewerSocketOpen(MPI_Comm comm,char *machine,int port,PetscViewer &viewer) 2765c6c1daeSBarry Smith $ VecView(Vec vector,PetscViewer viewer) 2775c6c1daeSBarry Smith 2785c6c1daeSBarry Smith Options Database Keys: 2795c6c1daeSBarry Smith For use with PETSC_VIEWER_SOCKET_WORLD, PETSC_VIEWER_SOCKET_SELF, 2805c6c1daeSBarry Smith PETSC_VIEWER_SOCKET_() or if 2810298fd71SBarry Smith NULL is passed for machine or PETSC_DEFAULT is passed for port 2825c6c1daeSBarry Smith $ -viewer_socket_machine <machine> 2835c6c1daeSBarry Smith $ -viewer_socket_port <port> 2845c6c1daeSBarry Smith 2855c6c1daeSBarry Smith Environmental variables: 286a2b725a8SWilliam Gropp + PETSC_VIEWER_SOCKET_PORT - portnumber 287a2b725a8SWilliam Gropp - PETSC_VIEWER_SOCKET_MACHINE - machine name 2885c6c1daeSBarry Smith 2895c6c1daeSBarry Smith Currently the only socket client available is MATLAB. See 290c4762a1bSJed Brown src/dm/tests/ex12.c and ex12.m for an example of usage. 2915c6c1daeSBarry Smith 29295452b02SPatrick Sanan Notes: 29395452b02SPatrick Sanan The socket viewer is in some sense a subclass of the binary viewer, to read and write to the socket 294a30fc760SBarry Smith use PetscViewerBinaryRead(), PetscViewerBinaryWrite(), PetscViewerBinarWriteStringArray(), PetscViewerBinaryGetDescriptor(). 295a30fc760SBarry Smith 296a30fc760SBarry Smith Use this for communicating with an interactive MATLAB session, see PETSC_VIEWER_MATLAB_() for writing output to a 297a30fc760SBarry Smith .mat file. Use PetscMatlabEngineCreate() or PETSC_MATLAB_ENGINE_(), PETSC_MATLAB_ENGINE_SELF, or PETSC_MATLAB_ENGINE_WORLD 298a30fc760SBarry Smith for communicating with a MATLAB Engine 2995c6c1daeSBarry Smith 300db781477SPatrick Sanan .seealso: `MatView()`, `VecView()`, `PetscViewerDestroy()`, `PetscViewerCreate()`, `PetscViewerSetType()`, 301db781477SPatrick Sanan `PetscViewerSocketSetConnection()`, `PETSC_VIEWER_SOCKET_`, `PETSC_VIEWER_SOCKET_WORLD`, 302db781477SPatrick Sanan `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`, `PetscViewerBinaryWriteStringArray()`, 303db781477SPatrick Sanan `PetscBinaryViewerGetDescriptor()`, `PetscMatlabEngineCreate()` 3045c6c1daeSBarry Smith @*/ 3055c6c1daeSBarry Smith PetscErrorCode PetscViewerSocketOpen(MPI_Comm comm,const char machine[],int port,PetscViewer *lab) 3065c6c1daeSBarry Smith { 3075c6c1daeSBarry Smith PetscFunctionBegin; 3089566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(comm,lab)); 3099566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(*lab,PETSCVIEWERSOCKET)); 3109566063dSJacob Faibussowitsch PetscCall(PetscViewerSocketSetConnection(*lab,machine,port)); 3115c6c1daeSBarry Smith PetscFunctionReturn(0); 3125c6c1daeSBarry Smith } 3135c6c1daeSBarry Smith 3144416b707SBarry Smith static PetscErrorCode PetscViewerSetFromOptions_Socket(PetscOptionItems *PetscOptionsObject,PetscViewer v) 3155c6c1daeSBarry Smith { 3165c6c1daeSBarry Smith PetscInt def = -1; 3175c6c1daeSBarry Smith char sdef[256]; 3185c6c1daeSBarry Smith PetscBool tflg; 3195c6c1daeSBarry Smith 3205c6c1daeSBarry Smith PetscFunctionBegin; 3215c6c1daeSBarry Smith /* 3225c6c1daeSBarry Smith These options are not processed here, they are processed in PetscViewerSocketSetConnection(), they 3235c6c1daeSBarry Smith are listed here for the GUI to display 3245c6c1daeSBarry Smith */ 325d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject,"Socket PetscViewer Options"); 3269566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v),"PETSC_VIEWER_SOCKET_PORT",sdef,16,&tflg)); 3275c6c1daeSBarry Smith if (tflg) { 3289566063dSJacob Faibussowitsch PetscCall(PetscOptionsStringToInt(sdef,&def)); 329a297a907SKarl Rupp } else def = PETSCSOCKETDEFAULTPORT; 3309566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-viewer_socket_port","Port number to use for socket","PetscViewerSocketSetConnection",def,NULL,NULL)); 3315c6c1daeSBarry Smith 3329566063dSJacob Faibussowitsch PetscCall(PetscOptionsString("-viewer_socket_machine","Machine to use for socket","PetscViewerSocketSetConnection",sdef,NULL,sizeof(sdef),NULL)); 3339566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v),"PETSC_VIEWER_SOCKET_MACHINE",sdef,sizeof(sdef),&tflg)); 3345c6c1daeSBarry Smith if (!tflg) { 3359566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(sdef,sizeof(sdef))); 3365c6c1daeSBarry Smith } 337d0609cedSBarry Smith PetscOptionsHeadEnd(); 3385c6c1daeSBarry Smith PetscFunctionReturn(0); 3395c6c1daeSBarry Smith } 3405c6c1daeSBarry Smith 3414c9f2355SSatish Balay static PetscErrorCode PetscViewerBinaryGetSkipHeader_Socket(PetscViewer viewer,PetscBool *skip) 3424c9f2355SSatish Balay { 3434c9f2355SSatish Balay PetscViewer_Socket *vsocket = (PetscViewer_Socket*)viewer->data; 3444c9f2355SSatish Balay 3454c9f2355SSatish Balay PetscFunctionBegin; 3464c9f2355SSatish Balay *skip = vsocket->skipheader; 3474c9f2355SSatish Balay PetscFunctionReturn(0); 3484c9f2355SSatish Balay } 3494c9f2355SSatish Balay 3504c9f2355SSatish Balay static PetscErrorCode PetscViewerBinarySetSkipHeader_Socket(PetscViewer viewer,PetscBool skip) 3514c9f2355SSatish Balay { 3524c9f2355SSatish Balay PetscViewer_Socket *vsocket = (PetscViewer_Socket*)viewer->data; 3534c9f2355SSatish Balay 3544c9f2355SSatish Balay PetscFunctionBegin; 3554c9f2355SSatish Balay vsocket->skipheader = skip; 3564c9f2355SSatish Balay PetscFunctionReturn(0); 3574c9f2355SSatish Balay } 3584c9f2355SSatish Balay 3594c9f2355SSatish Balay static PetscErrorCode PetscViewerBinaryGetFlowControl_Socket(PetscViewer viewer,PetscInt *fc) 3604c9f2355SSatish Balay { 3614c9f2355SSatish Balay PetscFunctionBegin; 3624c9f2355SSatish Balay *fc = 0; 3634c9f2355SSatish Balay PetscFunctionReturn(0); 3644c9f2355SSatish Balay } 3654c9f2355SSatish Balay 3668556b5ebSBarry Smith /*MC 3678556b5ebSBarry Smith PETSCVIEWERSOCKET - A viewer that writes to a Unix socket 3688556b5ebSBarry Smith 369c2e3fba1SPatrick Sanan .seealso: `PetscViewerSocketOpen()`, `PetscViewerDrawOpen()`, `PETSC_VIEWER_DRAW_()`, `PETSC_VIEWER_DRAW_SELF`, `PETSC_VIEWER_DRAW_WORLD`, 370db781477SPatrick Sanan `PetscViewerCreate()`, `PetscViewerASCIIOpen()`, `PetscViewerBinaryOpen()`, `PETSCVIEWERBINARY`, `PETSCVIEWERDRAW`, 371db781477SPatrick Sanan `PetscViewerMatlabOpen()`, `VecView()`, `DMView()`, `PetscViewerMatlabPutArray()`, `PETSCVIEWERASCII`, `PETSCVIEWERMATLAB`, 372db781477SPatrick Sanan `PetscViewerFileSetName()`, `PetscViewerFileSetMode()`, `PetscViewerFormat`, `PetscViewerType`, `PetscViewerSetType()` 3738556b5ebSBarry Smith 3741b266c99SBarry Smith Level: beginner 3758556b5ebSBarry Smith M*/ 3768556b5ebSBarry Smith 3778cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_Socket(PetscViewer v) 3785c6c1daeSBarry Smith { 3795c6c1daeSBarry Smith PetscViewer_Socket *vmatlab; 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith PetscFunctionBegin; 3829566063dSJacob Faibussowitsch PetscCall(PetscNewLog(v,&vmatlab)); 3835c6c1daeSBarry Smith vmatlab->port = 0; 3845c6c1daeSBarry Smith v->data = (void*)vmatlab; 3855c6c1daeSBarry Smith v->ops->destroy = PetscViewerDestroy_Socket; 38602c9f0b5SLisandro Dalcin v->ops->flush = NULL; 3875c6c1daeSBarry Smith v->ops->setfromoptions = PetscViewerSetFromOptions_Socket; 3885c6c1daeSBarry Smith 3895c6c1daeSBarry Smith /* lie and say this is a binary viewer; then all the XXXView_Binary() methods will work correctly on it */ 3909566063dSJacob Faibussowitsch PetscCall(PetscObjectChangeTypeName((PetscObject)v,PETSCVIEWERBINARY)); 3919566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipHeader_C",PetscViewerBinarySetSkipHeader_Socket)); 3929566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipHeader_C",PetscViewerBinaryGetSkipHeader_Socket)); 3939566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetFlowControl_C",PetscViewerBinaryGetFlowControl_Socket)); 3944c9f2355SSatish Balay 3955c6c1daeSBarry Smith PetscFunctionReturn(0); 3965c6c1daeSBarry Smith } 3975c6c1daeSBarry Smith 3985c6c1daeSBarry Smith /*@C 3995c6c1daeSBarry Smith PetscViewerSocketSetConnection - Sets the machine and port that a PETSc socket 4005c6c1daeSBarry Smith viewer is to use 4015c6c1daeSBarry Smith 4025c6c1daeSBarry Smith Logically Collective on PetscViewer 4035c6c1daeSBarry Smith 4045c6c1daeSBarry Smith Input Parameters: 4055c6c1daeSBarry Smith + v - viewer to connect 4060298fd71SBarry Smith . machine - host to connect to, use NULL for the local machine,use "server" to passively wait for 4075c6c1daeSBarry Smith a connection from elsewhere 4085c6c1daeSBarry Smith - port - the port on the machine one is connecting to, use PETSC_DEFAULT for default 4095c6c1daeSBarry Smith 4105c6c1daeSBarry Smith Level: advanced 4115c6c1daeSBarry Smith 412db781477SPatrick Sanan .seealso: `PetscViewerSocketOpen()` 4135c6c1daeSBarry Smith @*/ 4145c6c1daeSBarry Smith PetscErrorCode PetscViewerSocketSetConnection(PetscViewer v,const char machine[],int port) 4155c6c1daeSBarry Smith { 4165c6c1daeSBarry Smith PetscMPIInt rank; 4175c6c1daeSBarry Smith char mach[256]; 4185c6c1daeSBarry Smith PetscBool tflg; 4193ca90d2dSJacob Faibussowitsch PetscViewer_Socket *vmatlab; 4205c6c1daeSBarry Smith 4215c6c1daeSBarry Smith PetscFunctionBegin; 4223ca90d2dSJacob Faibussowitsch PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1); 4233ca90d2dSJacob Faibussowitsch if (machine) PetscValidCharPointer(machine,2); 4243ca90d2dSJacob Faibussowitsch vmatlab = (PetscViewer_Socket*)v->data; 4255c6c1daeSBarry Smith /* PetscValidLogicalCollectiveInt(v,port,3); not a PetscInt */ 4265c6c1daeSBarry Smith if (port <= 0) { 4275c6c1daeSBarry Smith char portn[16]; 4289566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v),"PETSC_VIEWER_SOCKET_PORT",portn,16,&tflg)); 4295c6c1daeSBarry Smith if (tflg) { 4305c6c1daeSBarry Smith PetscInt pport; 4319566063dSJacob Faibussowitsch PetscCall(PetscOptionsStringToInt(portn,&pport)); 4325c6c1daeSBarry Smith port = (int)pport; 433a297a907SKarl Rupp } else port = PETSCSOCKETDEFAULTPORT; 4345c6c1daeSBarry Smith } 4355c6c1daeSBarry Smith if (!machine) { 4369566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetenv(PetscObjectComm((PetscObject)v),"PETSC_VIEWER_SOCKET_MACHINE",mach,sizeof(mach),&tflg)); 4375c6c1daeSBarry Smith if (!tflg) { 4389566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(mach,sizeof(mach))); 4395c6c1daeSBarry Smith } 4405c6c1daeSBarry Smith } else { 4419566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(mach,machine,sizeof(mach))); 4425c6c1daeSBarry Smith } 4435c6c1daeSBarry Smith 4449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)v),&rank)); 445dd400576SPatrick Sanan if (rank == 0) { 4469566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(mach,"server",&tflg)); 4475c6c1daeSBarry Smith if (tflg) { 4485c6c1daeSBarry Smith int listenport; 4499566063dSJacob Faibussowitsch PetscCall(PetscInfo(v,"Waiting for connection from socket process on port %d\n",port)); 4509566063dSJacob Faibussowitsch PetscCall(PetscSocketEstablish(port,&listenport)); 4519566063dSJacob Faibussowitsch PetscCall(PetscSocketListen(listenport,&vmatlab->port)); 4525c6c1daeSBarry Smith close(listenport); 4535c6c1daeSBarry Smith } else { 4549566063dSJacob Faibussowitsch PetscCall(PetscInfo(v,"Connecting to socket process on port %d machine %s\n",port,mach)); 4559566063dSJacob Faibussowitsch PetscCall(PetscOpenSocket(mach,port,&vmatlab->port)); 4565c6c1daeSBarry Smith } 4575c6c1daeSBarry Smith } 4585c6c1daeSBarry Smith PetscFunctionReturn(0); 4595c6c1daeSBarry Smith } 4605c6c1daeSBarry Smith 4615c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/ 4625c6c1daeSBarry Smith /* 4635c6c1daeSBarry Smith The variable Petsc_Viewer_Socket_keyval is used to indicate an MPI attribute that 4645c6c1daeSBarry Smith is attached to a communicator, in this case the attribute is a PetscViewer. 4655c6c1daeSBarry Smith */ 466d4c7638eSBarry Smith PetscMPIInt Petsc_Viewer_Socket_keyval = MPI_KEYVAL_INVALID; 4675c6c1daeSBarry Smith 4685c6c1daeSBarry Smith /*@C 4695c6c1daeSBarry Smith PETSC_VIEWER_SOCKET_ - Creates a socket viewer shared by all processors in a communicator. 4705c6c1daeSBarry Smith 471d083f849SBarry Smith Collective 4725c6c1daeSBarry Smith 4735c6c1daeSBarry Smith Input Parameter: 4745c6c1daeSBarry Smith . comm - the MPI communicator to share the socket PetscViewer 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Level: intermediate 4775c6c1daeSBarry Smith 4785c6c1daeSBarry Smith Options Database Keys: 4795c6c1daeSBarry Smith For use with the default PETSC_VIEWER_SOCKET_WORLD or if 4800298fd71SBarry Smith NULL is passed for machine or PETSC_DEFAULT is passed for port 4815c6c1daeSBarry Smith $ -viewer_socket_machine <machine> 4825c6c1daeSBarry Smith $ -viewer_socket_port <port> 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith Environmental variables: 485a2b725a8SWilliam Gropp + PETSC_VIEWER_SOCKET_PORT - portnumber 486a2b725a8SWilliam Gropp - PETSC_VIEWER_SOCKET_MACHINE - machine name 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith Notes: 489fa131761SBarry Smith Unlike almost all other PETSc routines, Petsc_VIEWER_SOCKET_ does not return 490fa131761SBarry Smith an error code, it returns NULL if it fails. The socket PetscViewer is usually used in the form 4915c6c1daeSBarry Smith $ XXXView(XXX object,PETSC_VIEWER_SOCKET_(comm)); 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith Currently the only socket client available is MATLAB. See 494c4762a1bSJed Brown src/dm/tests/ex12.c and ex12.m for an example of usage. 4955c6c1daeSBarry Smith 4965c6c1daeSBarry Smith Connects to a waiting socket and stays connected until PetscViewerDestroy() is called. 4975c6c1daeSBarry Smith 498a30fc760SBarry Smith Use this for communicating with an interactive MATLAB session, see PETSC_VIEWER_MATLAB_() for writing output to a 499a30fc760SBarry Smith .mat file. Use PetscMatlabEngineCreate() or PETSC_MATLAB_ENGINE_(), PETSC_MATLAB_ENGINE_SELF, or PETSC_MATLAB_ENGINE_WORLD 500a30fc760SBarry Smith for communicating with a MATLAB Engine 5015c6c1daeSBarry Smith 502db781477SPatrick Sanan .seealso: `PETSC_VIEWER_SOCKET_WORLD`, `PETSC_VIEWER_SOCKET_SELF`, `PetscViewerSocketOpen()`, `PetscViewerCreate()`, 503db781477SPatrick Sanan `PetscViewerSocketSetConnection()`, `PetscViewerDestroy()`, `PETSC_VIEWER_SOCKET_()`, `PetscViewerBinaryWrite()`, `PetscViewerBinaryRead()`, 504db781477SPatrick Sanan `PetscViewerBinaryWriteStringArray()`, `PetscViewerBinaryGetDescriptor()`, `PETSC_VIEWER_MATLAB_()` 5055c6c1daeSBarry Smith @*/ 5065c6c1daeSBarry Smith PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm comm) 5075c6c1daeSBarry Smith { 5085c6c1daeSBarry Smith PetscErrorCode ierr; 5095c6c1daeSBarry Smith PetscBool flg; 5105c6c1daeSBarry Smith PetscViewer viewer; 5115c6c1daeSBarry Smith MPI_Comm ncomm; 5125c6c1daeSBarry Smith 5135c6c1daeSBarry Smith PetscFunctionBegin; 51402c9f0b5SLisandro Dalcin ierr = PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(NULL);} 5155c6c1daeSBarry Smith if (Petsc_Viewer_Socket_keyval == MPI_KEYVAL_INVALID) { 51602c9f0b5SLisandro Dalcin ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,MPI_COMM_NULL_DELETE_FN,&Petsc_Viewer_Socket_keyval,NULL); 51702c9f0b5SLisandro Dalcin if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(NULL);} 5185c6c1daeSBarry Smith } 51947435625SJed Brown ierr = MPI_Comm_get_attr(ncomm,Petsc_Viewer_Socket_keyval,(void**)&viewer,(int*)&flg); 52002c9f0b5SLisandro Dalcin if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(NULL);} 5215c6c1daeSBarry Smith if (!flg) { /* PetscViewer not yet created */ 52202c9f0b5SLisandro Dalcin ierr = PetscViewerSocketOpen(ncomm,NULL,0,&viewer); 5232cb5e1ccSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_REPEAT," ");PetscFunctionReturn(NULL);} 5245c6c1daeSBarry Smith ierr = PetscObjectRegisterDestroy((PetscObject)viewer); 5252cb5e1ccSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_REPEAT," ");PetscFunctionReturn(NULL);} 52647435625SJed Brown ierr = MPI_Comm_set_attr(ncomm,Petsc_Viewer_Socket_keyval,(void*)viewer); 52702c9f0b5SLisandro Dalcin if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(NULL);} 5285c6c1daeSBarry Smith } 5295c6c1daeSBarry Smith ierr = PetscCommDestroy(&ncomm); 5302cb5e1ccSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_SOCKET_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_REPEAT," ");PetscFunctionReturn(NULL);} 5315c6c1daeSBarry Smith PetscFunctionReturn(viewer); 5325c6c1daeSBarry Smith } 533