clocks.c File Reference

#include "precomp.h"
#include <debug.h>

Include dependency graph for clocks.c:

Go to the source code of this file.

Classes
struct	KSIDEFAULTCLOCK
struct	KSICLOCK

Macros
#define	NDEBUG

Typedefs
typedef struct KSIDEFAULTCLOCK *	PKSIDEFAULTCLOCK
typedef struct KSICLOCK *	PKSICLOCK

Functions
NTSTATUS NTAPI	ClockPropertyTime (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyPhysicalTime (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyCorrelatedTime (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyCorrelatedPhysicalTime (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyResolution (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyState (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
NTSTATUS NTAPI	ClockPropertyFunctionTable (IN PIRP Irp, IN PKSIDENTIFIER Request, IN OUT PVOID Data)
	DEFINE_KSPROPERTY_CLOCKSET (ClockPropertyTable, ClockPropertyTime, ClockPropertyPhysicalTime, ClockPropertyCorrelatedTime, ClockPropertyCorrelatedPhysicalTime, ClockPropertyResolution, ClockPropertyState, ClockPropertyFunctionTable)
LONGLONG FASTCALL	ClockGetPhysicalTime (IN PFILE_OBJECT FileObject)
LONGLONG FASTCALL	ClockGetCorrelatedTime (IN PFILE_OBJECT FileObject, OUT PLONGLONG SystemTime)
LONGLONG FASTCALL	ClockGetTime (IN PFILE_OBJECT FileObject)
LONGLONG FASTCALL	ClockGetCorrelatedPhysicalTime (IN PFILE_OBJECT FileObject, OUT PLONGLONG SystemTime)
KSDDKAPI NTSTATUS NTAPI	KsCreateClock (IN HANDLE ConnectionHandle, IN PKSCLOCK_CREATE ClockCreate, OUT PHANDLE ClockHandle)
KSDDKAPI NTSTATUS NTAPI	KsValidateClockCreateRequest (IN PIRP Irp, OUT PKSCLOCK_CREATE *OutClockCreate)
NTSTATUS NTAPI	IKsClock_DispatchDeviceIoControl (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	IKsClock_DispatchClose (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
KSDDKAPI NTSTATUS NTAPI	KsCreateDefaultClock (IN PIRP Irp, IN PKSDEFAULTCLOCK DefaultClock)
KSDDKAPI NTSTATUS NTAPI	KsAllocateDefaultClock (OUT PKSDEFAULTCLOCK *DefaultClock)
KSDDKAPI NTSTATUS NTAPI	KsAllocateDefaultClockEx (OUT PKSDEFAULTCLOCK *DefaultClock, IN PVOID Context OPTIONAL, IN PFNKSSETTIMER SetTimer OPTIONAL, IN PFNKSCANCELTIMER CancelTimer OPTIONAL, IN PFNKSCORRELATEDTIME CorrelatedTime OPTIONAL, IN const KSRESOLUTION *Resolution OPTIONAL, IN ULONG Flags)
KSDDKAPI VOID NTAPI	KsFreeDefaultClock (IN PKSDEFAULTCLOCK DefaultClock)
KSDDKAPI KSSTATE NTAPI	KsGetDefaultClockState (IN PKSDEFAULTCLOCK DefaultClock)
KSDDKAPI VOID NTAPI	KsSetDefaultClockState (IN PKSDEFAULTCLOCK DefaultClock, IN KSSTATE State)
KSDDKAPI LONGLONG NTAPI	KsGetDefaultClockTime (IN PKSDEFAULTCLOCK DefaultClock)
KSDDKAPI VOID NTAPI	KsSetDefaultClockTime (IN PKSDEFAULTCLOCK DefaultClock, IN LONGLONG Time)

Variables
KSPROPERTY_SET	ClockPropertySet []
static KSDISPATCH_TABLE	DispatchTable

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 11 of file clocks.c.

Typedef Documentation

PKSICLOCK

typedef struct KSICLOCK * PKSICLOCK

PKSIDEFAULTCLOCK

typedef struct KSIDEFAULTCLOCK * PKSIDEFAULTCLOCK

Function Documentation

ClockGetCorrelatedPhysicalTime()

LONGLONG FASTCALL ClockGetCorrelatedPhysicalTime	(	IN PFILE_OBJECT	FileObject,
		OUT PLONGLONG	SystemTime
	)

Definition at line 91 of file clocks.c.

{
    UNIMPLEMENTED;
    return 0;
}

Referenced by ClockPropertyCorrelatedPhysicalTime(), and ClockPropertyFunctionTable().

ClockGetCorrelatedTime()

LONGLONG FASTCALL ClockGetCorrelatedTime	(	IN PFILE_OBJECT	FileObject,
		OUT PLONGLONG	SystemTime
	)

Definition at line 72 of file clocks.c.

{
    UNIMPLEMENTED;
    return 0;
}

Referenced by ClockPropertyCorrelatedTime(), and ClockPropertyFunctionTable().

ClockGetPhysicalTime()

LONGLONG FASTCALL ClockGetPhysicalTime

(

IN PFILE_OBJECT

FileObject

)

Definition at line 63 of file clocks.c.

{
    UNIMPLEMENTED;
    return 0;
}

Referenced by ClockPropertyFunctionTable(), and ClockPropertyPhysicalTime().

ClockGetTime()

LONGLONG FASTCALL ClockGetTime

(

IN PFILE_OBJECT

FileObject

)

Definition at line 82 of file clocks.c.

{
    UNIMPLEMENTED;
    return 0;
}

Referenced by ClockPropertyFunctionTable(), and ClockPropertyTime().

ClockPropertyCorrelatedPhysicalTime()

NTSTATUS NTAPI ClockPropertyCorrelatedPhysicalTime	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 155 of file clocks.c.

{
    PKSCORRELATED_TIME Time = (PKSCORRELATED_TIME)Data;
    PIO_STACK_LOCATION IoStack = IoGetCurrentIrpStackLocation(Irp);

    DPRINT("ClockPropertyCorrelatedPhysicalTime\n");

    Time->Time = ClockGetCorrelatedPhysicalTime(IoStack->FileObject, &Time->SystemTime);

    Irp->IoStatus.Information = sizeof(KSCORRELATED_TIME);
    return STATUS_SUCCESS;
}

ClockPropertyCorrelatedTime()

NTSTATUS NTAPI ClockPropertyCorrelatedTime	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 137 of file clocks.c.

{
    PKSCORRELATED_TIME Time = (PKSCORRELATED_TIME)Data;
    PIO_STACK_LOCATION IoStack = IoGetCurrentIrpStackLocation(Irp);

    DPRINT("ClockPropertyCorrelatedTime\n");

    Time->Time = ClockGetCorrelatedTime(IoStack->FileObject, &Time->SystemTime);

    Irp->IoStatus.Information = sizeof(KSCORRELATED_TIME);
    return STATUS_SUCCESS;
}

ClockPropertyFunctionTable()

NTSTATUS NTAPI ClockPropertyFunctionTable	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 238 of file clocks.c.

{
    PKSCLOCK_FUNCTIONTABLE Table = (PKSCLOCK_FUNCTIONTABLE)Data;

    DPRINT("ClockPropertyFunctionTable\n");

    Table->GetCorrelatedPhysicalTime = ClockGetCorrelatedPhysicalTime;
    Table->GetCorrelatedTime = ClockGetCorrelatedTime;
    Table->GetPhysicalTime = ClockGetPhysicalTime;
    Table->GetTime = ClockGetTime;

    return STATUS_SUCCESS;
}

ClockPropertyPhysicalTime()

NTSTATUS NTAPI ClockPropertyPhysicalTime	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 119 of file clocks.c.

{
    PLONGLONG Time = (PLONGLONG)Data;
    PIO_STACK_LOCATION IoStack = IoGetCurrentIrpStackLocation(Irp);

    DPRINT("ClockPropertyPhysicalTime\n");

    *Time = ClockGetPhysicalTime(IoStack->FileObject);

    Irp->IoStatus.Information = sizeof(LONGLONG);
    return STATUS_SUCCESS;
}

ClockPropertyResolution()

NTSTATUS NTAPI ClockPropertyResolution	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 173 of file clocks.c.

{
    PKSICLOCK Clock;
    PKSIOBJECT_HEADER ObjectHeader;
    PIO_STACK_LOCATION IoStack;
    PKSRESOLUTION Resolution = (PKSRESOLUTION)Data;

    DPRINT("ClockPropertyResolution\n");

    /* get stack location */
    IoStack = IoGetCurrentIrpStackLocation(Irp);

    /* get the object header */
    ObjectHeader = (PKSIOBJECT_HEADER)IoStack->FileObject->FsContext2;

    /* sanity check */
    ASSERT(ObjectHeader);

    /* locate ks pin implementation from KSPIN offset */
    Clock = (PKSICLOCK)ObjectHeader->ObjectType;

    Resolution->Error = Clock->DefaultClock->Error;
    Resolution->Granularity = Clock->DefaultClock->Granularity;

    Irp->IoStatus.Information = sizeof(KSRESOLUTION);
    return STATUS_SUCCESS;
}

ClockPropertyState()

NTSTATUS NTAPI ClockPropertyState	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 206 of file clocks.c.

{
    PKSICLOCK Clock;
    PKSIOBJECT_HEADER ObjectHeader;
    PKSSTATE State = (PKSSTATE)Data;
    PIO_STACK_LOCATION IoStack;

    DPRINT("ClockPropertyState\n");

    /* get stack location */
    IoStack = IoGetCurrentIrpStackLocation(Irp);

    /* get the object header */
    ObjectHeader = (PKSIOBJECT_HEADER)IoStack->FileObject->FsContext2;

    /* sanity check */
    ASSERT(ObjectHeader);

    /* locate ks pin implementation from KSPIN offset */
    Clock = (PKSICLOCK)ObjectHeader->ObjectType;

    *State = Clock->DefaultClock->State;
    Irp->IoStatus.Information = sizeof(KSSTATE);

    return STATUS_SUCCESS;
}

ClockPropertyTime()

NTSTATUS NTAPI ClockPropertyTime	(	IN PIRP	Irp,
		IN PKSIDENTIFIER	Request,
		IN OUT PVOID	Data
	)

Definition at line 101 of file clocks.c.

{
    PLONGLONG Time = (PLONGLONG)Data;
    PIO_STACK_LOCATION IoStack = IoGetCurrentIrpStackLocation(Irp);

    DPRINT("ClockPropertyTime\n");

    *Time = ClockGetTime(IoStack->FileObject);

    Irp->IoStatus.Information = sizeof(LONGLONG);
    return STATUS_SUCCESS;
}

DEFINE_KSPROPERTY_CLOCKSET()

DEFINE_KSPROPERTY_CLOCKSET	(	ClockPropertyTable	,
		ClockPropertyTime	,
		ClockPropertyPhysicalTime	,
		ClockPropertyCorrelatedTime	,
		ClockPropertyCorrelatedPhysicalTime	,
		ClockPropertyResolution	,
		ClockPropertyState	,
		ClockPropertyFunctionTable
	)

IKsClock_DispatchClose()

NTSTATUS NTAPI IKsClock_DispatchClose	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 351 of file clocks.c.

{
    UNIMPLEMENTED;

    Irp->IoStatus.Status = STATUS_SUCCESS;
    CompleteRequest(Irp, IO_NO_INCREMENT);

    return STATUS_SUCCESS;
}

IKsClock_DispatchDeviceIoControl()

NTSTATUS NTAPI IKsClock_DispatchDeviceIoControl	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 312 of file clocks.c.

{
    PIO_STACK_LOCATION IoStack;
    UNICODE_STRING GuidString;
    PKSPROPERTY Property;
    NTSTATUS Status;

    DPRINT("IKsClock_DispatchDeviceIoControl\n");

    /* get current io stack */
    IoStack = IoGetCurrentIrpStackLocation(Irp);

    /* FIXME support events */
    ASSERT(IoStack->Parameters.DeviceIoControl.IoControlCode == IOCTL_KS_PROPERTY);

    /* sanity check */
    ASSERT(IoStack->Parameters.DeviceIoControl.InputBufferLength >= sizeof(KSPROPERTY));

    /* call property handler */
    Status = KsPropertyHandler(Irp, 1, ClockPropertySet);

    /* get property from input buffer */
    Property = (PKSPROPERTY)IoStack->Parameters.DeviceIoControl.Type3InputBuffer;

    RtlStringFromGUID(&Property->Set, &GuidString);
    DPRINT("IKsClock_DispatchDeviceIoControl property Set |%S| Id %u Flags %x Status %lx ResultLength %lu\n", GuidString.Buffer, Property->Id, Property->Flags, Status, Irp->IoStatus.Information);
    RtlFreeUnicodeString(&GuidString);


    Irp->IoStatus.Status = STATUS_SUCCESS;
    CompleteRequest(Irp, IO_NO_INCREMENT);

    return STATUS_SUCCESS;
}

KsAllocateDefaultClock()

KSDDKAPI NTSTATUS NTAPI KsAllocateDefaultClock

(

OUT PKSDEFAULTCLOCK *

DefaultClock

)

Definition at line 434 of file clocks.c.

{
    return KsAllocateDefaultClockEx(DefaultClock, NULL, NULL, NULL, NULL, NULL, 0);
}

KsAllocateDefaultClockEx()

KSDDKAPI NTSTATUS NTAPI KsAllocateDefaultClockEx	(	OUT PKSDEFAULTCLOCK *	DefaultClock,
		IN PVOID Context	OPTIONAL,
		IN PFNKSSETTIMER SetTimer	OPTIONAL,
		IN PFNKSCANCELTIMER CancelTimer	OPTIONAL,
		IN PFNKSCORRELATEDTIME CorrelatedTime	OPTIONAL,
		IN const KSRESOLUTION *Resolution	OPTIONAL,
		IN ULONG	Flags
	)

Definition at line 446 of file clocks.c.

{
    PKSIDEFAULTCLOCK Clock;

    if (!DefaultClock)
       return STATUS_INVALID_PARAMETER_1;

    /* allocate default clock */
    Clock = AllocateItem(NonPagedPool, sizeof(KSIDEFAULTCLOCK));
    if (!Clock)
        return STATUS_INSUFFICIENT_RESOURCES;

    /* initialize default clock */
    KeInitializeSpinLock(&Clock->TimeLock);
    KeInitializeTimer(&Clock->Timer);
    Clock->ReferenceCount = 1;
    Clock->Context = Context;
    Clock->SetTimer = SetTimer;
    Clock->CancelTimer = CancelTimer;
    Clock->CorrelatedTime = CorrelatedTime;
    Clock->Flags = Flags;

    if (Resolution)
    {
        if (SetTimer)
        {
            Clock->Error = Resolution->Error;
        }

        if (CorrelatedTime)
        {
            Clock->Granularity = Resolution->Granularity;
        }
    }

    *DefaultClock = (PKSDEFAULTCLOCK)Clock;
    return STATUS_SUCCESS;
}

Referenced by IKsPin_DispatchCreateClock(), and KsAllocateDefaultClock().

KsCreateClock()

KSDDKAPI NTSTATUS NTAPI KsCreateClock	(	IN HANDLE	ConnectionHandle,
		IN PKSCLOCK_CREATE	ClockCreate,
		OUT PHANDLE	ClockHandle
	)

Definition at line 260 of file clocks.c.

{
    return KspCreateObjectType(ConnectionHandle,
                               KSSTRING_Clock,
                               ClockCreate,
                               sizeof(KSCLOCK_CREATE),
                               GENERIC_READ,
                               ClockHandle);
}

KsCreateDefaultClock()

KSDDKAPI NTSTATUS NTAPI KsCreateDefaultClock	(	IN PIRP	Irp,
		IN PKSDEFAULTCLOCK	DefaultClock
	)

Definition at line 383 of file clocks.c.

{
    NTSTATUS Status;
    PKSCLOCK_CREATE ClockCreate;
    PKSICLOCK Clock;

    Status = KsValidateClockCreateRequest(Irp, &ClockCreate);
    if (!NT_SUCCESS(Status))
        return Status;

    /* let's allocate the clock struct */
    Clock = AllocateItem(NonPagedPool, sizeof(KSICLOCK));
    if (!Clock)
    {
        FreeItem(ClockCreate);
        return STATUS_INSUFFICIENT_RESOURCES;
    }

    /* now allocate the object header */
    Status = KsAllocateObjectHeader((PVOID*)&Clock->ObjectHeader, 0, NULL, Irp, &DispatchTable);

    /* did it work */
    if (!NT_SUCCESS(Status))
    {
        /* failed */
        FreeItem(ClockCreate);
        FreeItem(Clock);
        return Status;
    }

    /* initialize clock */
    /* FIXME IKsClock */
    Clock->ObjectHeader->ObjectType = (PVOID)Clock;
    Clock->ref = 1;
    Clock->ClockCreate = ClockCreate;
    Clock->DefaultClock = (PKSIDEFAULTCLOCK)DefaultClock;

    /* increment reference count */
    InterlockedIncrement(&Clock->DefaultClock->ReferenceCount);

    return Status;
}

Referenced by IKsPin_DispatchCreateClock().

KsFreeDefaultClock()

KSDDKAPI VOID NTAPI KsFreeDefaultClock

(

IN PKSDEFAULTCLOCK

DefaultClock

)

Definition at line 498 of file clocks.c.

{
    PKSIDEFAULTCLOCK Clock = (PKSIDEFAULTCLOCK)DefaultClock;

    InterlockedDecrement(&Clock->ReferenceCount);

    if (Clock->ReferenceCount == 0)
    {
        /* free default clock */
        FreeItem(Clock);
    }
}

KsGetDefaultClockState()

KSDDKAPI KSSTATE NTAPI KsGetDefaultClockState

(

IN PKSDEFAULTCLOCK

DefaultClock

)

Definition at line 518 of file clocks.c.

{
    PKSIDEFAULTCLOCK Clock = (PKSIDEFAULTCLOCK)DefaultClock;
    return Clock->State;
}

KsGetDefaultClockTime()

KSDDKAPI LONGLONG NTAPI KsGetDefaultClockTime

(

IN PKSDEFAULTCLOCK

DefaultClock

)

Definition at line 551 of file clocks.c.

{
    LONGLONG Time = 0LL;
    PKSIDEFAULTCLOCK Clock = (PKSIDEFAULTCLOCK)DefaultClock;

    Time = ExInterlockedCompareExchange64(&Clock->Time, &Time, &Time, &Clock->TimeLock);

    return Time;
}

KsSetDefaultClockState()

KSDDKAPI VOID NTAPI KsSetDefaultClockState	(	IN PKSDEFAULTCLOCK	DefaultClock,
		IN KSSTATE	State
	)

Definition at line 531 of file clocks.c.

{
    PKSIDEFAULTCLOCK Clock = (PKSIDEFAULTCLOCK)DefaultClock;

    if (State != Clock->State)
    {
         /* FIXME set time etc */
         Clock->State = State;
    }

}

KsSetDefaultClockTime()

KSDDKAPI VOID NTAPI KsSetDefaultClockTime	(	IN PKSDEFAULTCLOCK	DefaultClock,
		IN LONGLONG	Time
	)

Definition at line 568 of file clocks.c.

{
    PKSIDEFAULTCLOCK Clock = (PKSIDEFAULTCLOCK)DefaultClock;

    /* set the time safely */
    ExInterlockedCompareExchange64(&Clock->Time, &Time, &Clock->Time, &Clock->TimeLock);
}

KsValidateClockCreateRequest()

KSDDKAPI NTSTATUS NTAPI KsValidateClockCreateRequest	(	IN PIRP	Irp,
		OUT PKSCLOCK_CREATE *	OutClockCreate
	)

Definition at line 279 of file clocks.c.

{
    PKSCLOCK_CREATE ClockCreate;
    NTSTATUS Status;
    ULONG Size;

    /* minimum request size */
    Size = sizeof(KSCLOCK_CREATE);

    /* copy create request */
    Status = KspCopyCreateRequest(Irp, 
                                  KSSTRING_Clock,
                                  &Size,
                                  (PVOID*)&ClockCreate);

    if (!NT_SUCCESS(Status))
        return Status;

    if (ClockCreate->CreateFlags != 0)
    {
        /* flags must be zero */
        FreeItem(ClockCreate);
        return STATUS_INVALID_PARAMETER;
    }

    *OutClockCreate = ClockCreate;
    return STATUS_SUCCESS;
}

Referenced by KsCreateDefaultClock().

Variable Documentation

ClockPropertySet

KSPROPERTY_SET ClockPropertySet[]

Initial value:

=
{
    {
        &KSPROPSETID_Clock,
        sizeof(ClockPropertyTable) / sizeof(KSPROPERTY_ITEM),
        (const KSPROPERTY_ITEM*)&ClockPropertyTable,
        0,
        NULL
    }
}

Definition at line 50 of file clocks.c.

Referenced by IKsClock_DispatchDeviceIoControl().

DispatchTable

KSDISPATCH_TABLE DispatchTable

static

Initial value:

=
{
    IKsClock_DispatchDeviceIoControl,
    KsDispatchInvalidDeviceRequest,
    KsDispatchInvalidDeviceRequest,
    KsDispatchInvalidDeviceRequest,
    IKsClock_DispatchClose,
    KsDispatchQuerySecurity,
    KsDispatchSetSecurity,
    KsDispatchFastIoDeviceControlFailure,
    KsDispatchFastReadFailure,
    KsDispatchFastReadFailure,
}

Definition at line 363 of file clocks.c.

Referenced by KsCreateDefaultClock().