env_test.cc 123 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719
  1. // Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
  2. // This source code is licensed under both the GPLv2 (found in the
  3. // COPYING file in the root directory) and Apache 2.0 License
  4. // (found in the LICENSE.Apache file in the root directory).
  5. //
  6. // Copyright (c) 2011 The LevelDB Authors. All rights reserved.
  7. // Use of this source code is governed by a BSD-style license that can be
  8. // found in the LICENSE file. See the AUTHORS file for names of contributors.
  9. #ifndef OS_WIN
  10. #include <sys/ioctl.h>
  11. #endif
  12. #if defined(ROCKSDB_IOURING_PRESENT)
  13. #include <liburing.h>
  14. #include <sys/uio.h>
  15. #endif
  16. #include <sys/types.h>
  17. #include <atomic>
  18. #include <list>
  19. #include <mutex>
  20. #include <unordered_set>
  21. #ifdef OS_LINUX
  22. #include <fcntl.h>
  23. #include <linux/fs.h>
  24. #include <sys/stat.h>
  25. #include <unistd.h>
  26. #include <cstdlib>
  27. #endif
  28. #ifdef ROCKSDB_FALLOCATE_PRESENT
  29. #include <cerrno>
  30. #endif
  31. #include "db/db_impl/db_impl.h"
  32. #include "env/emulated_clock.h"
  33. #include "env/env_chroot.h"
  34. #include "env/env_encryption_ctr.h"
  35. #include "env/fs_readonly.h"
  36. #include "env/mock_env.h"
  37. #include "env/unique_id_gen.h"
  38. #include "logging/log_buffer.h"
  39. #include "logging/logging.h"
  40. #include "options/options_helper.h"
  41. #include "port/malloc.h"
  42. #include "port/port.h"
  43. #include "port/stack_trace.h"
  44. #include "rocksdb/convenience.h"
  45. #include "rocksdb/env.h"
  46. #include "rocksdb/env_encryption.h"
  47. #include "rocksdb/file_system.h"
  48. #include "rocksdb/system_clock.h"
  49. #include "rocksdb/utilities/object_registry.h"
  50. #include "test_util/mock_time_env.h"
  51. #include "test_util/sync_point.h"
  52. #include "test_util/testharness.h"
  53. #include "test_util/testutil.h"
  54. #include "util/coding.h"
  55. #include "util/crc32c.h"
  56. #include "util/mutexlock.h"
  57. #include "util/random.h"
  58. #include "util/string_util.h"
  59. #include "utilities/counted_fs.h"
  60. #include "utilities/env_timed.h"
  61. #include "utilities/fault_injection_env.h"
  62. #include "utilities/fault_injection_fs.h"
  63. namespace ROCKSDB_NAMESPACE {
  64. using port::kPageSize;
  65. static const int kDelayMicros = 100000;
  66. struct Deleter {
  67. explicit Deleter(void (*fn)(void*)) : fn_(fn) {}
  68. void operator()(void* ptr) {
  69. assert(fn_);
  70. assert(ptr);
  71. (*fn_)(ptr);
  72. }
  73. void (*fn_)(void*);
  74. };
  75. extern "C" bool RocksDbIOUringEnable() { return true; }
  76. std::unique_ptr<char, Deleter> NewAligned(const size_t size, const char ch) {
  77. char* ptr = nullptr;
  78. #ifdef OS_WIN
  79. if (nullptr ==
  80. (ptr = reinterpret_cast<char*>(_aligned_malloc(size, kPageSize)))) {
  81. return std::unique_ptr<char, Deleter>(nullptr, Deleter(_aligned_free));
  82. }
  83. std::unique_ptr<char, Deleter> uptr(ptr, Deleter(_aligned_free));
  84. #else
  85. if (posix_memalign(reinterpret_cast<void**>(&ptr), kPageSize, size) != 0) {
  86. return std::unique_ptr<char, Deleter>(nullptr, Deleter(free));
  87. }
  88. std::unique_ptr<char, Deleter> uptr(ptr, Deleter(free));
  89. #endif
  90. memset(uptr.get(), ch, size);
  91. return uptr;
  92. }
  93. class EnvPosixTest : public testing::Test {
  94. private:
  95. port::Mutex mu_;
  96. std::string events_;
  97. public:
  98. Env* env_;
  99. bool direct_io_;
  100. EnvPosixTest() : env_(Env::Default()), direct_io_(false) {}
  101. ~EnvPosixTest() {
  102. SyncPoint::GetInstance()->DisableProcessing();
  103. SyncPoint::GetInstance()->LoadDependency({});
  104. SyncPoint::GetInstance()->ClearAllCallBacks();
  105. }
  106. };
  107. class EnvPosixTestWithParam
  108. : public EnvPosixTest,
  109. public ::testing::WithParamInterface<std::pair<Env*, bool>> {
  110. public:
  111. EnvPosixTestWithParam() {
  112. std::pair<Env*, bool> param_pair = GetParam();
  113. env_ = param_pair.first;
  114. direct_io_ = param_pair.second;
  115. }
  116. void WaitThreadPoolsEmpty() {
  117. // Wait until the thread pools are empty.
  118. while (env_->GetThreadPoolQueueLen(Env::Priority::LOW) != 0) {
  119. Env::Default()->SleepForMicroseconds(kDelayMicros);
  120. }
  121. while (env_->GetThreadPoolQueueLen(Env::Priority::HIGH) != 0) {
  122. Env::Default()->SleepForMicroseconds(kDelayMicros);
  123. }
  124. }
  125. ~EnvPosixTestWithParam() override { WaitThreadPoolsEmpty(); }
  126. };
  127. static void SetBool(void* ptr) {
  128. reinterpret_cast<std::atomic<bool>*>(ptr)->store(true);
  129. }
  130. TEST_F(EnvPosixTest, DISABLED_RunImmediately) {
  131. for (int pri = Env::BOTTOM; pri < Env::TOTAL; ++pri) {
  132. std::atomic<bool> called(false);
  133. env_->SetBackgroundThreads(1, static_cast<Env::Priority>(pri));
  134. env_->Schedule(&SetBool, &called, static_cast<Env::Priority>(pri));
  135. Env::Default()->SleepForMicroseconds(kDelayMicros);
  136. ASSERT_TRUE(called.load());
  137. }
  138. }
  139. TEST_F(EnvPosixTest, RunEventually) {
  140. std::atomic<bool> called(false);
  141. env_->StartThread(&SetBool, &called);
  142. env_->WaitForJoin();
  143. ASSERT_TRUE(called.load());
  144. }
  145. #ifdef OS_WIN
  146. TEST_F(EnvPosixTest, AreFilesSame) {
  147. {
  148. bool tmp;
  149. if (env_->AreFilesSame("", "", &tmp).IsNotSupported()) {
  150. fprintf(stderr,
  151. "skipping EnvBasicTestWithParam.AreFilesSame due to "
  152. "unsupported Env::AreFilesSame\n");
  153. return;
  154. }
  155. }
  156. const EnvOptions soptions;
  157. auto* env = Env::Default();
  158. std::string same_file_name = test::PerThreadDBPath(env, "same_file");
  159. std::string same_file_link_name = same_file_name + "_link";
  160. std::unique_ptr<WritableFile> same_file;
  161. ASSERT_OK(env->NewWritableFile(same_file_name, &same_file, soptions));
  162. same_file->Append("random_data");
  163. ASSERT_OK(same_file->Flush());
  164. same_file.reset();
  165. ASSERT_OK(env->LinkFile(same_file_name, same_file_link_name));
  166. bool result = false;
  167. ASSERT_OK(env->AreFilesSame(same_file_name, same_file_link_name, &result));
  168. ASSERT_TRUE(result);
  169. }
  170. #endif
  171. #ifdef OS_LINUX
  172. TEST_F(EnvPosixTest, DISABLED_FilePermission) {
  173. // Only works for Linux environment
  174. if (env_ == Env::Default()) {
  175. EnvOptions soptions;
  176. std::vector<std::string> fileNames{
  177. test::PerThreadDBPath(env_, "testfile"),
  178. test::PerThreadDBPath(env_, "testfile1")};
  179. std::unique_ptr<WritableFile> wfile;
  180. ASSERT_OK(env_->NewWritableFile(fileNames[0], &wfile, soptions));
  181. ASSERT_OK(env_->NewWritableFile(fileNames[1], &wfile, soptions));
  182. wfile.reset();
  183. std::unique_ptr<RandomRWFile> rwfile;
  184. ASSERT_OK(env_->NewRandomRWFile(fileNames[1], &rwfile, soptions));
  185. struct stat sb;
  186. for (const auto& filename : fileNames) {
  187. if (::stat(filename.c_str(), &sb) == 0) {
  188. ASSERT_EQ(sb.st_mode & 0777, 0644);
  189. }
  190. ASSERT_OK(env_->DeleteFile(filename));
  191. }
  192. env_->SetAllowNonOwnerAccess(false);
  193. ASSERT_OK(env_->NewWritableFile(fileNames[0], &wfile, soptions));
  194. ASSERT_OK(env_->NewWritableFile(fileNames[1], &wfile, soptions));
  195. wfile.reset();
  196. ASSERT_OK(env_->NewRandomRWFile(fileNames[1], &rwfile, soptions));
  197. for (const auto& filename : fileNames) {
  198. if (::stat(filename.c_str(), &sb) == 0) {
  199. ASSERT_EQ(sb.st_mode & 0777, 0600);
  200. }
  201. ASSERT_OK(env_->DeleteFile(filename));
  202. }
  203. }
  204. }
  205. TEST_F(EnvPosixTest, LowerThreadPoolCpuPriority) {
  206. std::atomic<CpuPriority> from_priority(CpuPriority::kNormal);
  207. std::atomic<CpuPriority> to_priority(CpuPriority::kNormal);
  208. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  209. "ThreadPoolImpl::BGThread::BeforeSetCpuPriority",
  210. [&](void* pri) { from_priority.store(*static_cast<CpuPriority*>(pri)); });
  211. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  212. "ThreadPoolImpl::BGThread::AfterSetCpuPriority",
  213. [&](void* pri) { to_priority.store(*static_cast<CpuPriority*>(pri)); });
  214. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  215. env_->SetBackgroundThreads(1, Env::BOTTOM);
  216. env_->SetBackgroundThreads(1, Env::HIGH);
  217. auto RunTask = [&](Env::Priority pool) {
  218. std::atomic<bool> called(false);
  219. env_->Schedule(&SetBool, &called, pool);
  220. for (int i = 0; i < kDelayMicros; i++) {
  221. if (called.load()) {
  222. break;
  223. }
  224. Env::Default()->SleepForMicroseconds(1);
  225. }
  226. ASSERT_TRUE(called.load());
  227. };
  228. {
  229. // Same priority, no-op.
  230. env_->LowerThreadPoolCPUPriority(Env::Priority::BOTTOM,
  231. CpuPriority::kNormal)
  232. .PermitUncheckedError();
  233. RunTask(Env::Priority::BOTTOM);
  234. ASSERT_EQ(from_priority, CpuPriority::kNormal);
  235. ASSERT_EQ(to_priority, CpuPriority::kNormal);
  236. }
  237. {
  238. // Higher priority, no-op.
  239. env_->LowerThreadPoolCPUPriority(Env::Priority::BOTTOM, CpuPriority::kHigh)
  240. .PermitUncheckedError();
  241. RunTask(Env::Priority::BOTTOM);
  242. ASSERT_EQ(from_priority, CpuPriority::kNormal);
  243. ASSERT_EQ(to_priority, CpuPriority::kNormal);
  244. }
  245. {
  246. // Lower priority from kNormal -> kLow.
  247. env_->LowerThreadPoolCPUPriority(Env::Priority::BOTTOM, CpuPriority::kLow)
  248. .PermitUncheckedError();
  249. RunTask(Env::Priority::BOTTOM);
  250. ASSERT_EQ(from_priority, CpuPriority::kNormal);
  251. ASSERT_EQ(to_priority, CpuPriority::kLow);
  252. }
  253. {
  254. // Lower priority from kLow -> kIdle.
  255. env_->LowerThreadPoolCPUPriority(Env::Priority::BOTTOM, CpuPriority::kIdle)
  256. .PermitUncheckedError();
  257. RunTask(Env::Priority::BOTTOM);
  258. ASSERT_EQ(from_priority, CpuPriority::kLow);
  259. ASSERT_EQ(to_priority, CpuPriority::kIdle);
  260. }
  261. {
  262. // Lower priority from kNormal -> kIdle for another pool.
  263. env_->LowerThreadPoolCPUPriority(Env::Priority::HIGH, CpuPriority::kIdle)
  264. .PermitUncheckedError();
  265. RunTask(Env::Priority::HIGH);
  266. ASSERT_EQ(from_priority, CpuPriority::kNormal);
  267. ASSERT_EQ(to_priority, CpuPriority::kIdle);
  268. }
  269. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  270. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->ClearAllCallBacks();
  271. }
  272. #endif
  273. TEST_F(EnvPosixTest, MemoryMappedFileBuffer) {
  274. const int kFileBytes = 1 << 15; // 32 KB
  275. std::string expected_data;
  276. std::string fname = test::PerThreadDBPath(env_, "testfile");
  277. {
  278. std::unique_ptr<WritableFile> wfile;
  279. const EnvOptions soptions;
  280. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  281. Random rnd(301);
  282. expected_data = rnd.RandomString(kFileBytes);
  283. ASSERT_OK(wfile->Append(expected_data));
  284. }
  285. std::unique_ptr<MemoryMappedFileBuffer> mmap_buffer;
  286. Status status = env_->NewMemoryMappedFileBuffer(fname, &mmap_buffer);
  287. // it should be supported at least on linux
  288. #if !defined(OS_LINUX)
  289. if (status.IsNotSupported()) {
  290. fprintf(stderr,
  291. "skipping EnvPosixTest.MemoryMappedFileBuffer due to "
  292. "unsupported Env::NewMemoryMappedFileBuffer\n");
  293. return;
  294. }
  295. #endif // !defined(OS_LINUX)
  296. ASSERT_OK(status);
  297. ASSERT_NE(nullptr, mmap_buffer.get());
  298. ASSERT_NE(nullptr, mmap_buffer->GetBase());
  299. ASSERT_EQ(kFileBytes, mmap_buffer->GetLen());
  300. std::string actual_data(reinterpret_cast<const char*>(mmap_buffer->GetBase()),
  301. mmap_buffer->GetLen());
  302. ASSERT_EQ(expected_data, actual_data);
  303. }
  304. #ifndef ROCKSDB_NO_DYNAMIC_EXTENSION
  305. TEST_F(EnvPosixTest, LoadRocksDBLibrary) {
  306. std::shared_ptr<DynamicLibrary> library;
  307. std::function<void*(void*, const char*)> function;
  308. Status status = env_->LoadLibrary("no-such-library", "", &library);
  309. ASSERT_NOK(status);
  310. ASSERT_EQ(nullptr, library.get());
  311. status = env_->LoadLibrary("rocksdb", "", &library);
  312. if (status.ok()) { // If we have can find a rocksdb shared library
  313. ASSERT_NE(nullptr, library.get());
  314. ASSERT_OK(library->LoadFunction("rocksdb_create_default_env",
  315. &function)); // from C definition
  316. ASSERT_NE(nullptr, function);
  317. ASSERT_NOK(library->LoadFunction("no-such-method", &function));
  318. ASSERT_EQ(nullptr, function);
  319. ASSERT_OK(env_->LoadLibrary(library->Name(), "", &library));
  320. } else {
  321. ASSERT_EQ(nullptr, library.get());
  322. }
  323. }
  324. #endif // !ROCKSDB_NO_DYNAMIC_EXTENSION
  325. #if !defined(OS_WIN) && !defined(ROCKSDB_NO_DYNAMIC_EXTENSION)
  326. TEST_F(EnvPosixTest, LoadRocksDBLibraryWithSearchPath) {
  327. std::shared_ptr<DynamicLibrary> library;
  328. std::function<void*(void*, const char*)> function;
  329. ASSERT_NOK(env_->LoadLibrary("no-such-library", "/tmp", &library));
  330. ASSERT_EQ(nullptr, library.get());
  331. ASSERT_NOK(env_->LoadLibrary("dl", "/tmp", &library));
  332. ASSERT_EQ(nullptr, library.get());
  333. Status status = env_->LoadLibrary("rocksdb", "/tmp:./", &library);
  334. if (status.ok()) {
  335. ASSERT_NE(nullptr, library.get());
  336. ASSERT_OK(env_->LoadLibrary(library->Name(), "", &library));
  337. }
  338. char buff[1024];
  339. std::string cwd = getcwd(buff, sizeof(buff));
  340. status = env_->LoadLibrary("rocksdb", "/tmp:" + cwd, &library);
  341. if (status.ok()) {
  342. ASSERT_NE(nullptr, library.get());
  343. ASSERT_OK(env_->LoadLibrary(library->Name(), "", &library));
  344. }
  345. }
  346. #endif // !OS_WIN && !ROCKSDB_NO_DYNAMIC_EXTENSION
  347. TEST_P(EnvPosixTestWithParam, UnSchedule) {
  348. std::atomic<bool> called(false);
  349. env_->SetBackgroundThreads(1, Env::LOW);
  350. /* Block the low priority queue */
  351. test::SleepingBackgroundTask sleeping_task, sleeping_task1;
  352. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &sleeping_task,
  353. Env::Priority::LOW);
  354. /* Schedule another task */
  355. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &sleeping_task1,
  356. Env::Priority::LOW, &sleeping_task1);
  357. /* Remove it with a different tag */
  358. ASSERT_EQ(0, env_->UnSchedule(&called, Env::Priority::LOW));
  359. /* Remove it from the queue with the right tag */
  360. ASSERT_EQ(1, env_->UnSchedule(&sleeping_task1, Env::Priority::LOW));
  361. // Unblock background thread
  362. sleeping_task.WakeUp();
  363. /* Schedule another task */
  364. env_->Schedule(&SetBool, &called);
  365. for (int i = 0; i < kDelayMicros; i++) {
  366. if (called.load()) {
  367. break;
  368. }
  369. Env::Default()->SleepForMicroseconds(1);
  370. }
  371. ASSERT_TRUE(called.load());
  372. ASSERT_TRUE(!sleeping_task.IsSleeping() && !sleeping_task1.IsSleeping());
  373. WaitThreadPoolsEmpty();
  374. }
  375. // This tests assumes that the last scheduled
  376. // task will run last. In fact, in the allotted
  377. // sleeping time nothing may actually run or they may
  378. // run in any order. The purpose of the test is unclear.
  379. #ifndef OS_WIN
  380. TEST_P(EnvPosixTestWithParam, RunMany) {
  381. env_->SetBackgroundThreads(1, Env::LOW);
  382. std::atomic<int> last_id(0);
  383. struct CB {
  384. std::atomic<int>* last_id_ptr; // Pointer to shared slot
  385. int id; // Order# for the execution of this callback
  386. CB(std::atomic<int>* p, int i) : last_id_ptr(p), id(i) {}
  387. static void Run(void* v) {
  388. CB* cb = static_cast<CB*>(v);
  389. int cur = cb->last_id_ptr->load();
  390. ASSERT_EQ(cb->id - 1, cur);
  391. cb->last_id_ptr->store(cb->id);
  392. }
  393. };
  394. // Schedule in different order than start time
  395. CB cb1(&last_id, 1);
  396. CB cb2(&last_id, 2);
  397. CB cb3(&last_id, 3);
  398. CB cb4(&last_id, 4);
  399. env_->Schedule(&CB::Run, &cb1);
  400. env_->Schedule(&CB::Run, &cb2);
  401. env_->Schedule(&CB::Run, &cb3);
  402. env_->Schedule(&CB::Run, &cb4);
  403. // thread-pool pops a thread function and then run the function, which may
  404. // cause threadpool is empty but the last function is still running. Add a
  405. // dummy function at the end, to make sure the last callback is finished
  406. // before threadpool is empty.
  407. struct DummyCB {
  408. static void Run(void*) {}
  409. };
  410. env_->Schedule(&DummyCB::Run, nullptr);
  411. WaitThreadPoolsEmpty();
  412. ASSERT_EQ(4, last_id.load(std::memory_order_acquire));
  413. }
  414. #endif
  415. struct State {
  416. port::Mutex mu;
  417. int val;
  418. int num_running;
  419. };
  420. static void ThreadBody(void* arg) {
  421. State* s = static_cast<State*>(arg);
  422. s->mu.Lock();
  423. s->val += 1;
  424. s->num_running -= 1;
  425. s->mu.Unlock();
  426. }
  427. TEST_P(EnvPosixTestWithParam, StartThread) {
  428. State state;
  429. state.val = 0;
  430. state.num_running = 3;
  431. for (int i = 0; i < 3; i++) {
  432. env_->StartThread(&ThreadBody, &state);
  433. }
  434. while (true) {
  435. state.mu.Lock();
  436. int num = state.num_running;
  437. state.mu.Unlock();
  438. if (num == 0) {
  439. break;
  440. }
  441. Env::Default()->SleepForMicroseconds(kDelayMicros);
  442. }
  443. ASSERT_EQ(state.val, 3);
  444. WaitThreadPoolsEmpty();
  445. }
  446. TEST_P(EnvPosixTestWithParam, TwoPools) {
  447. // Data structures to signal tasks to run.
  448. port::Mutex mutex;
  449. port::CondVar cv(&mutex);
  450. bool should_start = false;
  451. class CB {
  452. public:
  453. CB(const std::string& pool_name, int pool_size, port::Mutex* trigger_mu,
  454. port::CondVar* trigger_cv, bool* _should_start)
  455. : mu_(),
  456. num_running_(0),
  457. num_finished_(0),
  458. pool_size_(pool_size),
  459. pool_name_(pool_name),
  460. trigger_mu_(trigger_mu),
  461. trigger_cv_(trigger_cv),
  462. should_start_(_should_start) {}
  463. static void Run(void* v) {
  464. CB* cb = static_cast<CB*>(v);
  465. cb->Run();
  466. }
  467. void Run() {
  468. {
  469. MutexLock l(&mu_);
  470. num_running_++;
  471. // make sure we don't have more than pool_size_ jobs running.
  472. ASSERT_LE(num_running_, pool_size_.load());
  473. }
  474. {
  475. MutexLock l(trigger_mu_);
  476. while (!(*should_start_)) {
  477. trigger_cv_->Wait();
  478. }
  479. }
  480. {
  481. MutexLock l(&mu_);
  482. num_running_--;
  483. num_finished_++;
  484. }
  485. }
  486. int NumFinished() {
  487. MutexLock l(&mu_);
  488. return num_finished_;
  489. }
  490. void Reset(int pool_size) {
  491. pool_size_.store(pool_size);
  492. num_finished_ = 0;
  493. }
  494. private:
  495. port::Mutex mu_;
  496. int num_running_;
  497. int num_finished_;
  498. std::atomic<int> pool_size_;
  499. std::string pool_name_;
  500. port::Mutex* trigger_mu_;
  501. port::CondVar* trigger_cv_;
  502. bool* should_start_;
  503. };
  504. const int kLowPoolSize = 2;
  505. const int kHighPoolSize = 4;
  506. const int kJobs = 8;
  507. CB low_pool_job("low", kLowPoolSize, &mutex, &cv, &should_start);
  508. CB high_pool_job("high", kHighPoolSize, &mutex, &cv, &should_start);
  509. env_->SetBackgroundThreads(kLowPoolSize);
  510. env_->SetBackgroundThreads(kHighPoolSize, Env::Priority::HIGH);
  511. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::LOW));
  512. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  513. // schedule same number of jobs in each pool
  514. for (int i = 0; i < kJobs; i++) {
  515. env_->Schedule(&CB::Run, &low_pool_job);
  516. env_->Schedule(&CB::Run, &high_pool_job, Env::Priority::HIGH);
  517. }
  518. // Wait a short while for the jobs to be dispatched.
  519. int sleep_count = 0;
  520. while ((unsigned int)(kJobs - kLowPoolSize) !=
  521. env_->GetThreadPoolQueueLen(Env::Priority::LOW) ||
  522. (unsigned int)(kJobs - kHighPoolSize) !=
  523. env_->GetThreadPoolQueueLen(Env::Priority::HIGH)) {
  524. env_->SleepForMicroseconds(kDelayMicros);
  525. if (++sleep_count > 100) {
  526. break;
  527. }
  528. }
  529. ASSERT_EQ((unsigned int)(kJobs - kLowPoolSize),
  530. env_->GetThreadPoolQueueLen());
  531. ASSERT_EQ((unsigned int)(kJobs - kLowPoolSize),
  532. env_->GetThreadPoolQueueLen(Env::Priority::LOW));
  533. ASSERT_EQ((unsigned int)(kJobs - kHighPoolSize),
  534. env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  535. // Trigger jobs to run.
  536. {
  537. MutexLock l(&mutex);
  538. should_start = true;
  539. cv.SignalAll();
  540. }
  541. // wait for all jobs to finish
  542. while (low_pool_job.NumFinished() < kJobs ||
  543. high_pool_job.NumFinished() < kJobs) {
  544. env_->SleepForMicroseconds(kDelayMicros);
  545. }
  546. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::LOW));
  547. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  548. // Hold jobs to schedule;
  549. should_start = false;
  550. // call IncBackgroundThreadsIfNeeded to two pools. One increasing and
  551. // the other decreasing
  552. env_->IncBackgroundThreadsIfNeeded(kLowPoolSize - 1, Env::Priority::LOW);
  553. env_->IncBackgroundThreadsIfNeeded(kHighPoolSize + 1, Env::Priority::HIGH);
  554. high_pool_job.Reset(kHighPoolSize + 1);
  555. low_pool_job.Reset(kLowPoolSize);
  556. // schedule same number of jobs in each pool
  557. for (int i = 0; i < kJobs; i++) {
  558. env_->Schedule(&CB::Run, &low_pool_job);
  559. env_->Schedule(&CB::Run, &high_pool_job, Env::Priority::HIGH);
  560. }
  561. // Wait a short while for the jobs to be dispatched.
  562. sleep_count = 0;
  563. while ((unsigned int)(kJobs - kLowPoolSize) !=
  564. env_->GetThreadPoolQueueLen(Env::Priority::LOW) ||
  565. (unsigned int)(kJobs - (kHighPoolSize + 1)) !=
  566. env_->GetThreadPoolQueueLen(Env::Priority::HIGH)) {
  567. env_->SleepForMicroseconds(kDelayMicros);
  568. if (++sleep_count > 100) {
  569. break;
  570. }
  571. }
  572. ASSERT_EQ((unsigned int)(kJobs - kLowPoolSize),
  573. env_->GetThreadPoolQueueLen());
  574. ASSERT_EQ((unsigned int)(kJobs - kLowPoolSize),
  575. env_->GetThreadPoolQueueLen(Env::Priority::LOW));
  576. ASSERT_EQ((unsigned int)(kJobs - (kHighPoolSize + 1)),
  577. env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  578. // Trigger jobs to run.
  579. {
  580. MutexLock l(&mutex);
  581. should_start = true;
  582. cv.SignalAll();
  583. }
  584. // wait for all jobs to finish
  585. while (low_pool_job.NumFinished() < kJobs ||
  586. high_pool_job.NumFinished() < kJobs) {
  587. env_->SleepForMicroseconds(kDelayMicros);
  588. }
  589. env_->SetBackgroundThreads(kHighPoolSize, Env::Priority::HIGH);
  590. WaitThreadPoolsEmpty();
  591. }
  592. TEST_P(EnvPosixTestWithParam, DecreaseNumBgThreads) {
  593. constexpr int kWaitMicros = 60000000; // 1min
  594. std::vector<test::SleepingBackgroundTask> tasks(10);
  595. // Set number of thread to 1 first.
  596. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  597. // Schedule 3 tasks. 0 running; Task 1, 2 waiting.
  598. for (size_t i = 0; i < 3; i++) {
  599. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[i],
  600. Env::Priority::HIGH);
  601. }
  602. ASSERT_FALSE(tasks[0].TimedWaitUntilSleeping(kWaitMicros));
  603. ASSERT_EQ(2U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  604. ASSERT_TRUE(tasks[0].IsSleeping());
  605. ASSERT_TRUE(!tasks[1].IsSleeping());
  606. ASSERT_TRUE(!tasks[2].IsSleeping());
  607. // Increase to 2 threads. Task 0, 1 running; 2 waiting
  608. env_->SetBackgroundThreads(2, Env::Priority::HIGH);
  609. ASSERT_FALSE(tasks[1].TimedWaitUntilSleeping(kWaitMicros));
  610. ASSERT_EQ(1U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  611. ASSERT_TRUE(tasks[0].IsSleeping());
  612. ASSERT_TRUE(tasks[1].IsSleeping());
  613. ASSERT_TRUE(!tasks[2].IsSleeping());
  614. // Shrink back to 1 thread. Still task 0, 1 running, 2 waiting
  615. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  616. Env::Default()->SleepForMicroseconds(kDelayMicros);
  617. ASSERT_EQ(1U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  618. ASSERT_TRUE(tasks[0].IsSleeping());
  619. ASSERT_TRUE(tasks[1].IsSleeping());
  620. ASSERT_TRUE(!tasks[2].IsSleeping());
  621. // The last task finishes. Task 0 running, 2 waiting.
  622. tasks[1].WakeUp();
  623. ASSERT_FALSE(tasks[1].TimedWaitUntilDone(kWaitMicros));
  624. ASSERT_EQ(1U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  625. ASSERT_TRUE(tasks[0].IsSleeping());
  626. ASSERT_TRUE(!tasks[1].IsSleeping());
  627. ASSERT_TRUE(!tasks[2].IsSleeping());
  628. // Increase to 5 threads. Task 0 and 2 running.
  629. env_->SetBackgroundThreads(5, Env::Priority::HIGH);
  630. ASSERT_FALSE(tasks[2].TimedWaitUntilSleeping(kWaitMicros));
  631. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  632. ASSERT_TRUE(tasks[0].IsSleeping());
  633. ASSERT_TRUE(!tasks[1].IsSleeping());
  634. ASSERT_TRUE(tasks[2].IsSleeping());
  635. // Change number of threads a couple of times while there is no sufficient
  636. // tasks.
  637. env_->SetBackgroundThreads(7, Env::Priority::HIGH);
  638. tasks[2].WakeUp();
  639. ASSERT_FALSE(tasks[2].TimedWaitUntilDone(kWaitMicros));
  640. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  641. env_->SetBackgroundThreads(3, Env::Priority::HIGH);
  642. Env::Default()->SleepForMicroseconds(kDelayMicros);
  643. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  644. env_->SetBackgroundThreads(4, Env::Priority::HIGH);
  645. Env::Default()->SleepForMicroseconds(kDelayMicros);
  646. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  647. env_->SetBackgroundThreads(5, Env::Priority::HIGH);
  648. Env::Default()->SleepForMicroseconds(kDelayMicros);
  649. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  650. env_->SetBackgroundThreads(4, Env::Priority::HIGH);
  651. Env::Default()->SleepForMicroseconds(kDelayMicros);
  652. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  653. Env::Default()->SleepForMicroseconds(kDelayMicros * 50);
  654. // Enqueue 5 more tasks. Thread pool size now is 4.
  655. // Task 0, 3, 4, 5 running;6, 7 waiting.
  656. for (size_t i = 3; i < 8; i++) {
  657. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[i],
  658. Env::Priority::HIGH);
  659. }
  660. for (size_t i = 3; i <= 5; i++) {
  661. ASSERT_FALSE(tasks[i].TimedWaitUntilSleeping(kWaitMicros));
  662. }
  663. ASSERT_EQ(2U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  664. ASSERT_TRUE(tasks[0].IsSleeping());
  665. ASSERT_TRUE(!tasks[1].IsSleeping());
  666. ASSERT_TRUE(!tasks[2].IsSleeping());
  667. ASSERT_TRUE(tasks[3].IsSleeping());
  668. ASSERT_TRUE(tasks[4].IsSleeping());
  669. ASSERT_TRUE(tasks[5].IsSleeping());
  670. ASSERT_TRUE(!tasks[6].IsSleeping());
  671. ASSERT_TRUE(!tasks[7].IsSleeping());
  672. // Wake up task 0, 3 and 4. Task 5, 6, 7 running.
  673. tasks[0].WakeUp();
  674. tasks[3].WakeUp();
  675. tasks[4].WakeUp();
  676. for (size_t i = 5; i < 8; i++) {
  677. ASSERT_FALSE(tasks[i].TimedWaitUntilSleeping(kWaitMicros));
  678. }
  679. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  680. for (size_t i = 5; i < 8; i++) {
  681. ASSERT_TRUE(tasks[i].IsSleeping());
  682. }
  683. // Shrink back to 1 thread. Still task 5, 6, 7 running
  684. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  685. Env::Default()->SleepForMicroseconds(kDelayMicros);
  686. ASSERT_TRUE(tasks[5].IsSleeping());
  687. ASSERT_TRUE(tasks[6].IsSleeping());
  688. ASSERT_TRUE(tasks[7].IsSleeping());
  689. // Wake up task 6. Task 5, 7 running
  690. tasks[6].WakeUp();
  691. ASSERT_FALSE(tasks[6].TimedWaitUntilDone(kWaitMicros));
  692. ASSERT_TRUE(tasks[5].IsSleeping());
  693. ASSERT_TRUE(!tasks[6].IsSleeping());
  694. ASSERT_TRUE(tasks[7].IsSleeping());
  695. // Wake up threads 7. Task 5 running
  696. tasks[7].WakeUp();
  697. ASSERT_FALSE(tasks[7].TimedWaitUntilDone(kWaitMicros));
  698. ASSERT_TRUE(!tasks[7].IsSleeping());
  699. // Enqueue thread 8 and 9. Task 5 running; one of 8, 9 might be running.
  700. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[8],
  701. Env::Priority::HIGH);
  702. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[9],
  703. Env::Priority::HIGH);
  704. Env::Default()->SleepForMicroseconds(kDelayMicros);
  705. ASSERT_GT(env_->GetThreadPoolQueueLen(Env::Priority::HIGH), (unsigned int)0);
  706. ASSERT_TRUE(!tasks[8].IsSleeping() || !tasks[9].IsSleeping());
  707. // Increase to 4 threads. Task 5, 8, 9 running.
  708. env_->SetBackgroundThreads(4, Env::Priority::HIGH);
  709. Env::Default()->SleepForMicroseconds(kDelayMicros);
  710. ASSERT_EQ((unsigned int)0, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  711. ASSERT_TRUE(tasks[8].IsSleeping());
  712. ASSERT_TRUE(tasks[9].IsSleeping());
  713. // Shrink to 1 thread
  714. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  715. // Wake up thread 9.
  716. tasks[9].WakeUp();
  717. ASSERT_FALSE(tasks[9].TimedWaitUntilDone(kWaitMicros));
  718. ASSERT_TRUE(!tasks[9].IsSleeping());
  719. ASSERT_TRUE(tasks[8].IsSleeping());
  720. // Wake up thread 8
  721. tasks[8].WakeUp();
  722. ASSERT_FALSE(tasks[8].TimedWaitUntilDone(kWaitMicros));
  723. ASSERT_TRUE(!tasks[8].IsSleeping());
  724. // Wake up the last thread
  725. tasks[5].WakeUp();
  726. ASSERT_FALSE(tasks[5].TimedWaitUntilDone(kWaitMicros));
  727. WaitThreadPoolsEmpty();
  728. }
  729. TEST_P(EnvPosixTestWithParam, ReserveThreads) {
  730. // Initialize the background thread to 1 in case other threads exist
  731. // from the last unit test
  732. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  733. ASSERT_EQ(env_->GetBackgroundThreads(Env::HIGH), 1);
  734. constexpr int kWaitMicros = 10000000; // 10seconds
  735. std::vector<test::SleepingBackgroundTask> tasks(4);
  736. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  737. // Set the sync point to ensure thread 0 can terminate
  738. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->LoadDependency(
  739. {{"ThreadPoolImpl::BGThread::Termination:th0",
  740. "EnvTest::ReserveThreads:0"}});
  741. // Empty the thread pool to ensure all the threads can start later
  742. env_->SetBackgroundThreads(0, Env::Priority::HIGH);
  743. TEST_SYNC_POINT("EnvTest::ReserveThreads:0");
  744. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  745. // Set the sync point to ensure threads start and pass the sync point
  746. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->LoadDependency(
  747. {{"ThreadPoolImpl::BGThread::Start:th0", "EnvTest::ReserveThreads:1"},
  748. {"ThreadPoolImpl::BGThread::Start:th1", "EnvTest::ReserveThreads:2"},
  749. {"ThreadPoolImpl::BGThread::Start:th2", "EnvTest::ReserveThreads:3"},
  750. {"ThreadPoolImpl::BGThread::Start:th3", "EnvTest::ReserveThreads:4"}});
  751. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  752. // Set number of thread to 3 first.
  753. env_->SetBackgroundThreads(3, Env::Priority::HIGH);
  754. ASSERT_EQ(env_->GetBackgroundThreads(Env::HIGH), 3);
  755. // Add sync points to ensure all 3 threads start
  756. TEST_SYNC_POINT("EnvTest::ReserveThreads:1");
  757. TEST_SYNC_POINT("EnvTest::ReserveThreads:2");
  758. TEST_SYNC_POINT("EnvTest::ReserveThreads:3");
  759. // Reserve 2 threads
  760. ASSERT_EQ(2, env_->ReserveThreads(2, Env::Priority::HIGH));
  761. // Schedule 3 tasks. Task 0 running (in this context, doing
  762. // SleepingBackgroundTask); Task 1, 2 waiting; 3 reserved threads.
  763. for (size_t i = 0; i < 3; i++) {
  764. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[i],
  765. Env::Priority::HIGH);
  766. }
  767. ASSERT_FALSE(tasks[0].TimedWaitUntilSleeping(kWaitMicros));
  768. ASSERT_EQ(2U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  769. ASSERT_TRUE(tasks[0].IsSleeping());
  770. ASSERT_TRUE(!tasks[1].IsSleeping());
  771. ASSERT_TRUE(!tasks[2].IsSleeping());
  772. // Release 2 threads. Task 0, 1, 2 running; 0 reserved thread.
  773. ASSERT_EQ(2, env_->ReleaseThreads(2, Env::Priority::HIGH));
  774. ASSERT_FALSE(tasks[1].TimedWaitUntilSleeping(kWaitMicros));
  775. ASSERT_FALSE(tasks[2].TimedWaitUntilSleeping(kWaitMicros));
  776. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  777. ASSERT_TRUE(tasks[1].IsSleeping());
  778. ASSERT_TRUE(tasks[2].IsSleeping());
  779. // No more threads can be reserved
  780. ASSERT_EQ(0, env_->ReserveThreads(3, Env::Priority::HIGH));
  781. // Expand the number of background threads so that the last thread
  782. // is waiting
  783. env_->SetBackgroundThreads(4, Env::Priority::HIGH);
  784. // Add sync point to ensure the 4th thread starts
  785. TEST_SYNC_POINT("EnvTest::ReserveThreads:4");
  786. // As the thread pool is expanded, we can reserve one more thread
  787. ASSERT_EQ(1, env_->ReserveThreads(3, Env::Priority::HIGH));
  788. // No more threads can be reserved
  789. ASSERT_EQ(0, env_->ReserveThreads(3, Env::Priority::HIGH));
  790. // Reset the sync points for the next iteration in BGThread or the
  791. // next time Submit() is called
  792. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  793. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->LoadDependency(
  794. {{"ThreadPoolImpl::BGThread::WaitingThreadsInc",
  795. "EnvTest::ReserveThreads:5"},
  796. {"ThreadPoolImpl::BGThread::Termination", "EnvTest::ReserveThreads:6"},
  797. {"ThreadPoolImpl::Submit::Enqueue", "EnvTest::ReserveThreads:7"}});
  798. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  799. tasks[0].WakeUp();
  800. ASSERT_FALSE(tasks[0].TimedWaitUntilDone(kWaitMicros));
  801. // Add sync point to ensure the number of waiting threads increases
  802. TEST_SYNC_POINT("EnvTest::ReserveThreads:5");
  803. // 1 more thread can be reserved
  804. ASSERT_EQ(1, env_->ReserveThreads(3, Env::Priority::HIGH));
  805. // 2 reserved threads now
  806. // Currently, two threads are blocked since the number of waiting
  807. // threads is equal to the number of reserved threads (i.e., 2).
  808. // If we reduce the number of background thread to 1, at least one thread
  809. // will be the last excessive thread (here we have no control over the
  810. // number of excessive threads because thread order does not
  811. // necessarily follows the schedule order, but we ensure that the last thread
  812. // shall not run any task by expanding the thread pool after we schedule
  813. // the tasks), and thus they(it) become(s) unblocked, the number of waiting
  814. // threads decreases to 0 or 1, but the number of reserved threads is still 2
  815. env_->SetBackgroundThreads(1, Env::Priority::HIGH);
  816. // Task 1,2 running; 2 reserved threads, however, in fact, we only have
  817. // 0 or 1 waiting thread in the thread pool, proved by the
  818. // following test, we CANNOT reserve 2 threads even though we just
  819. // release 2
  820. TEST_SYNC_POINT("EnvTest::ReserveThreads:6");
  821. ASSERT_EQ(2, env_->ReleaseThreads(2, Env::Priority::HIGH));
  822. ASSERT_GT(2, env_->ReserveThreads(2, Env::Priority::HIGH));
  823. // Every new task will be put into the queue at this point
  824. env_->Schedule(&test::SleepingBackgroundTask::DoSleepTask, &tasks[3],
  825. Env::Priority::HIGH);
  826. TEST_SYNC_POINT("EnvTest::ReserveThreads:7");
  827. ASSERT_EQ(1U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  828. ASSERT_TRUE(!tasks[3].IsSleeping());
  829. // Set the number of threads to 3 so that Task 3 can dequeue
  830. env_->SetBackgroundThreads(3, Env::Priority::HIGH);
  831. // Wakup Task 1
  832. tasks[1].WakeUp();
  833. ASSERT_FALSE(tasks[1].TimedWaitUntilDone(kWaitMicros));
  834. // Task 2, 3 running (Task 3 dequeue); 0 or 1 reserved thread
  835. ASSERT_FALSE(tasks[3].TimedWaitUntilSleeping(kWaitMicros));
  836. ASSERT_TRUE(tasks[3].IsSleeping());
  837. ASSERT_EQ(0U, env_->GetThreadPoolQueueLen(Env::Priority::HIGH));
  838. // At most 1 thread can be released
  839. ASSERT_GT(2, env_->ReleaseThreads(3, Env::Priority::HIGH));
  840. tasks[2].WakeUp();
  841. ASSERT_FALSE(tasks[2].TimedWaitUntilDone(kWaitMicros));
  842. tasks[3].WakeUp();
  843. ASSERT_FALSE(tasks[3].TimedWaitUntilDone(kWaitMicros));
  844. WaitThreadPoolsEmpty();
  845. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  846. }
  847. #if (defined OS_LINUX || defined OS_WIN)
  848. namespace {
  849. bool IsSingleVarint(const std::string& s) {
  850. Slice slice(s);
  851. uint64_t v;
  852. if (!GetVarint64(&slice, &v)) {
  853. return false;
  854. }
  855. return slice.size() == 0;
  856. }
  857. bool IsUniqueIDValid(const std::string& s) {
  858. return !s.empty() && !IsSingleVarint(s);
  859. }
  860. const size_t MAX_ID_SIZE = 100;
  861. char temp_id[MAX_ID_SIZE];
  862. } // namespace
  863. // Determine whether we can use the FS_IOC_GETVERSION ioctl
  864. // on a file in directory DIR. Create a temporary file therein,
  865. // try to apply the ioctl (save that result), cleanup and
  866. // return the result. Return true if it is supported, and
  867. // false if anything fails.
  868. // Note that this function "knows" that dir has just been created
  869. // and is empty, so we create a simply-named test file: "f".
  870. bool ioctl_support__FS_IOC_GETVERSION(const std::string& dir) {
  871. #ifdef OS_WIN
  872. return true;
  873. #else
  874. const std::string file = dir + "/f";
  875. int fd;
  876. do {
  877. fd = open(file.c_str(), O_CREAT | O_RDWR | O_TRUNC, 0644);
  878. } while (fd < 0 && errno == EINTR);
  879. long int version;
  880. bool ok = (fd >= 0 && ioctl(fd, FS_IOC_GETVERSION, &version) >= 0);
  881. close(fd);
  882. unlink(file.c_str());
  883. return ok;
  884. #endif
  885. }
  886. // To ensure that Env::GetUniqueId-related tests work correctly, the files
  887. // should be stored in regular storage like "hard disk" or "flash device",
  888. // and not on a tmpfs file system (like /dev/shm and /tmp on some systems).
  889. // Otherwise we cannot get the correct id.
  890. //
  891. // This function serves as the replacement for test::TmpDir(), which may be
  892. // customized to be on a file system that doesn't work with GetUniqueId().
  893. class IoctlFriendlyTmpdir {
  894. public:
  895. explicit IoctlFriendlyTmpdir() {
  896. char dir_buf[100];
  897. const char* fmt = "%s/rocksdb.XXXXXX";
  898. const char* tmp = getenv("TEST_IOCTL_FRIENDLY_TMPDIR");
  899. #ifdef OS_WIN
  900. #define rmdir _rmdir
  901. if (tmp == nullptr) {
  902. tmp = getenv("TMP");
  903. }
  904. snprintf(dir_buf, sizeof dir_buf, fmt, tmp);
  905. auto result = _mktemp(dir_buf);
  906. assert(result != nullptr);
  907. BOOL ret = CreateDirectory(dir_buf, NULL);
  908. assert(ret == TRUE);
  909. dir_ = dir_buf;
  910. #else
  911. std::list<std::string> candidate_dir_list = {"/var/tmp", "/tmp"};
  912. // If $TEST_IOCTL_FRIENDLY_TMPDIR/rocksdb.XXXXXX fits, use
  913. // $TEST_IOCTL_FRIENDLY_TMPDIR; subtract 2 for the "%s", and
  914. // add 1 for the trailing NUL byte.
  915. if (tmp && strlen(tmp) + strlen(fmt) - 2 + 1 <= sizeof dir_buf) {
  916. // use $TEST_IOCTL_FRIENDLY_TMPDIR value
  917. candidate_dir_list.push_front(tmp);
  918. }
  919. for (const std::string& d : candidate_dir_list) {
  920. snprintf(dir_buf, sizeof dir_buf, fmt, d.c_str());
  921. if (mkdtemp(dir_buf)) {
  922. if (ioctl_support__FS_IOC_GETVERSION(dir_buf)) {
  923. dir_ = dir_buf;
  924. return;
  925. } else {
  926. // Diagnose ioctl-related failure only if this is the
  927. // directory specified via that envvar.
  928. if (tmp && tmp == d) {
  929. fprintf(stderr,
  930. "TEST_IOCTL_FRIENDLY_TMPDIR-specified directory is "
  931. "not suitable: %s\n",
  932. d.c_str());
  933. }
  934. rmdir(dir_buf); // ignore failure
  935. }
  936. } else {
  937. // mkdtemp failed: diagnose it, but don't give up.
  938. fprintf(stderr, "mkdtemp(%s/...) failed: %s\n", d.c_str(),
  939. errnoStr(errno).c_str());
  940. }
  941. }
  942. // check if it's running test within a docker container, in which case, the
  943. // file system inside `overlayfs` may not support FS_IOC_GETVERSION
  944. // skip the tests
  945. struct stat buffer;
  946. if (stat("/.dockerenv", &buffer) == 0) {
  947. is_supported_ = false;
  948. return;
  949. }
  950. fprintf(stderr,
  951. "failed to find an ioctl-friendly temporary directory;"
  952. " specify one via the TEST_IOCTL_FRIENDLY_TMPDIR envvar\n");
  953. std::abort();
  954. #endif
  955. }
  956. ~IoctlFriendlyTmpdir() { rmdir(dir_.c_str()); }
  957. const std::string& name() const { return dir_; }
  958. bool is_supported() const { return is_supported_; }
  959. private:
  960. std::string dir_;
  961. bool is_supported_ = true;
  962. };
  963. TEST_F(EnvPosixTest, PositionedAppend) {
  964. std::unique_ptr<WritableFile> writable_file;
  965. EnvOptions options;
  966. options.use_direct_writes = true;
  967. options.use_mmap_writes = false;
  968. std::string fname = test::PerThreadDBPath(env_, "positioned_append");
  969. SetupSyncPointsToMockDirectIO();
  970. ASSERT_OK(env_->NewWritableFile(fname, &writable_file, options));
  971. const size_t kBlockSize = 4096;
  972. const size_t kDataSize = kPageSize;
  973. // Write a page worth of 'a'
  974. auto data_ptr = NewAligned(kDataSize, 'a');
  975. Slice data_a(data_ptr.get(), kDataSize);
  976. ASSERT_OK(writable_file->PositionedAppend(data_a, 0U));
  977. // Write a page worth of 'b' right after the first sector
  978. data_ptr = NewAligned(kDataSize, 'b');
  979. Slice data_b(data_ptr.get(), kDataSize);
  980. ASSERT_OK(writable_file->PositionedAppend(data_b, kBlockSize));
  981. ASSERT_OK(writable_file->Close());
  982. // The file now has 1 sector worth of a followed by a page worth of b
  983. // Verify the above
  984. std::unique_ptr<SequentialFile> seq_file;
  985. ASSERT_OK(env_->NewSequentialFile(fname, &seq_file, options));
  986. size_t scratch_len = kPageSize * 2;
  987. std::unique_ptr<char[]> scratch(new char[scratch_len]);
  988. Slice result;
  989. ASSERT_OK(seq_file->Read(scratch_len, &result, scratch.get()));
  990. ASSERT_EQ(kPageSize + kBlockSize, result.size());
  991. ASSERT_EQ('a', result[kBlockSize - 1]);
  992. ASSERT_EQ('b', result[kBlockSize]);
  993. }
  994. // `GetUniqueId()` temporarily returns zero on Windows. `BlockBasedTable` can
  995. // handle a return value of zero but this test case cannot.
  996. #ifndef OS_WIN
  997. TEST_P(EnvPosixTestWithParam, RandomAccessUniqueID) {
  998. // Create file.
  999. if (env_ == Env::Default()) {
  1000. EnvOptions soptions;
  1001. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1002. IoctlFriendlyTmpdir ift;
  1003. if (!ift.is_supported()) {
  1004. ROCKSDB_GTEST_BYPASS(
  1005. "FS_IOC_GETVERSION is not supported by the filesystem");
  1006. return;
  1007. }
  1008. std::string fname = ift.name() + "/testfile";
  1009. std::unique_ptr<WritableFile> wfile;
  1010. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1011. std::unique_ptr<RandomAccessFile> file;
  1012. // Get Unique ID
  1013. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1014. size_t id_size = file->GetUniqueId(temp_id, MAX_ID_SIZE);
  1015. ASSERT_TRUE(id_size > 0);
  1016. std::string unique_id1(temp_id, id_size);
  1017. ASSERT_TRUE(IsUniqueIDValid(unique_id1));
  1018. // Get Unique ID again
  1019. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1020. id_size = file->GetUniqueId(temp_id, MAX_ID_SIZE);
  1021. ASSERT_TRUE(id_size > 0);
  1022. std::string unique_id2(temp_id, id_size);
  1023. ASSERT_TRUE(IsUniqueIDValid(unique_id2));
  1024. // Get Unique ID again after waiting some time.
  1025. env_->SleepForMicroseconds(1000000);
  1026. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1027. id_size = file->GetUniqueId(temp_id, MAX_ID_SIZE);
  1028. ASSERT_TRUE(id_size > 0);
  1029. std::string unique_id3(temp_id, id_size);
  1030. ASSERT_TRUE(IsUniqueIDValid(unique_id3));
  1031. // Check IDs are the same.
  1032. ASSERT_EQ(unique_id1, unique_id2);
  1033. ASSERT_EQ(unique_id2, unique_id3);
  1034. // Delete the file
  1035. ASSERT_OK(env_->DeleteFile(fname));
  1036. }
  1037. }
  1038. #endif // !defined(OS_WIN)
  1039. // only works in linux platforms
  1040. #ifdef ROCKSDB_FALLOCATE_PRESENT
  1041. TEST_P(EnvPosixTestWithParam, AllocateTest) {
  1042. if (env_ == Env::Default()) {
  1043. SetupSyncPointsToMockDirectIO();
  1044. std::string fname = test::PerThreadDBPath(env_, "preallocate_testfile");
  1045. // Try fallocate in a file to see whether the target file system supports
  1046. // it.
  1047. // Skip the test if fallocate is not supported.
  1048. std::string fname_test_fallocate =
  1049. test::PerThreadDBPath(env_, "preallocate_testfile_2");
  1050. int fd = -1;
  1051. do {
  1052. fd = open(fname_test_fallocate.c_str(), O_CREAT | O_RDWR | O_TRUNC, 0644);
  1053. } while (fd < 0 && errno == EINTR);
  1054. ASSERT_GT(fd, 0);
  1055. int alloc_status = fallocate(fd, 0, 0, 1);
  1056. int err_number = 0;
  1057. if (alloc_status != 0) {
  1058. err_number = errno;
  1059. fprintf(stderr, "Warning: fallocate() fails, %s\n",
  1060. errnoStr(err_number).c_str());
  1061. }
  1062. close(fd);
  1063. ASSERT_OK(env_->DeleteFile(fname_test_fallocate));
  1064. if (alloc_status != 0 && err_number == EOPNOTSUPP) {
  1065. // The filesystem containing the file does not support fallocate
  1066. return;
  1067. }
  1068. EnvOptions soptions;
  1069. soptions.use_mmap_writes = false;
  1070. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1071. std::unique_ptr<WritableFile> wfile;
  1072. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1073. // allocate 100 MB
  1074. size_t kPreallocateSize = 100 * 1024 * 1024;
  1075. size_t kBlockSize = 512;
  1076. size_t kDataSize = 1024 * 1024;
  1077. auto data_ptr = NewAligned(kDataSize, 'A');
  1078. Slice data(data_ptr.get(), kDataSize);
  1079. wfile->SetPreallocationBlockSize(kPreallocateSize);
  1080. wfile->PrepareWrite(wfile->GetFileSize(), kDataSize);
  1081. ASSERT_OK(wfile->Append(data));
  1082. ASSERT_OK(wfile->Flush());
  1083. struct stat f_stat;
  1084. ASSERT_EQ(stat(fname.c_str(), &f_stat), 0);
  1085. ASSERT_EQ((unsigned int)kDataSize, f_stat.st_size);
  1086. // verify that blocks are preallocated
  1087. // Note here that we don't check the exact number of blocks preallocated --
  1088. // we only require that number of allocated blocks is at least what we
  1089. // expect.
  1090. // It looks like some FS give us more blocks that we asked for. That's fine.
  1091. // It might be worth investigating further.
  1092. ASSERT_LE((unsigned int)(kPreallocateSize / kBlockSize), f_stat.st_blocks);
  1093. // close the file, should deallocate the blocks
  1094. wfile.reset();
  1095. stat(fname.c_str(), &f_stat);
  1096. ASSERT_EQ((unsigned int)kDataSize, f_stat.st_size);
  1097. // verify that preallocated blocks were deallocated on file close
  1098. // Because the FS might give us more blocks, we add a full page to the size
  1099. // and expect the number of blocks to be less or equal to that.
  1100. ASSERT_GE((f_stat.st_size + kPageSize + kBlockSize - 1) / kBlockSize,
  1101. (unsigned int)f_stat.st_blocks);
  1102. }
  1103. }
  1104. #endif // ROCKSDB_FALLOCATE_PRESENT
  1105. // Returns true if any of the strings in ss are the prefix of another string.
  1106. bool HasPrefix(const std::unordered_set<std::string>& ss) {
  1107. for (const std::string& s : ss) {
  1108. if (s.empty()) {
  1109. return true;
  1110. }
  1111. for (size_t i = 1; i < s.size(); ++i) {
  1112. if (ss.count(s.substr(0, i)) != 0) {
  1113. return true;
  1114. }
  1115. }
  1116. }
  1117. return false;
  1118. }
  1119. // `GetUniqueId()` temporarily returns zero on Windows. `BlockBasedTable` can
  1120. // handle a return value of zero but this test case cannot.
  1121. #ifndef OS_WIN
  1122. TEST_P(EnvPosixTestWithParam, RandomAccessUniqueIDConcurrent) {
  1123. if (env_ == Env::Default()) {
  1124. // Check whether a bunch of concurrently existing files have unique IDs.
  1125. EnvOptions soptions;
  1126. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1127. // Create the files
  1128. IoctlFriendlyTmpdir ift;
  1129. if (!ift.is_supported()) {
  1130. ROCKSDB_GTEST_BYPASS(
  1131. "FS_IOC_GETVERSION is not supported by the filesystem");
  1132. return;
  1133. }
  1134. std::vector<std::string> fnames;
  1135. for (int i = 0; i < 1000; ++i) {
  1136. fnames.push_back(ift.name() + "/" + "testfile" + std::to_string(i));
  1137. // Create file.
  1138. std::unique_ptr<WritableFile> wfile;
  1139. ASSERT_OK(env_->NewWritableFile(fnames[i], &wfile, soptions));
  1140. }
  1141. // Collect and check whether the IDs are unique.
  1142. std::unordered_set<std::string> ids;
  1143. for (const std::string& fname : fnames) {
  1144. std::unique_ptr<RandomAccessFile> file;
  1145. std::string unique_id;
  1146. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1147. size_t id_size = file->GetUniqueId(temp_id, MAX_ID_SIZE);
  1148. ASSERT_TRUE(id_size > 0);
  1149. unique_id = std::string(temp_id, id_size);
  1150. ASSERT_TRUE(IsUniqueIDValid(unique_id));
  1151. ASSERT_TRUE(ids.count(unique_id) == 0);
  1152. ids.insert(unique_id);
  1153. }
  1154. // Delete the files
  1155. for (const std::string& fname : fnames) {
  1156. ASSERT_OK(env_->DeleteFile(fname));
  1157. }
  1158. ASSERT_TRUE(!HasPrefix(ids));
  1159. }
  1160. }
  1161. // TODO: Disable the flaky test, it's a known issue that ext4 may return same
  1162. // key after file deletion. The issue is tracked in #7405, #7470.
  1163. TEST_P(EnvPosixTestWithParam, DISABLED_RandomAccessUniqueIDDeletes) {
  1164. if (env_ == Env::Default()) {
  1165. EnvOptions soptions;
  1166. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1167. IoctlFriendlyTmpdir ift;
  1168. if (!ift.is_supported()) {
  1169. ROCKSDB_GTEST_BYPASS(
  1170. "FS_IOC_GETVERSION is not supported by the filesystem");
  1171. return;
  1172. }
  1173. std::string fname = ift.name() + "/" + "testfile";
  1174. // Check that after file is deleted we don't get same ID again in a new
  1175. // file.
  1176. std::unordered_set<std::string> ids;
  1177. for (int i = 0; i < 1000; ++i) {
  1178. // Create file.
  1179. {
  1180. std::unique_ptr<WritableFile> wfile;
  1181. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1182. }
  1183. // Get Unique ID
  1184. std::string unique_id;
  1185. {
  1186. std::unique_ptr<RandomAccessFile> file;
  1187. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1188. size_t id_size = file->GetUniqueId(temp_id, MAX_ID_SIZE);
  1189. ASSERT_TRUE(id_size > 0);
  1190. unique_id = std::string(temp_id, id_size);
  1191. }
  1192. ASSERT_TRUE(IsUniqueIDValid(unique_id));
  1193. ASSERT_TRUE(ids.count(unique_id) == 0);
  1194. ids.insert(unique_id);
  1195. // Delete the file
  1196. ASSERT_OK(env_->DeleteFile(fname));
  1197. }
  1198. ASSERT_TRUE(!HasPrefix(ids));
  1199. }
  1200. }
  1201. #endif // !defined(OS_WIN)
  1202. TEST_P(EnvPosixTestWithParam, MultiRead) {
  1203. EnvOptions soptions;
  1204. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1205. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1206. const size_t kSectorSize = 4096;
  1207. const size_t kNumSectors = 8;
  1208. // Create file.
  1209. {
  1210. std::unique_ptr<WritableFile> wfile;
  1211. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1212. !defined(OS_AIX)
  1213. if (soptions.use_direct_writes) {
  1214. soptions.use_direct_writes = false;
  1215. }
  1216. #endif
  1217. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1218. for (size_t i = 0; i < kNumSectors; ++i) {
  1219. auto data = NewAligned(kSectorSize * 8, static_cast<char>(i + 1));
  1220. Slice slice(data.get(), kSectorSize);
  1221. ASSERT_OK(wfile->Append(slice));
  1222. }
  1223. ASSERT_OK(wfile->Close());
  1224. }
  1225. // More attempts to simulate more partial result sequences.
  1226. for (uint32_t attempt = 0; attempt < 20; attempt++) {
  1227. // Random Read
  1228. Random rnd(301 + attempt);
  1229. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  1230. "UpdateResults::io_uring_result", [&](void* arg) {
  1231. if (attempt > 0) {
  1232. // No failure in the first attempt.
  1233. size_t& bytes_read = *static_cast<size_t*>(arg);
  1234. if (rnd.OneIn(4)) {
  1235. bytes_read = 0;
  1236. } else if (rnd.OneIn(3)) {
  1237. bytes_read = static_cast<size_t>(
  1238. rnd.Uniform(static_cast<int>(bytes_read)));
  1239. }
  1240. }
  1241. });
  1242. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1243. std::unique_ptr<RandomAccessFile> file;
  1244. std::vector<ReadRequest> reqs(3);
  1245. std::vector<std::unique_ptr<char, Deleter>> data;
  1246. uint64_t offset = 0;
  1247. for (size_t i = 0; i < reqs.size(); ++i) {
  1248. reqs[i].offset = offset;
  1249. offset += 2 * kSectorSize;
  1250. reqs[i].len = kSectorSize;
  1251. data.emplace_back(NewAligned(kSectorSize, 0));
  1252. reqs[i].scratch = data.back().get();
  1253. }
  1254. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1255. !defined(OS_AIX)
  1256. if (soptions.use_direct_reads) {
  1257. soptions.use_direct_reads = false;
  1258. }
  1259. #endif
  1260. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1261. ASSERT_OK(file->MultiRead(reqs.data(), reqs.size()));
  1262. for (size_t i = 0; i < reqs.size(); ++i) {
  1263. auto buf = NewAligned(kSectorSize * 8, static_cast<char>(i * 2 + 1));
  1264. ASSERT_OK(reqs[i].status);
  1265. ASSERT_EQ(memcmp(reqs[i].scratch, buf.get(), kSectorSize), 0);
  1266. }
  1267. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  1268. }
  1269. }
  1270. TEST_F(EnvPosixTest, MultiReadNonAlignedLargeNum) {
  1271. // In this test we don't do aligned read, so it doesn't work for
  1272. // direct I/O case.
  1273. EnvOptions soptions;
  1274. soptions.use_direct_reads = soptions.use_direct_writes = false;
  1275. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1276. const size_t kTotalSize = 81920;
  1277. Random rnd(301);
  1278. std::string expected_data = rnd.RandomString(kTotalSize);
  1279. // Create file.
  1280. {
  1281. std::unique_ptr<WritableFile> wfile;
  1282. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1283. ASSERT_OK(wfile->Append(expected_data));
  1284. ASSERT_OK(wfile->Close());
  1285. }
  1286. // More attempts to simulate more partial result sequences.
  1287. for (uint32_t attempt = 0; attempt < 25; attempt++) {
  1288. // Right now kIoUringDepth is hard coded as 256, so we need very large
  1289. // number of keys to cover the case of multiple rounds of submissions.
  1290. // Right now the test latency is still acceptable. If it ends up with
  1291. // too long, we can modify the io uring depth with SyncPoint here.
  1292. const int num_reads = rnd.Uniform(512) + 1;
  1293. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  1294. "UpdateResults::io_uring_result", [&](void* arg) {
  1295. if (attempt > 5) {
  1296. // Improve partial result rates in second half of the run to
  1297. // cover the case of repeated partial results.
  1298. int odd = (attempt < 15) ? num_reads / 2 : 4;
  1299. // No failure in first several attempts.
  1300. size_t& bytes_read = *static_cast<size_t*>(arg);
  1301. if (rnd.OneIn(odd)) {
  1302. bytes_read = 0;
  1303. } else if (rnd.OneIn(odd / 2)) {
  1304. bytes_read = static_cast<size_t>(
  1305. rnd.Uniform(static_cast<int>(bytes_read)));
  1306. }
  1307. }
  1308. });
  1309. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1310. // Generate (offset, len) pairs
  1311. std::set<int> start_offsets;
  1312. for (int i = 0; i < num_reads; i++) {
  1313. int rnd_off;
  1314. // No repeat offsets.
  1315. while (start_offsets.find(rnd_off = rnd.Uniform(81920)) !=
  1316. start_offsets.end()) {
  1317. }
  1318. start_offsets.insert(rnd_off);
  1319. }
  1320. std::vector<size_t> offsets;
  1321. std::vector<size_t> lens;
  1322. // std::set already sorted the offsets.
  1323. for (int so : start_offsets) {
  1324. offsets.push_back(so);
  1325. }
  1326. for (size_t i = 0; i + 1 < offsets.size(); i++) {
  1327. lens.push_back(static_cast<size_t>(
  1328. rnd.Uniform(static_cast<int>(offsets[i + 1] - offsets[i])) + 1));
  1329. }
  1330. lens.push_back(static_cast<size_t>(
  1331. rnd.Uniform(static_cast<int>(kTotalSize - offsets.back())) + 1));
  1332. ASSERT_EQ(num_reads, lens.size());
  1333. // Create requests
  1334. std::vector<std::string> scratches;
  1335. scratches.reserve(num_reads);
  1336. std::vector<ReadRequest> reqs(num_reads);
  1337. for (size_t i = 0; i < reqs.size(); ++i) {
  1338. reqs[i].offset = offsets[i];
  1339. reqs[i].len = lens[i];
  1340. scratches.emplace_back(reqs[i].len, ' ');
  1341. reqs[i].scratch = const_cast<char*>(scratches.back().data());
  1342. }
  1343. // Query the data
  1344. std::unique_ptr<RandomAccessFile> file;
  1345. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1346. ASSERT_OK(file->MultiRead(reqs.data(), reqs.size()));
  1347. // Validate results
  1348. for (int i = 0; i < num_reads; ++i) {
  1349. ASSERT_OK(reqs[i].status);
  1350. ASSERT_EQ(
  1351. Slice(expected_data.data() + offsets[i], lens[i]).ToString(true),
  1352. reqs[i].result.ToString(true));
  1353. }
  1354. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  1355. }
  1356. }
  1357. TEST_F(EnvPosixTest, NonAlignedDirectIOMultiReadBeyondFileSize) {
  1358. EnvOptions soptions;
  1359. soptions.use_direct_reads = true;
  1360. soptions.use_direct_writes = false;
  1361. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1362. Random rnd(301);
  1363. std::unique_ptr<WritableFile> wfile;
  1364. size_t alignment = 0;
  1365. // Create file.
  1366. {
  1367. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1368. auto data_ptr = NewAligned(4095, 'b');
  1369. Slice data_b(data_ptr.get(), 4095);
  1370. ASSERT_OK(wfile->PositionedAppend(data_b, 0U));
  1371. ASSERT_OK(wfile->Close());
  1372. }
  1373. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1374. !defined(OS_AIX) && !defined(OS_OPENBSD) && !defined(OS_FREEBSD)
  1375. if (soptions.use_direct_reads) {
  1376. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  1377. "NewRandomAccessFile:O_DIRECT", [&](void* arg) {
  1378. int* val = static_cast<int*>(arg);
  1379. *val &= ~O_DIRECT;
  1380. });
  1381. }
  1382. #endif
  1383. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1384. const int num_reads = 2;
  1385. // Create requests
  1386. std::vector<std::string> scratches;
  1387. scratches.reserve(num_reads);
  1388. std::vector<ReadRequest> reqs(num_reads);
  1389. std::unique_ptr<RandomAccessFile> file;
  1390. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1391. alignment = file->GetRequiredBufferAlignment();
  1392. ASSERT_EQ(num_reads, reqs.size());
  1393. std::vector<std::unique_ptr<char, Deleter>> data;
  1394. std::vector<size_t> offsets = {0, 2047};
  1395. std::vector<size_t> lens = {2047, 4096 - 2047};
  1396. for (size_t i = 0; i < num_reads; i++) {
  1397. // Do alignment
  1398. reqs[i].offset = static_cast<uint64_t>(TruncateToPageBoundary(
  1399. alignment, static_cast<size_t>(/*offset=*/offsets[i])));
  1400. reqs[i].len =
  1401. Roundup(static_cast<size_t>(/*offset=*/offsets[i]) + /*length=*/lens[i],
  1402. alignment) -
  1403. reqs[i].offset;
  1404. size_t new_capacity = Roundup(reqs[i].len, alignment);
  1405. data.emplace_back(NewAligned(new_capacity, 0));
  1406. reqs[i].scratch = data.back().get();
  1407. }
  1408. // Query the data
  1409. ASSERT_OK(file->MultiRead(reqs.data(), reqs.size()));
  1410. // Validate results
  1411. for (size_t i = 0; i < num_reads; ++i) {
  1412. ASSERT_OK(reqs[i].status);
  1413. }
  1414. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
  1415. }
  1416. #if defined(ROCKSDB_IOURING_PRESENT)
  1417. void GenerateFilesAndRequest(Env* env, const std::string& fname,
  1418. std::vector<ReadRequest>* ret_reqs,
  1419. std::vector<std::string>* scratches) {
  1420. const size_t kTotalSize = 81920;
  1421. Random rnd(301);
  1422. std::string expected_data = rnd.RandomString(kTotalSize);
  1423. // Create file.
  1424. {
  1425. std::unique_ptr<WritableFile> wfile;
  1426. ASSERT_OK(env->NewWritableFile(fname, &wfile, EnvOptions()));
  1427. ASSERT_OK(wfile->Append(expected_data));
  1428. ASSERT_OK(wfile->Close());
  1429. }
  1430. // Right now kIoUringDepth is hard coded as 256, so we need very large
  1431. // number of keys to cover the case of multiple rounds of submissions.
  1432. // Right now the test latency is still acceptable. If it ends up with
  1433. // too long, we can modify the io uring depth with SyncPoint here.
  1434. const int num_reads = 3;
  1435. std::vector<size_t> offsets = {10000, 20000, 30000};
  1436. std::vector<size_t> lens = {3000, 200, 100};
  1437. // Create requests
  1438. scratches->reserve(num_reads);
  1439. std::vector<ReadRequest>& reqs = *ret_reqs;
  1440. reqs.resize(num_reads);
  1441. for (int i = 0; i < num_reads; ++i) {
  1442. reqs[i].offset = offsets[i];
  1443. reqs[i].len = lens[i];
  1444. scratches->emplace_back(reqs[i].len, ' ');
  1445. reqs[i].scratch = const_cast<char*>(scratches->back().data());
  1446. }
  1447. }
  1448. TEST_F(EnvPosixTest, MultiReadIOUringError) {
  1449. // In this test we don't do aligned read, so we can't do direct I/O.
  1450. EnvOptions soptions;
  1451. soptions.use_direct_reads = soptions.use_direct_writes = false;
  1452. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1453. std::vector<std::string> scratches;
  1454. std::vector<ReadRequest> reqs;
  1455. GenerateFilesAndRequest(env_, fname, &reqs, &scratches);
  1456. // Query the data
  1457. std::unique_ptr<RandomAccessFile> file;
  1458. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1459. bool io_uring_wait_cqe_called = false;
  1460. SyncPoint::GetInstance()->SetCallBack(
  1461. "PosixRandomAccessFile::MultiRead:io_uring_wait_cqe:return",
  1462. [&](void* arg) {
  1463. if (!io_uring_wait_cqe_called) {
  1464. io_uring_wait_cqe_called = true;
  1465. ssize_t& ret = *(static_cast<ssize_t*>(arg));
  1466. ret = 1;
  1467. }
  1468. });
  1469. SyncPoint::GetInstance()->EnableProcessing();
  1470. Status s = file->MultiRead(reqs.data(), reqs.size());
  1471. if (io_uring_wait_cqe_called) {
  1472. ASSERT_NOK(s);
  1473. } else {
  1474. s.PermitUncheckedError();
  1475. }
  1476. SyncPoint::GetInstance()->DisableProcessing();
  1477. SyncPoint::GetInstance()->ClearAllCallBacks();
  1478. }
  1479. TEST_F(EnvPosixTest, MultiReadIOUringError2) {
  1480. // In this test we don't do aligned read, so we can't do direct I/O.
  1481. EnvOptions soptions;
  1482. soptions.use_direct_reads = soptions.use_direct_writes = false;
  1483. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1484. std::vector<std::string> scratches;
  1485. std::vector<ReadRequest> reqs;
  1486. GenerateFilesAndRequest(env_, fname, &reqs, &scratches);
  1487. // Query the data
  1488. std::unique_ptr<RandomAccessFile> file;
  1489. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1490. bool io_uring_submit_and_wait_called = false;
  1491. SyncPoint::GetInstance()->SetCallBack(
  1492. "PosixRandomAccessFile::MultiRead:io_uring_submit_and_wait:return1",
  1493. [&](void* arg) {
  1494. io_uring_submit_and_wait_called = true;
  1495. ssize_t* ret = static_cast<ssize_t*>(arg);
  1496. (*ret)--;
  1497. });
  1498. SyncPoint::GetInstance()->SetCallBack(
  1499. "PosixRandomAccessFile::MultiRead:io_uring_submit_and_wait:return2",
  1500. [&](void* arg) {
  1501. struct io_uring* iu = static_cast<struct io_uring*>(arg);
  1502. struct io_uring_cqe* cqe;
  1503. assert(io_uring_wait_cqe(iu, &cqe) == 0);
  1504. io_uring_cqe_seen(iu, cqe);
  1505. });
  1506. SyncPoint::GetInstance()->EnableProcessing();
  1507. Status s = file->MultiRead(reqs.data(), reqs.size());
  1508. if (io_uring_submit_and_wait_called) {
  1509. ASSERT_NOK(s);
  1510. } else {
  1511. s.PermitUncheckedError();
  1512. }
  1513. SyncPoint::GetInstance()->DisableProcessing();
  1514. SyncPoint::GetInstance()->ClearAllCallBacks();
  1515. }
  1516. #endif // ROCKSDB_IOURING_PRESENT
  1517. // Only works in linux platforms
  1518. #ifdef OS_WIN
  1519. TEST_P(EnvPosixTestWithParam, DISABLED_InvalidateCache) {
  1520. #else
  1521. TEST_P(EnvPosixTestWithParam, InvalidateCache) {
  1522. #endif
  1523. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1524. EnvOptions soptions;
  1525. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1526. std::string fname = test::PerThreadDBPath(env_, "testfile");
  1527. const size_t kSectorSize = 512;
  1528. auto data = NewAligned(kSectorSize, 0);
  1529. Slice slice(data.get(), kSectorSize);
  1530. // Create file.
  1531. {
  1532. std::unique_ptr<WritableFile> wfile;
  1533. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1534. !defined(OS_AIX)
  1535. if (soptions.use_direct_writes) {
  1536. soptions.use_direct_writes = false;
  1537. }
  1538. #endif
  1539. ASSERT_OK(env_->NewWritableFile(fname, &wfile, soptions));
  1540. ASSERT_OK(wfile->Append(slice));
  1541. ASSERT_OK(wfile->InvalidateCache(0, 0));
  1542. ASSERT_OK(wfile->Close());
  1543. }
  1544. // Random Read
  1545. {
  1546. std::unique_ptr<RandomAccessFile> file;
  1547. auto scratch = NewAligned(kSectorSize, 0);
  1548. Slice result;
  1549. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1550. !defined(OS_AIX)
  1551. if (soptions.use_direct_reads) {
  1552. soptions.use_direct_reads = false;
  1553. }
  1554. #endif
  1555. ASSERT_OK(env_->NewRandomAccessFile(fname, &file, soptions));
  1556. ASSERT_OK(file->Read(0, kSectorSize, &result, scratch.get()));
  1557. ASSERT_EQ(memcmp(scratch.get(), data.get(), kSectorSize), 0);
  1558. ASSERT_OK(file->InvalidateCache(0, 11));
  1559. ASSERT_OK(file->InvalidateCache(0, 0));
  1560. }
  1561. // Sequential Read
  1562. {
  1563. std::unique_ptr<SequentialFile> file;
  1564. auto scratch = NewAligned(kSectorSize, 0);
  1565. Slice result;
  1566. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1567. !defined(OS_AIX)
  1568. if (soptions.use_direct_reads) {
  1569. soptions.use_direct_reads = false;
  1570. }
  1571. #endif
  1572. ASSERT_OK(env_->NewSequentialFile(fname, &file, soptions));
  1573. if (file->use_direct_io()) {
  1574. ASSERT_OK(file->PositionedRead(0, kSectorSize, &result, scratch.get()));
  1575. } else {
  1576. ASSERT_OK(file->Read(kSectorSize, &result, scratch.get()));
  1577. }
  1578. ASSERT_EQ(memcmp(scratch.get(), data.get(), kSectorSize), 0);
  1579. ASSERT_OK(file->InvalidateCache(0, 11));
  1580. ASSERT_OK(file->InvalidateCache(0, 0));
  1581. }
  1582. // Delete the file
  1583. ASSERT_OK(env_->DeleteFile(fname));
  1584. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->ClearTrace();
  1585. }
  1586. #endif // OS_LINUX || OS_WIN
  1587. class TestLogger : public Logger {
  1588. public:
  1589. using Logger::Logv;
  1590. void Logv(const char* format, va_list ap) override {
  1591. log_count++;
  1592. char new_format[550];
  1593. std::fill_n(new_format, sizeof(new_format), '2');
  1594. {
  1595. va_list backup_ap;
  1596. va_copy(backup_ap, ap);
  1597. int n = vsnprintf(new_format, sizeof(new_format) - 1, format, backup_ap);
  1598. // 48 bytes for extra information + bytes allocated
  1599. // When we have n == -1 there is not a terminating zero expected
  1600. #ifdef OS_WIN
  1601. if (n < 0) {
  1602. char_0_count++;
  1603. }
  1604. #endif
  1605. if (new_format[0] == '[') {
  1606. // "[DEBUG] "
  1607. ASSERT_TRUE(n <= 56 + (512 - static_cast<int>(sizeof(port::TimeVal))));
  1608. } else {
  1609. ASSERT_TRUE(n <= 48 + (512 - static_cast<int>(sizeof(port::TimeVal))));
  1610. }
  1611. va_end(backup_ap);
  1612. }
  1613. for (size_t i = 0; i < sizeof(new_format); i++) {
  1614. if (new_format[i] == 'x') {
  1615. char_x_count++;
  1616. } else if (new_format[i] == '\0') {
  1617. char_0_count++;
  1618. }
  1619. }
  1620. }
  1621. int log_count;
  1622. int char_x_count;
  1623. int char_0_count;
  1624. };
  1625. TEST_P(EnvPosixTestWithParam, LogBufferTest) {
  1626. TestLogger test_logger;
  1627. test_logger.SetInfoLogLevel(InfoLogLevel::INFO_LEVEL);
  1628. test_logger.log_count = 0;
  1629. test_logger.char_x_count = 0;
  1630. test_logger.char_0_count = 0;
  1631. LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, &test_logger);
  1632. LogBuffer log_buffer_debug(DEBUG_LEVEL, &test_logger);
  1633. char bytes200[200];
  1634. std::fill_n(bytes200, sizeof(bytes200), '1');
  1635. bytes200[sizeof(bytes200) - 1] = '\0';
  1636. char bytes600[600];
  1637. std::fill_n(bytes600, sizeof(bytes600), '1');
  1638. bytes600[sizeof(bytes600) - 1] = '\0';
  1639. char bytes9000[9000];
  1640. std::fill_n(bytes9000, sizeof(bytes9000), '1');
  1641. bytes9000[sizeof(bytes9000) - 1] = '\0';
  1642. ROCKS_LOG_BUFFER(&log_buffer, "x%sx", bytes200);
  1643. ROCKS_LOG_BUFFER(&log_buffer, "x%sx", bytes600);
  1644. ROCKS_LOG_BUFFER(&log_buffer, "x%sx%sx%sx", bytes200, bytes200, bytes200);
  1645. ROCKS_LOG_BUFFER(&log_buffer, "x%sx%sx", bytes200, bytes600);
  1646. ROCKS_LOG_BUFFER(&log_buffer, "x%sx%sx", bytes600, bytes9000);
  1647. ROCKS_LOG_BUFFER(&log_buffer_debug, "x%sx", bytes200);
  1648. test_logger.SetInfoLogLevel(DEBUG_LEVEL);
  1649. ROCKS_LOG_BUFFER(&log_buffer_debug, "x%sx%sx%sx", bytes600, bytes9000,
  1650. bytes200);
  1651. ASSERT_EQ(0, test_logger.log_count);
  1652. log_buffer.FlushBufferToLog();
  1653. log_buffer_debug.FlushBufferToLog();
  1654. ASSERT_EQ(6, test_logger.log_count);
  1655. ASSERT_EQ(6, test_logger.char_0_count);
  1656. ASSERT_EQ(10, test_logger.char_x_count);
  1657. }
  1658. class TestLogger2 : public Logger {
  1659. public:
  1660. explicit TestLogger2(size_t max_log_size) : max_log_size_(max_log_size) {}
  1661. using Logger::Logv;
  1662. void Logv(const char* format, va_list ap) override {
  1663. char new_format[2000];
  1664. std::fill_n(new_format, sizeof(new_format), '2');
  1665. {
  1666. va_list backup_ap;
  1667. va_copy(backup_ap, ap);
  1668. int n = vsnprintf(new_format, sizeof(new_format) - 1, format, backup_ap);
  1669. // 48 bytes for extra information + bytes allocated
  1670. ASSERT_TRUE(n <=
  1671. 48 + static_cast<int>(max_log_size_ - sizeof(port::TimeVal)));
  1672. ASSERT_TRUE(n > static_cast<int>(max_log_size_ - sizeof(port::TimeVal)));
  1673. va_end(backup_ap);
  1674. }
  1675. }
  1676. size_t max_log_size_;
  1677. };
  1678. TEST_P(EnvPosixTestWithParam, LogBufferMaxSizeTest) {
  1679. char bytes9000[9000];
  1680. std::fill_n(bytes9000, sizeof(bytes9000), '1');
  1681. bytes9000[sizeof(bytes9000) - 1] = '\0';
  1682. for (size_t max_log_size = 256; max_log_size <= 1024;
  1683. max_log_size += 1024 - 256) {
  1684. TestLogger2 test_logger(max_log_size);
  1685. test_logger.SetInfoLogLevel(InfoLogLevel::INFO_LEVEL);
  1686. LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, &test_logger);
  1687. ROCKS_LOG_BUFFER_MAX_SZ(&log_buffer, max_log_size, "%s", bytes9000);
  1688. log_buffer.FlushBufferToLog();
  1689. }
  1690. }
  1691. TEST_P(EnvPosixTestWithParam, Preallocation) {
  1692. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1693. const std::string src = test::PerThreadDBPath(env_, "testfile");
  1694. std::unique_ptr<WritableFile> srcfile;
  1695. EnvOptions soptions;
  1696. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1697. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1698. !defined(OS_AIX) && !defined(OS_OPENBSD) && !defined(OS_FREEBSD)
  1699. if (soptions.use_direct_writes) {
  1700. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  1701. "NewWritableFile:O_DIRECT", [&](void* arg) {
  1702. int* val = static_cast<int*>(arg);
  1703. *val &= ~O_DIRECT;
  1704. });
  1705. }
  1706. #endif
  1707. ASSERT_OK(env_->NewWritableFile(src, &srcfile, soptions));
  1708. srcfile->SetPreallocationBlockSize(1024 * 1024);
  1709. // No writes should mean no preallocation
  1710. size_t block_size, last_allocated_block;
  1711. srcfile->GetPreallocationStatus(&block_size, &last_allocated_block);
  1712. ASSERT_EQ(last_allocated_block, 0UL);
  1713. // Small write should preallocate one block
  1714. size_t kStrSize = 4096;
  1715. auto data = NewAligned(kStrSize, 'A');
  1716. Slice str(data.get(), kStrSize);
  1717. srcfile->PrepareWrite(srcfile->GetFileSize(), kStrSize);
  1718. ASSERT_OK(srcfile->Append(str));
  1719. srcfile->GetPreallocationStatus(&block_size, &last_allocated_block);
  1720. ASSERT_EQ(last_allocated_block, 1UL);
  1721. // Write an entire preallocation block, make sure we increased by two.
  1722. {
  1723. auto buf_ptr = NewAligned(block_size, ' ');
  1724. Slice buf(buf_ptr.get(), block_size);
  1725. srcfile->PrepareWrite(srcfile->GetFileSize(), block_size);
  1726. ASSERT_OK(srcfile->Append(buf));
  1727. srcfile->GetPreallocationStatus(&block_size, &last_allocated_block);
  1728. ASSERT_EQ(last_allocated_block, 2UL);
  1729. }
  1730. // Write five more blocks at once, ensure we're where we need to be.
  1731. {
  1732. auto buf_ptr = NewAligned(block_size * 5, ' ');
  1733. Slice buf = Slice(buf_ptr.get(), block_size * 5);
  1734. srcfile->PrepareWrite(srcfile->GetFileSize(), buf.size());
  1735. ASSERT_OK(srcfile->Append(buf));
  1736. srcfile->GetPreallocationStatus(&block_size, &last_allocated_block);
  1737. ASSERT_EQ(last_allocated_block, 7UL);
  1738. }
  1739. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->ClearTrace();
  1740. }
  1741. // Test that the two ways to get children file attributes (in bulk or
  1742. // individually) behave consistently.
  1743. TEST_P(EnvPosixTestWithParam, ConsistentChildrenAttributes) {
  1744. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
  1745. EnvOptions soptions;
  1746. soptions.use_direct_reads = soptions.use_direct_writes = direct_io_;
  1747. const int kNumChildren = 10;
  1748. std::string data;
  1749. std::string test_base_dir = test::PerThreadDBPath(env_, "env_test_chr_attr");
  1750. env_->CreateDir(test_base_dir).PermitUncheckedError();
  1751. for (int i = 0; i < kNumChildren; ++i) {
  1752. const std::string path = test_base_dir + "/testfile_" + std::to_string(i);
  1753. std::unique_ptr<WritableFile> file;
  1754. #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(OS_SOLARIS) && \
  1755. !defined(OS_AIX) && !defined(OS_OPENBSD) && !defined(OS_FREEBSD)
  1756. if (soptions.use_direct_writes) {
  1757. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
  1758. "NewWritableFile:O_DIRECT", [&](void* arg) {
  1759. int* val = static_cast<int*>(arg);
  1760. *val &= ~O_DIRECT;
  1761. });
  1762. }
  1763. #endif
  1764. ASSERT_OK(env_->NewWritableFile(path, &file, soptions));
  1765. auto buf_ptr = NewAligned(data.size(), 'T');
  1766. Slice buf(buf_ptr.get(), data.size());
  1767. ASSERT_OK(file->Append(buf));
  1768. data.append(std::string(4096, 'T'));
  1769. }
  1770. std::vector<Env::FileAttributes> file_attrs;
  1771. ASSERT_OK(env_->GetChildrenFileAttributes(test_base_dir, &file_attrs));
  1772. for (int i = 0; i < kNumChildren; ++i) {
  1773. const std::string name = "testfile_" + std::to_string(i);
  1774. const std::string path = test_base_dir + "/" + name;
  1775. auto file_attrs_iter = std::find_if(
  1776. file_attrs.begin(), file_attrs.end(),
  1777. [&name](const Env::FileAttributes& fm) { return fm.name == name; });
  1778. ASSERT_TRUE(file_attrs_iter != file_attrs.end());
  1779. uint64_t size;
  1780. ASSERT_OK(env_->GetFileSize(path, &size));
  1781. ASSERT_EQ(size, 4096 * i);
  1782. ASSERT_EQ(size, file_attrs_iter->size_bytes);
  1783. }
  1784. ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->ClearTrace();
  1785. }
  1786. // Test that all WritableFileWrapper forwards all calls to WritableFile.
  1787. TEST_P(EnvPosixTestWithParam, WritableFileWrapper) {
  1788. class Base : public WritableFile {
  1789. public:
  1790. mutable int* step_;
  1791. void inc(int x) const { EXPECT_EQ(x, (*step_)++); }
  1792. explicit Base(int* step) : step_(step) { inc(0); }
  1793. Status Append(const Slice& /*data*/) override {
  1794. inc(1);
  1795. return Status::OK();
  1796. }
  1797. Status Append(
  1798. const Slice& /*data*/,
  1799. const DataVerificationInfo& /* verification_info */) override {
  1800. inc(1);
  1801. return Status::OK();
  1802. }
  1803. Status PositionedAppend(const Slice& /*data*/,
  1804. uint64_t /*offset*/) override {
  1805. inc(2);
  1806. return Status::OK();
  1807. }
  1808. Status PositionedAppend(
  1809. const Slice& /*data*/, uint64_t /*offset*/,
  1810. const DataVerificationInfo& /* verification_info */) override {
  1811. inc(2);
  1812. return Status::OK();
  1813. }
  1814. Status Truncate(uint64_t /*size*/) override {
  1815. inc(3);
  1816. return Status::OK();
  1817. }
  1818. Status Close() override {
  1819. inc(4);
  1820. return Status::OK();
  1821. }
  1822. Status Flush() override {
  1823. inc(5);
  1824. return Status::OK();
  1825. }
  1826. Status Sync() override {
  1827. inc(6);
  1828. return Status::OK();
  1829. }
  1830. Status Fsync() override {
  1831. inc(7);
  1832. return Status::OK();
  1833. }
  1834. bool IsSyncThreadSafe() const override {
  1835. inc(8);
  1836. return true;
  1837. }
  1838. bool use_direct_io() const override {
  1839. inc(9);
  1840. return true;
  1841. }
  1842. size_t GetRequiredBufferAlignment() const override {
  1843. inc(10);
  1844. return 0;
  1845. }
  1846. void SetIOPriority(Env::IOPriority /*pri*/) override { inc(11); }
  1847. Env::IOPriority GetIOPriority() override {
  1848. inc(12);
  1849. return Env::IOPriority::IO_LOW;
  1850. }
  1851. void SetWriteLifeTimeHint(Env::WriteLifeTimeHint /*hint*/) override {
  1852. inc(13);
  1853. }
  1854. Env::WriteLifeTimeHint GetWriteLifeTimeHint() override {
  1855. inc(14);
  1856. return Env::WriteLifeTimeHint::WLTH_NOT_SET;
  1857. }
  1858. uint64_t GetFileSize() override {
  1859. inc(15);
  1860. return 0;
  1861. }
  1862. void SetPreallocationBlockSize(size_t /*size*/) override { inc(16); }
  1863. void GetPreallocationStatus(size_t* /*block_size*/,
  1864. size_t* /*last_allocated_block*/) override {
  1865. inc(17);
  1866. }
  1867. size_t GetUniqueId(char* /*id*/, size_t /*max_size*/) const override {
  1868. inc(18);
  1869. return 0;
  1870. }
  1871. Status InvalidateCache(size_t /*offset*/, size_t /*length*/) override {
  1872. inc(19);
  1873. return Status::OK();
  1874. }
  1875. Status RangeSync(uint64_t /*offset*/, uint64_t /*nbytes*/) override {
  1876. inc(20);
  1877. return Status::OK();
  1878. }
  1879. void PrepareWrite(size_t /*offset*/, size_t /*len*/) override { inc(21); }
  1880. Status Allocate(uint64_t /*offset*/, uint64_t /*len*/) override {
  1881. inc(22);
  1882. return Status::OK();
  1883. }
  1884. public:
  1885. ~Base() override { inc(23); }
  1886. };
  1887. class Wrapper : public WritableFileWrapper {
  1888. public:
  1889. explicit Wrapper(WritableFile* target) : WritableFileWrapper(target) {}
  1890. };
  1891. int step = 0;
  1892. {
  1893. Base b(&step);
  1894. Wrapper w(&b);
  1895. ASSERT_OK(w.Append(Slice()));
  1896. ASSERT_OK(w.PositionedAppend(Slice(), 0));
  1897. ASSERT_OK(w.Truncate(0));
  1898. ASSERT_OK(w.Close());
  1899. ASSERT_OK(w.Flush());
  1900. ASSERT_OK(w.Sync());
  1901. ASSERT_OK(w.Fsync());
  1902. w.IsSyncThreadSafe();
  1903. w.use_direct_io();
  1904. w.GetRequiredBufferAlignment();
  1905. w.SetIOPriority(Env::IOPriority::IO_HIGH);
  1906. w.GetIOPriority();
  1907. w.SetWriteLifeTimeHint(Env::WriteLifeTimeHint::WLTH_NOT_SET);
  1908. w.GetWriteLifeTimeHint();
  1909. w.GetFileSize();
  1910. w.SetPreallocationBlockSize(0);
  1911. w.GetPreallocationStatus(nullptr, nullptr);
  1912. w.GetUniqueId(nullptr, 0);
  1913. ASSERT_OK(w.InvalidateCache(0, 0));
  1914. ASSERT_OK(w.RangeSync(0, 0));
  1915. w.PrepareWrite(0, 0);
  1916. ASSERT_OK(w.Allocate(0, 0));
  1917. }
  1918. EXPECT_EQ(24, step);
  1919. }
  1920. TEST_P(EnvPosixTestWithParam, PosixRandomRWFile) {
  1921. const std::string path = test::PerThreadDBPath(env_, "random_rw_file");
  1922. env_->DeleteFile(path).PermitUncheckedError();
  1923. std::unique_ptr<RandomRWFile> file;
  1924. // Cannot open non-existing file.
  1925. ASSERT_NOK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  1926. // Create the file using WritableFile
  1927. {
  1928. std::unique_ptr<WritableFile> wf;
  1929. ASSERT_OK(env_->NewWritableFile(path, &wf, EnvOptions()));
  1930. }
  1931. ASSERT_OK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  1932. char buf[10000];
  1933. Slice read_res;
  1934. ASSERT_OK(file->Write(0, "ABCD"));
  1935. ASSERT_OK(file->Read(0, 10, &read_res, buf));
  1936. ASSERT_EQ(read_res.ToString(), "ABCD");
  1937. ASSERT_OK(file->Write(2, "XXXX"));
  1938. ASSERT_OK(file->Read(0, 10, &read_res, buf));
  1939. ASSERT_EQ(read_res.ToString(), "ABXXXX");
  1940. ASSERT_OK(file->Write(10, "ZZZ"));
  1941. ASSERT_OK(file->Read(10, 10, &read_res, buf));
  1942. ASSERT_EQ(read_res.ToString(), "ZZZ");
  1943. ASSERT_OK(file->Write(11, "Y"));
  1944. ASSERT_OK(file->Read(10, 10, &read_res, buf));
  1945. ASSERT_EQ(read_res.ToString(), "ZYZ");
  1946. ASSERT_OK(file->Write(200, "FFFFF"));
  1947. ASSERT_OK(file->Read(200, 10, &read_res, buf));
  1948. ASSERT_EQ(read_res.ToString(), "FFFFF");
  1949. ASSERT_OK(file->Write(205, "XXXX"));
  1950. ASSERT_OK(file->Read(200, 10, &read_res, buf));
  1951. ASSERT_EQ(read_res.ToString(), "FFFFFXXXX");
  1952. ASSERT_OK(file->Write(5, "QQQQ"));
  1953. ASSERT_OK(file->Read(0, 9, &read_res, buf));
  1954. ASSERT_EQ(read_res.ToString(), "ABXXXQQQQ");
  1955. ASSERT_OK(file->Read(2, 4, &read_res, buf));
  1956. ASSERT_EQ(read_res.ToString(), "XXXQ");
  1957. // Close file and reopen it
  1958. ASSERT_OK(file->Close());
  1959. ASSERT_OK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  1960. ASSERT_OK(file->Read(0, 9, &read_res, buf));
  1961. ASSERT_EQ(read_res.ToString(), "ABXXXQQQQ");
  1962. ASSERT_OK(file->Read(10, 3, &read_res, buf));
  1963. ASSERT_EQ(read_res.ToString(), "ZYZ");
  1964. ASSERT_OK(file->Read(200, 9, &read_res, buf));
  1965. ASSERT_EQ(read_res.ToString(), "FFFFFXXXX");
  1966. ASSERT_OK(file->Write(4, "TTTTTTTTTTTTTTTT"));
  1967. ASSERT_OK(file->Read(0, 10, &read_res, buf));
  1968. ASSERT_EQ(read_res.ToString(), "ABXXTTTTTT");
  1969. // Clean up
  1970. ASSERT_OK(env_->DeleteFile(path));
  1971. }
  1972. class RandomRWFileWithMirrorString {
  1973. public:
  1974. explicit RandomRWFileWithMirrorString(RandomRWFile* _file) : file_(_file) {}
  1975. void Write(size_t offset, const std::string& data) {
  1976. // Write to mirror string
  1977. StringWrite(offset, data);
  1978. // Write to file
  1979. Status s = file_->Write(offset, data);
  1980. ASSERT_OK(s) << s.ToString();
  1981. }
  1982. void Read(size_t offset = 0, size_t n = 1000000) {
  1983. Slice str_res(nullptr, 0);
  1984. if (offset < file_mirror_.size()) {
  1985. size_t str_res_sz = std::min(file_mirror_.size() - offset, n);
  1986. str_res = Slice(file_mirror_.data() + offset, str_res_sz);
  1987. StopSliceAtNull(&str_res);
  1988. }
  1989. Slice file_res;
  1990. Status s = file_->Read(offset, n, &file_res, buf_);
  1991. ASSERT_OK(s) << s.ToString();
  1992. StopSliceAtNull(&file_res);
  1993. ASSERT_EQ(str_res.ToString(), file_res.ToString()) << offset << " " << n;
  1994. }
  1995. void SetFile(RandomRWFile* _file) { file_ = _file; }
  1996. private:
  1997. void StringWrite(size_t offset, const std::string& src) {
  1998. if (offset + src.size() > file_mirror_.size()) {
  1999. file_mirror_.resize(offset + src.size(), '\0');
  2000. }
  2001. char* pos = const_cast<char*>(file_mirror_.data() + offset);
  2002. memcpy(pos, src.data(), src.size());
  2003. }
  2004. void StopSliceAtNull(Slice* slc) {
  2005. for (size_t i = 0; i < slc->size(); i++) {
  2006. if ((*slc)[i] == '\0') {
  2007. *slc = Slice(slc->data(), i);
  2008. break;
  2009. }
  2010. }
  2011. }
  2012. char buf_[10000];
  2013. RandomRWFile* file_;
  2014. std::string file_mirror_;
  2015. };
  2016. TEST_P(EnvPosixTestWithParam, PosixRandomRWFileRandomized) {
  2017. const std::string path = test::PerThreadDBPath(env_, "random_rw_file_rand");
  2018. env_->DeleteFile(path).PermitUncheckedError();
  2019. std::unique_ptr<RandomRWFile> file;
  2020. #ifdef OS_LINUX
  2021. // Cannot open non-existing file.
  2022. ASSERT_NOK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  2023. #endif
  2024. // Create the file using WritableFile
  2025. {
  2026. std::unique_ptr<WritableFile> wf;
  2027. ASSERT_OK(env_->NewWritableFile(path, &wf, EnvOptions()));
  2028. }
  2029. ASSERT_OK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  2030. RandomRWFileWithMirrorString file_with_mirror(file.get());
  2031. Random rnd(301);
  2032. std::string buf;
  2033. for (int i = 0; i < 10000; i++) {
  2034. // Genrate random data
  2035. buf = rnd.RandomString(10);
  2036. // Pick random offset for write
  2037. size_t write_off = rnd.Next() % 1000;
  2038. file_with_mirror.Write(write_off, buf);
  2039. // Pick random offset for read
  2040. size_t read_off = rnd.Next() % 1000;
  2041. size_t read_sz = rnd.Next() % 20;
  2042. file_with_mirror.Read(read_off, read_sz);
  2043. if (i % 500 == 0) {
  2044. // Reopen the file every 500 iters
  2045. ASSERT_OK(env_->NewRandomRWFile(path, &file, EnvOptions()));
  2046. file_with_mirror.SetFile(file.get());
  2047. }
  2048. }
  2049. // clean up
  2050. ASSERT_OK(env_->DeleteFile(path));
  2051. }
  2052. class TestEnv : public EnvWrapper {
  2053. public:
  2054. explicit TestEnv() : EnvWrapper(Env::Default()), close_count(0) {}
  2055. const char* Name() const override { return "TestEnv"; }
  2056. class TestLogger : public Logger {
  2057. public:
  2058. using Logger::Logv;
  2059. explicit TestLogger(TestEnv* env_ptr) : Logger() { env = env_ptr; }
  2060. ~TestLogger() override {
  2061. if (!closed_) {
  2062. Status s = CloseHelper();
  2063. s.PermitUncheckedError();
  2064. }
  2065. }
  2066. void Logv(const char* /*format*/, va_list /*ap*/) override {}
  2067. protected:
  2068. Status CloseImpl() override { return CloseHelper(); }
  2069. private:
  2070. Status CloseHelper() {
  2071. env->CloseCountInc();
  2072. return Status::OK();
  2073. }
  2074. TestEnv* env;
  2075. };
  2076. void CloseCountInc() { close_count++; }
  2077. int GetCloseCount() { return close_count; }
  2078. Status NewLogger(const std::string& /*fname*/,
  2079. std::shared_ptr<Logger>* result) override {
  2080. result->reset(new TestLogger(this));
  2081. return Status::OK();
  2082. }
  2083. private:
  2084. int close_count;
  2085. };
  2086. class EnvTest : public testing::Test {
  2087. public:
  2088. EnvTest() : test_directory_(test::PerThreadDBPath("env_test")) {}
  2089. protected:
  2090. const std::string test_directory_;
  2091. };
  2092. TEST_F(EnvTest, Close) {
  2093. TestEnv* env = new TestEnv();
  2094. std::shared_ptr<Logger> logger;
  2095. Status s;
  2096. s = env->NewLogger("", &logger);
  2097. ASSERT_OK(s);
  2098. ASSERT_OK(logger.get()->Close());
  2099. ASSERT_EQ(env->GetCloseCount(), 1);
  2100. // Call Close() again. CloseHelper() should not be called again
  2101. ASSERT_OK(logger.get()->Close());
  2102. ASSERT_EQ(env->GetCloseCount(), 1);
  2103. logger.reset();
  2104. ASSERT_EQ(env->GetCloseCount(), 1);
  2105. s = env->NewLogger("", &logger);
  2106. ASSERT_OK(s);
  2107. logger.reset();
  2108. ASSERT_EQ(env->GetCloseCount(), 2);
  2109. delete env;
  2110. }
  2111. class LogvWithInfoLogLevelLogger : public Logger {
  2112. public:
  2113. using Logger::Logv;
  2114. void Logv(const InfoLogLevel /* log_level */, const char* /* format */,
  2115. va_list /* ap */) override {}
  2116. };
  2117. TEST_F(EnvTest, LogvWithInfoLogLevel) {
  2118. // Verifies the log functions work on a `Logger` that only overrides the
  2119. // `Logv()` overload including `InfoLogLevel`.
  2120. const std::string kSampleMessage("sample log message");
  2121. LogvWithInfoLogLevelLogger logger;
  2122. ROCKS_LOG_HEADER(&logger, "%s", kSampleMessage.c_str());
  2123. ROCKS_LOG_DEBUG(&logger, "%s", kSampleMessage.c_str());
  2124. ROCKS_LOG_INFO(&logger, "%s", kSampleMessage.c_str());
  2125. ROCKS_LOG_WARN(&logger, "%s", kSampleMessage.c_str());
  2126. ROCKS_LOG_ERROR(&logger, "%s", kSampleMessage.c_str());
  2127. ROCKS_LOG_FATAL(&logger, "%s", kSampleMessage.c_str());
  2128. }
  2129. INSTANTIATE_TEST_CASE_P(DefaultEnvWithoutDirectIO, EnvPosixTestWithParam,
  2130. ::testing::Values(std::pair<Env*, bool>(Env::Default(),
  2131. false)));
  2132. INSTANTIATE_TEST_CASE_P(DefaultEnvWithDirectIO, EnvPosixTestWithParam,
  2133. ::testing::Values(std::pair<Env*, bool>(Env::Default(),
  2134. true)));
  2135. #if !defined(OS_WIN)
  2136. static Env* GetChrootEnv() {
  2137. static std::unique_ptr<Env> chroot_env(
  2138. NewChrootEnv(Env::Default(), test::TmpDir(Env::Default())));
  2139. return chroot_env.get();
  2140. }
  2141. INSTANTIATE_TEST_CASE_P(ChrootEnvWithoutDirectIO, EnvPosixTestWithParam,
  2142. ::testing::Values(std::pair<Env*, bool>(GetChrootEnv(),
  2143. false)));
  2144. INSTANTIATE_TEST_CASE_P(ChrootEnvWithDirectIO, EnvPosixTestWithParam,
  2145. ::testing::Values(std::pair<Env*, bool>(GetChrootEnv(),
  2146. true)));
  2147. #endif // !defined(OS_WIN)
  2148. class EnvFSTestWithParam
  2149. : public ::testing::Test,
  2150. public ::testing::WithParamInterface<std::tuple<bool, bool, bool>> {
  2151. public:
  2152. EnvFSTestWithParam() {
  2153. bool env_non_null = std::get<0>(GetParam());
  2154. bool env_default = std::get<1>(GetParam());
  2155. bool fs_default = std::get<2>(GetParam());
  2156. env_ = env_non_null ? (env_default ? Env::Default() : nullptr) : nullptr;
  2157. fs_ = fs_default
  2158. ? FileSystem::Default()
  2159. : std::make_shared<FaultInjectionTestFS>(FileSystem::Default());
  2160. if (env_non_null && env_default && !fs_default) {
  2161. env_ptr_ = NewCompositeEnv(fs_);
  2162. }
  2163. if (env_non_null && !env_default && fs_default) {
  2164. env_ptr_ =
  2165. std::unique_ptr<Env>(new FaultInjectionTestEnv(Env::Default()));
  2166. fs_.reset();
  2167. }
  2168. if (env_non_null && !env_default && !fs_default) {
  2169. env_ptr_.reset(new FaultInjectionTestEnv(Env::Default()));
  2170. composite_env_ptr_.reset(new CompositeEnvWrapper(env_ptr_.get(), fs_));
  2171. env_ = composite_env_ptr_.get();
  2172. } else {
  2173. env_ = env_ptr_.get();
  2174. }
  2175. dbname1_ = test::PerThreadDBPath("env_fs_test1");
  2176. dbname2_ = test::PerThreadDBPath("env_fs_test2");
  2177. }
  2178. ~EnvFSTestWithParam() = default;
  2179. Env* env_;
  2180. std::unique_ptr<Env> env_ptr_;
  2181. std::unique_ptr<Env> composite_env_ptr_;
  2182. std::shared_ptr<FileSystem> fs_;
  2183. std::string dbname1_;
  2184. std::string dbname2_;
  2185. };
  2186. TEST_P(EnvFSTestWithParam, OptionsTest) {
  2187. Options opts;
  2188. opts.env = env_;
  2189. opts.create_if_missing = true;
  2190. std::string dbname = dbname1_;
  2191. if (env_) {
  2192. if (fs_) {
  2193. ASSERT_EQ(fs_.get(), env_->GetFileSystem().get());
  2194. } else {
  2195. ASSERT_NE(FileSystem::Default().get(), env_->GetFileSystem().get());
  2196. }
  2197. }
  2198. for (int i = 0; i < 2; ++i) {
  2199. DB* db;
  2200. Status s = DB::Open(opts, dbname, &db);
  2201. ASSERT_OK(s);
  2202. WriteOptions wo;
  2203. ASSERT_OK(db->Put(wo, "a", "a"));
  2204. ASSERT_OK(db->Flush(FlushOptions()));
  2205. ASSERT_OK(db->Put(wo, "b", "b"));
  2206. ASSERT_OK(db->Flush(FlushOptions()));
  2207. ASSERT_OK(db->CompactRange(CompactRangeOptions(), nullptr, nullptr));
  2208. std::string val;
  2209. ASSERT_OK(db->Get(ReadOptions(), "a", &val));
  2210. ASSERT_EQ("a", val);
  2211. ASSERT_OK(db->Get(ReadOptions(), "b", &val));
  2212. ASSERT_EQ("b", val);
  2213. ASSERT_OK(db->Close());
  2214. delete db;
  2215. ASSERT_OK(DestroyDB(dbname, opts));
  2216. dbname = dbname2_;
  2217. }
  2218. }
  2219. // The parameters are as follows -
  2220. // 1. True means Options::env is non-null, false means null
  2221. // 2. True means use Env::Default, false means custom
  2222. // 3. True means use FileSystem::Default, false means custom
  2223. INSTANTIATE_TEST_CASE_P(EnvFSTest, EnvFSTestWithParam,
  2224. ::testing::Combine(::testing::Bool(), ::testing::Bool(),
  2225. ::testing::Bool()));
  2226. // This test ensures that default Env and those allocated by
  2227. // NewCompositeEnv() all share the same threadpool
  2228. TEST_F(EnvTest, MultipleCompositeEnv) {
  2229. std::shared_ptr<FaultInjectionTestFS> fs1 =
  2230. std::make_shared<FaultInjectionTestFS>(FileSystem::Default());
  2231. std::shared_ptr<FaultInjectionTestFS> fs2 =
  2232. std::make_shared<FaultInjectionTestFS>(FileSystem::Default());
  2233. std::unique_ptr<Env> env1 = NewCompositeEnv(fs1);
  2234. std::unique_ptr<Env> env2 = NewCompositeEnv(fs2);
  2235. Env::Default()->SetBackgroundThreads(8, Env::HIGH);
  2236. Env::Default()->SetBackgroundThreads(16, Env::LOW);
  2237. ASSERT_EQ(env1->GetBackgroundThreads(Env::LOW), 16);
  2238. ASSERT_EQ(env1->GetBackgroundThreads(Env::HIGH), 8);
  2239. ASSERT_EQ(env2->GetBackgroundThreads(Env::LOW), 16);
  2240. ASSERT_EQ(env2->GetBackgroundThreads(Env::HIGH), 8);
  2241. }
  2242. TEST_F(EnvTest, IsDirectory) {
  2243. Status s = Env::Default()->CreateDirIfMissing(test_directory_);
  2244. ASSERT_OK(s);
  2245. const std::string test_sub_dir = test_directory_ + "sub1";
  2246. const std::string test_file_path = test_directory_ + "file1";
  2247. ASSERT_OK(Env::Default()->CreateDirIfMissing(test_sub_dir));
  2248. bool is_dir = false;
  2249. ASSERT_OK(Env::Default()->IsDirectory(test_sub_dir, &is_dir));
  2250. ASSERT_TRUE(is_dir);
  2251. {
  2252. std::unique_ptr<FSWritableFile> wfile;
  2253. s = Env::Default()->GetFileSystem()->NewWritableFile(
  2254. test_file_path, FileOptions(), &wfile, /*dbg=*/nullptr);
  2255. ASSERT_OK(s);
  2256. std::unique_ptr<WritableFileWriter> fwriter;
  2257. fwriter.reset(new WritableFileWriter(std::move(wfile), test_file_path,
  2258. FileOptions(),
  2259. SystemClock::Default().get()));
  2260. constexpr char buf[] = "test";
  2261. s = fwriter->Append(IOOptions(), buf);
  2262. ASSERT_OK(s);
  2263. }
  2264. ASSERT_OK(Env::Default()->IsDirectory(test_file_path, &is_dir));
  2265. ASSERT_FALSE(is_dir);
  2266. }
  2267. TEST_F(EnvTest, EnvWriteVerificationTest) {
  2268. Status s = Env::Default()->CreateDirIfMissing(test_directory_);
  2269. const std::string test_file_path = test_directory_ + "file1";
  2270. ASSERT_OK(s);
  2271. std::shared_ptr<FaultInjectionTestFS> fault_fs(
  2272. new FaultInjectionTestFS(FileSystem::Default()));
  2273. fault_fs->SetChecksumHandoffFuncType(ChecksumType::kCRC32c);
  2274. std::unique_ptr<Env> fault_fs_env(NewCompositeEnv(fault_fs));
  2275. std::unique_ptr<WritableFile> file;
  2276. s = fault_fs_env->NewWritableFile(test_file_path, &file, EnvOptions());
  2277. ASSERT_OK(s);
  2278. DataVerificationInfo v_info;
  2279. std::string test_data = "test";
  2280. std::string checksum;
  2281. uint32_t v_crc32c = crc32c::Extend(0, test_data.c_str(), test_data.size());
  2282. PutFixed32(&checksum, v_crc32c);
  2283. v_info.checksum = Slice(checksum);
  2284. s = file->Append(Slice(test_data), v_info);
  2285. ASSERT_OK(s);
  2286. }
  2287. class CreateEnvTest : public testing::Test {
  2288. public:
  2289. CreateEnvTest() {
  2290. config_options_.ignore_unknown_options = false;
  2291. config_options_.ignore_unsupported_options = false;
  2292. }
  2293. ConfigOptions config_options_;
  2294. };
  2295. TEST_F(CreateEnvTest, LoadCTRProvider) {
  2296. config_options_.invoke_prepare_options = false;
  2297. std::string CTR = CTREncryptionProvider::kClassName();
  2298. std::shared_ptr<EncryptionProvider> provider;
  2299. // Test a provider with no cipher
  2300. ASSERT_OK(
  2301. EncryptionProvider::CreateFromString(config_options_, CTR, &provider));
  2302. ASSERT_NE(provider, nullptr);
  2303. ASSERT_EQ(provider->Name(), CTR);
  2304. ASSERT_NOK(provider->PrepareOptions(config_options_));
  2305. ASSERT_NOK(provider->ValidateOptions(DBOptions(), ColumnFamilyOptions()));
  2306. auto cipher = provider->GetOptions<std::shared_ptr<BlockCipher>>("Cipher");
  2307. ASSERT_NE(cipher, nullptr);
  2308. ASSERT_EQ(cipher->get(), nullptr);
  2309. provider.reset();
  2310. ASSERT_OK(EncryptionProvider::CreateFromString(config_options_,
  2311. CTR + "://test", &provider));
  2312. ASSERT_NE(provider, nullptr);
  2313. ASSERT_EQ(provider->Name(), CTR);
  2314. ASSERT_OK(provider->PrepareOptions(config_options_));
  2315. ASSERT_OK(provider->ValidateOptions(DBOptions(), ColumnFamilyOptions()));
  2316. cipher = provider->GetOptions<std::shared_ptr<BlockCipher>>("Cipher");
  2317. ASSERT_NE(cipher, nullptr);
  2318. ASSERT_NE(cipher->get(), nullptr);
  2319. ASSERT_STREQ(cipher->get()->Name(), "ROT13");
  2320. provider.reset();
  2321. ASSERT_OK(EncryptionProvider::CreateFromString(config_options_, "1://test",
  2322. &provider));
  2323. ASSERT_NE(provider, nullptr);
  2324. ASSERT_EQ(provider->Name(), CTR);
  2325. ASSERT_OK(provider->PrepareOptions(config_options_));
  2326. ASSERT_OK(provider->ValidateOptions(DBOptions(), ColumnFamilyOptions()));
  2327. cipher = provider->GetOptions<std::shared_ptr<BlockCipher>>("Cipher");
  2328. ASSERT_NE(cipher, nullptr);
  2329. ASSERT_NE(cipher->get(), nullptr);
  2330. ASSERT_STREQ(cipher->get()->Name(), "ROT13");
  2331. provider.reset();
  2332. ASSERT_OK(EncryptionProvider::CreateFromString(
  2333. config_options_, "id=" + CTR + "; cipher=ROT13", &provider));
  2334. ASSERT_NE(provider, nullptr);
  2335. ASSERT_EQ(provider->Name(), CTR);
  2336. cipher = provider->GetOptions<std::shared_ptr<BlockCipher>>("Cipher");
  2337. ASSERT_NE(cipher, nullptr);
  2338. ASSERT_NE(cipher->get(), nullptr);
  2339. ASSERT_STREQ(cipher->get()->Name(), "ROT13");
  2340. provider.reset();
  2341. }
  2342. TEST_F(CreateEnvTest, LoadROT13Cipher) {
  2343. std::shared_ptr<BlockCipher> cipher;
  2344. // Test a provider with no cipher
  2345. ASSERT_OK(BlockCipher::CreateFromString(config_options_, "ROT13", &cipher));
  2346. ASSERT_NE(cipher, nullptr);
  2347. ASSERT_STREQ(cipher->Name(), "ROT13");
  2348. }
  2349. TEST_F(CreateEnvTest, CreateDefaultSystemClock) {
  2350. std::shared_ptr<SystemClock> clock, copy;
  2351. ASSERT_OK(SystemClock::CreateFromString(config_options_,
  2352. SystemClock::kDefaultName(), &clock));
  2353. ASSERT_NE(clock, nullptr);
  2354. ASSERT_EQ(clock, SystemClock::Default());
  2355. std::string opts_str = clock->ToString(config_options_);
  2356. std::string mismatch;
  2357. ASSERT_OK(SystemClock::CreateFromString(config_options_, opts_str, &copy));
  2358. ASSERT_TRUE(clock->AreEquivalent(config_options_, copy.get(), &mismatch));
  2359. }
  2360. TEST_F(CreateEnvTest, CreateMockSystemClock) {
  2361. std::shared_ptr<SystemClock> mock, copy;
  2362. config_options_.registry->AddLibrary("test")->AddFactory<SystemClock>(
  2363. MockSystemClock::kClassName(),
  2364. [](const std::string& /*uri*/, std::unique_ptr<SystemClock>* guard,
  2365. std::string* /* errmsg */) {
  2366. guard->reset(new MockSystemClock(nullptr));
  2367. return guard->get();
  2368. });
  2369. ASSERT_OK(SystemClock::CreateFromString(
  2370. config_options_, EmulatedSystemClock::kClassName(), &mock));
  2371. ASSERT_NE(mock, nullptr);
  2372. ASSERT_STREQ(mock->Name(), EmulatedSystemClock::kClassName());
  2373. ASSERT_EQ(mock->Inner(), SystemClock::Default().get());
  2374. std::string opts_str = mock->ToString(config_options_);
  2375. std::string mismatch;
  2376. ASSERT_OK(SystemClock::CreateFromString(config_options_, opts_str, &copy));
  2377. ASSERT_TRUE(mock->AreEquivalent(config_options_, copy.get(), &mismatch));
  2378. std::string id = std::string("id=") + EmulatedSystemClock::kClassName() +
  2379. ";target=" + MockSystemClock::kClassName();
  2380. ASSERT_OK(SystemClock::CreateFromString(config_options_, id, &mock));
  2381. ASSERT_NE(mock, nullptr);
  2382. ASSERT_STREQ(mock->Name(), EmulatedSystemClock::kClassName());
  2383. ASSERT_NE(mock->Inner(), nullptr);
  2384. ASSERT_STREQ(mock->Inner()->Name(), MockSystemClock::kClassName());
  2385. ASSERT_EQ(mock->Inner()->Inner(), SystemClock::Default().get());
  2386. opts_str = mock->ToString(config_options_);
  2387. ASSERT_OK(SystemClock::CreateFromString(config_options_, opts_str, &copy));
  2388. ASSERT_TRUE(mock->AreEquivalent(config_options_, copy.get(), &mismatch));
  2389. ASSERT_OK(SystemClock::CreateFromString(
  2390. config_options_, EmulatedSystemClock::kClassName(), &mock));
  2391. }
  2392. TEST_F(CreateEnvTest, CreateReadOnlyFileSystem) {
  2393. std::shared_ptr<FileSystem> fs, copy;
  2394. ASSERT_OK(FileSystem::CreateFromString(
  2395. config_options_, ReadOnlyFileSystem::kClassName(), &fs));
  2396. ASSERT_NE(fs, nullptr);
  2397. ASSERT_STREQ(fs->Name(), ReadOnlyFileSystem::kClassName());
  2398. ASSERT_EQ(fs->Inner(), FileSystem::Default().get());
  2399. std::string opts_str = fs->ToString(config_options_);
  2400. std::string mismatch;
  2401. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2402. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2403. ASSERT_OK(FileSystem::CreateFromString(
  2404. config_options_,
  2405. std::string("id=") + ReadOnlyFileSystem::kClassName() +
  2406. "; target=" + TimedFileSystem::kClassName(),
  2407. &fs));
  2408. ASSERT_NE(fs, nullptr);
  2409. opts_str = fs->ToString(config_options_);
  2410. ASSERT_STREQ(fs->Name(), ReadOnlyFileSystem::kClassName());
  2411. ASSERT_NE(fs->Inner(), nullptr);
  2412. ASSERT_STREQ(fs->Inner()->Name(), TimedFileSystem::kClassName());
  2413. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2414. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2415. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2416. }
  2417. TEST_F(CreateEnvTest, CreateTimedFileSystem) {
  2418. std::shared_ptr<FileSystem> fs, copy;
  2419. ASSERT_OK(FileSystem::CreateFromString(config_options_,
  2420. TimedFileSystem::kClassName(), &fs));
  2421. ASSERT_NE(fs, nullptr);
  2422. ASSERT_STREQ(fs->Name(), TimedFileSystem::kClassName());
  2423. ASSERT_EQ(fs->Inner(), FileSystem::Default().get());
  2424. std::string opts_str = fs->ToString(config_options_);
  2425. std::string mismatch;
  2426. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2427. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2428. ASSERT_OK(FileSystem::CreateFromString(
  2429. config_options_,
  2430. std::string("id=") + TimedFileSystem::kClassName() +
  2431. "; target=" + ReadOnlyFileSystem::kClassName(),
  2432. &fs));
  2433. ASSERT_NE(fs, nullptr);
  2434. opts_str = fs->ToString(config_options_);
  2435. ASSERT_STREQ(fs->Name(), TimedFileSystem::kClassName());
  2436. ASSERT_NE(fs->Inner(), nullptr);
  2437. ASSERT_STREQ(fs->Inner()->Name(), ReadOnlyFileSystem::kClassName());
  2438. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2439. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2440. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2441. }
  2442. TEST_F(CreateEnvTest, CreateCountedFileSystem) {
  2443. std::shared_ptr<FileSystem> fs, copy;
  2444. ASSERT_OK(FileSystem::CreateFromString(config_options_,
  2445. CountedFileSystem::kClassName(), &fs));
  2446. ASSERT_NE(fs, nullptr);
  2447. ASSERT_STREQ(fs->Name(), CountedFileSystem::kClassName());
  2448. ASSERT_EQ(fs->Inner(), FileSystem::Default().get());
  2449. std::string opts_str = fs->ToString(config_options_);
  2450. std::string mismatch;
  2451. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2452. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2453. ASSERT_OK(FileSystem::CreateFromString(
  2454. config_options_,
  2455. std::string("id=") + CountedFileSystem::kClassName() +
  2456. "; target=" + ReadOnlyFileSystem::kClassName(),
  2457. &fs));
  2458. ASSERT_NE(fs, nullptr);
  2459. opts_str = fs->ToString(config_options_);
  2460. ASSERT_STREQ(fs->Name(), CountedFileSystem::kClassName());
  2461. ASSERT_NE(fs->Inner(), nullptr);
  2462. ASSERT_STREQ(fs->Inner()->Name(), ReadOnlyFileSystem::kClassName());
  2463. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2464. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2465. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2466. }
  2467. #ifndef OS_WIN
  2468. TEST_F(CreateEnvTest, CreateChrootFileSystem) {
  2469. std::shared_ptr<FileSystem> fs, copy;
  2470. auto tmp_dir = test::TmpDir(Env::Default());
  2471. // The Chroot FileSystem has a required "chroot_dir" option.
  2472. ASSERT_NOK(FileSystem::CreateFromString(config_options_,
  2473. ChrootFileSystem::kClassName(), &fs));
  2474. // ChrootFileSystem fails with an invalid directory
  2475. ASSERT_NOK(FileSystem::CreateFromString(
  2476. config_options_,
  2477. std::string("chroot_dir=/No/Such/Directory; id=") +
  2478. ChrootFileSystem::kClassName(),
  2479. &fs));
  2480. std::string chroot_opts = std::string("chroot_dir=") + tmp_dir +
  2481. std::string("; id=") +
  2482. ChrootFileSystem::kClassName();
  2483. // Create a valid ChrootFileSystem with an inner Default
  2484. ASSERT_OK(FileSystem::CreateFromString(config_options_, chroot_opts, &fs));
  2485. ASSERT_NE(fs, nullptr);
  2486. ASSERT_STREQ(fs->Name(), ChrootFileSystem::kClassName());
  2487. ASSERT_EQ(fs->Inner(), FileSystem::Default().get());
  2488. std::string opts_str = fs->ToString(config_options_);
  2489. std::string mismatch;
  2490. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2491. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2492. // Create a valid ChrootFileSystem with an inner TimedFileSystem
  2493. ASSERT_OK(FileSystem::CreateFromString(
  2494. config_options_,
  2495. chroot_opts + "; target=" + TimedFileSystem::kClassName(), &fs));
  2496. ASSERT_NE(fs, nullptr);
  2497. ASSERT_STREQ(fs->Name(), ChrootFileSystem::kClassName());
  2498. ASSERT_NE(fs->Inner(), nullptr);
  2499. ASSERT_STREQ(fs->Inner()->Name(), TimedFileSystem::kClassName());
  2500. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2501. opts_str = fs->ToString(config_options_);
  2502. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2503. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2504. // Create a TimedFileSystem with an inner ChrootFileSystem
  2505. ASSERT_OK(FileSystem::CreateFromString(
  2506. config_options_,
  2507. "target={" + chroot_opts + "}; id=" + TimedFileSystem::kClassName(),
  2508. &fs));
  2509. ASSERT_NE(fs, nullptr);
  2510. ASSERT_STREQ(fs->Name(), TimedFileSystem::kClassName());
  2511. ASSERT_NE(fs->Inner(), nullptr);
  2512. ASSERT_STREQ(fs->Inner()->Name(), ChrootFileSystem::kClassName());
  2513. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2514. opts_str = fs->ToString(config_options_);
  2515. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2516. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2517. }
  2518. #endif // OS_WIN
  2519. TEST_F(CreateEnvTest, CreateEncryptedFileSystem) {
  2520. std::shared_ptr<FileSystem> fs, copy;
  2521. std::string base_opts =
  2522. std::string("provider=1://test; id=") + EncryptedFileSystem::kClassName();
  2523. // Rewrite the default FileSystem URI if the "TEST_FS_URI" environment
  2524. // variable is set. This is useful to test customer encryption plugins.
  2525. const char* uri = getenv("TEST_FS_URI");
  2526. if (uri != nullptr) {
  2527. base_opts = uri;
  2528. }
  2529. // The EncryptedFileSystem requires a "provider" option.
  2530. ASSERT_NOK(FileSystem::CreateFromString(
  2531. config_options_, EncryptedFileSystem::kClassName(), &fs));
  2532. ASSERT_OK(FileSystem::CreateFromString(config_options_, base_opts, &fs));
  2533. ASSERT_NE(fs, nullptr);
  2534. ASSERT_STREQ(fs->Name(), EncryptedFileSystem::kClassName());
  2535. ASSERT_EQ(fs->Inner(), FileSystem::Default().get());
  2536. std::string opts_str = fs->ToString(config_options_);
  2537. std::string mismatch;
  2538. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2539. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2540. ASSERT_OK(FileSystem::CreateFromString(
  2541. config_options_, base_opts + "; target=" + TimedFileSystem::kClassName(),
  2542. &fs));
  2543. ASSERT_NE(fs, nullptr);
  2544. ASSERT_STREQ(fs->Name(), EncryptedFileSystem::kClassName());
  2545. ASSERT_NE(fs->Inner(), nullptr);
  2546. ASSERT_STREQ(fs->Inner()->Name(), TimedFileSystem::kClassName());
  2547. ASSERT_EQ(fs->Inner()->Inner(), FileSystem::Default().get());
  2548. opts_str = fs->ToString(config_options_);
  2549. ASSERT_OK(FileSystem::CreateFromString(config_options_, opts_str, &copy));
  2550. ASSERT_TRUE(fs->AreEquivalent(config_options_, copy.get(), &mismatch));
  2551. }
  2552. namespace {
  2553. constexpr size_t kThreads = 8;
  2554. constexpr size_t kIdsPerThread = 1000;
  2555. // This is a mini-stress test to check for duplicates in functions like
  2556. // GenerateUniqueId()
  2557. template <typename IdType, class Hash = std::hash<IdType>>
  2558. struct NoDuplicateMiniStressTest {
  2559. std::unordered_set<IdType, Hash> ids;
  2560. std::mutex mutex;
  2561. Env* env;
  2562. NoDuplicateMiniStressTest() { env = Env::Default(); }
  2563. virtual ~NoDuplicateMiniStressTest() = default;
  2564. void Run() {
  2565. std::array<std::thread, kThreads> threads;
  2566. for (size_t i = 0; i < kThreads; ++i) {
  2567. threads[i] = std::thread([&]() { ThreadFn(); });
  2568. }
  2569. for (auto& thread : threads) {
  2570. thread.join();
  2571. }
  2572. // All must be unique
  2573. ASSERT_EQ(ids.size(), kThreads * kIdsPerThread);
  2574. }
  2575. void ThreadFn() {
  2576. std::array<IdType, kIdsPerThread> my_ids;
  2577. // Generate in parallel threads as fast as possible
  2578. for (size_t i = 0; i < kIdsPerThread; ++i) {
  2579. my_ids[i] = Generate();
  2580. }
  2581. // Now collate
  2582. std::lock_guard<std::mutex> lock(mutex);
  2583. for (auto& id : my_ids) {
  2584. ids.insert(id);
  2585. }
  2586. }
  2587. virtual IdType Generate() = 0;
  2588. };
  2589. void VerifyRfcUuids(const std::unordered_set<std::string>& uuids) {
  2590. if (uuids.empty()) {
  2591. return;
  2592. }
  2593. }
  2594. using uint64_pair_t = std::pair<uint64_t, uint64_t>;
  2595. struct HashUint64Pair {
  2596. std::size_t operator()(
  2597. std::pair<uint64_t, uint64_t> const& u) const noexcept {
  2598. // Assume suitable distribution already
  2599. return static_cast<size_t>(u.first ^ u.second);
  2600. }
  2601. };
  2602. } // namespace
  2603. TEST_F(EnvTest, GenerateUniqueId) {
  2604. struct MyStressTest : public NoDuplicateMiniStressTest<std::string> {
  2605. std::string Generate() override { return env->GenerateUniqueId(); }
  2606. };
  2607. MyStressTest t;
  2608. t.Run();
  2609. // Basically verify RFC-4122 format
  2610. for (auto& uuid : t.ids) {
  2611. ASSERT_EQ(36U, uuid.size());
  2612. ASSERT_EQ('-', uuid[8]);
  2613. ASSERT_EQ('-', uuid[13]);
  2614. ASSERT_EQ('-', uuid[18]);
  2615. ASSERT_EQ('-', uuid[23]);
  2616. }
  2617. }
  2618. TEST_F(EnvTest, GenerateDbSessionId) {
  2619. struct MyStressTest : public NoDuplicateMiniStressTest<std::string> {
  2620. std::string Generate() override { return DBImpl::GenerateDbSessionId(env); }
  2621. };
  2622. MyStressTest t;
  2623. t.Run();
  2624. // Basically verify session ID
  2625. for (auto& id : t.ids) {
  2626. ASSERT_EQ(20U, id.size());
  2627. }
  2628. }
  2629. constexpr bool kRequirePortGenerateRfcUuid =
  2630. #if defined(OS_LINUX) || defined(OS_ANDROID) || defined(OS_WIN)
  2631. true;
  2632. #else
  2633. false;
  2634. #endif
  2635. TEST_F(EnvTest, PortGenerateRfcUuid) {
  2636. if (!kRequirePortGenerateRfcUuid) {
  2637. ROCKSDB_GTEST_SKIP("Not supported/expected on this platform");
  2638. return;
  2639. }
  2640. struct MyStressTest : public NoDuplicateMiniStressTest<std::string> {
  2641. std::string Generate() override {
  2642. std::string u;
  2643. assert(port::GenerateRfcUuid(&u));
  2644. return u;
  2645. }
  2646. };
  2647. MyStressTest t;
  2648. t.Run();
  2649. // Extra verification on versions and variants
  2650. VerifyRfcUuids(t.ids);
  2651. }
  2652. // Test the atomic, linear generation of GenerateRawUniqueId
  2653. TEST_F(EnvTest, GenerateRawUniqueId) {
  2654. struct MyStressTest
  2655. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2656. uint64_pair_t Generate() override {
  2657. uint64_pair_t p;
  2658. GenerateRawUniqueId(&p.first, &p.second);
  2659. return p;
  2660. }
  2661. };
  2662. MyStressTest t;
  2663. t.Run();
  2664. }
  2665. // Test that each entropy source ("track") is at least adequate
  2666. TEST_F(EnvTest, GenerateRawUniqueIdTrackPortUuidOnly) {
  2667. if (!kRequirePortGenerateRfcUuid) {
  2668. ROCKSDB_GTEST_SKIP("Not supported/expected on this platform");
  2669. return;
  2670. }
  2671. struct MyStressTest
  2672. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2673. uint64_pair_t Generate() override {
  2674. uint64_pair_t p;
  2675. TEST_GenerateRawUniqueId(&p.first, &p.second, false, true, true);
  2676. return p;
  2677. }
  2678. };
  2679. MyStressTest t;
  2680. t.Run();
  2681. }
  2682. TEST_F(EnvTest, GenerateRawUniqueIdTrackEnvDetailsOnly) {
  2683. struct MyStressTest
  2684. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2685. uint64_pair_t Generate() override {
  2686. uint64_pair_t p;
  2687. TEST_GenerateRawUniqueId(&p.first, &p.second, true, false, true);
  2688. return p;
  2689. }
  2690. };
  2691. MyStressTest t;
  2692. t.Run();
  2693. }
  2694. TEST_F(EnvTest, GenerateRawUniqueIdTrackRandomDeviceOnly) {
  2695. struct MyStressTest
  2696. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2697. uint64_pair_t Generate() override {
  2698. uint64_pair_t p;
  2699. TEST_GenerateRawUniqueId(&p.first, &p.second, true, true, false);
  2700. return p;
  2701. }
  2702. };
  2703. MyStressTest t;
  2704. t.Run();
  2705. }
  2706. TEST_F(EnvTest, SemiStructuredUniqueIdGenTest) {
  2707. // Must be thread safe and usable as a static
  2708. static SemiStructuredUniqueIdGen gen;
  2709. struct MyStressTest
  2710. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2711. uint64_pair_t Generate() override {
  2712. uint64_pair_t p;
  2713. gen.GenerateNext(&p.first, &p.second);
  2714. return p;
  2715. }
  2716. };
  2717. MyStressTest t;
  2718. t.Run();
  2719. }
  2720. TEST_F(EnvTest, SemiStructuredUniqueIdGenTestSmaller) {
  2721. // For small generated types, will cycle through all the possible values.
  2722. SemiStructuredUniqueIdGen gen;
  2723. std::vector<bool> hit(256);
  2724. for (int i = 0; i < 256; ++i) {
  2725. auto val = gen.GenerateNext<uint8_t>();
  2726. ASSERT_FALSE(hit[val]);
  2727. hit[val] = true;
  2728. }
  2729. for (int i = 0; i < 256; ++i) {
  2730. ASSERT_TRUE(hit[i]);
  2731. }
  2732. }
  2733. TEST_F(EnvTest, UnpredictableUniqueIdGenTest1) {
  2734. // Must be thread safe and usable as a static.
  2735. static UnpredictableUniqueIdGen gen;
  2736. struct MyStressTest
  2737. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2738. uint64_pair_t Generate() override {
  2739. uint64_pair_t p;
  2740. gen.GenerateNext(&p.first, &p.second);
  2741. return p;
  2742. }
  2743. };
  2744. MyStressTest t;
  2745. t.Run();
  2746. }
  2747. TEST_F(EnvTest, UnpredictableUniqueIdGenTest2) {
  2748. // Even if we completely strip the seeding and entropy of the structure
  2749. // down to a bare minimum, we still get quality pseudorandom results.
  2750. static UnpredictableUniqueIdGen gen{
  2751. UnpredictableUniqueIdGen::TEST_ZeroInitialized{}};
  2752. struct MyStressTest
  2753. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2754. uint64_pair_t Generate() override {
  2755. uint64_pair_t p;
  2756. // No extra entropy is required to get quality pseudorandom results
  2757. gen.GenerateNextWithEntropy(&p.first, &p.second, /*no extra entropy*/ 0);
  2758. return p;
  2759. }
  2760. };
  2761. MyStressTest t;
  2762. t.Run();
  2763. }
  2764. TEST_F(EnvTest, UnpredictableUniqueIdGenTest3) {
  2765. struct MyStressTest
  2766. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2767. uint64_pair_t Generate() override {
  2768. uint64_pair_t p;
  2769. thread_local UnpredictableUniqueIdGen gen{
  2770. UnpredictableUniqueIdGen::TEST_ZeroInitialized{}};
  2771. // Even without the counter (reset it to thread id), we get quality
  2772. // single-threaded results (because part of each result is fed back
  2773. // into pool).
  2774. gen.TEST_counter().store(Env::Default()->GetThreadID());
  2775. gen.GenerateNext(&p.first, &p.second);
  2776. return p;
  2777. }
  2778. };
  2779. MyStressTest t;
  2780. t.Run();
  2781. }
  2782. TEST_F(EnvTest, UnpredictableUniqueIdGenTest4) {
  2783. struct MyStressTest
  2784. : public NoDuplicateMiniStressTest<uint64_pair_t, HashUint64Pair> {
  2785. uint64_pair_t Generate() override {
  2786. uint64_pair_t p;
  2787. // Even if we reset the state to thread ID each time, RDTSC instruction
  2788. // suffices for quality single-threaded results.
  2789. UnpredictableUniqueIdGen gen{
  2790. UnpredictableUniqueIdGen::TEST_ZeroInitialized{}};
  2791. gen.TEST_counter().store(Env::Default()->GetThreadID());
  2792. gen.GenerateNext(&p.first, &p.second);
  2793. return p;
  2794. }
  2795. };
  2796. MyStressTest t;
  2797. #ifdef __SSE4_2__ // Our rough check for RDTSC
  2798. t.Run();
  2799. #else
  2800. ROCKSDB_GTEST_BYPASS("Requires IA32 with RDTSC");
  2801. // because nanosecond time might not be high enough fidelity to have
  2802. // incremented after a few hundred instructions, especially in cases where
  2803. // we really only have microsecond fidelity. Also, wall clock might not be
  2804. // monotonic.
  2805. #endif
  2806. }
  2807. TEST_F(EnvTest, FailureToCreateLockFile) {
  2808. auto env = Env::Default();
  2809. auto fs = env->GetFileSystem();
  2810. std::string dir = test::PerThreadDBPath(env, "lockdir");
  2811. std::string file = dir + "/lockfile";
  2812. // Ensure directory doesn't exist
  2813. ASSERT_OK(DestroyDir(env, dir));
  2814. // Make sure that we can acquire a file lock after the first attempt fails
  2815. FileLock* lock = nullptr;
  2816. ASSERT_NOK(fs->LockFile(file, IOOptions(), &lock, /*dbg*/ nullptr));
  2817. ASSERT_FALSE(lock);
  2818. ASSERT_OK(fs->CreateDir(dir, IOOptions(), /*dbg*/ nullptr));
  2819. ASSERT_OK(fs->LockFile(file, IOOptions(), &lock, /*dbg*/ nullptr));
  2820. ASSERT_OK(fs->UnlockFile(lock, IOOptions(), /*dbg*/ nullptr));
  2821. // Clean up
  2822. ASSERT_OK(DestroyDir(env, dir));
  2823. }
  2824. TEST_F(CreateEnvTest, CreateDefaultEnv) {
  2825. ConfigOptions options;
  2826. options.ignore_unsupported_options = false;
  2827. std::shared_ptr<Env> guard;
  2828. Env* env = nullptr;
  2829. ASSERT_OK(Env::CreateFromString(options, "", &env));
  2830. ASSERT_EQ(env, Env::Default());
  2831. env = nullptr;
  2832. ASSERT_OK(Env::CreateFromString(options, Env::kDefaultName(), &env));
  2833. ASSERT_EQ(env, Env::Default());
  2834. env = nullptr;
  2835. ASSERT_OK(Env::CreateFromString(options, "", &env, &guard));
  2836. ASSERT_EQ(env, Env::Default());
  2837. ASSERT_EQ(guard, nullptr);
  2838. env = nullptr;
  2839. ASSERT_OK(Env::CreateFromString(options, Env::kDefaultName(), &env, &guard));
  2840. ASSERT_EQ(env, Env::Default());
  2841. ASSERT_EQ(guard, nullptr);
  2842. std::string opt_str = env->ToString(options);
  2843. ASSERT_OK(Env::CreateFromString(options, opt_str, &env));
  2844. ASSERT_EQ(env, Env::Default());
  2845. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &guard));
  2846. ASSERT_EQ(env, Env::Default());
  2847. ASSERT_EQ(guard, nullptr);
  2848. }
  2849. namespace {
  2850. class WrappedEnv : public EnvWrapper {
  2851. public:
  2852. explicit WrappedEnv(Env* t) : EnvWrapper(t) {}
  2853. explicit WrappedEnv(const std::shared_ptr<Env>& t) : EnvWrapper(t) {}
  2854. static const char* kClassName() { return "WrappedEnv"; }
  2855. const char* Name() const override { return kClassName(); }
  2856. static void Register(ObjectLibrary& lib, const std::string& /*arg*/) {
  2857. lib.AddFactory<Env>(
  2858. WrappedEnv::kClassName(),
  2859. [](const std::string& /*uri*/, std::unique_ptr<Env>* guard,
  2860. std::string* /* errmsg */) {
  2861. guard->reset(new WrappedEnv(nullptr));
  2862. return guard->get();
  2863. });
  2864. }
  2865. };
  2866. } // namespace
  2867. TEST_F(CreateEnvTest, CreateMockEnv) {
  2868. ConfigOptions options;
  2869. options.ignore_unsupported_options = false;
  2870. WrappedEnv::Register(*(options.registry->AddLibrary("test")), "");
  2871. std::shared_ptr<Env> guard, copy;
  2872. std::string opt_str;
  2873. Env* env = nullptr;
  2874. ASSERT_NOK(Env::CreateFromString(options, MockEnv::kClassName(), &env));
  2875. ASSERT_OK(
  2876. Env::CreateFromString(options, MockEnv::kClassName(), &env, &guard));
  2877. ASSERT_NE(env, nullptr);
  2878. ASSERT_NE(env, Env::Default());
  2879. opt_str = env->ToString(options);
  2880. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2881. ASSERT_NE(copy, guard);
  2882. std::string mismatch;
  2883. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2884. guard.reset(MockEnv::Create(Env::Default(), SystemClock::Default()));
  2885. opt_str = guard->ToString(options);
  2886. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2887. std::unique_ptr<Env> wrapped_env(new WrappedEnv(Env::Default()));
  2888. guard.reset(MockEnv::Create(wrapped_env.get(), SystemClock::Default()));
  2889. opt_str = guard->ToString(options);
  2890. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2891. opt_str = copy->ToString(options);
  2892. }
  2893. TEST_F(CreateEnvTest, CreateWrappedEnv) {
  2894. ConfigOptions options;
  2895. options.ignore_unsupported_options = false;
  2896. WrappedEnv::Register(*(options.registry->AddLibrary("test")), "");
  2897. Env* env = nullptr;
  2898. std::shared_ptr<Env> guard, copy;
  2899. std::string opt_str;
  2900. std::string mismatch;
  2901. ASSERT_NOK(Env::CreateFromString(options, WrappedEnv::kClassName(), &env));
  2902. ASSERT_OK(
  2903. Env::CreateFromString(options, WrappedEnv::kClassName(), &env, &guard));
  2904. ASSERT_NE(env, nullptr);
  2905. ASSERT_NE(env, Env::Default());
  2906. ASSERT_FALSE(guard->AreEquivalent(options, Env::Default(), &mismatch));
  2907. opt_str = env->ToString(options);
  2908. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2909. ASSERT_NE(copy, guard);
  2910. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2911. guard.reset(new WrappedEnv(std::make_shared<WrappedEnv>(Env::Default())));
  2912. ASSERT_NE(guard.get(), env);
  2913. opt_str = guard->ToString(options);
  2914. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2915. ASSERT_NE(copy, guard);
  2916. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2917. guard.reset(new WrappedEnv(std::make_shared<WrappedEnv>(
  2918. std::make_shared<WrappedEnv>(Env::Default()))));
  2919. ASSERT_NE(guard.get(), env);
  2920. opt_str = guard->ToString(options);
  2921. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2922. ASSERT_NE(copy, guard);
  2923. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2924. }
  2925. TEST_F(CreateEnvTest, CreateCompositeEnv) {
  2926. ConfigOptions options;
  2927. options.ignore_unsupported_options = false;
  2928. std::shared_ptr<Env> guard, copy;
  2929. Env* env = nullptr;
  2930. std::string mismatch, opt_str;
  2931. WrappedEnv::Register(*(options.registry->AddLibrary("test")), "");
  2932. std::unique_ptr<Env> base(NewCompositeEnv(FileSystem::Default()));
  2933. std::unique_ptr<Env> wrapped(new WrappedEnv(Env::Default()));
  2934. std::shared_ptr<FileSystem> timed_fs =
  2935. std::make_shared<TimedFileSystem>(FileSystem::Default());
  2936. std::shared_ptr<SystemClock> clock =
  2937. std::make_shared<EmulatedSystemClock>(SystemClock::Default());
  2938. opt_str = base->ToString(options);
  2939. ASSERT_NOK(Env::CreateFromString(options, opt_str, &env));
  2940. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &guard));
  2941. ASSERT_NE(env, nullptr);
  2942. ASSERT_NE(env, Env::Default());
  2943. ASSERT_EQ(env->GetFileSystem(), FileSystem::Default());
  2944. ASSERT_EQ(env->GetSystemClock(), SystemClock::Default());
  2945. base = NewCompositeEnv(timed_fs);
  2946. opt_str = base->ToString(options);
  2947. ASSERT_NOK(Env::CreateFromString(options, opt_str, &env));
  2948. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &guard));
  2949. ASSERT_NE(env, nullptr);
  2950. ASSERT_NE(env, Env::Default());
  2951. ASSERT_NE(env->GetFileSystem(), FileSystem::Default());
  2952. ASSERT_EQ(env->GetSystemClock(), SystemClock::Default());
  2953. env = nullptr;
  2954. guard.reset(new CompositeEnvWrapper(wrapped.get(), timed_fs));
  2955. opt_str = guard->ToString(options);
  2956. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2957. ASSERT_NE(env, nullptr);
  2958. ASSERT_NE(env, Env::Default());
  2959. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2960. env = nullptr;
  2961. guard.reset(new CompositeEnvWrapper(wrapped.get(), clock));
  2962. opt_str = guard->ToString(options);
  2963. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2964. ASSERT_NE(env, nullptr);
  2965. ASSERT_NE(env, Env::Default());
  2966. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2967. env = nullptr;
  2968. guard.reset(new CompositeEnvWrapper(wrapped.get(), timed_fs, clock));
  2969. opt_str = guard->ToString(options);
  2970. ASSERT_OK(Env::CreateFromString(options, opt_str, &env, &copy));
  2971. ASSERT_NE(env, nullptr);
  2972. ASSERT_NE(env, Env::Default());
  2973. ASSERT_TRUE(guard->AreEquivalent(options, copy.get(), &mismatch));
  2974. guard.reset(new CompositeEnvWrapper(nullptr, timed_fs, clock));
  2975. ColumnFamilyOptions cf_opts;
  2976. DBOptions db_opts;
  2977. db_opts.env = guard.get();
  2978. auto comp = db_opts.env->CheckedCast<CompositeEnvWrapper>();
  2979. ASSERT_NE(comp, nullptr);
  2980. ASSERT_EQ(comp->Inner(), nullptr);
  2981. ASSERT_NOK(ValidateOptions(db_opts, cf_opts));
  2982. ASSERT_OK(db_opts.env->PrepareOptions(options));
  2983. ASSERT_NE(comp->Inner(), nullptr);
  2984. ASSERT_OK(ValidateOptions(db_opts, cf_opts));
  2985. }
  2986. // Forward declaration
  2987. class ReadAsyncFS;
  2988. struct MockIOHandle {
  2989. std::function<void(FSReadRequest&, void*)> cb;
  2990. void* cb_arg;
  2991. bool create_io_error;
  2992. };
  2993. // ReadAsyncFS and ReadAsyncRandomAccessFile mocks the FS doing asynchronous
  2994. // reads by creating threads that submit read requests and then calling Poll API
  2995. // to obtain those results.
  2996. class ReadAsyncRandomAccessFile : public FSRandomAccessFileOwnerWrapper {
  2997. public:
  2998. ReadAsyncRandomAccessFile(ReadAsyncFS& fs,
  2999. std::unique_ptr<FSRandomAccessFile>& file)
  3000. : FSRandomAccessFileOwnerWrapper(std::move(file)), fs_(fs) {}
  3001. IOStatus ReadAsync(FSReadRequest& req, const IOOptions& opts,
  3002. std::function<void(FSReadRequest&, void*)> cb,
  3003. void* cb_arg, void** io_handle, IOHandleDeleter* del_fn,
  3004. IODebugContext* dbg) override;
  3005. private:
  3006. ReadAsyncFS& fs_;
  3007. int counter = 0;
  3008. };
  3009. class ReadAsyncFS : public FileSystemWrapper {
  3010. public:
  3011. explicit ReadAsyncFS(const std::shared_ptr<FileSystem>& wrapped)
  3012. : FileSystemWrapper(wrapped) {}
  3013. static const char* kClassName() { return "ReadAsyncFS"; }
  3014. const char* Name() const override { return kClassName(); }
  3015. IOStatus NewRandomAccessFile(const std::string& fname,
  3016. const FileOptions& opts,
  3017. std::unique_ptr<FSRandomAccessFile>* result,
  3018. IODebugContext* dbg) override {
  3019. std::unique_ptr<FSRandomAccessFile> file;
  3020. IOStatus s = target()->NewRandomAccessFile(fname, opts, &file, dbg);
  3021. EXPECT_OK(s);
  3022. result->reset(new ReadAsyncRandomAccessFile(*this, file));
  3023. return s;
  3024. }
  3025. IOStatus Poll(std::vector<void*>& io_handles,
  3026. size_t /*min_completions*/) override {
  3027. // Wait for the threads completion.
  3028. for (auto& t : workers) {
  3029. t.join();
  3030. }
  3031. for (size_t i = 0; i < io_handles.size(); i++) {
  3032. MockIOHandle* handle = static_cast<MockIOHandle*>(io_handles[i]);
  3033. if (handle->create_io_error) {
  3034. FSReadRequest req;
  3035. req.status = IOStatus::IOError();
  3036. handle->cb(req, handle->cb_arg);
  3037. }
  3038. }
  3039. return IOStatus::OK();
  3040. }
  3041. std::vector<std::thread> workers;
  3042. };
  3043. IOStatus ReadAsyncRandomAccessFile::ReadAsync(
  3044. FSReadRequest& req, const IOOptions& opts,
  3045. std::function<void(FSReadRequest&, void*)> cb, void* cb_arg,
  3046. void** io_handle, IOHandleDeleter* del_fn, IODebugContext* dbg) {
  3047. IOHandleDeleter deletefn = [](void* args) -> void {
  3048. delete (static_cast<MockIOHandle*>(args));
  3049. args = nullptr;
  3050. };
  3051. *del_fn = deletefn;
  3052. // Allocate and populate io_handle.
  3053. MockIOHandle* mock_handle = new MockIOHandle();
  3054. bool create_io_error = false;
  3055. if (counter % 2) {
  3056. create_io_error = true;
  3057. }
  3058. mock_handle->create_io_error = create_io_error;
  3059. mock_handle->cb = cb;
  3060. mock_handle->cb_arg = cb_arg;
  3061. *io_handle = static_cast<void*>(mock_handle);
  3062. counter++;
  3063. // Submit read request asynchronously.
  3064. std::function<void(FSReadRequest)> submit_request =
  3065. [&opts, cb, cb_arg, dbg, create_io_error, this](FSReadRequest _req) {
  3066. if (!create_io_error) {
  3067. _req.status = target()->Read(_req.offset, _req.len, opts,
  3068. &(_req.result), _req.scratch, dbg);
  3069. cb(_req, cb_arg);
  3070. }
  3071. };
  3072. fs_.workers.emplace_back(submit_request, std::move(req));
  3073. return IOStatus::OK();
  3074. }
  3075. class TestAsyncRead : public testing::Test {
  3076. public:
  3077. TestAsyncRead() { env_ = Env::Default(); }
  3078. Env* env_;
  3079. };
  3080. // Tests the default implementation of ReadAsync API.
  3081. TEST_F(TestAsyncRead, ReadAsync) {
  3082. EnvOptions soptions;
  3083. std::shared_ptr<ReadAsyncFS> fs =
  3084. std::make_shared<ReadAsyncFS>(env_->GetFileSystem());
  3085. std::string fname = test::PerThreadDBPath(env_, "testfile");
  3086. const size_t kSectorSize = 4096;
  3087. const size_t kNumSectors = 8;
  3088. // 1. create & write to a file.
  3089. {
  3090. std::unique_ptr<FSWritableFile> wfile;
  3091. ASSERT_OK(
  3092. fs->NewWritableFile(fname, FileOptions(), &wfile, nullptr /*dbg*/));
  3093. for (size_t i = 0; i < kNumSectors; ++i) {
  3094. auto data = NewAligned(kSectorSize * 8, static_cast<char>(i + 1));
  3095. Slice slice(data.get(), kSectorSize);
  3096. ASSERT_OK(wfile->Append(slice, IOOptions(), nullptr));
  3097. }
  3098. ASSERT_OK(wfile->Close(IOOptions(), nullptr));
  3099. }
  3100. // 2. Read file
  3101. {
  3102. std::unique_ptr<FSRandomAccessFile> file;
  3103. ASSERT_OK(fs->NewRandomAccessFile(fname, FileOptions(), &file, nullptr));
  3104. IOOptions opts;
  3105. std::vector<void*> io_handles(kNumSectors);
  3106. std::vector<FSReadRequest> reqs(kNumSectors);
  3107. std::vector<std::unique_ptr<char, Deleter>> data;
  3108. std::vector<size_t> vals;
  3109. IOHandleDeleter del_fn;
  3110. uint64_t offset = 0;
  3111. // Initialize read requests
  3112. for (size_t i = 0; i < kNumSectors; i++) {
  3113. reqs[i].offset = offset;
  3114. reqs[i].len = kSectorSize;
  3115. data.emplace_back(NewAligned(kSectorSize, 0));
  3116. reqs[i].scratch = data.back().get();
  3117. vals.push_back(i);
  3118. offset += kSectorSize;
  3119. }
  3120. // callback function passed to async read.
  3121. std::function<void(FSReadRequest&, void*)> callback =
  3122. [&](FSReadRequest& req, void* cb_arg) {
  3123. assert(cb_arg != nullptr);
  3124. size_t i = *(reinterpret_cast<size_t*>(cb_arg));
  3125. reqs[i].offset = req.offset;
  3126. reqs[i].result = req.result;
  3127. reqs[i].status = req.status;
  3128. };
  3129. // Submit asynchronous read requests.
  3130. for (size_t i = 0; i < kNumSectors; i++) {
  3131. void* cb_arg = static_cast<void*>(&(vals[i]));
  3132. ASSERT_OK(file->ReadAsync(reqs[i], opts, callback, cb_arg,
  3133. &(io_handles[i]), &del_fn, nullptr));
  3134. }
  3135. // Poll for the submitted requests.
  3136. fs->Poll(io_handles, kNumSectors);
  3137. // Check the status of read requests.
  3138. for (size_t i = 0; i < kNumSectors; i++) {
  3139. if (i % 2) {
  3140. ASSERT_EQ(reqs[i].status, IOStatus::IOError());
  3141. } else {
  3142. auto buf = NewAligned(kSectorSize * 8, static_cast<char>(i + 1));
  3143. Slice expected_data(buf.get(), kSectorSize);
  3144. ASSERT_EQ(reqs[i].offset, i * kSectorSize);
  3145. ASSERT_OK(reqs[i].status);
  3146. ASSERT_EQ(expected_data.ToString(), reqs[i].result.ToString());
  3147. }
  3148. }
  3149. // Delete io_handles.
  3150. for (size_t i = 0; i < io_handles.size(); i++) {
  3151. del_fn(io_handles[i]);
  3152. }
  3153. }
  3154. }
  3155. struct StaticDestructionTester {
  3156. bool activated = false;
  3157. ~StaticDestructionTester() {
  3158. if (activated && !kMustFreeHeapAllocations) {
  3159. // Make sure we can still call some things on default Env.
  3160. std::string hostname;
  3161. Env::Default()->GetHostNameString(&hostname);
  3162. }
  3163. }
  3164. } static_destruction_tester;
  3165. TEST(EnvTestMisc, StaticDestruction) {
  3166. // Check for any crashes during static destruction.
  3167. static_destruction_tester.activated = true;
  3168. }
  3169. // Test GetFileSize API
  3170. class TestGetFileSize : public testing::Test {
  3171. public:
  3172. TestGetFileSize() { env_ = Env::Default(); }
  3173. Env* env_;
  3174. };
  3175. // Validate GetFileSize API returns the right value.
  3176. // Use the default implementation from env
  3177. TEST_F(TestGetFileSize, GetFileSize) {
  3178. EnvOptions soptions;
  3179. auto fs = env_->GetFileSystem();
  3180. std::string fname = test::PerThreadDBPath(env_, "getFileSizeTestfile");
  3181. // randomize file size
  3182. auto rnd = Random::GetTLSInstance();
  3183. auto expectedFileSize = rnd->Uniform(256 * 1024) + 1;
  3184. auto content = rnd->RandomBinaryString(static_cast<int>(expectedFileSize));
  3185. ASSERT_OK(CreateFile(fs.get(), fname, content, false));
  3186. std::unique_ptr<FSRandomAccessFile> file;
  3187. ASSERT_OK(fs->NewRandomAccessFile(fname, FileOptions(), &file, nullptr));
  3188. uint64_t fileSizeFromFileSystemAPI;
  3189. ASSERT_OK(
  3190. fs->GetFileSize(fname, IOOptions(), &fileSizeFromFileSystemAPI, nullptr));
  3191. ASSERT_EQ(fileSizeFromFileSystemAPI, expectedFileSize);
  3192. uint64_t fileSizeFromFsRandomAccessFileAPI;
  3193. ASSERT_OK(file->GetFileSize(&fileSizeFromFsRandomAccessFileAPI));
  3194. ASSERT_EQ(fileSizeFromFsRandomAccessFileAPI, expectedFileSize);
  3195. }
  3196. class TestIOActivity : public testing::Test {
  3197. public:
  3198. TestIOActivity() {}
  3199. };
  3200. TEST_F(TestIOActivity, IOActivityToString) {
  3201. ASSERT_EQ(Env::IOActivityToString(Env::IOActivity::kMultiGet), "MultiGet");
  3202. ASSERT_EQ(Env::IOActivityToString(Env::IOActivity::kCustomIOActivity80),
  3203. "CustomIOActivity80");
  3204. ASSERT_EQ(Env::IOActivityToString(Env::IOActivity::kCustomIOActivityA9),
  3205. "CustomIOActivityA9");
  3206. ASSERT_EQ(Env::IOActivityToString(Env::IOActivity::kCustomIOActivityFE),
  3207. "CustomIOActivityFE");
  3208. ASSERT_EQ(Env::IOActivityToString(Env::IOActivity::kUnknown), "Unknown");
  3209. }
  3210. } // namespace ROCKSDB_NAMESPACE
  3211. int main(int argc, char** argv) {
  3212. ROCKSDB_NAMESPACE::port::InstallStackTraceHandler();
  3213. ::testing::InitGoogleTest(&argc, argv);
  3214. return RUN_ALL_TESTS();
  3215. }