storbios.hxx 4.53 KB
Newer Older
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
Michael Meeks's avatar
Michael Meeks committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
19

20 21
#ifndef INCLUDED_STORE_SOURCE_STORBIOS_HXX
#define INCLUDED_STORE_SOURCE_STORBIOS_HXX
22

23 24 25
#include <sal/types.h>
#include <rtl/ref.hxx>
#include <osl/mutex.hxx>
26

27
#include <store/types.h>
28 29 30 31 32 33
#include "object.hxx"
#include "storbase.hxx"

namespace store
{

34 35
class ILockBytes;
class PageCache;
36
struct SuperBlockPage;
37 38 39 40 41 42

class OStorePageBIOS : public store::OStoreObject
{
public:
    /** Construction.
     */
43
    OStorePageBIOS();
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

    /** Conversion into Mutex&
     */
    inline operator osl::Mutex& (void) const;

    /** Initialization.
     *  @param  pLockBytes [in]
     *  @param  eAccessMode [in]
     *  @param  rnPageSize [inout]
     *  @return store_E_None upon success
     */
    virtual storeError initialize (
        ILockBytes *    pLockBytes,
        storeAccessMode eAccessMode,
        sal_uInt16 &    rnPageSize);

    rtl::Reference< PageData::Allocator > & allocator()
    {
        return m_xAllocator;
    }

    /** read.
     */
    storeError read (
68
        sal_uInt32 nAddr, void *pData, sal_uInt32 nSize) const;
69 70 71 72

    /** write.
     */
    storeError write (
73
        sal_uInt32 nAddr, const void *pData, sal_uInt32 nSize) const;
74 75 76

    /** isWriteable.
     */
77
    inline bool isWriteable() const;
78 79 80

    /** isValid.
     */
81
    inline bool isValid() const;
82 83 84 85 86 87

    /** Page Access.
     */
    storeError acquirePage (
        const OStorePageDescriptor& rDescr, storeAccessMode eMode);

88
    storeError releasePage (const OStorePageDescriptor& rDescr);
89

90
    storeError allocate (OStorePageObject& rPage);
91

92
    storeError free (sal_uInt32 nAddr);
93 94 95 96 97 98 99 100 101 102 103 104

    /** Page I/O.
     */
    storeError loadObjectAt (
        OStorePageObject& rPage, sal_uInt32 nAddr);

    storeError saveObjectAt (
        OStorePageObject& rPage, sal_uInt32 nAddr);

    /** close.
     *  @return store_E_None upon success.
     */
105
    storeError close();
106 107 108 109

    /** flush.
     *  @return store_E_None upon success.
     */
110
    storeError flush();
111 112 113 114

protected:
    /** Destruction (OReference).
     */
115
    virtual ~OStorePageBIOS() override;
116 117 118 119 120 121 122

private:
    /** Representation.
     */
    rtl::Reference<ILockBytes>    m_xLockBytes;
    osl::Mutex                    m_aMutex;

123
    std::unique_ptr<SuperBlockPage> m_pSuper;
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

    bool                          m_bWriteable;

    rtl::Reference< PageData::Allocator > m_xAllocator;
    rtl::Reference< PageCache >   m_xCache;

    /** Page Access (control).
     */
public:
    struct Ace
    {
        Ace *      m_next;
        Ace *      m_prev;

        sal_uInt32 m_addr;
        sal_uInt32 m_used;

        Ace();
        ~Ace();

Stephan Bergmann's avatar
Stephan Bergmann committed
144
        static int SAL_CALL constructor (void * obj, void * arg);
145 146 147 148 149 150 151 152 153 154

        static Ace * find   (Ace * head, sal_uInt32 addr);
        static void  insert (Ace * head, Ace * entry);
    };

private:
    Ace m_ace_head;

    class AceCache;

155
    /** Initialization.
156
     */
157 158 159 160 161
    storeError initialize_Impl (
        ILockBytes *    pLockBytes,
        storeAccessMode eAccessMode,
        sal_uInt16 &    rnPageSize);
    void cleanup_Impl();
162 163 164 165

    /** Page Maintenance.
     */
    storeError loadObjectAt_Impl (
166
        OStorePageObject & rPage, sal_uInt32 nAddr) const;
167
    storeError saveObjectAt_Impl (
168
        OStorePageObject & rPage, sal_uInt32 nAddr) const;
169

170 171
    OStorePageBIOS (const OStorePageBIOS&) = delete;
    OStorePageBIOS& operator= (const OStorePageBIOS&) = delete;
172 173 174 175
};

inline OStorePageBIOS::operator osl::Mutex& (void) const
{
176
    return const_cast<osl::Mutex&>(m_aMutex);
177
}
178
inline bool OStorePageBIOS::isWriteable() const
179 180 181
{
    return m_bWriteable;
}
182
inline bool OStorePageBIOS::isValid() const
183 184 185 186 187 188
{
    return m_xLockBytes.is();
}

} // namespace store

189
#endif // INCLUDED_STORE_SOURCE_STORBIOS_HXX
190 191

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */