ending_retirement_test.cpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. #include <array>
  2. #include <cassert>
  3. #include "../Sunrise/src/client/hooks/ember_movies/readiness_rules.h"
  4. #include "../Sunrise/src/client/hooks/ember_movies/sunburn_rules.h"
  5. #include "../Sunrise/src/client/hooks/ember_movies/playback_rules.h"
  6. #include "../Sunrise/src/client/hooks/ember_movies/surface_rules.h"
  7. #include "../Sunrise/src/client/hooks/ember_movies/orbit_rules.h"
  8. #include "../Sunrise/src/client/hooks/mission_retirement/mission_retirement.h"
  9. #include "../Sunrise/src/middleware/bap/activity_message/roster_presence.h"
  10. #include "../Sunrise/src/middleware/encoding/bit_reader.h"
  11. #include "../Sunrise/src/state/activity/membership/teleport_rules.h"
  12. #include "../Sunrise/src/core/logging/log.h"
  13. namespace sunrise::core::log {
  14. bool accepts(Channel, Level) noexcept { return false; }
  15. void write(Channel, Level, std::string_view) noexcept {}
  16. }
  17. namespace wire = sunrise::middleware::bap::activity_message::sensor_auth_update;
  18. namespace retire = sunrise::client::hooks::mission_retirement;
  19. namespace member = sunrise::state::activity::membership;
  20. using sunrise::middleware::encoding::bits::Reader;
  21. static void expect(Reader& reader, unsigned width, std::uint64_t expected) {
  22. std::uint64_t value{};
  23. assert(reader.read(static_cast<std::uint8_t>(width), value) && value == expected);
  24. }
  25. int main() {
  26. namespace movies=sunrise::client::hooks::ember_movies;
  27. movies::OrbitReturn orbit;
  28. movies::OrbitObservation inApex{true,true,false,false,true,0,38,38,true};
  29. using OA=movies::OrbitAction;
  30. assert(orbit.observe(1000,inApex)==OA::none); // Playing movies cannot arm return.
  31. orbit.arm(1000);
  32. assert(orbit.observe(9000,inApex)==OA::none); // Host must actually publish completion.
  33. inApex.complete=true;
  34. assert(orbit.observe(10000,inApex)==OA::none);
  35. assert(orbit.observe(17999,inApex)==OA::none); // Full banner window.
  36. assert(orbit.observe(18000,inApex)==OA::select);
  37. assert(orbit.observe(18001,inApex)==OA::none); // No duplicate commit.
  38. auto inOrbit=inApex; inOrbit.emberSelected=false;inOrbit.orbitSelected=true;
  39. inOrbit.exactOwner=false; // Committing orbit may already retire the old ActivityClient link.
  40. assert(orbit.observe(18002,inOrbit)==OA::cleanup); // Requires destination readback.
  41. assert(orbit.observe(18003,inOrbit)==OA::none); // No repeated cleanup request.
  42. movies::OrbitObservation betweenWorlds{};betweenWorlds.step=28;
  43. assert(orbit.observe(18004,betweenWorlds)==OA::none);
  44. assert(orbit.active());
  45. inOrbit.step=29;
  46. assert(orbit.observe(18100,inOrbit)==OA::orbitSetup);
  47. assert(!orbit.active() && orbit.observe(20000,inApex)==OA::none);
  48. orbit.arm(30000);
  49. auto stale=inApex;stale.exactOwner=false;
  50. assert(orbit.observe(31000,stale)==OA::canceled);
  51. orbit.arm(40000);
  52. auto departed=inApex;departed.step=28;
  53. assert(orbit.observe(41000,departed)==OA::canceled);
  54. orbit.arm(50000);inApex.complete=false;
  55. assert(orbit.observe(140001,inApex)==OA::timedOut);
  56. orbit.arm(150000);inApex.complete=true;
  57. assert(orbit.observe(150000,inApex)==OA::none);
  58. assert(orbit.observe(158000,inApex)==OA::select);
  59. assert(orbit.observe(158001,departed)==OA::none); // Native cleanup already began.
  60. assert(orbit.observe(158100,inOrbit)==OA::orbitSetup);
  61. orbit.arm(160000);
  62. assert(orbit.observe(160000,inApex)==OA::none);
  63. assert(orbit.observe(168000,inApex)==OA::select);
  64. auto replaced=inOrbit;replaced.step=38;replaced.sameWorld=false;
  65. assert(orbit.observe(168001,replaced)==OA::canceled);
  66. movies::SurfaceRegistrations surfaces{};
  67. for (unsigned i=1;i<=6;++i) surfaces[i].entries[0]=movies::movie_surface_definitions[i-1];
  68. // Live black-video capture: old candidate handles remain, but no container
  69. // holds a registration and every selected surface is FFFFFFFF.
  70. assert(!movies::movie_surfaces_registered(surfaces));
  71. for (unsigned i=1;i<=6;++i) surfaces[i].count=1;
  72. assert(movies::movie_surfaces_registered(surfaces));
  73. assert(!movies::movie_surfaces_selected(surfaces));
  74. for (unsigned i=1;i<=6;++i) surfaces[i].selected=surfaces[i].entries[0];
  75. assert(movies::movie_surfaces_selected(surfaces));
  76. surfaces[4].count=0;
  77. assert(!movies::movie_surfaces_registered(surfaces));
  78. surfaces[4].count=4;
  79. assert(!movies::movie_surfaces_registered(surfaces));
  80. surfaces[4].count=2;surfaces[4].entries[1]=123;
  81. assert(!movies::movie_surfaces_registered(surfaces)); // another surface owns the top
  82. surfaces[4].count=1;
  83. surfaces[7].count=1;surfaces[7].entries[0]=123;
  84. assert(!movies::movie_surfaces_registered(surfaces)); // do not publish an unrelated pending slot
  85. surfaces[7].selected=123;
  86. assert(movies::movie_surfaces_selected(surfaces));
  87. // Native kind 2 resolves shared-tag records; these ordinary movie tags require 1.
  88. static_assert(movies::movie_resource_kind==1);
  89. assert((movies::movie_metadata(0x80BCA001)==std::array<std::uint32_t,4>{0x80BCA001,0x80BCA000,0x80B9EB33,0x80BCA032}));
  90. assert((movies::movie_metadata(0x80BCA003)==std::array<std::uint32_t,4>{0x80BCA003,0x80BCA002,0x80B9EB34,0x80BCA032}));
  91. assert((movies::movie_metadata(0x80BCA034)==std::array<std::uint32_t,4>{})); // media is not a wrapper
  92. assert(movies::movie_stream(0x80BCA001)==0x80BCA034);
  93. assert(movies::movie_stream(0x80BCA003)==0x80C7C000);
  94. assert(movies::movie_stream(0x80BCA000)==0xFFFFFFFF);
  95. // The 13f07ee capture: metadata was loaded, but the video stream still held a
  96. // free-list entry (FEFE0035, 0, location 0). Native CRI entered error state 7.
  97. assert(!movies::movie_stream_ready(0xFEFE0035,0,0));
  98. assert(movies::movie_stream_ready(0xE80779A0,0x41363B,0x10000005));
  99. assert(!movies::movie_stream_ready(0xC0000000,0x41363B,0x10000005));
  100. assert(!movies::movie_stream_ready(0x280779A0,0x41363B,0x10000005));
  101. assert(!movies::movie_stream_ready(0xE80779A0,0x40103B,0x10000005));
  102. assert(!movies::movie_stream_ready(0xE80779A0,0x41363B,0));
  103. assert(!movies::movie_stream_ready(0xE80779A0,0x41363B,0x100000005ULL));
  104. // Captured crash: registered movie tags contain free-list entries, not resident headers.
  105. assert(!movies::movie_resources_ready(1,0x80BCA001,false,0,false,0xFFFFFFFF));
  106. assert(!movies::movie_resources_ready(2,0x80BCA001,false,0x80BCA000,true,0x80BCA034));
  107. assert(!movies::movie_resources_ready(2,0x80BCA001,true,0x80BCA000,false,0x80BCA034));
  108. assert(!movies::movie_resources_ready(2,0x80BCA001,true,0x80BCA002,true,0x80BCA034));
  109. assert(!movies::movie_resources_ready(3,0x80BCA001,true,0x80BCA000,true,0x80BCA034));
  110. assert(!movies::movie_resources_ready(2,0x80BCA001,true,0x80BCA000,true,0xFFFFFFFF));
  111. assert(movies::movie_resources_ready(2,0x80BCA001,true,0x80BCA000,true,0x80BCA034));
  112. assert(movies::movie_resources_ready(2,0x80BCA003,true,0x80BCA002,true,0x80C7C000));
  113. assert(!movies::resource_can_release(0) && !movies::resource_can_release(1));
  114. assert(movies::resource_can_release(2) && movies::resource_can_release(3));
  115. // Only Ember slot 43 may borrow sunburn. The global Foundry effect and rail shock stay distinct.
  116. assert(movies::ember_burn_source(0x80B3C0C6,0x80809540,0xAC8,0x80C1D9E0));
  117. assert(!movies::ember_burn_source(0x80BEB26F,0x80809540,0xAC8,0x80C1D9E0));
  118. assert(!movies::ember_burn_source(0x80B3C0C6,0x8080953F,0xAC8,0x80C1D9E0));
  119. assert(!movies::ember_burn_source(0x80B3C0C6,0x80809540,0xAC0,0x80C1D9E0));
  120. assert(!movies::ember_burn_source(0x80B3C0C6,0x80809540,0xAC8,0x80C1D389));
  121. movies::Playback playback;
  122. assert(playback.observe(false,5,true)==movies::Status::preparing);
  123. assert(playback.observe(true,0,false)==movies::Status::preparing);
  124. assert(playback.observe(true,6,false)==movies::Status::preparing);
  125. assert(playback.observe(true,3,true)==movies::Status::preparing);
  126. assert(playback.observe(true,5,true)==movies::Status::playing);
  127. assert(playback.observe(true,6,true)==movies::Status::playing);
  128. assert(playback.observe(true,6,false)==movies::Status::complete);
  129. assert(playback.observe(false,6,false)==movies::Status::failed);
  130. assert(playback.observe(true,7,false)==movies::Status::failed);
  131. movies::Playback skipped;
  132. assert(skipped.observe(true,5,true)==movies::Status::playing);
  133. assert(skipped.observe(true,0,false)==movies::Status::complete);
  134. std::array<std::uint32_t, 5> history{102, 103, 104};
  135. std::size_t historyCount = 3;
  136. const std::array<std::uint32_t, 3> movieOne{105, 102, 104};
  137. const std::array<std::uint32_t, 3> movieTwo{106, 105, 104};
  138. assert(wire::extend_key_order(history, historyCount, movieOne));
  139. assert(wire::extend_key_order(history, historyCount, movieTwo));
  140. assert(historyCount == 5 && (history == std::array<std::uint32_t, 5>{102,103,104,105,106}));
  141. assert(wire::extend_key_order(history, historyCount, movieOne));
  142. const std::array<std::uint32_t, 1> overflow{107};
  143. assert(!wire::extend_key_order(history, historyCount, overflow));
  144. // Unknown/empty worlds and a different owner cannot masquerade as cleanup.
  145. retire::Progress progress{retire::Status::baselinePending, 0};
  146. progress.observe(0, 1234, 4, 0);
  147. assert(progress.value == retire::Status::baselinePending);
  148. progress.observe(0, 1234, 8, 4);
  149. assert(progress.value == retire::Status::retiring);
  150. progress.observe(1, 1234, 4, 0);
  151. progress.observe(0, 5678, 4, 0);
  152. progress.observe(0, 1234, 0, 0);
  153. progress.observe(0, 1234, 5, 1);
  154. assert(progress.value == retire::Status::retiring);
  155. progress.observe(0, 1234, 4, 0);
  156. assert(progress.value == retire::Status::complete);
  157. // Exercise the actual encoder: old keys retain their ordinal, a clear bit removes
  158. // only the retired key, and phase two contains no body for that removed group.
  159. static wire::Snapshot snapshot{};
  160. std::array<std::uint8_t, 1> types{1}, flags{0};
  161. std::array<std::uint16_t, 1> indices{0};
  162. std::array<std::uint32_t, 3> keys{102, 103, 104};
  163. std::array<wire::BubbleSubBlock, 1> blocks{{{0, keys}}};
  164. snapshot.roster.groupCount = 4; snapshot.roster.topLevelGroupCount = 1;
  165. snapshot.roster.bubbleSubBlocks = blocks;
  166. for (unsigned i = 0; i < 4; ++i) {
  167. auto& group = snapshot.roster.groups[i];
  168. group.key = 101 + i; group.slotTypes = types; group.slotFlags = flags; group.slotIndices = indices;
  169. }
  170. snapshot.roster.groups[2].retired = true;
  171. std::array<std::byte, 4096> bytes{}; std::size_t size{};
  172. assert(wire::encode_sensor_auth_update(snapshot, bytes, size));
  173. Reader mask{std::span(bytes).first(size)};
  174. assert(mask.skip(wire::kLatchBitWithoutGrant + 1 + wire::delta_bits(1, {}) - 1));
  175. expect(mask, 1, 1); expect(mask, 7, 1); // Field one, one bubble.
  176. expect(mask, 1, 1); expect(mask, 32, 0x80000000U);
  177. expect(mask, 1, 1); expect(mask, 1, 1); expect(mask, 7, 3);
  178. for (auto key : keys) expect(mask, 32, key);
  179. expect(mask, 1, 1); expect(mask, 32, 5); // Keep ordinals 0 and 2.
  180. expect(mask, 32, 0); expect(mask, 32, 0);
  181. Reader bodies{std::span(bytes).first(size)};
  182. assert(bodies.skip(wire::kLatchBitWithoutGrant + 1 + wire::delta_bits(1, blocks)));
  183. for (auto key : {101U, 102U, 104U}) {
  184. expect(bodies, 1, 1); expect(bodies, 32, key); expect(bodies, 32, 0);
  185. expect(bodies, 1, 1); expect(bodies, 32, key); expect(bodies, 7, 2);
  186. expect(bodies, 16, 32768); expect(bodies, 32, 0); expect(bodies, 1, 0);
  187. }
  188. expect(bodies, 1, 0); expect(bodies, 1, 0);
  189. snapshot.roster.groups[0].retired = true;
  190. assert(!wire::encode_sensor_auth_update(snapshot, bytes, size));
  191. member::MembershipState state{};
  192. state.hasHostTeleport = true; state.hostTeleportQualified = true;
  193. state.hostTeleport = {1, 8, 1, 123}; state.teleport = {2, 8, 1, 123};
  194. state.region.index = 1; state.currentReported = true; state.currentRegion.index = 0;
  195. member::observe_qualified_teleport(state);
  196. assert(state.hostTeleport.state == 1); // Pending-region advertisement is not arrival.
  197. state.teleport.state = 3; state.currentRegion.index = 1;
  198. state.teleport.sliceSetHash = 124;
  199. member::observe_qualified_teleport(state); assert(state.hostTeleport.state == 1);
  200. state.teleport.sliceSetHash = 123; state.teleport.token = 7;
  201. member::observe_qualified_teleport(state); assert(state.hostTeleport.state == 1);
  202. state.teleport.token = 8;
  203. member::observe_qualified_teleport(state); assert(state.hostTeleport.state == 3);
  204. state.teleport.state = 0;
  205. member::observe_qualified_teleport(state); assert(!state.hasHostTeleport);
  206. assert(member::next_teleport_token(255) == 1 && member::next_teleport_token(8) == 9);
  207. }