filobsup.c File Reference

#include "cdprocs.h"

Include dependency graph for filobsup.c:

Go to the source code of this file.

Macros
#define	BugCheckFileId   (CDFS_BUG_CHECK_FILOBSUP)
#define	TYPE_OF_OPEN_MASK   (0x00000007)

Functions
	_When_ (TypeOfOpen==UnopenedFileObject, _At_(Fcb, _In_opt_))
	_When_ (return==UnopenedFileObject, _At_(*Fcb, _Post_null_)) _When_(return !
	_At_ (Fcb, _Outptr_)
TYPE_OF_OPEN	CdFastDecodeFileObject (_In_ PFILE_OBJECT FileObject, _Out_ PFCB *Fcb)

Macro Definition Documentation

BugCheckFileId

#define BugCheckFileId   (CDFS_BUG_CHECK_FILOBSUP)

Definition at line 22 of file filobsup.c.

TYPE_OF_OPEN_MASK

#define TYPE_OF_OPEN_MASK   (0x00000007)

Definition at line 28 of file filobsup.c.

Function Documentation

_At_()

_At_	(	Fcb	,
		_Outptr_
	)

Definition at line 128 of file filobsup.c.

{
    TYPE_OF_OPEN TypeOfOpen;
 
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER( IrpContext );
 
    //
    //  If this is an unopened file object then return NULL for the
    //  Fcb/Ccb.  Don't trust any other values in the file object.
    //
 
    TypeOfOpen = (TYPE_OF_OPEN) FlagOn( (ULONG_PTR) FileObject->FsContext2,
                                        TYPE_OF_OPEN_MASK );
 
    if (TypeOfOpen == UnopenedFileObject) {
 
        *Fcb = NULL;
        *Ccb = NULL;
 
    } else {
 
        //
        //  The Fcb is pointed to by the FsContext field.  The Ccb is in
        //  FsContext2 (after clearing the low three bits).  The low three
        //  bits are the file object type.
        //
 
        *Fcb = FileObject->FsContext;
        *Ccb = FileObject->FsContext2;
 
#ifdef _MSC_VER
#pragma warning( suppress: 4213 )
#endif
        ClearFlag( (*(PULONG_PTR)Ccb), TYPE_OF_OPEN_MASK ); /* ReactOS Change: GCC "invalid lvalue in assignment" */
    }
 
    //
    //  Now return the type of open.
    //
 
    return TypeOfOpen;
}

_When_() [1/2]

_When_	(	return	= = UnopenedFileObject,
		_At_ *,	_Post_null_
	)

_When_() [2/2]

_When_	(	TypeOfOpen	= = UnopenedFileObject,
		_At_(Fcb, _In_opt_)
	)

Definition at line 37 of file filobsup.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER( IrpContext );
 
    //
    //  We only have values 0 to 7 available so make sure we didn't
    //  inadvertantly add a new type.
    //
 
    NT_ASSERTMSG( "FileObject types exceed available bits\n", BeyondValidType <= 8 );
 
    //
    //  Setting a file object to type UnopenedFileObject means just
    //  clearing all of the context fields.  All the other input
    //
 
    if (TypeOfOpen == UnopenedFileObject) {
 
        FileObject->FsContext =
        FileObject->FsContext2 = NULL;
 
        return;
    }
 
    //
    //  Check that the 3 low-order bits of the Ccb are clear.
    //
 
    NT_ASSERTMSG( "Ccb is not quad-aligned\n", !FlagOn( ((ULONG_PTR) Ccb), TYPE_OF_OPEN_MASK ));
 
    //
    //  We will or the type of open into the low order bits of FsContext2
    //  along with the Ccb value.
    //  The Fcb is stored into the FsContext field.
    //
 
    FileObject->FsContext = Fcb;
    FileObject->FsContext2 = Ccb;
 
#ifdef _MSC_VER
#pragma warning( suppress: 4213 )
#endif
    SetFlag( (*(PULONG_PTR)&FileObject->FsContext2), TypeOfOpen ); /* ReactOS Change: GCC "invalid lvalue in assignment" */
 
    //
    //  Set the Vpb field in the file object.
    //
 
    FileObject->Vpb = Fcb->Vcb->Vpb;
 
    return;
}

CdFastDecodeFileObject()

TYPE_OF_OPEN CdFastDecodeFileObject	(	_In_ PFILE_OBJECT	FileObject,
		_Out_ PFCB *	Fcb
	)

Definition at line 206 of file filobsup.c.

{
    PAGED_CODE();
 
    ASSERT_FILE_OBJECT( FileObject );
 
    //
    //  The Fcb is in the FsContext field.  The type of open is in the low
    //  bits of the Ccb.
    //
 
    *Fcb = FileObject->FsContext;
 
    return (TYPE_OF_OPEN)
            FlagOn( (ULONG_PTR) FileObject->FsContext2, TYPE_OF_OPEN_MASK );
}

Referenced by _Function_class_(), CdFastLock(), CdFastUnlockAll(), CdFastUnlockAllByKey(), and CdFastUnlockSingle().