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 /* FUNCTIONS *****************************************************************/
20 static DRIVER_CANCEL NpfsListeningCancelRoutine
;
22 NpfsListeningCancelRoutine(IN PDEVICE_OBJECT DeviceObject
,
25 PNPFS_WAITER_ENTRY Waiter
;
27 Waiter
= (PNPFS_WAITER_ENTRY
)&Irp
->Tail
.Overlay
.DriverContext
;
29 DPRINT("NpfsListeningCancelRoutine() called for <%wZ>\n",
30 &Waiter
->Ccb
->Fcb
->PipeName
);
32 IoReleaseCancelSpinLock(Irp
->CancelIrql
);
35 KeLockMutex(&Waiter
->Ccb
->Fcb
->CcbListLock
);
36 RemoveEntryList(&Waiter
->Entry
);
37 KeUnlockMutex(&Waiter
->Ccb
->Fcb
->CcbListLock
);
39 Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
40 Irp
->IoStatus
.Information
= 0;
41 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
46 NpfsAddListeningServerInstance(PIRP Irp
,
49 PNPFS_WAITER_ENTRY Entry
;
52 Entry
= (PNPFS_WAITER_ENTRY
)&Irp
->Tail
.Overlay
.DriverContext
;
56 KeLockMutex(&Ccb
->Fcb
->CcbListLock
);
58 IoMarkIrpPending(Irp
);
59 InsertTailList(&Ccb
->Fcb
->WaiterListHead
, &Entry
->Entry
);
61 IoAcquireCancelSpinLock(&oldIrql
);
64 (void)IoSetCancelRoutine(Irp
, NpfsListeningCancelRoutine
);
65 IoReleaseCancelSpinLock(oldIrql
);
66 KeUnlockMutex(&Ccb
->Fcb
->CcbListLock
);
67 return STATUS_PENDING
;
69 IoReleaseCancelSpinLock(oldIrql
);
71 RemoveEntryList(&Entry
->Entry
);
73 Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
74 Irp
->IoStatus
.Information
= 0;
75 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
76 KeUnlockMutex(&Ccb
->Fcb
->CcbListLock
);
78 return STATUS_CANCELLED
;
83 NpfsConnectPipe(PIRP Irp
,
86 PIO_STACK_LOCATION IoStack
;
87 PFILE_OBJECT FileObject
;
89 PLIST_ENTRY current_entry
;
94 DPRINT("NpfsConnectPipe()\n");
96 if (Ccb
->PipeState
== FILE_PIPE_CONNECTED_STATE
)
98 KeResetEvent(&Ccb
->ConnectEvent
);
99 return STATUS_PIPE_CONNECTED
;
102 if (Ccb
->PipeState
== FILE_PIPE_CLOSING_STATE
)
103 return STATUS_PIPE_CLOSING
;
105 DPRINT("Waiting for connection...\n");
108 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
109 FileObject
= IoStack
->FileObject
;
110 Flags
= FileObject
->Flags
;
112 /* search for a listening client fcb */
113 KeLockMutex(&Fcb
->CcbListLock
);
115 current_entry
= Fcb
->ClientCcbListHead
.Flink
;
116 while (current_entry
!= &Fcb
->ClientCcbListHead
)
118 ClientCcb
= CONTAINING_RECORD(current_entry
,
122 if (ClientCcb
->PipeState
== 0)
124 /* found a passive (waiting) client CCB */
125 DPRINT("Passive (waiting) client CCB found -- wake the client\n");
126 KeSetEvent(&ClientCcb
->ConnectEvent
, IO_NO_INCREMENT
, FALSE
);
131 if (ClientCcb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
133 /* found a listening client CCB */
134 DPRINT("Listening client CCB found -- connecting\n");
136 /* connect client and server CCBs */
137 Ccb
->OtherSide
= ClientCcb
;
138 ClientCcb
->OtherSide
= Ccb
;
140 /* set connected state */
141 Ccb
->PipeState
= FILE_PIPE_CONNECTED_STATE
;
142 ClientCcb
->PipeState
= FILE_PIPE_CONNECTED_STATE
;
144 KeUnlockMutex(&Fcb
->CcbListLock
);
146 /* FIXME: create and initialize data queues */
148 /* signal client's connect event */
149 DPRINT("Setting the ConnectEvent for %x\n", ClientCcb
);
150 KeSetEvent(&ClientCcb
->ConnectEvent
, IO_NO_INCREMENT
, FALSE
);
152 return STATUS_PIPE_CONNECTED
;
156 current_entry
= current_entry
->Flink
;
159 /* no listening client fcb found */
160 DPRINT("No listening client fcb found -- waiting for client\n");
162 Ccb
->PipeState
= FILE_PIPE_LISTENING_STATE
;
164 Status
= NpfsAddListeningServerInstance(Irp
, Ccb
);
166 KeUnlockMutex(&Fcb
->CcbListLock
);
168 if (Flags
& FO_SYNCHRONOUS_IO
)
170 KeWaitForSingleObject(&Ccb
->ConnectEvent
,
177 DPRINT("NpfsConnectPipe() done (Status %lx)\n", Status
);
184 NpfsDisconnectPipe(PNPFS_CCB Ccb
)
191 DPRINT("NpfsDisconnectPipe()\n");
194 KeLockMutex(&Fcb
->CcbListLock
);
196 if (Ccb
->PipeState
== FILE_PIPE_DISCONNECTED_STATE
)
198 DPRINT("Pipe is already disconnected\n");
199 Status
= STATUS_SUCCESS
;
201 else if (Ccb
->PipeState
== FILE_PIPE_CONNECTED_STATE
)
203 Server
= (Ccb
->PipeEnd
== FILE_PIPE_SERVER_END
);
204 OtherSide
= Ccb
->OtherSide
;
205 //Ccb->OtherSide = NULL;
206 Ccb
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
207 /* Lock the server first */
210 ExAcquireFastMutex(&Ccb
->DataListLock
);
211 ExAcquireFastMutex(&OtherSide
->DataListLock
);
215 ExAcquireFastMutex(&OtherSide
->DataListLock
);
216 ExAcquireFastMutex(&Ccb
->DataListLock
);
218 OtherSide
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
219 //OtherSide->OtherSide = NULL;
221 * Signaling the write event. If is possible that an other
222 * thread waits for an empty buffer.
224 KeSetEvent(&OtherSide
->ReadEvent
, IO_NO_INCREMENT
, FALSE
);
225 KeSetEvent(&OtherSide
->WriteEvent
, IO_NO_INCREMENT
, FALSE
);
228 ExReleaseFastMutex(&OtherSide
->DataListLock
);
229 ExReleaseFastMutex(&Ccb
->DataListLock
);
233 ExReleaseFastMutex(&Ccb
->DataListLock
);
234 ExReleaseFastMutex(&OtherSide
->DataListLock
);
236 Status
= STATUS_SUCCESS
;
238 else if (Ccb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
241 PNPFS_WAITER_ENTRY WaitEntry
= NULL
;
242 BOOLEAN Complete
= FALSE
;
245 Entry
= Ccb
->Fcb
->WaiterListHead
.Flink
;
246 while (Entry
!= &Ccb
->Fcb
->WaiterListHead
)
248 WaitEntry
= CONTAINING_RECORD(Entry
, NPFS_WAITER_ENTRY
, Entry
);
249 if (WaitEntry
->Ccb
== Ccb
)
251 RemoveEntryList(Entry
);
252 Irp
= CONTAINING_RECORD(Entry
, IRP
, Tail
.Overlay
.DriverContext
);
253 Complete
= (NULL
== IoSetCancelRoutine(Irp
, NULL
));
256 Entry
= Entry
->Flink
;
263 Irp
->IoStatus
.Status
= STATUS_PIPE_BROKEN
;
264 Irp
->IoStatus
.Information
= 0;
265 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
268 Ccb
->PipeState
= FILE_PIPE_DISCONNECTED_STATE
;
269 Status
= STATUS_SUCCESS
;
271 else if (Ccb
->PipeState
== FILE_PIPE_CLOSING_STATE
)
273 Status
= STATUS_PIPE_CLOSING
;
277 Status
= STATUS_UNSUCCESSFUL
;
279 KeUnlockMutex(&Fcb
->CcbListLock
);
285 NpfsWaitPipe(PIRP Irp
,
288 PLIST_ENTRY current_entry
;
291 PFILE_PIPE_WAIT_FOR_BUFFER WaitPipe
;
293 LARGE_INTEGER TimeOut
;
295 DPRINT("NpfsWaitPipe\n");
297 WaitPipe
= (PFILE_PIPE_WAIT_FOR_BUFFER
)Irp
->AssociatedIrp
.SystemBuffer
;
300 if (Ccb
->PipeState
!= 0)
302 DPRINT("Pipe is not in passive (waiting) state!\n");
303 return STATUS_UNSUCCESSFUL
;
306 /* search for listening server */
307 current_entry
= Fcb
->ServerCcbListHead
.Flink
;
308 while (current_entry
!= &Fcb
->ServerCcbListHead
)
310 ServerCcb
= CONTAINING_RECORD(current_entry
,
314 if (ServerCcb
->PipeState
== FILE_PIPE_LISTENING_STATE
)
316 /* found a listening server CCB */
317 DPRINT("Listening server CCB found -- connecting\n");
319 return STATUS_SUCCESS
;
322 current_entry
= current_entry
->Flink
;
325 /* No listening server fcb found */
327 /* If no timeout specified, use the default one */
328 if (WaitPipe
->TimeoutSpecified
)
329 TimeOut
= WaitPipe
->Timeout
;
331 TimeOut
= Fcb
->TimeOut
;
334 Status
= KeWaitForSingleObject(&Ccb
->ConnectEvent
,
340 DPRINT("KeWaitForSingleObject() returned (Status %lx)\n", Status
);
347 * FUNCTION: Return current state of a pipe
349 * Irp = Pointer to I/O request packet
350 * IrpSp = Pointer to current stack location of Irp
352 * Status of operation
356 * FUNCTION: Peek at a pipe (get information about messages)
358 * Irp = Pointer to I/O request packet
359 * IoStack = Pointer to current stack location of Irp
361 * Status of operation
364 NpfsPeekPipe(PIRP Irp
,
365 PIO_STACK_LOCATION IoStack
)
367 ULONG OutputBufferLength
;
368 ULONG ReturnLength
= 0;
369 PFILE_PIPE_PEEK_BUFFER Reply
;
373 ULONG MessageCount
= 0;
375 ULONG ReadDataAvailable
;
378 DPRINT("NpfsPeekPipe\n");
380 OutputBufferLength
= IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
;
381 DPRINT("OutputBufferLength: %lu\n", OutputBufferLength
);
383 /* Validate parameters */
384 if (OutputBufferLength
< sizeof(FILE_PIPE_PEEK_BUFFER
))
386 DPRINT1("Buffer too small\n");
387 return STATUS_INVALID_PARAMETER
;
390 Ccb
= IoStack
->FileObject
->FsContext2
;
391 Reply
= (PFILE_PIPE_PEEK_BUFFER
)Irp
->AssociatedIrp
.SystemBuffer
;
395 Reply
->NamedPipeState
= Ccb
->PipeState
;
397 Reply
->ReadDataAvailable
= Ccb
->ReadDataAvailable
;
398 DPRINT("ReadDataAvailable: %lu\n", Ccb
->ReadDataAvailable
);
400 ExAcquireFastMutex(&Ccb
->DataListLock
);
401 BufferPtr
= Ccb
->ReadPtr
;
402 DPRINT("BufferPtr = %x\n", BufferPtr
);
403 if (Ccb
->Fcb
->PipeType
== FILE_PIPE_BYTE_STREAM_TYPE
)
405 DPRINT("Byte Stream Mode\n");
406 Reply
->MessageLength
= Ccb
->ReadDataAvailable
;
407 DPRINT("Reply->MessageLength %lu\n",Reply
->MessageLength
);
410 if (Reply
->Data
[0] && (OutputBufferLength
>= Ccb
->ReadDataAvailable
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0])))
412 ReturnLength
= Ccb
->ReadDataAvailable
;
413 memcpy(&Reply
->Data
[0], (PVOID
)BufferPtr
, Ccb
->ReadDataAvailable
);
418 DPRINT("Message Mode\n");
419 ReadDataAvailable
=Ccb
->ReadDataAvailable
;
421 if (ReadDataAvailable
> 0)
423 memcpy(&Reply
->MessageLength
, BufferPtr
, sizeof(ULONG
));
425 while ((ReadDataAvailable
> 0) && (BufferPtr
< Ccb
->WritePtr
))
427 memcpy(&MessageLength
, BufferPtr
, sizeof(MessageLength
));
429 ASSERT(MessageLength
> 0);
431 DPRINT("MessageLength = %lu\n",MessageLength
);
432 ReadDataAvailable
-= MessageLength
;
435 /* If its the first message, copy the Message if the size of buffer is large enough */
439 && (OutputBufferLength
>= (MessageLength
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0]))))
441 memcpy(&Reply
->Data
[0], (PVOID
)((ULONG
)BufferPtr
+ sizeof(MessageLength
)), MessageLength
);
442 ReturnLength
= MessageLength
;
446 BufferPtr
=(PVOID
)((ULONG
)BufferPtr
+ MessageLength
+ sizeof(MessageLength
));
447 DPRINT("BufferPtr = %x\n", BufferPtr
);
448 DPRINT("ReadDataAvailable: %lu\n", ReadDataAvailable
);
451 if (ReadDataAvailable
!= 0)
453 DPRINT1("Possible memory corruption.\n");
458 ExReleaseFastMutex(&Ccb
->DataListLock
);
460 Reply
->NumberOfMessages
= MessageCount
;
462 Irp
->IoStatus
.Information
= ReturnLength
+ FIELD_OFFSET(FILE_PIPE_PEEK_BUFFER
, Data
[0]);
463 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
465 Status
= STATUS_SUCCESS
;
467 DPRINT("NpfsPeekPipe done\n");
474 NpfsFileSystemControl(PDEVICE_OBJECT DeviceObject
,
477 PIO_STACK_LOCATION IoStack
;
478 PFILE_OBJECT FileObject
;
480 PNPFS_DEVICE_EXTENSION DeviceExt
;
484 DPRINT("NpfsFileSystemContol(DeviceObject %p Irp %p)\n", DeviceObject
, Irp
);
486 DeviceExt
= (PNPFS_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
487 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
488 DPRINT("IoStack: %p\n", IoStack
);
489 FileObject
= IoStack
->FileObject
;
490 DPRINT("FileObject: %p\n", FileObject
);
491 Ccb
= FileObject
->FsContext2
;
492 DPRINT("CCB: %p\n", Ccb
);
494 DPRINT("Pipe: %p\n", Fcb
);
495 DPRINT("PipeName: %wZ\n", &Fcb
->PipeName
);
497 Irp
->IoStatus
.Information
= 0;
499 switch (IoStack
->Parameters
.FileSystemControl
.FsControlCode
)
501 case FSCTL_PIPE_ASSIGN_EVENT
:
502 DPRINT1("Assign event not implemented\n");
503 Status
= STATUS_NOT_IMPLEMENTED
;
506 case FSCTL_PIPE_DISCONNECT
:
507 DPRINT("Disconnecting pipe %wZ\n", &Fcb
->PipeName
);
508 Status
= NpfsDisconnectPipe(Ccb
);
511 case FSCTL_PIPE_LISTEN
:
512 DPRINT("Connecting pipe %wZ\n", &Fcb
->PipeName
);
513 Status
= NpfsConnectPipe(Irp
, Ccb
);
516 case FSCTL_PIPE_PEEK
:
517 DPRINT("Peeking pipe %wZ\n", &Fcb
->PipeName
);
518 Status
= NpfsPeekPipe(Irp
, (PIO_STACK_LOCATION
)IoStack
);
521 case FSCTL_PIPE_QUERY_EVENT
:
522 DPRINT1("Query event not implemented\n");
523 Status
= STATUS_NOT_IMPLEMENTED
;
526 case FSCTL_PIPE_TRANSCEIVE
:
527 /* If you implement this, please remove the workaround in
528 lib/kernel32/file/npipe.c function TransactNamedPipe() */
529 DPRINT1("Transceive not implemented\n");
530 Status
= STATUS_NOT_IMPLEMENTED
;
533 case FSCTL_PIPE_WAIT
:
534 DPRINT("Waiting for pipe %wZ\n", &Fcb
->PipeName
);
535 Status
= NpfsWaitPipe(Irp
, Ccb
);
538 case FSCTL_PIPE_IMPERSONATE
:
539 DPRINT1("Impersonate not implemented\n");
540 Status
= STATUS_NOT_IMPLEMENTED
;
543 case FSCTL_PIPE_SET_CLIENT_PROCESS
:
544 DPRINT1("Set client process not implemented\n");
545 Status
= STATUS_NOT_IMPLEMENTED
;
548 case FSCTL_PIPE_QUERY_CLIENT_PROCESS
:
549 DPRINT1("Query client process not implemented\n");
550 Status
= STATUS_NOT_IMPLEMENTED
;
553 case FSCTL_PIPE_INTERNAL_READ
:
554 DPRINT1("Internal read not implemented\n");
555 Status
= STATUS_NOT_IMPLEMENTED
;
558 case FSCTL_PIPE_INTERNAL_WRITE
:
559 DPRINT1("Internal write not implemented\n");
560 Status
= STATUS_NOT_IMPLEMENTED
;
563 case FSCTL_PIPE_INTERNAL_TRANSCEIVE
:
564 DPRINT1("Internal transceive not implemented\n");
565 Status
= STATUS_NOT_IMPLEMENTED
;
568 case FSCTL_PIPE_INTERNAL_READ_OVFLOW
:
569 DPRINT1("Internal read overflow not implemented\n");
570 Status
= STATUS_NOT_IMPLEMENTED
;
574 DPRINT1("Unrecognized IoControlCode: %x\n",
575 IoStack
->Parameters
.FileSystemControl
.FsControlCode
);
576 Status
= STATUS_UNSUCCESSFUL
;
579 if (Status
!= STATUS_PENDING
)
581 Irp
->IoStatus
.Status
= Status
;
583 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
591 NpfsFlushBuffers(PDEVICE_OBJECT DeviceObject
,
594 /* FIXME: Implement */
596 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
597 Irp
->IoStatus
.Information
= 0;
599 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
601 return STATUS_SUCCESS
;