summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Naming/Persistent_Context_Index.h
blob: 2b60b3ede0ff627c3dc5cf190b59e86b3f2624fc (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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    cos
//
// = FILENAME
//    Persistent_Context_Index.h
//
// = AUTHOR
//    Marina Spivak <marina@cs.wustl.edu>
//
// ============================================================================

#ifndef TAO_PERSISTENT_CONTEXT_INDEX_H
#define TAO_PERSISTENT_CONTEXT_INDEX_H

#include "Persistent_Entries.h"

class TAO_ORBSVCS_Export TAO_Persistent_Context_Index
{
  // = TITLE
  //     This class facilitates implementation of Persistent
  //     Naming Service.  It keeps track, centrally, of several pieces of
  //     info for each Persistent Naming Context, allowing to perform the
  //     initialization necessary for each Naming Context to
  //     restore the state of the Naming Service from persistent storage
  //     on server start-up.
  //
  // = DESCRIPTION
  //     This class creates a memory-mapped file, allocates a hash
  //     table from that file, and uses the hash table to store POA id,
  //     and table and counter pointers for each Persistent Naming
  //     Context.  There are methods for adding and deleting entries
  //     from this hash table as new Persistent Naming Contexts are
  //     created and old ones are destroyed.  This hash table
  //     facilitates Persistent Naming Context servant initialization
  //     upon Naming Server start-up.
public:
  // = Some typedefs for convenience.

  typedef ACE_Hash_Map_With_Allocator<TAO_Persistent_Index_ExtId,
    TAO_Persistent_Index_IntId> CONTEXT_INDEX;
  // Hash map in which we will store info about each Persistent Naming Context.

  typedef ACE_Hash_Map_With_Allocator<TAO_Persistent_ExtId,
    TAO_Persistent_IntId> CONTEXT;
  // Hash map used by Persistent Naming Context to keep its state.

  typedef ACE_Allocator_Adapter <ACE_Malloc <ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX>
  > ALLOCATOR;
  // Allocator we will be using to make the Naming Service persistent.

  // = Initialization and termination methods.

  TAO_Persistent_Context_Index (CORBA::ORB_ptr orb,
                                PortableServer::POA_ptr poa);
  // Constructor.

  int open (LPCTSTR file_name,
            void * base_address = ACE_DEFAULT_BASE_ADDR);
  // Create ACE_Allocator, open/create memory-mapped file with the
  // specified file name/base address.  Find or allocate <index_>.
  // Return 0 on success or -1 on failure.

  int init (size_t context_size);
  // If <index_> contains no entries (i.e., was just created), create
  // a root Persistent Naming Context servant with table of size
  // <context_size>, and make an entry for it
  // in the <index_>.  If <index_> contains entries, create a
  // Persistent Naming Context servant for each entry.  Return 0 on
  // success and -1 on failure.

  ~TAO_Persistent_Context_Index (void);
  // Destructor.  The memory mapped file that was opened/created is
  // not deleted, since we want it to keep the state of the Naming
  // Service until the next run.

  // = Methods for adding/removing entries.

  int bind (const char *poa_id,
            ACE_UINT32 *&counter,
            CONTEXT *hash_map);
  // Create an entry for a Persistent Naming Context in <index_>,
  // i.e., a context with <poa_id>, <counter> and <hash_map> has just
  // been created, and is registering with us.

  int unbind (const char *poa_id);
  // Remove an entry for the Persistent Naming Context with <poa_id>
  // from <index_> (i.e., this context has just been destroyed).

  // = Accessors.

  ACE_Allocator *allocator (void);
  // Return allocator.

  CORBA::ORB_ptr orb (void);
  // Return orb pointer.

  char *root_ior (void);
  // Return ior of the root Naming Context (returns a copy - must be
  // deallocated by the user).

private:

  int recreate_all (void);
  // Helper for the <init> method.  Iterates over <index_>, and
  // creates a servant for each entry.

  int create_index (void);
  // Helper for the <open> method.

  int create_index_helper (void *buffer);
  // Helper for <create_index> method: places hash table into an
  // allocated space.

  ACE_SYNCH_MUTEX lock_;
  // Lock to prevent multiple threads from modifying entries in the
  // <index_> simultanneously.

  ALLOCATOR *allocator_;
  // Allocator that deals out memory from a memory-mapped file.  We
  // use it here, and in TAO_Persistent_Naming_Context, whenever we
  // deal with data that should be kept in persistent store.

  CONTEXT_INDEX *index_;
  // Hash map where we keep entries for all Persistent Naming
  // Contexts.

  LPCTSTR index_file_;
  // Name of the memory-mapped file used by <allocator_>.

  void *base_address_;
  // Base address for the memory-mapped file.

  CORBA::ORB_var orb_;
  // ORB.  We use it for several object_to_string conversions, and
  // keep it around for Persistent Naming Contexts' use.

  PortableServer::POA_var poa_;
  // POA under which to register Persistent Naming Context servants
  // during start-up.

  CORBA::String_var root_ior_;
  // The ior of the root Naming Context.
};

#endif /* TAO_PERSISTENT_CONTEXT_INDEX_H */