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   }
  75
  76   File::~File(){
  77     if(comm_->rank() == 0){
  78       delete shared_file_pointer_;
  79       delete[] list_;
  80     }
  81     delete win_;
  82     delete file_;
  83     if (info_ != MPI_INFO_NULL)
  84       simgrid::smpi::Info::unref(info_);
  85     if (errhandler_ != MPI_ERRHANDLER_NULL)
  86       simgrid::smpi::Errhandler::unref(errhandler_);
  87   }
  88
  89   int File::close(MPI_File *fh){
  90     XBT_DEBUG("Closing MPI_File %s", (*fh)->file_->get_path());
  91     (*fh)->sync();
  92     if((*fh)->flags() & MPI_MODE_DELETE_ON_CLOSE)
  93       (*fh)->file_->unlink();
  94     delete (*fh);
  95     return MPI_SUCCESS;
  96   }
  97
  98   int File::del(const char* filename, const Info*)
  99   {
 100     //get the file with MPI_MODE_DELETE_ON_CLOSE and then close it
 101     auto* f = new File(MPI_COMM_SELF, filename, MPI_MODE_DELETE_ON_CLOSE | MPI_MODE_RDWR, nullptr);
 102     close(&f);
 103     return MPI_SUCCESS;
 104   }
 105
 106   int File::get_position(MPI_Offset* offset) const
 107   {
 108     *offset=file_->tell();
 109     return MPI_SUCCESS;
 110   }
 111
 112   int File::get_position_shared(MPI_Offset* offset) const
 113   {
 114     shared_mutex_->lock();
 115     *offset=*shared_file_pointer_;
 116     shared_mutex_->unlock();
 117     return MPI_SUCCESS;
 118   }
 119
 120   int File::seek(MPI_Offset offset, int whence){
 121     switch(whence){
 122       case(MPI_SEEK_SET):
 123         XBT_VERB("Seeking in MPI_File %s, setting offset %lld", file_->get_path(), offset);
 124         file_->seek(offset,SEEK_SET);
 125         break;
 126       case(MPI_SEEK_CUR):
 127         XBT_VERB("Seeking in MPI_File %s, current offset + %lld", file_->get_path(), offset);
 128         file_->seek(offset,SEEK_CUR);
 129         break;
 130       case(MPI_SEEK_END):
 131         XBT_VERB("Seeking in MPI_File %s, end offset + %lld", file_->get_path(), offset);
 132         file_->seek(offset,SEEK_END);
 133         break;
 134       default:
 135         return MPI_ERR_FILE;
 136     }
 137     return MPI_SUCCESS;
 138   }
 139
 140   int File::seek_shared(MPI_Offset offset, int whence){
 141     shared_mutex_->lock();
 142     seek(offset,whence);
 143     *shared_file_pointer_=file_->tell();
 144     shared_mutex_->unlock();
 145     return MPI_SUCCESS;
 146   }
 147
 148   int File::read(MPI_File fh, void* /*buf*/, int count, const Datatype* datatype, MPI_Status* status)
 149   {
 150     //get position first as we may be doing non contiguous reads and it will probably be updated badly
 151     MPI_Offset position = fh->file_->tell();
 152     MPI_Offset movesize = datatype->get_extent()*count;
 153     MPI_Offset readsize = datatype->size()*count;
 154     XBT_DEBUG("Position before read in MPI_File %s : %llu",fh->file_->get_path(),fh->file_->tell());
 155     MPI_Offset read = fh->file_->read(readsize);
 156     XBT_VERB("Read in MPI_File %s, %lld bytes read, readsize %lld bytes, movesize %lld", fh->file_->get_path(), read, readsize, movesize);
 157     if(readsize!=movesize){
 158       fh->file_->seek(position+movesize, SEEK_SET);
 159     }
 160     XBT_VERB("Position after read in MPI_File %s : %llu",fh->file_->get_path(), fh->file_->tell());
 161     if(status != MPI_STATUS_IGNORE)
 162       status->count=count*datatype->size();
 163     return MPI_SUCCESS;
 164   }
 165
 166   /*Ordered and Shared Versions, with RMA-based locks : Based on the model described in :*/
 167   /* @InProceedings{10.1007/11557265_15,*/
 168   /* author="Latham, Robert and Ross, Robert and Thakur, Rajeev and Toonen, Brian",*/
 169   /* title="Implementing MPI-IO Shared File Pointers Without File System Support",*/
 170   /* booktitle="Recent Advances in Parallel Virtual Machine and Message Passing Interface",*/
 171   /* year="2005",*/
 172   /* publisher="Springer Berlin Heidelberg",*/
 173   /* address="Berlin, Heidelberg",*/
 174   /* pages="84--93"*/
 175   /* }*/
 176   int File::read_shared(MPI_File fh, void* buf, int count, const Datatype* datatype, MPI_Status* status)
 177   {
 178     fh->shared_mutex_->lock();
 179     fh->seek(*(fh->shared_file_pointer_),MPI_SEEK_SET);
 180     read(fh, buf, count, datatype, status);
 181     *(fh->shared_file_pointer_)=fh->file_->tell();
 182     fh->shared_mutex_->unlock();
 183     return MPI_SUCCESS;
 184   }
 185
 186   int File::read_ordered(MPI_File fh, void* buf, int count, const Datatype* datatype, MPI_Status* status)
 187   {
 188     //0 needs to get the shared pointer value
 189     MPI_Offset val;
 190     if(fh->comm_->rank()==0){
 191       val=*(fh->shared_file_pointer_);
 192     }else{
 193       val=count*datatype->size();
 194     }
 195
 196     MPI_Offset result;
 197     simgrid::smpi::colls::scan(&val, &result, 1, MPI_OFFSET, MPI_SUM, fh->comm_);
 198     fh->seek(result, MPI_SEEK_SET);
 199     int ret = fh->op_all<simgrid::smpi::File::read>(buf, count, datatype, status);
 200     if(fh->comm_->rank()==fh->comm_->size()-1){
 201       fh->shared_mutex_->lock();
 202       *(fh->shared_file_pointer_)=fh->file_->tell();
 203       fh->shared_mutex_->unlock();
 204     }
 205     char c;
 206     simgrid::smpi::colls::bcast(&c, 1, MPI_BYTE, fh->comm_->size() - 1, fh->comm_);
 207     return ret;
 208   }
 209
 210   int File::write(MPI_File fh, void* /*buf*/, int count, const Datatype* datatype, MPI_Status* status)
 211   {
 212     //get position first as we may be doing non contiguous reads and it will probably be updated badly
 213     MPI_Offset position = fh->file_->tell();
 214     MPI_Offset movesize = datatype->get_extent()*count;
 215     MPI_Offset writesize = datatype->size()*count;
 216     XBT_DEBUG("Position before write in MPI_File %s : %llu",fh->file_->get_path(),fh->file_->tell());
 217     MPI_Offset write = fh->file_->write(writesize, true);
 218     XBT_VERB("Write in MPI_File %s, %lld bytes written, readsize %lld bytes, movesize %lld", fh->file_->get_path(), write, writesize, movesize);
 219     if(writesize!=movesize){
 220       fh->file_->seek(position+movesize, SEEK_SET);
 221     }
 222     XBT_VERB("Position after write in MPI_File %s : %llu",fh->file_->get_path(), fh->file_->tell());
 223     if(status != MPI_STATUS_IGNORE)
 224       status->count=count*datatype->size();
 225     return MPI_SUCCESS;
 226   }
 227
 228   int File::write_shared(MPI_File fh, const void* buf, int count, const Datatype* datatype, MPI_Status* status)
 229   {
 230     fh->shared_mutex_->lock();
 231     XBT_DEBUG("Write shared on %s - Shared ptr before : %lld",fh->file_->get_path(), *(fh->shared_file_pointer_));
 232     fh->seek(*(fh->shared_file_pointer_),MPI_SEEK_SET);
 233     write(fh, const_cast<void*>(buf), count, datatype, status);
 234     *(fh->shared_file_pointer_)=fh->file_->tell();
 235     XBT_DEBUG("Write shared on %s - Shared ptr after : %lld",fh->file_->get_path(), *(fh->shared_file_pointer_));
 236     fh->shared_mutex_->unlock();
 237     return MPI_SUCCESS;
 238   }
 239
 240   int File::write_ordered(MPI_File fh, const void* buf, int count, const Datatype* datatype, MPI_Status* status)
 241   {
 242     //0 needs to get the shared pointer value
 243     MPI_Offset val;
 244     if(fh->comm_->rank()==0){
 245       val=*(fh->shared_file_pointer_);
 246     }else{
 247       val=count*datatype->size();
 248     }
 249     MPI_Offset result;
 250     simgrid::smpi::colls::scan(&val, &result, 1, MPI_OFFSET, MPI_SUM, fh->comm_);
 251     fh->seek(result, MPI_SEEK_SET);
 252     int ret = fh->op_all<simgrid::smpi::File::write>(const_cast<void*>(buf), count, datatype, status);
 253     if(fh->comm_->rank()==fh->comm_->size()-1){
 254       fh->shared_mutex_->lock();
 255       *(fh->shared_file_pointer_)=fh->file_->tell();
 256       fh->shared_mutex_->unlock();
 257     }
 258     char c;
 259     simgrid::smpi::colls::bcast(&c, 1, MPI_BYTE, fh->comm_->size() - 1, fh->comm_);
 260     return ret;
 261   }
 262
 263   int File::set_view(MPI_Offset /*disp*/, MPI_Datatype etype, MPI_Datatype filetype, const char* datarep, const Info*)
 264   {
 265     etype_=etype;
 266     filetype_=filetype;
 267     datarep_=std::string(datarep);
 268     seek_shared(0,MPI_SEEK_SET);
 269     return MPI_SUCCESS;
 270   }
 271
 272   int File::get_view(MPI_Offset* /*disp*/, MPI_Datatype* etype, MPI_Datatype* filetype, char* datarep) const
 273   {
 274     *etype=etype_;
 275     *filetype=filetype_;
 276     snprintf(datarep, MPI_MAX_NAME_STRING+1, "%s", datarep_.c_str());
 277     return MPI_SUCCESS;
 278   }
 279
 280   int File::size() const
 281   {
 282     return file_->size();
 283   }
 284
 285   int File::flags() const
 286   {
 287     return flags_;
 288   }
 289
 290   int File::sync(){
 291     //no idea
 292     return simgrid::smpi::colls::barrier(comm_);
 293   }
 294
 295   MPI_Info File::info()
 296   {
 297     if (info_ == MPI_INFO_NULL)
 298       info_ = new Info();
 299     info_->ref();
 300     return info_;
 301   }
 302
 303   void File::set_info(MPI_Info info)
 304   {
 305     if (info_ != MPI_INFO_NULL)
 306       simgrid::smpi::Info::unref(info_);
 307     info_ = info;
 308     if (info_ != MPI_INFO_NULL)
 309       info_->ref();
 310   }
 311
 312   MPI_Comm File::comm() const
 313   {
 314     return comm_;
 315   }
 316
 317   MPI_Errhandler File::errhandler()
 318   {
 319     if (errhandler_ != MPI_ERRHANDLER_NULL)
 320       errhandler_->ref();
 321     return errhandler_;
 322   }
 323
 324   void File::set_errhandler(MPI_Errhandler errhandler)
 325   {
 326     if (errhandler_ != MPI_ERRHANDLER_NULL)
 327       simgrid::smpi::Errhandler::unref(errhandler_);
 328     errhandler_ = errhandler;
 329     if (errhandler_ != MPI_ERRHANDLER_NULL)
 330       errhandler_->ref();
 331   }
 332
 333   File* File::f2c(int id){
 334     return static_cast<File*>(F2C::f2c(id));
 335   }
 336 }
 337 }