Logo ROOT  
Reference Guide
TMapFile.h
Go to the documentation of this file.
1// @(#)root/io:$Id$
2// Author: Fons Rademakers 08/07/97
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TMapFile
13#define ROOT_TMapFile
14
15#ifdef WIN32
16#include "Windows4Root.h"
17#endif
18
19#include "TObject.h"
20
21class TDirectory;
22class TList;
23class TMapRec;
24
25class TMapFile : public TObject {
26
27friend class TMapRec;
28
29private:
30 Longptr_t fFd; ///< Descriptor of mapped file
31 Int_t fVersion; ///< ROOT version (or -1 for shadow map file)
32 char *fName; ///< Name of mapped file
33 char *fTitle; ///< Title of mapped file
34 char *fOption; ///< Directory creation options
35 void *fMmallocDesc; ///< Pointer to mmalloc descriptor
36 ULongptr_t fBaseAddr; ///< Base address of mapped memory region
37 Int_t fSize; ///< Original start size of memory mapped region
38 TMapRec *fFirst; ///< List of streamed objects is shared memory
39 TMapRec *fLast; ///< Last object in list of shared objects
40 Longptr_t fOffset; ///< Offset in bytes for region mapped by reader
41 TDirectory *fDirectory; ///< Pointer to directory associated to this mapfile
42 TList *fBrowseList; ///< List of KeyMapFile objects
43 Bool_t fWritable; ///< TRUE if mapped file opened in RDWR mode
44 Longptr_t fSemaphore; ///< Modification semaphore (or getpid() for WIN32)
45 ULongptr_t fhSemaphore; ///< HANDLE of WIN32 Mutex object to implement semaphore
46 TObject *fGetting; ///< Don't deadlock in update mode, when from Get() Add() is called
47 Int_t fWritten; ///< Number of objects written so far
48 Double_t fSumBuffer; ///< Sum of buffer sizes of objects written so far
49 Double_t fSum2Buffer; ///< Sum of squares of buffer sizes of objects written so far
50
51 static Longptr_t fgMapAddress; ///< Map to this address, set address via SetMapAddress()
52 static void *fgMmallocDesc; ///< Used in Close() and operator delete()
53
54protected:
55 TMapFile();
56 TMapFile(const char *name, const char *title, Option_t *option, Int_t size, TMapFile *&newMapFile);
57 TMapFile(const TMapFile &f, Longptr_t offset = 0);
58
59 TMapFile &operator=(const TMapFile &rhs) = delete;
60
62 void InitDirectory();
63 TObject *Remove(TObject *obj, Bool_t lock);
64 TObject *Remove(const char *name, Bool_t lock);
65 void SumBuffer(Int_t bufsize);
67
68 void CreateSemaphore(Int_t pid = 0);
71 void DeleteSemaphore();
72
73 static void *MapToAddress();
74
75public:
76 enum { kDefaultMapSize = 0x80000 }; // default size of mapped heap is 500 KB
77
78 // Should both be protected (waiting for cint)
79 virtual ~TMapFile();
80 void *operator new(size_t sz) { return TObject::operator new(sz); }
81 void *operator new[](size_t sz) { return TObject::operator new[](sz); }
82 void *operator new(size_t sz, void *vp) { return TObject::operator new(sz, vp); }
83 void *operator new[](size_t sz, void *vp) { return TObject::operator new[](sz, vp); }
84 void operator delete(void *vp);
85
86 void Browse(TBrowser *b) override;
87 void Close(Option_t *option = "");
88 void *GetBaseAddr() const { return (void *)fBaseAddr; }
89 void *GetBreakval() const;
91 Int_t GetFd() const { return fFd; }
92 void *GetMmallocDesc() const { return fMmallocDesc; }
93 const char *GetName() const override { return fName; }
94 Int_t GetSize() const { return fSize; }
95 const char *GetOption() const override { return fOption; }
96 const char *GetTitle() const override { return fTitle; }
97 TMapRec *GetFirst() const { return (TMapRec*)((Longptr_t) fFirst + fOffset); }
98 TMapRec *GetLast() const { return (TMapRec*)((Longptr_t) fLast + fOffset); }
99 Bool_t IsFolder() const override;
100 Bool_t IsWritable() const { return fWritable; }
101 void *OrgAddress(void *addr) const { return (void *)((Longptr_t)addr - fOffset); }
102 void Print(Option_t *option="") const override;
103 void ls(Option_t *option="") const override;
104 Bool_t cd(const char *path = nullptr);
105
106 void Add(const TObject *obj, const char *name = "");
107 void Update(TObject *obj = 0);
108 TObject *Remove(TObject *obj) { return Remove(obj, kTRUE); }
109 TObject *Remove(const char *name) { return Remove(name, kTRUE); }
110 void RemoveAll();
111 TObject *Get(const char *name, TObject *retObj = nullptr);
112
113 static TMapFile *Create(const char *name, Option_t *option="READ", Int_t size=kDefaultMapSize, const char *title="");
114 static TMapFile *WhichMapFile(void *addr);
115 static void SetMapAddress(Longptr_t addr);
116
117 ClassDefOverride(TMapFile,0) // Memory mapped directory structure
118};
119
120
121
122/**
123\class TMapRec
124\ingroup IO
125
126Keep track of an object in the mapped file.
127
128A TMapFile contains a list of TMapRec objects which keep track of
129the actual objects stored in the mapped file.
130*/
131
132class TMapRec {
133
134friend class TMapFile;
135
136private:
137 char *fName; ///< Object name
138 char *fClassName; ///< Class name
139 TObject *fObject; ///< Pointer to original object
140 void *fBuffer; ///< Buffer containing object of class name
141 Int_t fBufSize; ///< Buffer size
142 TMapRec *fNext; ///< Next MapRec in list
143
144 TMapRec(const TMapRec&) = delete;
145 TMapRec &operator=(const TMapRec&) = delete;
146
147public:
148 TMapRec(const char *name, const TObject *obj, Int_t size, void *buf);
149 ~TMapRec();
150 const char *GetName(Longptr_t offset = 0) const { return (char *)((Longptr_t) fName + offset); }
151 const char *GetClassName(Longptr_t offset = 0) const { return (char *)((Longptr_t) fClassName + offset); }
152 void *GetBuffer(Longptr_t offset = 0) const { return (void *)((Longptr_t) fBuffer + offset); }
153 Int_t GetBufSize() const { return fBufSize; }
154 TObject *GetObject() const;
155 TMapRec *GetNext(Longptr_t offset = 0) const { return (TMapRec *)((Longptr_t) fNext + offset); }
156};
157
158#endif
#define f(i)
Definition: RSha256.hxx:104
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
long Longptr_t
Definition: RtypesCore.h:82
unsigned long ULongptr_t
Definition: RtypesCore.h:83
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h offset
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t b
char name[80]
Definition: TGX11.cxx:110
Using a TBrowser one can browse all ROOT objects.
Definition: TBrowser.h:37
Describe directory structure in memory.
Definition: TDirectory.h:45
A doubly linked list.
Definition: TList.h:38
This class implements a shared memory region mapped to a file.
Definition: TMapFile.h:25
static TMapFile * WhichMapFile(void *addr)
Definition: TMapFile.cxx:1232
void * GetBreakval() const
Return the current location in the memory region for this malloc heap which represents the end of mem...
Definition: TMapFile.cxx:1129
Int_t fWritten
Number of objects written so far.
Definition: TMapFile.h:47
Int_t GetSize() const
Definition: TMapFile.h:94
static TMapFile * Create(const char *name, Option_t *option="READ", Int_t size=kDefaultMapSize, const char *title="")
Create a memory mapped file.
Definition: TMapFile.cxx:1147
TMapRec * fLast
Last object in list of shared objects.
Definition: TMapFile.h:39
Int_t fVersion
ROOT version (or -1 for shadow map file)
Definition: TMapFile.h:31
Bool_t IsFolder() const override
Returns kTRUE in case object is a folder (i.e. contains browsable lists).
Definition: TMapFile.cxx:1032
ULongptr_t fBaseAddr
Base address of mapped memory region.
Definition: TMapFile.h:36
TObject * Remove(TObject *obj)
Definition: TMapFile.h:108
const char * GetName() const override
Returns name of object.
Definition: TMapFile.h:93
Int_t GetFd() const
Definition: TMapFile.h:91
void ls(Option_t *option="") const override
List contents of TMapFile.
Definition: TMapFile.cxx:1078
void Close(Option_t *option="")
Close a mapped file.
Definition: TMapFile.cxx:954
TDirectory * fDirectory
Pointer to directory associated to this mapfile.
Definition: TMapFile.h:41
void SumBuffer(Int_t bufsize)
Increment statistics for buffer sizes of objects in this file.
Definition: TMapFile.cxx:1103
void Update(TObject *obj=0)
Update an object (or all objects, if obj == 0) in shared memory.
Definition: TMapFile.cxx:634
void * GetMmallocDesc() const
Definition: TMapFile.h:92
const char * GetTitle() const override
Returns title of object.
Definition: TMapFile.h:96
TObject * Get(const char *name, TObject *retObj=nullptr)
Return pointer to object retrieved from shared memory.
Definition: TMapFile.cxx:775
void * GetBaseAddr() const
Definition: TMapFile.h:88
void Print(Option_t *option="") const override
Print some info about the mapped file.
Definition: TMapFile.cxx:1015
char * fTitle
Title of mapped file.
Definition: TMapFile.h:33
void InitDirectory()
Create the directory associated to this mapfile.
Definition: TMapFile.cxx:580
TMapRec * GetLast() const
Definition: TMapFile.h:98
Bool_t IsWritable() const
Definition: TMapFile.h:100
TMapFile & operator=(const TMapFile &rhs)=delete
void RemoveAll()
Remove all objects from shared memory.
Definition: TMapFile.cxx:750
Double_t fSum2Buffer
Sum of squares of buffer sizes of objects written so far.
Definition: TMapFile.h:49
Bool_t fWritable
TRUE if mapped file opened in RDWR mode.
Definition: TMapFile.h:43
Longptr_t fOffset
Offset in bytes for region mapped by reader.
Definition: TMapFile.h:40
void * OrgAddress(void *addr) const
Definition: TMapFile.h:101
const char * GetOption() const override
Definition: TMapFile.h:95
Bool_t cd(const char *path=nullptr)
Cd to associated directory.
Definition: TMapFile.cxx:1068
void DeleteSemaphore()
Delete the semaphore.
Definition: TMapFile.cxx:852
Longptr_t fSemaphore
Modification semaphore (or getpid() for WIN32)
Definition: TMapFile.h:44
TList * fBrowseList
List of KeyMapFile objects.
Definition: TMapFile.h:42
TMapRec * fFirst
List of streamed objects is shared memory.
Definition: TMapFile.h:38
ULongptr_t fhSemaphore
HANDLE of WIN32 Mutex object to implement semaphore.
Definition: TMapFile.h:45
static void * MapToAddress()
Return the base address at which we would like the next TMapFile's mapped data to start.
Definition: TMapFile.cxx:1206
TObject * fGetting
Don't deadlock in update mode, when from Get() Add() is called.
Definition: TMapFile.h:46
TMapFile * FindShadowMapFile()
Returns shadow map file.
Definition: TMapFile.cxx:999
void * fMmallocDesc
Pointer to mmalloc descriptor.
Definition: TMapFile.h:35
Double_t fSumBuffer
Sum of buffer sizes of objects written so far.
Definition: TMapFile.h:48
static void * fgMmallocDesc
Used in Close() and operator delete()
Definition: TMapFile.h:52
TDirectory * GetDirectory() const
Definition: TMapFile.h:90
void CreateSemaphore(Int_t pid=0)
Create semaphore used for synchronizing access to shared memory.
Definition: TMapFile.cxx:822
Longptr_t fFd
Descriptor of mapped file.
Definition: TMapFile.h:30
Int_t fSize
Original start size of memory mapped region.
Definition: TMapFile.h:37
TObject * Remove(TObject *obj, Bool_t lock)
Remove object from shared memory.
Definition: TMapFile.cxx:674
Int_t ReleaseSemaphore()
Release semaphore. Returns 0 if OK, -1 on error.
Definition: TMapFile.cxx:922
static void SetMapAddress(Longptr_t addr)
Set preferred map address.
Definition: TMapFile.cxx:1184
char * fName
Name of mapped file.
Definition: TMapFile.h:32
TMapFile()
Default ctor. Does not much except setting some basic values.
Definition: TMapFile.cxx:198
char * fOption
Directory creation options.
Definition: TMapFile.h:34
Int_t AcquireSemaphore()
Acquire semaphore. Returns 0 if OK, -1 on error.
Definition: TMapFile.cxx:877
TObject * Remove(const char *name)
Definition: TMapFile.h:109
void Browse(TBrowser *b) override
Browse contents of TMapFile.
Definition: TMapFile.cxx:1041
void Add(const TObject *obj, const char *name="")
Add an object to the list of objects to be stored in shared memory.
Definition: TMapFile.cxx:595
virtual ~TMapFile()
TMapFiles may not be deleted, since we want to keep the complete TMapFile object in the mapped file f...
Definition: TMapFile.cxx:547
static Longptr_t fgMapAddress
Map to this address, set address via SetMapAddress()
Definition: TMapFile.h:51
Int_t GetBestBuffer()
Return the best buffer size for objects in this file.
Definition: TMapFile.cxx:1117
@ kDefaultMapSize
Definition: TMapFile.h:76
TMapRec * GetFirst() const
Definition: TMapFile.h:97
Keep track of an object in the mapped file.
Definition: TMapFile.h:132
TObject * fObject
Pointer to original object.
Definition: TMapFile.h:139
TMapRec & operator=(const TMapRec &)=delete
Int_t fBufSize
Buffer size.
Definition: TMapFile.h:141
TMapRec(const TMapRec &)=delete
char * fName
Object name.
Definition: TMapFile.h:137
const char * GetClassName(Longptr_t offset=0) const
Definition: TMapFile.h:151
TMapRec * fNext
Next MapRec in list.
Definition: TMapFile.h:142
TObject * GetObject() const
This method returns a pointer to the original object.
Definition: TMapFile.cxx:185
const char * GetName(Longptr_t offset=0) const
Definition: TMapFile.h:150
TMapRec * GetNext(Longptr_t offset=0) const
Definition: TMapFile.h:155
void * GetBuffer(Longptr_t offset=0) const
Definition: TMapFile.h:152
char * fClassName
Class name.
Definition: TMapFile.h:138
Int_t GetBufSize() const
Definition: TMapFile.h:153
void * fBuffer
Buffer containing object of class name.
Definition: TMapFile.h:140
~TMapRec()
Destructor.
Definition: TMapFile.cxx:173
Mother of all ROOT objects.
Definition: TObject.h:37