3 * - By John Hodge (thePowersGang)
16 #include <posix_signals.h>
19 #define OUTPUT_RINGBUFFER_LEN 1024 // Number of bytes in output queue before client blocks
20 #define INPUT_RINGBUFFER_LEN 256 // Number of bytes in input queue before being dropped
21 #define INPUT_LINE_LEN 256
32 tPTY_OutputFcn OutputFcn;
33 tPTY_ReqResize ReqResize;
43 char InputData[INPUT_RINGBUFFER_LEN];
46 char LineData[INPUT_LINE_LEN];
51 char OutputData[OUTPUT_RINGBUFFER_LEN];
53 tVFS_Node *ServerNode;
57 tPGID ControllingProcGroup;
61 int PTY_Install(char **Arguments);
62 int PTY_ReadDir(tVFS_Node *Node, int Pos, char Name[FILENAME_MAX]);
63 tVFS_Node *PTY_FindDir(tVFS_Node *Node, const char *Name, Uint Flags);
65 size_t _rb_write(void *buf, size_t buflen, int *rd, int *wr, const void *data, size_t len);
66 size_t _rb_read(void *buf, size_t buflen, int *rd, int *wr, void *data, size_t len);
67 size_t PTY_int_WriteInput(tPTY *PTY, const char *Input, size_t Length);
68 size_t PTY_int_SendInput(tPTY *PTY, const char *Input, size_t Length);
70 size_t PTY_ReadClient(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags);
71 size_t PTY_WriteClient(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer, Uint Flags);
72 void PTY_ReferenceClient(tVFS_Node *Node);
73 void PTY_CloseClient(tVFS_Node *Node);
74 size_t PTY_ReadServer(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags);
75 size_t PTY_WriteServer(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer, Uint Flags);
76 void PTY_CloseServer(tVFS_Node *Node);
77 int PTY_IOCtl(tVFS_Node *Node, int ID, void *Arg);
80 MODULE_DEFINE(0, 0x100, PTY, PTY_Install, NULL, NULL);
81 tVFS_NodeType gPTY_NodeType_Root = {
82 .TypeName = "PTY-Root",
83 .ReadDir = PTY_ReadDir,
84 .FindDir = PTY_FindDir,
86 tVFS_NodeType gPTY_NodeType_Client = {
87 .TypeName = "PTY-Client",
88 .Read = PTY_ReadClient,
89 .Write = PTY_WriteClient,
91 .Reference = PTY_ReferenceClient,
92 .Close = PTY_CloseClient
94 tVFS_NodeType gPTY_NodeType_Server = {
95 .TypeName = "PTY-Server",
96 .Read = PTY_ReadServer,
97 .Write = PTY_WriteServer,
99 .Close = PTY_CloseServer
101 tDevFS_Driver gPTY_Driver = {
104 .Flags = VFS_FFLAG_DIRECTORY,
105 .Type = &gPTY_NodeType_Root,
110 tRWLock glPTY_NumPTYs;
111 tPTY *gpPTY_FirstNumPTY;
112 int giPTY_NamedCount;
113 tRWLock glPTY_NamedPTYs;
114 tPTY *gpPTY_FirstNamedPTY;
117 int PTY_Install(char **Arguments)
119 DevFS_AddDevice(&gPTY_Driver);
120 return MODULE_ERR_OK;
123 // --- Management ---
124 tPTY *PTY_Create(const char *Name, void *Handle, tPTY_OutputFcn Output, tPTY_ReqResize ReqResize, tPTY_ModeSet ModeSet)
126 tPTY **prev_np = NULL;
133 if( Name[0] == '\0' )
135 RWLock_AcquireWrite(&glPTY_NumPTYs);
136 // Get a pty ID if Name==NULL
137 prev_np = &gpPTY_FirstNumPTY;
138 for( tPTY *pty = gpPTY_FirstNumPTY; pty; prev_np = &pty->Next, pty = pty->Next )
140 if( pty->NumericName > idx )
144 namelen = snprintf(NULL,0, "%u", idx);
146 else if( Name[strlen(Name)-1] == '#' )
149 // - "gui#" would translate to "gui0", "gui1", "gui2", ...
151 prev_np = &gpPTY_FirstNamedPTY;
153 RWLock_AcquireWrite(&glPTY_NamedPTYs);
155 namelen = strlen(Name)-1;
156 for( tPTY *pty = gpPTY_FirstNamedPTY; pty; prev_np = &pty->Next, pty = pty->Next )
158 int cmp = strncmp(pty->Name, Name, namelen);
165 if( pty->Name[namelen] == '\0' )
168 // Find an unused index
170 int this_idx = strtol(pty->Name+namelen, &name_end, 10);
171 if( *name_end != '\0' )
178 namelen += snprintf(NULL, 0, "%u", idx);
182 prev_np = &gpPTY_FirstNamedPTY;
184 // Check the name isn't decimal
186 if( strtol(Name, &end, 10) != 0 && *end == '\0' ) {
191 RWLock_AcquireWrite(&glPTY_NamedPTYs);
193 for( tPTY *pty = gpPTY_FirstNamedPTY; pty; prev_np = &pty->Next, pty = pty->Next )
195 int cmp = strcmp(pty->Name, Name);
199 RWLock_Release(&glPTY_NamedPTYs);
205 namelen = strlen(Name);
209 tPTY *ret = calloc(sizeof(tPTY) + namelen + 1, 1);
215 // - List maintainance
216 ret->Next = *prev_np;
218 // - PTY Name (Used by VT)
219 ret->Name = (char*)(ret + 1);
221 strcpy(ret->Name, Name);
223 sprintf(ret->Name, "%.*s%u", strlen(Name)-1, Name, idx);
225 sprintf(ret->Name, "%u", idx);
226 ret->NumericName = idx;
227 // - Output function and handle (same again)
228 ret->OutputHandle = Handle;
229 ret->OutputFcn = Output;
230 ret->ReqResize = ReqResize;
231 ret->ModeSet = ModeSet;
233 ret->ClientNode.ImplPtr = ret;
234 ret->ClientNode.Type = &gPTY_NodeType_Client;
235 ret->ClientNode.UID = Threads_GetUID();
236 ret->ClientNode.GID = Threads_GetGID();
237 ret->ClientNode.NumACLs = 1;
238 ret->ClientNode.ACLs = &ret->OwnerRW;
239 // - Owner Read-Write ACL
240 ret->OwnerRW.Ent.ID = Threads_GetUID();
241 ret->OwnerRW.Perm.Perms = -1;
245 RWLock_Release(&glPTY_NamedPTYs);
249 RWLock_Release(&glPTY_NumPTYs);
255 int PTY_SetAttrib(tPTY *PTY, const struct ptydims *Dims, const struct ptymode *Mode, int WasClient)
259 // (for now) userland terminals can't be put into framebuffer mode
260 // - Userland PTYs are streams, framebuffer is a block
261 if( !PTY->OutputFcn && (Mode->OutputMode & PTYOMODE_BUFFMT) == PTYBUFFMT_FB ) {
267 if( PTY->ModeSet && PTY->ModeSet(PTY->OutputHandle, Mode) )
272 else if( !PTY->OutputFcn )
274 Log_Warning("PTY", "TODO: Inform server of client SETMODE, halt output");
275 // Block slave write until master ACKs
276 // 0-length read on master indicates need to GETMODE
281 // Should the client be informed that the server just twiddled the modes?
282 Log_Warning("PTY", "Server changed mode, TODO: inform client?");
284 LOG("PTY %p mode set to {0%o, 0%o}", PTY, Mode->InputMode, Mode->OutputMode);
292 if( PTY->ReqResize && PTY->ReqResize(PTY->OutputHandle, Dims) )
297 else if( !PTY->OutputFcn )
299 // Inform server process... somehow
300 Log_Warning("PTY", "TODO: Inform server of client resize request");
305 // SIGWINSZ to client
306 Threads_SignalGroup(PTY->ControllingProcGroup, SIGWINCH);
308 LOG("PTY %p dims set to %ix%i", PTY, Dims->W, Dims->H);
314 void PTY_Close(tPTY *PTY)
319 size_t _rb_write(void *buf, size_t buflen, int *rd, int *wr, const void *data, size_t len)
321 size_t space = (*rd - *wr + buflen - 1) % buflen;
322 len = MIN(space, len);
323 if(*wr + len >= buflen) {
324 size_t prelen = buflen - *wr;
325 memcpy((char*)buf + *wr, data, prelen);
326 memcpy(buf, (char*)data + prelen, len - prelen);
330 memcpy((char*)buf + *wr, data, len);
335 size_t _rb_read(void *buf, size_t buflen, int *rd, int *wr, void *data, size_t len)
337 size_t space = (*wr - *rd + buflen) % buflen;
338 len = MIN(space, len);
339 if(*rd + len >= buflen) {
340 size_t prelen = buflen - *rd;
341 memcpy(data, (char*)buf + *rd, prelen);
342 memcpy((char*)data + prelen, buf, len - prelen);
346 memcpy(data, (char*)buf + *rd, len);
352 size_t PTY_int_WriteInput(tPTY *PTY, const char *Input, size_t Length)
356 Mutex_Acquire(&PTY->InputMutex);
358 ret = _rb_write(PTY->InputData, INPUT_RINGBUFFER_LEN, &PTY->InputReadPos, &PTY->InputWritePos,
361 Mutex_Release(&PTY->InputMutex);
363 VFS_MarkAvaliable(&PTY->ClientNode, 1);
364 if(ret < Length && PTY->ServerNode)
365 VFS_MarkFull(PTY->ServerNode, 1);
370 size_t PTY_int_SendInput(tPTY *PTY, const char *Input, size_t Length)
372 size_t ret = 1, print = 1;
374 // Input mode stuff only counts for text output mode
375 // - Any other is Uint32 keypresses
376 if( (PTY->Mode.OutputMode & PTYOMODE_BUFFMT) != PTYBUFFMT_TEXT )
377 return PTY_int_WriteInput(PTY, Input, Length);
378 // If in raw mode, flush directlr
379 if( (PTY->Mode.InputMode & PTYIMODE_RAW) )
380 return PTY_int_WriteInput(PTY, Input, Length);
382 if( PTY->Mode.InputMode & PTYIMODE_CANON )
384 const char char_bs = '\b';
389 Threads_SignalGroup(PTY->ControllingProcGroup, SIGINT);
393 PTY_int_WriteInput(PTY, PTY->LineData, PTY->LineLength);
394 PTY->HasHitEOF = (PTY->LineLength == 0);
399 if(PTY->LineLength != 0)
402 case 'w'-'a': // Word erase
403 while(PTY->LineLength != 0 && isalnum(PTY->LineData[--PTY->LineLength]))
404 PTY_WriteClient(&PTY->ClientNode, 0, 1, &char_bs, 0);
407 case 'u'-'a': // Kill
408 while(PTY->LineLength > 0)
409 PTY_WriteClient(&PTY->ClientNode, 0, 1, &char_bs, 0);
419 if(PTY->LineLength == INPUT_LINE_LEN) {
420 PTY_int_WriteInput(PTY, PTY->LineData, PTY->LineLength);
423 PTY->LineData[PTY->LineLength++] = '\n';
424 PTY_int_WriteInput(PTY, PTY->LineData, PTY->LineLength);
427 // TODO: Handle ^[[D and ^[[C for in-line editing, also ^[[1~/^[[4~ (home/end)
432 if(PTY->LineLength == INPUT_LINE_LEN) {
433 PTY_int_WriteInput(PTY, PTY->LineData, PTY->LineLength);
436 PTY->LineData[PTY->LineLength++] = Input[0];
442 ret = PTY_int_WriteInput(PTY, Input, Length);
446 if( PTY->Mode.InputMode & PTYIMODE_ECHO )
448 PTY_WriteClient(&PTY->ClientNode, 0, print, Input, 0);
454 size_t PTY_SendInput(tPTY *PTY, const char *Input, size_t Length)
457 while( ret < Length && !PTY->ClientNode.BufferFull )
459 // TODO: Detect blocking?
460 ret += PTY_int_SendInput(PTY, Input + ret, Length - ret);
466 int PTY_ReadDir(tVFS_Node *Node, int Pos, char Name[FILENAME_MAX])
470 if( idx < giPTY_NumCount )
472 RWLock_AcquireRead(&glPTY_NumPTYs);
473 for( pty = gpPTY_FirstNumPTY; pty && idx; pty = pty->Next )
475 RWLock_Release(&glPTY_NumPTYs);
477 else if( idx < (giPTY_NumCount + giPTY_NamedCount) )
479 idx -= giPTY_NumCount;
480 RWLock_AcquireRead(&glPTY_NamedPTYs);
481 for( pty = gpPTY_FirstNamedPTY; pty && idx; pty = pty->Next )
483 RWLock_Release(&glPTY_NamedPTYs);
490 strncpy(Name, pty->Name, FILENAME_MAX);
494 tVFS_Node *PTY_FindDir(tVFS_Node *Node, const char *Name, Uint Flags)
497 int num = strtol(Name, &end, 10);
499 if( strcmp(Name, "ptmx") == 0 ) {
500 tVFS_Node *ret = calloc(sizeof(tVFS_Node), 1);
502 ret->Type = &gPTY_NodeType_Server;
506 if( Name[0] == '\0' )
510 if( num && end[0] == '\0' )
513 RWLock_AcquireRead(&glPTY_NumPTYs);
514 for( tPTY *pty = gpPTY_FirstNumPTY; pty; pty = pty->Next )
516 if( pty->NumericName > num )
518 if( pty->NumericName == num ) {
523 RWLock_Release(&glPTY_NumPTYs);
528 RWLock_AcquireRead(&glPTY_NamedPTYs);
529 for( tPTY *pty = gpPTY_FirstNamedPTY; pty; pty = pty->Next )
531 int cmp = strcmp(pty->Name, Name);
539 RWLock_Release(&glPTY_NamedPTYs);
541 // Debug("PTY_FindDir('%s') returned %p", Name, &ret->ClientNode);
543 tVFS_Node *retnode = &ret->ClientNode;
544 retnode->ReferenceCount ++;
551 //\! Read from the client's input
552 size_t PTY_ReadClient(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags)
554 tPTY *pty = Node->ImplPtr;
556 // Read from flushed queue
557 tTime timeout_z = 0, *timeout = (Flags & VFS_IOFLAG_NOBLOCK) ? &timeout_z : NULL;
560 // If server has disconnected, return EIO
561 if( pty->ServerNode && pty->ServerNode->ReferenceCount == 0 ) {
562 //Threads_PostSignal(SIGPIPE);
566 // Wait for data to be ready
567 rv = VFS_SelectNode(Node, VFS_SELECT_READ, timeout, "PTY_ReadClient");
569 errno = (timeout ? EWOULDBLOCK : EINTR);
573 Mutex_Acquire(&pty->InputMutex);
574 Length = _rb_read(pty->InputData, INPUT_RINGBUFFER_LEN, &pty->InputReadPos, &pty->InputWritePos,
576 if( Length && pty->ServerNode )
577 VFS_MarkFull(pty->ServerNode, 0);
578 Mutex_Release(&pty->InputMutex);
580 if(pty->InputReadPos == pty->InputWritePos)
581 VFS_MarkAvaliable(Node, 0);
583 if(Length == 0 && !pty->HasHitEOF) {
591 //\! Write to the client's output
592 size_t PTY_WriteClient(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer, Uint Flags)
594 tPTY *pty = Node->ImplPtr;
596 // If the server has terminated, send SIGPIPE
597 if( pty->ServerNode && pty->ServerNode->ReferenceCount == 0 )
599 Threads_PostSignal(SIGPIPE);
604 // Write to either FIFO or directly to output function
605 if( pty->OutputFcn ) {
606 pty->OutputFcn(pty->OutputHandle, Length, Buffer);
611 size_t remaining = Length;
614 tTime timeout_z, *timeout = (Flags & VFS_IOFLAG_NOBLOCK) ? &timeout_z : NULL;
617 rv = VFS_SelectNode(Node, VFS_SELECT_WRITE, timeout, "PTY_WriteClient");
619 errno = (timeout ? EWOULDBLOCK : EINTR);
623 // Write to output ringbuffer
624 size_t written = _rb_write(pty->OutputData, OUTPUT_RINGBUFFER_LEN,
625 &pty->OutputReadPos, &pty->OutputWritePos,
627 LOG("Wrote %i of %i : '%.*s'", written, remaining, written, Buffer);
628 VFS_MarkAvaliable(pty->ServerNode, 1);
629 if( (pty->OutputWritePos + 1) % OUTPUT_RINGBUFFER_LEN == pty->OutputReadPos )
630 VFS_MarkFull(Node, 1);
632 remaining -= written;
633 Buffer = (const char*)Buffer + written;
634 } while( remaining > 0 || (Flags & VFS_IOFLAG_NOBLOCK) );
636 return Length - remaining;
639 void PTY_ReferenceClient(tVFS_Node *Node)
641 Node->ReferenceCount ++;
644 void PTY_CloseClient(tVFS_Node *Node)
646 tPTY *pty = Node->ImplPtr;
647 Node->ReferenceCount --;
649 // Remove PID from list
650 // TODO: Maintain list of client processes
652 // Free structure if this was the last open handle
653 if( Node->ReferenceCount > 0 )
655 if( pty->ServerNode && pty->ServerNode->ReferenceCount == 0 )
657 // Free the structure! (Should be off the PTY list now)
658 free(pty->ServerNode);
663 //\! Read from the client's output
664 size_t PTY_ReadServer(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags)
666 tPTY *pty = Node->ImplPtr;
672 // TODO: Prevent two servers fighting over client's output
675 // Kernel-land PTYs can't be read from userland
679 // Read back from fifo
680 tTime timeout_z = 0, *timeout = (Flags & VFS_IOFLAG_NOBLOCK) ? &timeout_z : NULL;
681 int rv = VFS_SelectNode(Node, VFS_SELECT_READ, timeout, "PTY_ReadServer");
683 errno = (timeout ? EWOULDBLOCK : EINTR);
687 Length = _rb_read(pty->OutputData, OUTPUT_RINGBUFFER_LEN,
688 &pty->OutputReadPos, &pty->OutputWritePos,
690 LOG("Read %i '%.*s'", Length, Length, Buffer);
691 if( pty->OutputReadPos == pty->OutputWritePos )
692 VFS_MarkAvaliable(Node, 0);
693 VFS_MarkFull(&pty->ClientNode, 0);
698 //\! Write to the client's input
699 size_t PTY_WriteServer(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer, Uint Flags)
701 tPTY *pty = Node->ImplPtr;
707 tTime timeout_z = 0, *timeout = (Flags & VFS_IOFLAG_NOBLOCK) ? &timeout_z : NULL;
708 int rv = VFS_SelectNode(Node, VFS_SELECT_WRITE, timeout, "PTY_WriteServer");
710 errno = (timeout ? EWOULDBLOCK : EINTR);
715 used += PTY_SendInput(Node->ImplPtr, Buffer, Length);
716 } while( used < Length && !(Flags & VFS_IOFLAG_NOBLOCK) );
718 if( (pty->InputWritePos+1)%INPUT_RINGBUFFER_LEN == pty->InputReadPos )
719 VFS_MarkFull(Node, 1);
723 void PTY_CloseServer(tVFS_Node *Node)
725 tPTY *pty = Node->ImplPtr;
727 Node->ReferenceCount --;
728 // If reference count == 0, remove from main list
729 if( Node->ReferenceCount > 0 )
732 // Locate on list and remove
734 if( pty->NumericName == -1 ) {
735 RWLock_AcquireWrite(&glPTY_NamedPTYs);
736 prev_np = &gpPTY_FirstNamedPTY;
739 RWLock_AcquireWrite(&glPTY_NumPTYs);
740 prev_np = &gpPTY_FirstNumPTY;
743 // Search list until *prev_np is equal to pty
744 for( tPTY *tmp = *prev_np; *prev_np != pty && tmp; prev_np = &tmp->Next, tmp = tmp->Next )
748 if( *prev_np != pty ) {
749 Log_Error("PTY", "PTY %p(%i/%s) not on list at deletion time", pty, pty->NumericName, pty->Name);
752 *prev_np = pty->Next;
756 if( pty->NumericName == -1 ) {
757 RWLock_Release(&glPTY_NamedPTYs);
761 RWLock_Release(&glPTY_NumPTYs);
765 // Send SIGHUP to controling PGID
766 if( pty->ControllingProcGroup > 0 ) {
767 Threads_SignalGroup(pty->ControllingProcGroup, SIGHUP);
770 // If there are no open children, we can safely free this PTY
771 if( pty->ClientNode.ReferenceCount == 0 ) {
777 int PTY_IOCtl(tVFS_Node *Node, int ID, void *Data)
779 tPTY *pty = Node->ImplPtr;
780 struct ptymode *mode = Data;
781 struct ptydims *dims = Data;
783 int is_server = !pty || Node == pty->ServerNode;
787 case DRV_IOCTL_TYPE: return DRV_TYPE_TERMINAL;
788 case DRV_IOCTL_IDENT: memcpy(Data, "PTY\0", 4); return 0;
789 case DRV_IOCTL_VERSION: return 0x100;
790 case DRV_IOCTL_LOOKUP: return 0;
792 case PTY_IOCTL_GETMODE:
794 if( !CheckMem(Data, sizeof(*mode)) ) { errno = EINVAL; return -1; }
796 // TODO: ACK client's SETMODE
798 case PTY_IOCTL_SETMODE:
800 if( !CheckMem(Data, sizeof(*mode)) ) { errno = EINVAL; return -1; }
801 PTY_SetAttrib(pty, NULL, mode, !is_server);
803 case PTY_IOCTL_GETDIMS:
805 if( !CheckMem(Data, sizeof(*dims)) ) { errno = EINVAL; return -1; }
808 case PTY_IOCTL_SETDIMS:
810 if( !CheckMem(Data, sizeof(*dims)) ) { errno = EINVAL; return -1; }
811 PTY_SetAttrib(pty, dims, NULL, !is_server);
813 case PTY_IOCTL_GETID:
816 size_t len = strlen(pty->Name)+1;
819 if( !CheckMem(Data, len) ) { errno = EINVAL; return -1; }
820 strcpy(Data, pty->Name);
825 case PTY_IOCTL_SETID:
826 if( Data && !CheckString(Data) ) { errno = EINVAL; return -1; }
827 if( pty ) return EALREADY;
828 pty = PTY_Create(Data, NULL, NULL,NULL, NULL);
832 pty->ServerNode = Node;
834 case PTY_IOCTL_SETPGRP:
835 // TODO: Should this only be done by client?
838 if( !CheckMem(Data, sizeof(tPGID)) ) { errno = EINVAL; return -1; }
839 pty->ControllingProcGroup = *(tPGID*)Data;
840 Log_Debug("PTY", "Set controlling PGID to %i", pty->ControllingProcGroup);
842 return pty->ControllingProcGroup;