src/smpi/mpi/smpi_file.cpp

   1 /* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5 #include "private.hpp"
   6
   7 #include "smpi_comm.hpp"
   8 #include "smpi_coll.hpp"
   9 #include "smpi_datatype.hpp"
  10 #include "smpi_info.hpp"
  11 #include "smpi_win.hpp"
  12 #include "smpi_request.hpp"
  13
  14 #include "smpi_file.hpp"
  15 #include "smpi_status.hpp"
  16 #include "simgrid/s4u/Disk.hpp"
  17 #include "simgrid/s4u/Host.hpp"
  18 #include "simgrid/plugins/file_system.h"
  19
  20 #define FP_SIZE sizeof(MPI_Offset)
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_io, smpi, "Logging specific to SMPI (RMA operations)");
  23
  24 MPI_Errhandler SMPI_default_File_Errhandler = MPI_ERRORS_RETURN;
  25
  26 namespace simgrid{
  27 namespace smpi{
  28
  29   File::File(MPI_Comm comm, const char *filename, int amode, MPI_Info info): comm_(comm), flags_(amode), info_(info) {
  30     if (info_ != MPI_INFO_NULL)
  31       info_->ref();
  32     std::string fullname=filename;
  33     if (simgrid::s4u::Host::current()->get_disks().empty())
  34       xbt_die("SMPI/IO : Trying to open file on a diskless host ! Add one to your platform file");
  35
  36     size_t found=fullname.find('/');
  37     //in case no fullpath is provided ... just pick the first mountpoint.
  38     if(found==std::string::npos || fullname.rfind("./", 1) != std::string::npos){
  39       auto disk = simgrid::s4u::Host::current()->get_disks().front();
  40       std::string mount;
  41       if (disk->get_host() != simgrid::s4u::Host::current())
  42         mount = disk->extension<simgrid::s4u::FileSystemDiskExt>()->get_mount_point(disk->get_host());
  43       else
  44         mount = disk->extension<simgrid::s4u::FileSystemDiskExt>()->get_mount_point();
  45       XBT_DEBUG("No absolute path given for file opening, use '%s'", mount.c_str());
  46       if(fullname.rfind("./",1) != std::string::npos)
  47         fullname.replace(fullname.begin(), fullname.begin() + 1, mount);
  48       else{
  49         mount.append("/");
  50         fullname.insert(0, mount);
  51       }
  52     }
  53
  54     file_= new simgrid::s4u::File(fullname, nullptr);
  55     list_=nullptr;
  56     if (comm_->rank() == 0) {
  57       int size= comm_->size() + FP_SIZE;
  58       list_ = new char[size];
  59       errhandler_= SMPI_default_File_Errhandler;
  60       errhandler_->ref();
  61       memset(list_, 0, size);
  62       shared_file_pointer_ = new MPI_Offset();
  63       shared_mutex_ = s4u::Mutex::create();
  64       *shared_file_pointer_ = 0;
  65       win_=new Win(list_, size, 1, MPI_INFO_NULL, comm_);
  66     }else{
  67       errhandler_ = MPI_ERRHANDLER_NULL;
  68       win_=new Win(list_, 0, 1, MPI_INFO_NULL, comm_);
  69     }
  70     simgrid::smpi::colls::bcast(&shared_file_pointer_, 1, MPI_AINT, 0, comm);
  71     simgrid::smpi::colls::bcast(&shared_mutex_, 1, MPI_AINT, 0, comm);
  72     if(comm_->rank() != 0)
  73       intrusive_ptr_add_ref(&*shared_mutex_);
  74     this->add_f();
  75   }
  76
  77   File::~File(){
  78     if(comm_->rank() == 0){
  79       delete shared_file_pointer_;
  80       delete[] list_;
  81     }
  82     delete win_;
  83     delete file_;
  84     F2C::free_f(this->c2f());
  85     if (info_ != MPI_INFO_NULL)
  86       simgrid::smpi::Info::unref(info_);
  87     if (errhandler_ != MPI_ERRHANDLER_NULL)
  88       simgrid::smpi::Errhandler::unref(errhandler_);
  89   }
  90
  91   int File::close(MPI_File *fh){
  92     XBT_DEBUG("Closing MPI_File %s", (*fh)->file_->get_path());
  93     (*fh)->sync();
  94     if((*fh)->flags() & MPI_MODE_DELETE_ON_CLOSE)
  95       (*fh)->file_->unlink();
  96     delete (*fh);
  97     return MPI_SUCCESS;
  98   }
  99
 100   int File::del(const char* filename, const Info*)
 101   {
 102     //get the file with MPI_MODE_DELETE_ON_CLOSE and then close it
 103     auto* f = new File(MPI_COMM_SELF, filename, MPI_MODE_DELETE_ON_CLOSE | MPI_MODE_RDWR, nullptr);
 104     close(&f);
 105     return MPI_SUCCESS;
 106   }
 107
 108   int File::get_position(MPI_Offset* offset) const
 109   {
 110     *offset=file_->tell();
 111     return MPI_SUCCESS;
 112   }
 113
 114   int File::get_position_shared(MPI_Offset* offset) const
 115   {
 116     shared_mutex_->lock();
 117     *offset=*shared_file_pointer_;
 118     shared_mutex_->unlock();
 119     return MPI_SUCCESS;
 120   }
 121
 122   int File::seek(MPI_Offset offset, int whence){
 123     switch(whence){
 124       case(MPI_SEEK_SET):
 125         XBT_VERB("Seeking in MPI_File %s, setting offset %lld", file_->get_path(), offset);
 126         file_->seek(offset,SEEK_SET);
 127         break;
 128       case(MPI_SEEK_CUR):
 129         XBT_VERB("Seeking in MPI_File %s, current offset + %lld", file_->get_path(), offset);
 130         file_->seek(offset,SEEK_CUR);
 131         break;
 132       case(MPI_SEEK_END):
 133         XBT_VERB("Seeking in MPI_File %s, end offset + %lld", file_->get_path(), offset);
 134         file_->seek(offset,SEEK_END);
 135         break;
 136       default:
 137         return MPI_ERR_FILE;
 138     }
 139     return MPI_SUCCESS;
 140   }
 141
 142   int File::seek_shared(MPI_Offset offset, int whence){
 143     shared_mutex_->lock();
 144     seek(offset,whence);
 145     *shared_file_pointer_=file_->tell();
 146     shared_mutex_->unlock();
 147     return MPI_SUCCESS;
 148   }
 149
 150   int File::read(MPI_File fh, void* /*buf*/, int count, const Datatype* datatype, MPI_Status* status)
 151   {
 152     //get position first as we may be doing non contiguous reads and it will probably be updated badly
 153     MPI_Offset position = fh->file_->tell();
 154     MPI_Offset movesize = datatype->get_extent()*count;
 155     MPI_Offset readsize = datatype->size()*count;
 156     XBT_DEBUG("Position before read in MPI_File %s : %llu",fh->file_->get_path(),fh->file_->tell());
 157     MPI_Offset read = fh->file_->read(readsize);
 158     XBT_VERB("Read in MPI_File %s, %lld bytes read, readsize %lld bytes, movesize %lld", fh->file_->get_path(), read, readsize, movesize);
 159     if(readsize!=movesize){
 160       fh->file_->seek(position+movesize, SEEK_SET);
 161     }
 162     XBT_VERB("Position after read in MPI_File %s : %llu",fh->file_->get_path(), fh->file_->tell());
 163     if(status != MPI_STATUS_IGNORE)
 164       status->count=count*datatype->size();
 165     return MPI_SUCCESS;
 166   }
 167
 168   /*Ordered and Shared Versions, with RMA-based locks : Based on the model described in :*/
 169   /* @InProceedings{10.1007/11557265_15,*/
 170   /* author="Latham, Robert and Ross, Robert and Thakur, Rajeev and Toonen, Brian",*/
 171   /* title="Implementing MPI-IO Shared File Pointers Without File System Support",*/
 172   /* booktitle="Recent Advances in Parallel Virtual Machine and Message Passing Interface",*/
 173   /* year="2005",*/
 174   /* publisher="Springer Berlin Heidelberg",*/
 175   /* address="Berlin, Heidelberg",*/
 176   /* pages="84--93"*/
 177   /* }*/
 178   int File::read_shared(MPI_File fh, void* buf, int count, const Datatype* datatype, MPI_Status* status)
 179   {
 180     fh->shared_mutex_->lock();
 181     fh->seek(*(fh->shared_file_pointer_),MPI_SEEK_SET);
 182     read(fh, buf, count, datatype, status);
 183     *(fh->shared_file_pointer_)=fh->file_->tell();
 184     fh->shared_mutex_->unlock();
 185     return MPI_SUCCESS;
 186   }
 187
 188   int File::read_ordered(MPI_File fh, void* buf, int count, const Datatype* datatype, MPI_Status* status)
 189   {
 190     //0 needs to get the shared pointer value
 191     MPI_Offset val;
 192     if(fh->comm_->rank()==0){
 193       val=*(fh->shared_file_pointer_);
 194     }else{
 195       val=count*datatype->size();
 196     }
 197
 198     MPI_Offset result;
 199     simgrid::smpi::colls::scan(&val, &result, 1, MPI_OFFSET, MPI_SUM, fh->comm_);
 200     fh->seek(result, MPI_SEEK_SET);
 201     int ret = fh->op_all<simgrid::smpi::File::read>(buf, count, datatype, status);
 202     if(fh->comm_->rank()==fh->comm_->size()-1){
 203       fh->shared_mutex_->lock();
 204       *(fh->shared_file_pointer_)=fh->file_->tell();
 205       fh->shared_mutex_->unlock();
 206     }
 207     char c;
 208     simgrid::smpi::colls::bcast(&c, 1, MPI_BYTE, fh->comm_->size() - 1, fh->comm_);
 209     return ret;
 210   }
 211
 212   int File::write(MPI_File fh, void* /*buf*/, int count, const Datatype* datatype, MPI_Status* status)
 213   {
 214     //get position first as we may be doing non contiguous reads and it will probably be updated badly
 215     MPI_Offset position = fh->file_->tell();
 216     MPI_Offset movesize = datatype->get_extent()*count;
 217     MPI_Offset writesize = datatype->size()*count;
 218     XBT_DEBUG("Position before write in MPI_File %s : %llu",fh->file_->get_path(),fh->file_->tell());
 219     MPI_Offset write = fh->file_->write(writesize, true);
 220     XBT_VERB("Write in MPI_File %s, %lld bytes written, readsize %lld bytes, movesize %lld", fh->file_->get_path(), write, writesize, movesize);
 221     if(writesize!=movesize){
 222       fh->file_->seek(position+movesize, SEEK_SET);
 223     }
 224     XBT_VERB("Position after write in MPI_File %s : %llu",fh->file_->get_path(), fh->file_->tell());
 225     if(status != MPI_STATUS_IGNORE)
 226       status->count=count*datatype->size();
 227     return MPI_SUCCESS;
 228   }
 229
 230   int File::write_shared(MPI_File fh, const void* buf, int count, const Datatype* datatype, MPI_Status* status)
 231   {
 232     fh->shared_mutex_->lock();
 233     XBT_DEBUG("Write shared on %s - Shared ptr before : %lld",fh->file_->get_path(), *(fh->shared_file_pointer_));
 234     fh->seek(*(fh->shared_file_pointer_),MPI_SEEK_SET);
 235     write(fh, const_cast<void*>(buf), count, datatype, status);
 236     *(fh->shared_file_pointer_)=fh->file_->tell();
 237     XBT_DEBUG("Write shared on %s - Shared ptr after : %lld",fh->file_->get_path(), *(fh->shared_file_pointer_));
 238     fh->shared_mutex_->unlock();
 239     return MPI_SUCCESS;
 240   }
 241
 242   int File::write_ordered(MPI_File fh, const void* buf, int count, const Datatype* datatype, MPI_Status* status)
 243   {
 244     //0 needs to get the shared pointer value
 245     MPI_Offset val;
 246     if(fh->comm_->rank()==0){
 247       val=*(fh->shared_file_pointer_);
 248     }else{
 249       val=count*datatype->size();
 250     }
 251     MPI_Offset result;
 252     simgrid::smpi::colls::scan(&val, &result, 1, MPI_OFFSET, MPI_SUM, fh->comm_);
 253     fh->seek(result, MPI_SEEK_SET);
 254     int ret = fh->op_all<simgrid::smpi::File::write>(const_cast<void*>(buf), count, datatype, status);
 255     if(fh->comm_->rank()==fh->comm_->size()-1){
 256       fh->shared_mutex_->lock();
 257       *(fh->shared_file_pointer_)=fh->file_->tell();
 258       fh->shared_mutex_->unlock();
 259     }
 260     char c;
 261     simgrid::smpi::colls::bcast(&c, 1, MPI_BYTE, fh->comm_->size() - 1, fh->comm_);
 262     return ret;
 263   }
 264
 265   int File::set_view(MPI_Offset /*disp*/, MPI_Datatype etype, MPI_Datatype filetype, const char* datarep, const Info*)
 266   {
 267     etype_=etype;
 268     filetype_=filetype;
 269     datarep_=std::string(datarep);
 270     seek_shared(0,MPI_SEEK_SET);
 271     return MPI_SUCCESS;
 272   }
 273
 274   int File::get_view(MPI_Offset* /*disp*/, MPI_Datatype* etype, MPI_Datatype* filetype, char* datarep) const
 275   {
 276     *etype=etype_;
 277     *filetype=filetype_;
 278     snprintf(datarep, MPI_MAX_NAME_STRING+1, "%s", datarep_.c_str());
 279     return MPI_SUCCESS;
 280   }
 281
 282   int File::size() const
 283   {
 284     return file_->size();
 285   }
 286
 287   int File::flags() const
 288   {
 289     return flags_;
 290   }
 291
 292   int File::sync(){
 293     //no idea
 294     return simgrid::smpi::colls::barrier(comm_);
 295   }
 296
 297   MPI_Info File::info()
 298   {
 299     if (info_ == MPI_INFO_NULL)
 300       info_ = new Info();
 301     info_->ref();
 302     return info_;
 303   }
 304
 305   void File::set_info(MPI_Info info)
 306   {
 307     if (info_ != MPI_INFO_NULL)
 308       simgrid::smpi::Info::unref(info_);
 309     info_ = info;
 310     if (info_ != MPI_INFO_NULL)
 311       info_->ref();
 312   }
 313
 314   MPI_Comm File::comm() const
 315   {
 316     return comm_;
 317   }
 318
 319   MPI_Errhandler File::errhandler()
 320   {
 321     if (errhandler_ != MPI_ERRHANDLER_NULL)
 322       errhandler_->ref();
 323     return errhandler_;
 324   }
 325
 326   void File::set_errhandler(MPI_Errhandler errhandler)
 327   {
 328     if (errhandler_ != MPI_ERRHANDLER_NULL)
 329       simgrid::smpi::Errhandler::unref(errhandler_);
 330     errhandler_ = errhandler;
 331     if (errhandler_ != MPI_ERRHANDLER_NULL)
 332       errhandler_->ref();
 333   }
 334
 335   File* File::f2c(int id){
 336     return static_cast<File*>(F2C::f2c(id));
 337   }
 338 }
 339 }