xref: /aosp_15_r20/external/swiftshader/third_party/subzero/pnacl-llvm/DataStream.cpp (revision 03ce13f70fcc45d86ee91b7ee4cab1936a95046e)
1*03ce13f7SAndroid Build Coastguard Worker //===--- llvm/Support/DataStream.cpp - Lazy streamed data -----------------===//
2*03ce13f7SAndroid Build Coastguard Worker //
3*03ce13f7SAndroid Build Coastguard Worker //                     The LLVM Compiler Infrastructure
4*03ce13f7SAndroid Build Coastguard Worker //
5*03ce13f7SAndroid Build Coastguard Worker // This file is distributed under the University of Illinois Open Source
6*03ce13f7SAndroid Build Coastguard Worker // License. See LICENSE.TXT for details.
7*03ce13f7SAndroid Build Coastguard Worker //
8*03ce13f7SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
9*03ce13f7SAndroid Build Coastguard Worker //
10*03ce13f7SAndroid Build Coastguard Worker // This file implements DataStreamer, which fetches bytes of Data from
11*03ce13f7SAndroid Build Coastguard Worker // a stream source. It provides support for streaming (lazy reading) of
12*03ce13f7SAndroid Build Coastguard Worker // bitcode. An example implementation of streaming from a file or stdin
13*03ce13f7SAndroid Build Coastguard Worker // is included.
14*03ce13f7SAndroid Build Coastguard Worker //
15*03ce13f7SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
16*03ce13f7SAndroid Build Coastguard Worker 
17*03ce13f7SAndroid Build Coastguard Worker #include "llvm/Support/DataStream.h"
18*03ce13f7SAndroid Build Coastguard Worker #include "llvm/ADT/STLExtras.h"
19*03ce13f7SAndroid Build Coastguard Worker #include "llvm/ADT/Statistic.h"
20*03ce13f7SAndroid Build Coastguard Worker #include "llvm/Support/FileSystem.h"
21*03ce13f7SAndroid Build Coastguard Worker #include "llvm/Support/Program.h"
22*03ce13f7SAndroid Build Coastguard Worker #include <string>
23*03ce13f7SAndroid Build Coastguard Worker #include <system_error>
24*03ce13f7SAndroid Build Coastguard Worker #if !defined(_MSC_VER) && !defined(__MINGW32__)
25*03ce13f7SAndroid Build Coastguard Worker #include <unistd.h>
26*03ce13f7SAndroid Build Coastguard Worker #else
27*03ce13f7SAndroid Build Coastguard Worker #include <io.h>
28*03ce13f7SAndroid Build Coastguard Worker #endif
29*03ce13f7SAndroid Build Coastguard Worker using namespace llvm;
30*03ce13f7SAndroid Build Coastguard Worker 
31*03ce13f7SAndroid Build Coastguard Worker #define DEBUG_TYPE "Data-stream"
32*03ce13f7SAndroid Build Coastguard Worker 
33*03ce13f7SAndroid Build Coastguard Worker // Interface goals:
34*03ce13f7SAndroid Build Coastguard Worker // * StreamingMemoryObject doesn't care about complexities like using
35*03ce13f7SAndroid Build Coastguard Worker //   threads/async callbacks to actually overlap download+compile
36*03ce13f7SAndroid Build Coastguard Worker // * Don't want to duplicate Data in memory
37*03ce13f7SAndroid Build Coastguard Worker // * Don't need to know total Data len in advance
38*03ce13f7SAndroid Build Coastguard Worker // Non-goals:
39*03ce13f7SAndroid Build Coastguard Worker // StreamingMemoryObject already has random access so this interface only does
40*03ce13f7SAndroid Build Coastguard Worker // in-order streaming (no arbitrary seeking, else we'd have to buffer all the
41*03ce13f7SAndroid Build Coastguard Worker // Data here in addition to MemoryObject).  This also means that if we want
42*03ce13f7SAndroid Build Coastguard Worker // to be able to to free Data, BitstreamBytes/BitcodeReader will implement it
43*03ce13f7SAndroid Build Coastguard Worker 
44*03ce13f7SAndroid Build Coastguard Worker STATISTIC(NumStreamFetches, "Number of calls to Data stream fetch");
45*03ce13f7SAndroid Build Coastguard Worker 
46*03ce13f7SAndroid Build Coastguard Worker namespace llvm {
~DataStreamer()47*03ce13f7SAndroid Build Coastguard Worker DataStreamer::~DataStreamer() {}
48*03ce13f7SAndroid Build Coastguard Worker } // namespace llvm
49*03ce13f7SAndroid Build Coastguard Worker 
50*03ce13f7SAndroid Build Coastguard Worker namespace {
51*03ce13f7SAndroid Build Coastguard Worker 
52*03ce13f7SAndroid Build Coastguard Worker // Very simple stream backed by a file. Mostly useful for stdin and debugging;
53*03ce13f7SAndroid Build Coastguard Worker // actual file access is probably still best done with mmap.
54*03ce13f7SAndroid Build Coastguard Worker class DataFileStreamer : public DataStreamer {
55*03ce13f7SAndroid Build Coastguard Worker   int Fd;
56*03ce13f7SAndroid Build Coastguard Worker 
57*03ce13f7SAndroid Build Coastguard Worker public:
DataFileStreamer()58*03ce13f7SAndroid Build Coastguard Worker   DataFileStreamer() : Fd(0) {}
~DataFileStreamer()59*03ce13f7SAndroid Build Coastguard Worker   ~DataFileStreamer() override { close(Fd); }
GetBytes(unsigned char * buf,size_t len)60*03ce13f7SAndroid Build Coastguard Worker   size_t GetBytes(unsigned char *buf, size_t len) override {
61*03ce13f7SAndroid Build Coastguard Worker     NumStreamFetches++;
62*03ce13f7SAndroid Build Coastguard Worker     return read(Fd, buf, len);
63*03ce13f7SAndroid Build Coastguard Worker   }
64*03ce13f7SAndroid Build Coastguard Worker 
OpenFile(const std::string & Filename)65*03ce13f7SAndroid Build Coastguard Worker   std::error_code OpenFile(const std::string &Filename) {
66*03ce13f7SAndroid Build Coastguard Worker     if (Filename == "-") {
67*03ce13f7SAndroid Build Coastguard Worker       Fd = 0;
68*03ce13f7SAndroid Build Coastguard Worker       sys::ChangeStdinToBinary();
69*03ce13f7SAndroid Build Coastguard Worker       return std::error_code();
70*03ce13f7SAndroid Build Coastguard Worker     }
71*03ce13f7SAndroid Build Coastguard Worker 
72*03ce13f7SAndroid Build Coastguard Worker     return sys::fs::openFileForRead(Filename, Fd);
73*03ce13f7SAndroid Build Coastguard Worker   }
74*03ce13f7SAndroid Build Coastguard Worker };
75*03ce13f7SAndroid Build Coastguard Worker 
76*03ce13f7SAndroid Build Coastguard Worker } // namespace
77*03ce13f7SAndroid Build Coastguard Worker 
78*03ce13f7SAndroid Build Coastguard Worker std::unique_ptr<DataStreamer>
getDataFileStreamer(const std::string & Filename,std::string * StrError)79*03ce13f7SAndroid Build Coastguard Worker llvm::getDataFileStreamer(const std::string &Filename, std::string *StrError) {
80*03ce13f7SAndroid Build Coastguard Worker   std::unique_ptr<DataFileStreamer> s = make_unique<DataFileStreamer>();
81*03ce13f7SAndroid Build Coastguard Worker   if (std::error_code e = s->OpenFile(Filename)) {
82*03ce13f7SAndroid Build Coastguard Worker     *StrError =
83*03ce13f7SAndroid Build Coastguard Worker         std::string("Could not open ") + Filename + ": " + e.message() + "\n";
84*03ce13f7SAndroid Build Coastguard Worker     return nullptr;
85*03ce13f7SAndroid Build Coastguard Worker   }
86*03ce13f7SAndroid Build Coastguard Worker   return std::move(s);
87*03ce13f7SAndroid Build Coastguard Worker }
88