LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Citizen.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_DAF_BASE_CITIZEN_H
26 #define LSST_DAF_BASE_CITIZEN_H
27 
28 #include <map>
29 #include <ostream>
30 #include <pthread.h>
31 #include <string>
32 #include <vector>
33 #include <typeinfo>
34 
35 #include "lsst/base.h"
36 
37 namespace lsst {
38 namespace daf {
39 namespace base {
40 
41 class PersistentCitizenScope;
42 
56 public:
58  typedef unsigned long memId;
60  typedef memId (*memNewCallback)(const memId cid);
61  typedef memId (*memCallback)(const Citizen *ptr);
62 
63  Citizen(const std::type_info &);
64  Citizen(Citizen const &);
65  ~Citizen();
66 
67  Citizen &operator=(Citizen const &) { return *this; }
68  //
69  std::string repr() const;
70  void markPersistent(void);
71 
72  static int census(int, memId startingMemId = 0);
73  static void census(std::ostream &stream, memId startingMemId = 0);
74  static const std::vector<const Citizen *> *census();
75 
76  static bool hasBeenCorrupted();
77 
78  memId getId() const;
79 
80  static memId getNextMemId();
81 
82  static memId setNewCallbackId(memId id);
83  static memId setDeleteCallbackId(memId id);
84  static memNewCallback setNewCallback(memNewCallback func);
85  static memCallback setDeleteCallback(memCallback func);
86  static memCallback setCorruptionCallback(memCallback func);
87  //
88  enum { magicSentinel = 0xdeadbeef };
89  static int init();
90 
91 private:
94 
95  int _sentinel; // Initialised to _magicSentinel to detect overwritten memory
96  memId _CitizenId; // unique identifier for this pointer
97  const char *_typeName; // typeid()->name
98 
99  static memId _addCitizen(Citizen const *c);
100  static memId _nextMemIdAndIncrement(void);
101  //
102  // Book-keeping for _CitizenId
103  //
104  static memId _nextMemId(void);
105  static table _activeCitizens;
106  static table _persistentCitizens;
107  static bool &_shouldPersistCitizens();
108  //
109  // Callbacks
110  //
111  static memId _newId; // call _newCallback when _newID is allocated
112  static memId _deleteId; // call _deleteCallback when _deleteID is deleted
113 
114  static memNewCallback _newCallback;
115  static memCallback _deleteCallback;
116  static memCallback _corruptionCallback;
117  //
118  bool _hasBeenCorrupted() const;
119 
121 };
122 
132 public:
135 
136  // No copying
138  PersistentCitizenScope &operator=(const PersistentCitizenScope &) = delete;
139 
140  // No moving
142  PersistentCitizenScope &operator=(PersistentCitizenScope &&) = delete;
143 };
144 
145 } // namespace base
146 } // namespace daf
147 } // namespace lsst
148 
149 #endif
unsigned long memId
Type of the block&#39;s ID.
Definition: Citizen.h:58
uint64_t * ptr
Definition: RangeSet.cc:88
A PersistentCitizenScope object causes all Citizen objects created during its lifetime to be marked a...
Definition: Citizen.h:131
Citizen & operator=(Citizen const &)
Definition: Citizen.h:67
Basic LSST definitions.
def init()
Definition: tests.py:75
STL class.
STL class.
A base class for image defects.
STL class.
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition: base.h:54
Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...
Definition: Citizen.h:55
STL class.