2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: drivers/fs/np/fsctrl.c
5 * PURPOSE: Named pipe filesystem
6 * PROGRAMMER: David Welch <welch@cwcom.net>
11 /* INCLUDES ******************************************************************/
18 //#define USING_PROPER_NPFS_WAIT_SEMANTICS
20 /* FUNCTIONS *****************************************************************/
22 static DRIVER_CANCEL NpfsListeningCancelRoutine
;
24 NpfsListeningCancelRoutine(IN PDEVICE_OBJECT DeviceObject
,
27 PNPFS_WAITER_ENTRY Waiter
;
29 Waiter
= (PNPFS_WAITER_ENTRY
)&Irp
->Tail
.Overlay
.DriverContext
;
31 DPRINT("NpfsListeningCancelRoutine() called for <%wZ>\n",
32 &Waiter
->Ccb
->Fcb
->PipeName
);
34 IoReleaseCancelSpinLock(Irp
->CancelIrql
);
37 KeLockMutex(&Waiter
->Ccb
->Fcb
->CcbListLock
);
38 RemoveEntryList(&Waiter
->Entry
);
39 KeUnlockMutex(&Waiter
->Ccb
->Fcb
->CcbListLock
);
41 Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
42 Irp
->IoStatus
.Information
= 0;
43 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
48 NpfsAddListeningServerInstance(PIRP Irp
,
51 PNPFS_WAITER_ENTRY Entry
;
54 Entry
= (PNPFS_WAITER_ENTRY
)&Irp
->Tail
.Overlay
.DriverContext
;
58 KeLockMutex(&Ccb
->Fcb
->CcbListLock
);
60 IoMarkIrpPending(Irp
);
61 InsertTailList(&Ccb
->Fcb
->WaiterListHead
, &Entry
->Entry
);
63 IoAcquireCancelSpinLock(&oldIrql
);
66 (void)IoSetCancelRoutine(Irp
, NpfsListeningCancelRoutine
);
67 IoReleaseCancelSpinLock(oldIrql
);
68 KeUnlockMutex(&Ccb
->Fcb
->CcbListLock
);
69 return STATUS_PENDING
;
71 IoReleaseCancelSpinLock(oldIrql
);
73 RemoveEntryList(&Entry
->Entry
);
75 Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
76 Irp
->IoStatus
.Information
= 0;
77 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
78 KeUnlockMutex(&Ccb
->Fcb
->CcbListLock
);
80 return STATUS_CANCELLED
;
85 NpfsConnectPipe(PIRP Irp
,
88 PIO_STACK_LOCATION IoStack
;
89 PFILE_OBJECT FileObject
;
91 PLIST_ENTRY current_entry
;
96 DPRINT("NpfsConnectPipe()\n");
98 /* Fail, if the CCB is not a pipe CCB */
99 if (Ccb
->Type
!= CCB_PIPE
)
101 DPRINT1("Not a pipe\n");
102 return STATUS_ILLEGAL_FUNCTION
;
105 /* Fail, if the CCB is not a server end CCB */
106 if (Ccb
->PipeEnd
!= FILE_PIPE_SERVER_END
)
108 DPRINT1("Not the server end\n");
109 return STATUS_ILLEGAL_FUNCTION
;
112 if (Ccb
->PipeState
== FILE_PIPE_CONNECTED_STATE
)
114 KeResetEvent(&Ccb
->ConnectEvent
);
115 return STATUS_PIPE_CONNECTED
;
118 if (Ccb
->PipeState
== FILE_PIPE_CLOSING_STATE
)
119 return STATUS_PIPE_CLOSING
;
121 DPRINT("Waiting for connection...\n");
124 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
125 FileObject
= IoStack
->FileObject
;
126 Flags
= FileObject
->Flags
;
128 /* search for a listening client fcb */
129 KeLockMutex(&Fcb
->CcbListLock
);
131 current_entry
= Fcb
->ClientCcbListHead
.Flink
;
132 while (current_entry
!= &Fcb
->ClientCcbListHead
)
134 ClientCcb
= CONTAINING_RECORD(current_entry
,
138 if (ClientCcb
->PipeState
== 0)
140 /* found a passive (waiting) client CCB */
141 DPRINT("Passive (waiting) client CCB found -- wake the client\n");
142 KeSetEvent(&ClientCcb
->ConnectEvent
, IO_NO_INCREMENT
, FALSE
);
147 if (ClientCcb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
149 /* found a listening client CCB */
150 DPRINT("Listening client CCB found -- connecting\n");
152 /* connect client and server CCBs */
153 Ccb
->OtherSide
= ClientCcb
;
154 ClientCcb
->OtherSide
= Ccb
;
156 /* set connected state */
157 Ccb
->PipeState
= FILE_PIPE_CONNECTED_STATE
;
158 ClientCcb
->PipeState
= FILE_PIPE_CONNECTED_STATE
;
160 KeUnlockMutex(&Fcb
->CcbListLock
);
162 /* FIXME: create and initialize data queues */
164 /* signal client's connect event */
165 DPRINT("Setting the ConnectEvent for %x\n", ClientCcb
);
166 KeSetEvent(&ClientCcb
->ConnectEvent
, IO_NO_INCREMENT
, FALSE
);
168 return STATUS_PIPE_CONNECTED
;
172 current_entry
= current_entry
->Flink
;
175 /* no listening client fcb found */
176 DPRINT("No listening client fcb found -- waiting for client\n");
178 Ccb
->PipeState
= FILE_PIPE_LISTENING_STATE
;
180 Status
= NpfsAddListeningServerInstance(Irp
, Ccb
);
182 KeUnlockMutex(&Fcb
->CcbListLock
);
184 if (Flags
& FO_SYNCHRONOUS_IO
)
186 KeWaitForSingleObject(&Ccb
->ConnectEvent
,
193 DPRINT("NpfsConnectPipe() done (Status %lx)\n", Status
);
200 NpfsDisconnectPipe(PNPFS_CCB Ccb
)
207 DPRINT("NpfsDisconnectPipe()\n");
209 /* Fail, if the CCB is not a pipe CCB */
210 if (Ccb
->Type
!= CCB_PIPE
)
212 DPRINT1("Not a pipe\n");
213 return STATUS_ILLEGAL_FUNCTION
;
216 /* Fail, if the CCB is not a server end CCB */
217 if (Ccb
->PipeEnd
!= FILE_PIPE_SERVER_END
)
219 DPRINT1("Not the server end\n");
220 return STATUS_ILLEGAL_FUNCTION
;
224 KeLockMutex(&Fcb
->CcbListLock
);
226 if (Ccb
->PipeState
== FILE_PIPE_DISCONNECTED_STATE
)
228 DPRINT("Pipe is already disconnected\n");
229 Status
= STATUS_PIPE_DISCONNECTED
;
231 else if ((!Ccb
->OtherSide
) && (Ccb
->PipeState
== FILE_PIPE_CONNECTED_STATE
))
233 ExAcquireFastMutex(&Ccb
->DataListLock
);
234 Ccb
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
235 ExReleaseFastMutex(&Ccb
->DataListLock
);
236 Status
= STATUS_SUCCESS
;
238 else if (Ccb
->PipeState
== FILE_PIPE_CONNECTED_STATE
)
240 Server
= (Ccb
->PipeEnd
== FILE_PIPE_SERVER_END
);
241 OtherSide
= Ccb
->OtherSide
;
242 //Ccb->OtherSide = NULL;
243 Ccb
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
244 /* Lock the server first */
247 ExAcquireFastMutex(&Ccb
->DataListLock
);
248 ExAcquireFastMutex(&OtherSide
->DataListLock
);
252 ExAcquireFastMutex(&OtherSide
->DataListLock
);
253 ExAcquireFastMutex(&Ccb
->DataListLock
);
255 OtherSide
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
256 //OtherSide->OtherSide = NULL;
258 * Signaling the write event. If is possible that an other
259 * thread waits for an empty buffer.
261 KeSetEvent(&OtherSide
->ReadEvent
, IO_NO_INCREMENT
, FALSE
);
262 KeSetEvent(&OtherSide
->WriteEvent
, IO_NO_INCREMENT
, FALSE
);
265 ExReleaseFastMutex(&OtherSide
->DataListLock
);
266 ExReleaseFastMutex(&Ccb
->DataListLock
);
270 ExReleaseFastMutex(&Ccb
->DataListLock
);
271 ExReleaseFastMutex(&OtherSide
->DataListLock
);
273 Status
= STATUS_SUCCESS
;
275 else if (Ccb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
278 PNPFS_WAITER_ENTRY WaitEntry
= NULL
;
279 BOOLEAN Complete
= FALSE
;
282 Entry
= Ccb
->Fcb
->WaiterListHead
.Flink
;
283 while (Entry
!= &Ccb
->Fcb
->WaiterListHead
)
285 WaitEntry
= CONTAINING_RECORD(Entry
, NPFS_WAITER_ENTRY
, Entry
);
286 if (WaitEntry
->Ccb
== Ccb
)
288 RemoveEntryList(Entry
);
289 Irp
= CONTAINING_RECORD(Entry
, IRP
, Tail
.Overlay
.DriverContext
);
290 Complete
= (NULL
== IoSetCancelRoutine(Irp
, NULL
));
293 Entry
= Entry
->Flink
;
300 Irp
->IoStatus
.Status
= STATUS_PIPE_BROKEN
;
301 Irp
->IoStatus
.Information
= 0;
302 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
305 Ccb
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
306 Status
= STATUS_SUCCESS
;
308 else if (Ccb
->PipeState
== FILE_PIPE_CLOSING_STATE
)
310 Status
= STATUS_PIPE_CLOSING
;
314 Status
= STATUS_UNSUCCESSFUL
;
316 KeUnlockMutex(&Fcb
->CcbListLock
);
322 NpfsWaitPipe(PIRP Irp
,
325 PLIST_ENTRY current_entry
;
328 PFILE_PIPE_WAIT_FOR_BUFFER WaitPipe
;
329 LARGE_INTEGER TimeOut
;
331 #ifdef USING_PROPER_NPFS_WAIT_SEMANTICS
333 UNICODE_STRING PipeName
;
336 DPRINT("NpfsWaitPipe\n");
338 WaitPipe
= (PFILE_PIPE_WAIT_FOR_BUFFER
)Irp
->AssociatedIrp
.SystemBuffer
;
340 #ifdef USING_PROPER_NPFS_WAIT_SEMANTICS
341 /* Fail, if the CCB does not represent the root directory */
342 if (Ccb
->Type
!= CCB_DIRECTORY
)
343 return STATUS_ILLEGAL_FUNCTION
;
345 /* Calculate the pipe name length and allocate the buffer */
346 PipeName
.Length
= WaitPipe
->NameLength
+ sizeof(WCHAR
);
347 PipeName
.MaximumLength
= PipeName
.Length
+ sizeof(WCHAR
);
348 PipeName
.Buffer
= ExAllocatePool(NonPagedPool
, PipeName
.MaximumLength
);
349 if (PipeName
.Buffer
== NULL
)
351 DPRINT1("Could not allocate memory for the pipe name!\n");
352 return STATUS_NO_MEMORY
;
355 /* Copy the pipe name into the buffer, prepend a backslash and append a 0 character */
356 PipeName
.Buffer
[0] = L
'\\';
357 RtlCopyMemory(&PipeName
.Buffer
[1],
359 WaitPipe
->NameLength
);
360 PipeName
.Buffer
[PipeName
.Length
/ sizeof(WCHAR
)] = 0;
362 DPRINT("Waiting for Pipe %wZ\n", &PipeName
);
367 /* Lock the pipe list */
368 KeLockMutex(&Vcb
->PipeListLock
);
370 /* File a pipe with the given name */
371 Fcb
= NpfsFindPipe(Vcb
,
374 /* Unlock the pipe list */
375 KeUnlockMutex(&Vcb
->PipeListLock
);
377 /* Release the pipe name buffer */
378 ExFreePool(PipeName
.Buffer
);
380 /* Fail if not pipe was found */
383 DPRINT("No pipe found!\n", Fcb
);
384 return STATUS_OBJECT_NAME_NOT_FOUND
;
387 DPRINT("Fcb %p\n", Fcb
);
391 if (Ccb
->PipeState
!= 0)
393 DPRINT("Pipe is not in passive (waiting) state!\n");
394 return STATUS_UNSUCCESSFUL
;
398 /* search for listening server */
399 current_entry
= Fcb
->ServerCcbListHead
.Flink
;
400 while (current_entry
!= &Fcb
->ServerCcbListHead
)
402 ServerCcb
= CONTAINING_RECORD(current_entry
,
406 if (ServerCcb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
408 /* found a listening server CCB */
409 DPRINT("Listening server CCB found -- connecting\n");
411 return STATUS_SUCCESS
;
414 current_entry
= current_entry
->Flink
;
417 /* No listening server fcb found */
419 /* If no timeout specified, use the default one */
420 if (WaitPipe
->TimeoutSpecified
)
421 TimeOut
= WaitPipe
->Timeout
;
423 TimeOut
= Fcb
->TimeOut
;
426 Status
= KeWaitForSingleObject(&Ccb
->ConnectEvent
,
432 DPRINT("KeWaitForSingleObject() returned (Status %lx)\n", Status
);
439 * FUNCTION: Return current state of a pipe
441 * Irp = Pointer to I/O request packet
442 * IrpSp = Pointer to current stack location of Irp
444 * Status of operation
448 * FUNCTION: Peek at a pipe (get information about messages)
450 * Irp = Pointer to I/O request packet
451 * IoStack = Pointer to current stack location of Irp
453 * Status of operation
456 NpfsPeekPipe(PIRP Irp
,
457 PIO_STACK_LOCATION IoStack
)
459 ULONG OutputBufferLength
;
460 ULONG ReturnLength
= 0;
461 PFILE_PIPE_PEEK_BUFFER Reply
;
465 ULONG MessageCount
= 0;
467 ULONG ReadDataAvailable
;
470 DPRINT("NpfsPeekPipe\n");
472 OutputBufferLength
= IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
;
473 DPRINT("OutputBufferLength: %lu\n", OutputBufferLength
);
475 /* Validate parameters */
476 if (OutputBufferLength
< sizeof(FILE_PIPE_PEEK_BUFFER
))
478 DPRINT1("Buffer too small\n");
479 return STATUS_INVALID_PARAMETER
;
482 Ccb
= IoStack
->FileObject
->FsContext2
;
483 Reply
= (PFILE_PIPE_PEEK_BUFFER
)Irp
->AssociatedIrp
.SystemBuffer
;
487 Reply
->NamedPipeState
= Ccb
->PipeState
;
489 Reply
->ReadDataAvailable
= Ccb
->ReadDataAvailable
;
490 DPRINT("ReadDataAvailable: %lu\n", Ccb
->ReadDataAvailable
);
492 ExAcquireFastMutex(&Ccb
->DataListLock
);
493 BufferPtr
= Ccb
->ReadPtr
;
494 DPRINT("BufferPtr = %x\n", BufferPtr
);
495 if (Ccb
->Fcb
->PipeType
== FILE_PIPE_BYTE_STREAM_TYPE
)
497 DPRINT("Byte Stream Mode\n");
498 Reply
->MessageLength
= Ccb
->ReadDataAvailable
;
499 DPRINT("Reply->MessageLength %lu\n",Reply
->MessageLength
);
502 if (Reply
->Data
[0] && (OutputBufferLength
>= Ccb
->ReadDataAvailable
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0])))
504 ReturnLength
= Ccb
->ReadDataAvailable
;
505 memcpy(&Reply
->Data
[0], (PVOID
)BufferPtr
, Ccb
->ReadDataAvailable
);
510 DPRINT("Message Mode\n");
511 ReadDataAvailable
=Ccb
->ReadDataAvailable
;
513 if (ReadDataAvailable
> 0)
515 memcpy(&Reply
->MessageLength
, BufferPtr
, sizeof(ULONG
));
517 while ((ReadDataAvailable
> 0) && (BufferPtr
< Ccb
->WritePtr
))
519 memcpy(&MessageLength
, BufferPtr
, sizeof(MessageLength
));
521 ASSERT(MessageLength
> 0);
523 DPRINT("MessageLength = %lu\n",MessageLength
);
524 ReadDataAvailable
-= MessageLength
;
527 /* If its the first message, copy the Message if the size of buffer is large enough */
531 && (OutputBufferLength
>= (MessageLength
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0]))))
533 memcpy(&Reply
->Data
[0], (PVOID
)((ULONG_PTR
)BufferPtr
+ sizeof(MessageLength
)), MessageLength
);
534 ReturnLength
= MessageLength
;
538 BufferPtr
=(PVOID
)((ULONG_PTR
)BufferPtr
+ MessageLength
+ sizeof(MessageLength
));
539 DPRINT("BufferPtr = %x\n", BufferPtr
);
540 DPRINT("ReadDataAvailable: %lu\n", ReadDataAvailable
);
543 if (ReadDataAvailable
!= 0)
545 DPRINT1("Possible memory corruption.\n");
550 ExReleaseFastMutex(&Ccb
->DataListLock
);
552 Reply
->NumberOfMessages
= MessageCount
;
554 Irp
->IoStatus
.Information
= ReturnLength
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0]);
555 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
557 Status
= STATUS_SUCCESS
;
559 DPRINT("NpfsPeekPipe done\n");
566 NpfsFileSystemControl(PDEVICE_OBJECT DeviceObject
,
569 PIO_STACK_LOCATION IoStack
;
570 PFILE_OBJECT FileObject
;
576 DPRINT("NpfsFileSystemContol(DeviceObject %p Irp %p)\n", DeviceObject
, Irp
);
578 Vcb
= (PNPFS_VCB
)DeviceObject
->DeviceExtension
;
579 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
580 DPRINT("IoStack: %p\n", IoStack
);
581 FileObject
= IoStack
->FileObject
;
582 DPRINT("FileObject: %p\n", FileObject
);
583 Ccb
= FileObject
->FsContext2
;
584 DPRINT("CCB: %p\n", Ccb
);
586 DPRINT("Pipe: %p\n", Fcb
);
587 DPRINT("PipeName: %wZ\n", &Fcb
->PipeName
);
589 Irp
->IoStatus
.Information
= 0;
591 switch (IoStack
->Parameters
.FileSystemControl
.FsControlCode
)
593 case FSCTL_PIPE_ASSIGN_EVENT
:
594 DPRINT1("Assign event not implemented\n");
595 Status
= STATUS_NOT_IMPLEMENTED
;
598 case FSCTL_PIPE_DISCONNECT
:
599 DPRINT("Disconnecting pipe %wZ\n", &Fcb
->PipeName
);
600 Status
= NpfsDisconnectPipe(Ccb
);
603 case FSCTL_PIPE_LISTEN
:
604 DPRINT("Connecting pipe %wZ\n", &Fcb
->PipeName
);
605 Status
= NpfsConnectPipe(Irp
, Ccb
);
608 case FSCTL_PIPE_PEEK
:
609 DPRINT("Peeking pipe %wZ\n", &Fcb
->PipeName
);
610 Status
= NpfsPeekPipe(Irp
, (PIO_STACK_LOCATION
)IoStack
);
613 case FSCTL_PIPE_QUERY_EVENT
:
614 DPRINT1("Query event not implemented\n");
615 Status
= STATUS_NOT_IMPLEMENTED
;
618 case FSCTL_PIPE_TRANSCEIVE
:
619 /* If you implement this, please remove the workaround in
620 lib/kernel32/file/npipe.c function TransactNamedPipe() */
621 DPRINT1("Transceive not implemented\n");
622 Status
= STATUS_NOT_IMPLEMENTED
;
625 case FSCTL_PIPE_WAIT
:
626 DPRINT("Waiting for pipe %wZ\n", &Fcb
->PipeName
);
627 Status
= NpfsWaitPipe(Irp
, Ccb
);
630 case FSCTL_PIPE_IMPERSONATE
:
631 DPRINT1("Impersonate not implemented\n");
632 Status
= STATUS_NOT_IMPLEMENTED
;
635 case FSCTL_PIPE_SET_CLIENT_PROCESS
:
636 DPRINT1("Set client process not implemented\n");
637 Status
= STATUS_NOT_IMPLEMENTED
;
640 case FSCTL_PIPE_QUERY_CLIENT_PROCESS
:
641 DPRINT1("Query client process not implemented\n");
642 Status
= STATUS_NOT_IMPLEMENTED
;
645 case FSCTL_PIPE_INTERNAL_READ
:
646 DPRINT1("Internal read not implemented\n");
647 Status
= STATUS_NOT_IMPLEMENTED
;
650 case FSCTL_PIPE_INTERNAL_WRITE
:
651 DPRINT1("Internal write not implemented\n");
652 Status
= STATUS_NOT_IMPLEMENTED
;
655 case FSCTL_PIPE_INTERNAL_TRANSCEIVE
:
656 DPRINT1("Internal transceive not implemented\n");
657 Status
= STATUS_NOT_IMPLEMENTED
;
660 case FSCTL_PIPE_INTERNAL_READ_OVFLOW
:
661 DPRINT1("Internal read overflow not implemented\n");
662 Status
= STATUS_NOT_IMPLEMENTED
;
666 DPRINT1("Unrecognized IoControlCode: %x\n",
667 IoStack
->Parameters
.FileSystemControl
.FsControlCode
);
668 Status
= STATUS_UNSUCCESSFUL
;
671 if (Status
!= STATUS_PENDING
)
673 Irp
->IoStatus
.Status
= Status
;
675 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
683 NpfsFlushBuffers(PDEVICE_OBJECT DeviceObject
,
686 /* FIXME: Implement */
688 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
689 Irp
->IoStatus
.Information
= 0;
691 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
693 return STATUS_SUCCESS
;