MPQC 2.3.1
memshm.h
1//
2// memshm.h
3//
4// Copyright (C) 1996 Limit Point Systems, Inc.
5//
6// Author: Curtis Janssen <cljanss@limitpt.com>
7// Maintainer: LPS
8//
9// This file is part of the SC Toolkit.
10//
11// The SC Toolkit is free software; you can redistribute it and/or modify
12// it under the terms of the GNU Library General Public License as published by
13// the Free Software Foundation; either version 2, or (at your option)
14// any later version.
15//
16// The SC Toolkit is distributed in the hope that it will be useful,
17// but WITHOUT ANY WARRANTY; without even the implied warranty of
18// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19// GNU Library General Public License for more details.
20//
21// You should have received a copy of the GNU Library General Public License
22// along with the SC Toolkit; see the file COPYING.LIB. If not, write to
23// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24//
25// The U.S. Government is granted a limited license as per AL 91-7.
26//
27
28#ifdef __GNUC__
29#pragma interface
30#endif
31
32#ifndef _util_group_memshm_h
33#define _util_group_memshm_h
34
35#include <sys/types.h>
36#include <sys/ipc.h>
37#include <sys/shm.h>
38#include <iostream>
39
40#include <util/group/globcnt.h>
41#include <util/group/memmsg.h>
42
43#include <util/group/rnglock.h>
44
45namespace sc {
46
51 private:
52 int nregion_;
53 int *shmid_;
54 void **attach_address_;
55 GlobalCounter lock_;
56 GlobalCounter *update_;
57 void *data_;
58 void *memory_;
59 Pool *pool_;
60 RangeLock *rangelock_; // the locks_ member of the base class is ignored
61
62 void clear_release_count();
63 void wait_for_release();
64 void note_release();
65 void obtain_lock();
66 void release_lock();
67
68 void cleanup();
69 int attach_memory(void *ataddress, int size);
70 void detach_memory();
71 public:
72 ShmMemoryGrp(const Ref<MessageGrp>& msg);
75
76 void set_localsize(size_t);
77 void *localdata();
78
82 void release_readonly(void *data, distsize_t offset, int size);
83 void release_writeonly(void *data, distsize_t offset, int size);
84 void release_readwrite(void *data, distsize_t offset, int size);
85
86 void print(std::ostream &o = ExEnv::out0()) const;
87};
88
89}
90
91#endif
92
93// Local Variables:
94// mode: c++
95// c-file-style: "CLJ"
96// End:
static std::ostream & out0()
Return an ostream that writes from node 0.
Definition: globcnt.h:43
int size(int node)
Returns the amount of memory residing on node.
Definition: memory.h:165
distsize_t offset(int node)
Returns the global offset to node's memory.
Definition: memory.h:168
A MsgMemoryGrp that initializes its data using a messagegrp.
Definition: memmsg.h:41
Definition: pool.h:266
Definition: rnglock.h:59
A template class that maintains references counts.
Definition: ref.h:332
The ShmMemoryGrp concrete class provides an implementation of MsgMemoryGrp.
Definition: memshm.h:50
void release_readwrite(void *data, distsize_t offset, int size)
This is called when read/write access is no longer needed.
void release_writeonly(void *data, distsize_t offset, int size)
This is called when write access is no longer needed.
void * localdata()
Returns a pointer to the local data.
void * obtain_writeonly(distsize_t offset, int size)
This gives write access to the memory location. No locking is done.
void * obtain_readonly(distsize_t offset, int size)
This gives read access to the memory location. No locking is done.
void print(std::ostream &o=ExEnv::out0()) const
Prints out information about the object.
void set_localsize(size_t)
Set the size of locally held memory.
void release_readonly(void *data, distsize_t offset, int size)
This is called when read access is no longer needed.
void * obtain_readwrite(distsize_t offset, int size)
Only one thread can have an unreleased obtain_readwrite at a time.
Definition: memory.h:44

Generated at Sun Nov 27 2022 00:00:00 for MPQC 2.3.1 using the documentation package Doxygen 1.9.5.