mpqc-html/html/memproc_8h_source.html

//

// memproc.h

//

// Copyright (C) 1996 Limit Point Systems, Inc.

//

// Author: Curtis Janssen <cljanss@limitpt.com>

// Maintainer: LPS

//

// This file is part of the SC Toolkit.

//

// The SC Toolkit is free software; you can redistribute it and/or modify

// it under the terms of the GNU Library General Public License as published by

// the Free Software Foundation; either version 2, or (at your option)

// any later version.

//

// The SC Toolkit is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU Library General Public License for more details.

//

// You should have received a copy of the GNU Library General Public License

// along with the SC Toolkit; see the file COPYING.LIB.  If not, write to

// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

//

// The U.S. Government is granted a limited license as per AL 91-7.

//


#ifndef _util_group_memproc_h

#define _util_group_memproc_h


#include <sys/types.h>


#include <util/group/memmsg.h>


namespace sc {


class ProcMemoryGrp: public MemoryGrp {

  private:

    char *data_;

  public:

    ProcMemoryGrp();

    ProcMemoryGrp(const Ref<KeyVal>&);

    ~ProcMemoryGrp();


    void set_localsize(size_t);

    void *localdata();


    void *obtain_readwrite(distsize_t offset, size_t size);

    void *obtain_readonly(distsize_t offset, size_t size);

    void *obtain_writeonly(distsize_t offset, size_t size);

    void release_readonly(void *data, distsize_t offset, size_t size);

    void release_writeonly(void *data, distsize_t offset, size_t size);

    void release_readwrite(void *data, distsize_t offset, size_t size);


    void sync();

};


}


#endif


// Local Variables:

// mode: c++

// c-file-style: "CLJ"

// End:

sc::MemoryGrp
The MemoryGrp abstract class provides a way of accessing distributed memory in a parallel machine.
Definition memory.h:120

sc::MemoryGrp::size
int size(int node)
Returns the amount of memory residing on node.
Definition memory.h:161

sc::MemoryGrp::offset
distsize_t offset(int node)
Returns the global offset to node's memory.
Definition memory.h:164

sc::ProcMemoryGrp
The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single processor.
Definition memproc.h:39

sc::ProcMemoryGrp::localdata
void * localdata()
Returns a pointer to the local data.

sc::ProcMemoryGrp::set_localsize
void set_localsize(size_t)
Set the size of locally held memory.

sc::ProcMemoryGrp::obtain_writeonly
void * obtain_writeonly(distsize_t offset, size_t size)
This gives write access to the memory location. No locking is done.

sc::ProcMemoryGrp::release_readwrite
void release_readwrite(void *data, distsize_t offset, size_t size)
This is called when read/write access is no longer needed.

sc::ProcMemoryGrp::obtain_readonly
void * obtain_readonly(distsize_t offset, size_t size)
This gives read access to the memory location. No locking is done.

sc::ProcMemoryGrp::sync
void sync()
Synchronizes all the nodes.

sc::ProcMemoryGrp::release_readonly
void release_readonly(void *data, distsize_t offset, size_t size)
This is called when read access is no longer needed.

sc::ProcMemoryGrp::obtain_readwrite
void * obtain_readwrite(distsize_t offset, size_t size)
Only one thread can have an unreleased obtain_readwrite at a time.

sc::ProcMemoryGrp::release_writeonly
void release_writeonly(void *data, distsize_t offset, size_t size)
This is called when write access is no longer needed.

sc::Ref
A template class that maintains references counts.
Definition ref.h:361

sc
Contains all MPQC code up to version 3.
Definition mpqcin.h:14