summaryrefslogtreecommitdiffstats
path: root/include/utils/FileLock.h
blob: 2253cc257917ae6f6174e72c19959390285415dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
 * Copyright (C) 2010, T-Mobile USA, Inc.
 *
 * Licensed 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __LIBS_FILE_LOCK_H
#define __LIBS_FILE_LOCK_H

#include <fcntl.h>

namespace android {

/*
 * Object oriented interface for flock.  Implements reference counting so that
 * multiple levels of locks on the same object instance is possible.
 */
class FileLock {
public:
    FileLock(const char* fileName);

    /*
     * Lock the file.  A balanced call to unlock is required even if the lock
     * fails.
     */
    bool lock(int openFlags=O_RDWR, mode_t fileCreateMode=0755) {
        mRefCount++;
        if (mFd == -1) {
            return doLock(openFlags, fileCreateMode);
        } else {
            return true;
        }
    }

    /*
     * Call this when mapping is no longer needed.
     */
    void unlock(void) {
        if (--mRefCount <= 0) {
            delete this;
        }
    }

    /*
     * Return the name of the file this map came from, if known.
     */
    const char* getFileName(void) const { return mFileName; }

    /*
     * Return the open file descriptor, if locked; -1 otherwise.
     */
    int getFileDescriptor(void) const { return mFd; }

protected:
    // don't delete objects; call unlock()
    ~FileLock(void);

    bool doLock(int openFlags, mode_t fileCreateMode);

private:

    int         mRefCount;      // reference count
    int         mFd;            // file descriptor, if locked
    char*       mFileName;      // original file name, if known
};

}; // namespace android

#endif // __LIBS_FILE_LOCK_H