tcp.rs 279 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704
  1. // Heads up! Before working on this file you should read, at least, RFC 793 and
  2. // the parts of RFC 1122 that discuss TCP, as well as RFC 7323 for some of the TCP options.
  3. // Consult RFC 7414 when implementing a new feature.
  4. use core::fmt::Display;
  5. #[cfg(feature = "async")]
  6. use core::task::Waker;
  7. use core::{fmt, mem};
  8. #[cfg(feature = "async")]
  9. use crate::socket::WakerRegistration;
  10. use crate::socket::{Context, PollAt};
  11. use crate::storage::{Assembler, RingBuffer};
  12. use crate::time::{Duration, Instant};
  13. use crate::wire::{
  14. IpAddress, IpEndpoint, IpListenEndpoint, IpProtocol, IpRepr, TcpControl, TcpRepr, TcpSeqNumber,
  15. TcpTimestampGenerator, TcpTimestampRepr, TCP_HEADER_LEN,
  16. };
  17. mod congestion;
  18. macro_rules! tcp_trace {
  19. ($($arg:expr),*) => (net_log!(trace, $($arg),*));
  20. }
  21. /// Error returned by [`Socket::listen`]
  22. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  23. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  24. pub enum ListenError {
  25. InvalidState,
  26. Unaddressable,
  27. }
  28. impl Display for ListenError {
  29. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  30. match *self {
  31. ListenError::InvalidState => write!(f, "invalid state"),
  32. ListenError::Unaddressable => write!(f, "unaddressable destination"),
  33. }
  34. }
  35. }
  36. #[cfg(feature = "std")]
  37. impl std::error::Error for ListenError {}
  38. /// Error returned by [`Socket::connect`]
  39. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  40. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  41. pub enum ConnectError {
  42. InvalidState,
  43. Unaddressable,
  44. }
  45. impl Display for ConnectError {
  46. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  47. match *self {
  48. ConnectError::InvalidState => write!(f, "invalid state"),
  49. ConnectError::Unaddressable => write!(f, "unaddressable destination"),
  50. }
  51. }
  52. }
  53. #[cfg(feature = "std")]
  54. impl std::error::Error for ConnectError {}
  55. /// Error returned by [`Socket::send`]
  56. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  57. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  58. pub enum SendError {
  59. InvalidState,
  60. }
  61. impl Display for SendError {
  62. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  63. match *self {
  64. SendError::InvalidState => write!(f, "invalid state"),
  65. }
  66. }
  67. }
  68. #[cfg(feature = "std")]
  69. impl std::error::Error for SendError {}
  70. /// Error returned by [`Socket::recv`]
  71. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  72. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  73. pub enum RecvError {
  74. InvalidState,
  75. Finished,
  76. }
  77. impl Display for RecvError {
  78. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  79. match *self {
  80. RecvError::InvalidState => write!(f, "invalid state"),
  81. RecvError::Finished => write!(f, "operation finished"),
  82. }
  83. }
  84. }
  85. #[cfg(feature = "std")]
  86. impl std::error::Error for RecvError {}
  87. /// A TCP socket ring buffer.
  88. pub type SocketBuffer<'a> = RingBuffer<'a, u8>;
  89. /// The state of a TCP socket, according to [RFC 793].
  90. ///
  91. /// [RFC 793]: https://tools.ietf.org/html/rfc793
  92. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  93. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  94. pub enum State {
  95. Closed,
  96. Listen,
  97. SynSent,
  98. SynReceived,
  99. Established,
  100. FinWait1,
  101. FinWait2,
  102. CloseWait,
  103. Closing,
  104. LastAck,
  105. TimeWait,
  106. }
  107. impl fmt::Display for State {
  108. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  109. match *self {
  110. State::Closed => write!(f, "CLOSED"),
  111. State::Listen => write!(f, "LISTEN"),
  112. State::SynSent => write!(f, "SYN-SENT"),
  113. State::SynReceived => write!(f, "SYN-RECEIVED"),
  114. State::Established => write!(f, "ESTABLISHED"),
  115. State::FinWait1 => write!(f, "FIN-WAIT-1"),
  116. State::FinWait2 => write!(f, "FIN-WAIT-2"),
  117. State::CloseWait => write!(f, "CLOSE-WAIT"),
  118. State::Closing => write!(f, "CLOSING"),
  119. State::LastAck => write!(f, "LAST-ACK"),
  120. State::TimeWait => write!(f, "TIME-WAIT"),
  121. }
  122. }
  123. }
  124. /// RFC 6298: (2.1) Until a round-trip time (RTT) measurement has been made for a
  125. /// segment sent between the sender and receiver, the sender SHOULD
  126. /// set RTO <- 1 second,
  127. const RTTE_INITIAL_RTO: u32 = 1000;
  128. // Minimum "safety margin" for the RTO that kicks in when the
  129. // variance gets very low.
  130. const RTTE_MIN_MARGIN: u32 = 5;
  131. /// K, according to RFC 6298
  132. const RTTE_K: u32 = 4;
  133. // RFC 6298 (2.4): Whenever RTO is computed, if it is less than 1 second, then the
  134. // RTO SHOULD be rounded up to 1 second.
  135. const RTTE_MIN_RTO: u32 = 1000;
  136. // RFC 6298 (2.5) A maximum value MAY be placed on RTO provided it is at least 60
  137. // seconds
  138. const RTTE_MAX_RTO: u32 = 60_000;
  139. #[derive(Debug, Clone, Copy)]
  140. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  141. struct RttEstimator {
  142. /// true if we have made at least one rtt measurement.
  143. have_measurement: bool,
  144. // Using u32 instead of Duration to save space (Duration is i64)
  145. /// Smoothed RTT
  146. srtt: u32,
  147. /// RTT variance.
  148. rttvar: u32,
  149. /// Retransmission Time-Out
  150. rto: u32,
  151. timestamp: Option<(Instant, TcpSeqNumber)>,
  152. max_seq_sent: Option<TcpSeqNumber>,
  153. rto_count: u8,
  154. }
  155. impl Default for RttEstimator {
  156. fn default() -> Self {
  157. Self {
  158. have_measurement: false,
  159. srtt: 0, // ignored, will be overwritten on first measurement.
  160. rttvar: 0, // ignored, will be overwritten on first measurement.
  161. rto: RTTE_INITIAL_RTO,
  162. timestamp: None,
  163. max_seq_sent: None,
  164. rto_count: 0,
  165. }
  166. }
  167. }
  168. impl RttEstimator {
  169. fn retransmission_timeout(&self) -> Duration {
  170. Duration::from_millis(self.rto as _)
  171. }
  172. fn sample(&mut self, new_rtt: u32) {
  173. if self.have_measurement {
  174. // RFC 6298 (2.3) When a subsequent RTT measurement R' is made, a host MUST set (...)
  175. let diff = (self.srtt as i32 - new_rtt as i32).unsigned_abs();
  176. self.rttvar = (self.rttvar * 3 + diff).div_ceil(4);
  177. self.srtt = (self.srtt * 7 + new_rtt).div_ceil(8);
  178. } else {
  179. // RFC 6298 (2.2) When the first RTT measurement R is made, the host MUST set (...)
  180. self.have_measurement = true;
  181. self.srtt = new_rtt;
  182. self.rttvar = new_rtt / 2;
  183. }
  184. // RFC 6298 (2.2), (2.3)
  185. let margin = RTTE_MIN_MARGIN.max(self.rttvar * RTTE_K);
  186. self.rto = (self.srtt + margin).clamp(RTTE_MIN_RTO, RTTE_MAX_RTO);
  187. self.rto_count = 0;
  188. tcp_trace!(
  189. "rtte: sample={:?} srtt={:?} rttvar={:?} rto={:?}",
  190. new_rtt,
  191. self.srtt,
  192. self.rttvar,
  193. self.rto
  194. );
  195. }
  196. fn on_send(&mut self, timestamp: Instant, seq: TcpSeqNumber) {
  197. if self
  198. .max_seq_sent
  199. .map(|max_seq_sent| seq > max_seq_sent)
  200. .unwrap_or(true)
  201. {
  202. self.max_seq_sent = Some(seq);
  203. if self.timestamp.is_none() {
  204. self.timestamp = Some((timestamp, seq));
  205. tcp_trace!("rtte: sampling at seq={:?}", seq);
  206. }
  207. }
  208. }
  209. fn on_ack(&mut self, timestamp: Instant, seq: TcpSeqNumber) {
  210. if let Some((sent_timestamp, sent_seq)) = self.timestamp {
  211. if seq >= sent_seq {
  212. self.sample((timestamp - sent_timestamp).total_millis() as u32);
  213. self.timestamp = None;
  214. }
  215. }
  216. }
  217. fn on_retransmit(&mut self) {
  218. if self.timestamp.is_some() {
  219. tcp_trace!("rtte: abort sampling due to retransmit");
  220. }
  221. self.timestamp = None;
  222. // RFC 6298 (5.5) The host MUST set RTO <- RTO * 2 ("back off the timer"). The
  223. // maximum value discussed in (2.5) above may be used to provide
  224. // an upper bound to this doubling operation.
  225. self.rto = (self.rto * 2).min(RTTE_MAX_RTO);
  226. tcp_trace!("rtte: doubling rto to {:?}", self.rto);
  227. // RFC 6298: a TCP implementation MAY clear SRTT and RTTVAR after
  228. // backing off the timer multiple times as it is likely that the current
  229. // SRTT and RTTVAR are bogus in this situation. Once SRTT and RTTVAR
  230. // are cleared, they should be initialized with the next RTT sample
  231. // taken per (2.2) rather than using (2.3).
  232. self.rto_count += 1;
  233. if self.rto_count >= 3 {
  234. self.rto_count = 0;
  235. self.have_measurement = false;
  236. tcp_trace!("rtte: too many retransmissions, clearing srtt, rttvar.");
  237. }
  238. }
  239. }
  240. #[derive(Debug, Clone, Copy, PartialEq)]
  241. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  242. enum Timer {
  243. Idle {
  244. keep_alive_at: Option<Instant>,
  245. },
  246. Retransmit {
  247. expires_at: Instant,
  248. },
  249. FastRetransmit,
  250. ZeroWindowProbe {
  251. expires_at: Instant,
  252. delay: Duration,
  253. },
  254. Close {
  255. expires_at: Instant,
  256. },
  257. }
  258. const ACK_DELAY_DEFAULT: Duration = Duration::from_millis(10);
  259. const CLOSE_DELAY: Duration = Duration::from_millis(10_000);
  260. impl Timer {
  261. fn new() -> Timer {
  262. Timer::Idle {
  263. keep_alive_at: None,
  264. }
  265. }
  266. fn should_keep_alive(&self, timestamp: Instant) -> bool {
  267. match *self {
  268. Timer::Idle {
  269. keep_alive_at: Some(keep_alive_at),
  270. } if timestamp >= keep_alive_at => true,
  271. _ => false,
  272. }
  273. }
  274. fn should_retransmit(&self, timestamp: Instant) -> bool {
  275. match *self {
  276. Timer::Retransmit { expires_at } if timestamp >= expires_at => true,
  277. Timer::FastRetransmit => true,
  278. _ => false,
  279. }
  280. }
  281. fn should_close(&self, timestamp: Instant) -> bool {
  282. match *self {
  283. Timer::Close { expires_at } if timestamp >= expires_at => true,
  284. _ => false,
  285. }
  286. }
  287. fn should_zero_window_probe(&self, timestamp: Instant) -> bool {
  288. match *self {
  289. Timer::ZeroWindowProbe { expires_at, .. } if timestamp >= expires_at => true,
  290. _ => false,
  291. }
  292. }
  293. fn poll_at(&self) -> PollAt {
  294. match *self {
  295. Timer::Idle {
  296. keep_alive_at: Some(keep_alive_at),
  297. } => PollAt::Time(keep_alive_at),
  298. Timer::Idle {
  299. keep_alive_at: None,
  300. } => PollAt::Ingress,
  301. Timer::ZeroWindowProbe { expires_at, .. } => PollAt::Time(expires_at),
  302. Timer::Retransmit { expires_at, .. } => PollAt::Time(expires_at),
  303. Timer::FastRetransmit => PollAt::Now,
  304. Timer::Close { expires_at } => PollAt::Time(expires_at),
  305. }
  306. }
  307. fn set_for_idle(&mut self, timestamp: Instant, interval: Option<Duration>) {
  308. *self = Timer::Idle {
  309. keep_alive_at: interval.map(|interval| timestamp + interval),
  310. }
  311. }
  312. fn set_keep_alive(&mut self) {
  313. if let Timer::Idle { keep_alive_at } = self {
  314. if keep_alive_at.is_none() {
  315. *keep_alive_at = Some(Instant::from_millis(0))
  316. }
  317. }
  318. }
  319. fn rewind_keep_alive(&mut self, timestamp: Instant, interval: Option<Duration>) {
  320. if let Timer::Idle { keep_alive_at } = self {
  321. *keep_alive_at = interval.map(|interval| timestamp + interval)
  322. }
  323. }
  324. fn set_for_retransmit(&mut self, timestamp: Instant, delay: Duration) {
  325. match *self {
  326. Timer::Idle { .. }
  327. | Timer::FastRetransmit { .. }
  328. | Timer::Retransmit { .. }
  329. | Timer::ZeroWindowProbe { .. } => {
  330. *self = Timer::Retransmit {
  331. expires_at: timestamp + delay,
  332. }
  333. }
  334. Timer::Close { .. } => (),
  335. }
  336. }
  337. fn set_for_fast_retransmit(&mut self) {
  338. *self = Timer::FastRetransmit
  339. }
  340. fn set_for_close(&mut self, timestamp: Instant) {
  341. *self = Timer::Close {
  342. expires_at: timestamp + CLOSE_DELAY,
  343. }
  344. }
  345. fn set_for_zero_window_probe(&mut self, timestamp: Instant, delay: Duration) {
  346. *self = Timer::ZeroWindowProbe {
  347. expires_at: timestamp + delay,
  348. delay,
  349. }
  350. }
  351. fn rewind_zero_window_probe(&mut self, timestamp: Instant) {
  352. if let Timer::ZeroWindowProbe { mut delay, .. } = *self {
  353. delay = (delay * 2).min(Duration::from_millis(RTTE_MAX_RTO as _));
  354. *self = Timer::ZeroWindowProbe {
  355. expires_at: timestamp + delay,
  356. delay,
  357. }
  358. }
  359. }
  360. fn is_idle(&self) -> bool {
  361. matches!(self, Timer::Idle { .. })
  362. }
  363. fn is_zero_window_probe(&self) -> bool {
  364. matches!(self, Timer::ZeroWindowProbe { .. })
  365. }
  366. fn is_retransmit(&self) -> bool {
  367. matches!(self, Timer::Retransmit { .. } | Timer::FastRetransmit)
  368. }
  369. }
  370. #[derive(Debug, PartialEq, Eq, Clone, Copy)]
  371. enum AckDelayTimer {
  372. Idle,
  373. Waiting(Instant),
  374. Immediate,
  375. }
  376. #[derive(Debug, Copy, Clone, Eq, PartialEq)]
  377. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  378. struct Tuple {
  379. local: IpEndpoint,
  380. remote: IpEndpoint,
  381. }
  382. impl Display for Tuple {
  383. fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  384. write!(f, "{}:{}", self.local, self.remote)
  385. }
  386. }
  387. /// A congestion control algorithm.
  388. #[derive(Debug, Copy, Clone, Eq, PartialEq)]
  389. #[cfg_attr(feature = "defmt", derive(defmt::Format))]
  390. pub enum CongestionControl {
  391. None,
  392. #[cfg(feature = "socket-tcp-reno")]
  393. Reno,
  394. #[cfg(feature = "socket-tcp-cubic")]
  395. Cubic,
  396. }
  397. /// A Transmission Control Protocol socket.
  398. ///
  399. /// A TCP socket may passively listen for connections or actively connect to another endpoint.
  400. /// Note that, for listening sockets, there is no "backlog"; to be able to simultaneously
  401. /// accept several connections, as many sockets must be allocated, or any new connection
  402. /// attempts will be reset.
  403. #[derive(Debug)]
  404. pub struct Socket<'a> {
  405. state: State,
  406. timer: Timer,
  407. rtte: RttEstimator,
  408. assembler: Assembler,
  409. rx_buffer: SocketBuffer<'a>,
  410. rx_fin_received: bool,
  411. tx_buffer: SocketBuffer<'a>,
  412. /// Interval after which, if no inbound packets are received, the connection is aborted.
  413. timeout: Option<Duration>,
  414. /// Interval at which keep-alive packets will be sent.
  415. keep_alive: Option<Duration>,
  416. /// The time-to-live (IPv4) or hop limit (IPv6) value used in outgoing packets.
  417. hop_limit: Option<u8>,
  418. /// Address passed to listen(). Listen address is set when listen() is called and
  419. /// used every time the socket is reset back to the LISTEN state.
  420. listen_endpoint: IpListenEndpoint,
  421. /// Current 4-tuple (local and remote endpoints).
  422. tuple: Option<Tuple>,
  423. /// The sequence number corresponding to the beginning of the transmit buffer.
  424. /// I.e. an ACK(local_seq_no+n) packet removes n bytes from the transmit buffer.
  425. local_seq_no: TcpSeqNumber,
  426. /// The sequence number corresponding to the beginning of the receive buffer.
  427. /// I.e. userspace reading n bytes adds n to remote_seq_no.
  428. remote_seq_no: TcpSeqNumber,
  429. /// The last sequence number sent.
  430. /// I.e. in an idle socket, local_seq_no+tx_buffer.len().
  431. remote_last_seq: TcpSeqNumber,
  432. /// The last acknowledgement number sent.
  433. /// I.e. in an idle socket, remote_seq_no+rx_buffer.len().
  434. remote_last_ack: Option<TcpSeqNumber>,
  435. /// The last window length sent.
  436. remote_last_win: u16,
  437. /// The sending window scaling factor advertised to remotes which support RFC 1323.
  438. /// It is zero if the window <= 64KiB and/or the remote does not support it.
  439. remote_win_shift: u8,
  440. /// The remote window size, relative to local_seq_no
  441. /// I.e. we're allowed to send octets until local_seq_no+remote_win_len
  442. remote_win_len: usize,
  443. /// The receive window scaling factor for remotes which support RFC 1323, None if unsupported.
  444. remote_win_scale: Option<u8>,
  445. /// Whether or not the remote supports selective ACK as described in RFC 2018.
  446. remote_has_sack: bool,
  447. /// The maximum number of data octets that the remote side may receive.
  448. remote_mss: usize,
  449. /// The timestamp of the last packet received.
  450. remote_last_ts: Option<Instant>,
  451. /// The sequence number of the last packet received, used for sACK
  452. local_rx_last_seq: Option<TcpSeqNumber>,
  453. /// The ACK number of the last packet received.
  454. local_rx_last_ack: Option<TcpSeqNumber>,
  455. /// The number of packets received directly after
  456. /// each other which have the same ACK number.
  457. local_rx_dup_acks: u8,
  458. /// Duration for Delayed ACK. If None no ACKs will be delayed.
  459. ack_delay: Option<Duration>,
  460. /// Delayed ack timer. If set, packets containing exclusively
  461. /// ACK or window updates (ie, no data) won't be sent until expiry.
  462. ack_delay_timer: AckDelayTimer,
  463. /// Used for rate-limiting: No more challenge ACKs will be sent until this instant.
  464. challenge_ack_timer: Instant,
  465. /// Nagle's Algorithm enabled.
  466. nagle: bool,
  467. /// The congestion control algorithm.
  468. congestion_controller: congestion::AnyController,
  469. /// tsval generator - if some, tcp timestamp is enabled
  470. tsval_generator: Option<TcpTimestampGenerator>,
  471. /// 0 if not seen or timestamp not enabled
  472. last_remote_tsval: u32,
  473. #[cfg(feature = "async")]
  474. rx_waker: WakerRegistration,
  475. #[cfg(feature = "async")]
  476. tx_waker: WakerRegistration,
  477. }
  478. const DEFAULT_MSS: usize = 536;
  479. impl<'a> Socket<'a> {
  480. #[allow(unused_comparisons)] // small usize platforms always pass rx_capacity check
  481. /// Create a socket using the given buffers.
  482. pub fn new<T>(rx_buffer: T, tx_buffer: T) -> Socket<'a>
  483. where
  484. T: Into<SocketBuffer<'a>>,
  485. {
  486. let (rx_buffer, tx_buffer) = (rx_buffer.into(), tx_buffer.into());
  487. let rx_capacity = rx_buffer.capacity();
  488. // From RFC 1323:
  489. // [...] the above constraints imply that 2 * the max window size must be less
  490. // than 2**31 [...] Thus, the shift count must be limited to 14 (which allows
  491. // windows of 2**30 = 1 Gbyte).
  492. #[cfg(not(target_pointer_width = "16"))] // Prevent overflow
  493. if rx_capacity > (1 << 30) {
  494. panic!("receiving buffer too large, cannot exceed 1 GiB")
  495. }
  496. let rx_cap_log2 = mem::size_of::<usize>() * 8 - rx_capacity.leading_zeros() as usize;
  497. Socket {
  498. state: State::Closed,
  499. timer: Timer::new(),
  500. rtte: RttEstimator::default(),
  501. assembler: Assembler::new(),
  502. tx_buffer,
  503. rx_buffer,
  504. rx_fin_received: false,
  505. timeout: None,
  506. keep_alive: None,
  507. hop_limit: None,
  508. listen_endpoint: IpListenEndpoint::default(),
  509. tuple: None,
  510. local_seq_no: TcpSeqNumber::default(),
  511. remote_seq_no: TcpSeqNumber::default(),
  512. remote_last_seq: TcpSeqNumber::default(),
  513. remote_last_ack: None,
  514. remote_last_win: 0,
  515. remote_win_len: 0,
  516. remote_win_shift: rx_cap_log2.saturating_sub(16) as u8,
  517. remote_win_scale: None,
  518. remote_has_sack: false,
  519. remote_mss: DEFAULT_MSS,
  520. remote_last_ts: None,
  521. local_rx_last_ack: None,
  522. local_rx_last_seq: None,
  523. local_rx_dup_acks: 0,
  524. ack_delay: Some(ACK_DELAY_DEFAULT),
  525. ack_delay_timer: AckDelayTimer::Idle,
  526. challenge_ack_timer: Instant::from_secs(0),
  527. nagle: true,
  528. tsval_generator: None,
  529. last_remote_tsval: 0,
  530. congestion_controller: congestion::AnyController::new(),
  531. #[cfg(feature = "async")]
  532. rx_waker: WakerRegistration::new(),
  533. #[cfg(feature = "async")]
  534. tx_waker: WakerRegistration::new(),
  535. }
  536. }
  537. /// Enable or disable TCP Timestamp.
  538. pub fn set_tsval_generator(&mut self, generator: Option<TcpTimestampGenerator>) {
  539. self.tsval_generator = generator;
  540. }
  541. /// Return whether TCP Timestamp is enabled.
  542. pub fn timestamp_enabled(&self) -> bool {
  543. self.tsval_generator.is_some()
  544. }
  545. /// Set an algorithm for congestion control.
  546. ///
  547. /// `CongestionControl::None` indicates that no congestion control is applied.
  548. /// Options `CongestionControl::Cubic` and `CongestionControl::Reno` are also available.
  549. /// To use Reno and Cubic, please enable the `socket-tcp-reno` and `socket-tcp-cubic` features
  550. /// in the `smoltcp` crate, respectively.
  551. ///
  552. /// `CongestionControl::Reno` is a classic congestion control algorithm valued for its simplicity.
  553. /// Despite having a lower algorithmic complexity than `Cubic`,
  554. /// it is less efficient in terms of bandwidth usage.
  555. ///
  556. /// `CongestionControl::Cubic` represents a modern congestion control algorithm designed to
  557. /// be more efficient and fair compared to `CongestionControl::Reno`.
  558. /// It is the default choice for Linux, Windows, and macOS.
  559. /// `CongestionControl::Cubic` relies on double precision (`f64`) floating point operations, which may cause issues in some contexts:
  560. /// * Small embedded processors (such as Cortex-M0, Cortex-M1, and Cortex-M3) do not have an FPU, and floating point operations consume significant amounts of CPU time and Flash space.
  561. /// * Interrupt handlers should almost always avoid floating-point operations.
  562. /// * Kernel-mode code on desktop processors usually avoids FPU operations to reduce the penalty of saving and restoring FPU registers.
  563. ///
  564. /// In all these cases, `CongestionControl::Reno` is a better choice of congestion control algorithm.
  565. pub fn set_congestion_control(&mut self, congestion_control: CongestionControl) {
  566. use congestion::*;
  567. self.congestion_controller = match congestion_control {
  568. CongestionControl::None => AnyController::None(no_control::NoControl),
  569. #[cfg(feature = "socket-tcp-reno")]
  570. CongestionControl::Reno => AnyController::Reno(reno::Reno::new()),
  571. #[cfg(feature = "socket-tcp-cubic")]
  572. CongestionControl::Cubic => AnyController::Cubic(cubic::Cubic::new()),
  573. }
  574. }
  575. /// Return the current congestion control algorithm.
  576. pub fn congestion_control(&self) -> CongestionControl {
  577. use congestion::*;
  578. match self.congestion_controller {
  579. AnyController::None(_) => CongestionControl::None,
  580. #[cfg(feature = "socket-tcp-reno")]
  581. AnyController::Reno(_) => CongestionControl::Reno,
  582. #[cfg(feature = "socket-tcp-cubic")]
  583. AnyController::Cubic(_) => CongestionControl::Cubic,
  584. }
  585. }
  586. /// Register a waker for receive operations.
  587. ///
  588. /// The waker is woken on state changes that might affect the return value
  589. /// of `recv` method calls, such as receiving data, or the socket closing.
  590. ///
  591. /// Notes:
  592. ///
  593. /// - Only one waker can be registered at a time. If another waker was previously registered,
  594. /// it is overwritten and will no longer be woken.
  595. /// - The Waker is woken only once. Once woken, you must register it again to receive more wakes.
  596. /// - "Spurious wakes" are allowed: a wake doesn't guarantee the result of `recv` has
  597. /// necessarily changed.
  598. #[cfg(feature = "async")]
  599. pub fn register_recv_waker(&mut self, waker: &Waker) {
  600. self.rx_waker.register(waker)
  601. }
  602. /// Register a waker for send operations.
  603. ///
  604. /// The waker is woken on state changes that might affect the return value
  605. /// of `send` method calls, such as space becoming available in the transmit
  606. /// buffer, or the socket closing.
  607. ///
  608. /// Notes:
  609. ///
  610. /// - Only one waker can be registered at a time. If another waker was previously registered,
  611. /// it is overwritten and will no longer be woken.
  612. /// - The Waker is woken only once. Once woken, you must register it again to receive more wakes.
  613. /// - "Spurious wakes" are allowed: a wake doesn't guarantee the result of `send` has
  614. /// necessarily changed.
  615. #[cfg(feature = "async")]
  616. pub fn register_send_waker(&mut self, waker: &Waker) {
  617. self.tx_waker.register(waker)
  618. }
  619. /// Return the timeout duration.
  620. ///
  621. /// See also the [set_timeout](#method.set_timeout) method.
  622. pub fn timeout(&self) -> Option<Duration> {
  623. self.timeout
  624. }
  625. /// Return the ACK delay duration.
  626. ///
  627. /// See also the [set_ack_delay](#method.set_ack_delay) method.
  628. pub fn ack_delay(&self) -> Option<Duration> {
  629. self.ack_delay
  630. }
  631. /// Return whether Nagle's Algorithm is enabled.
  632. ///
  633. /// See also the [set_nagle_enabled](#method.set_nagle_enabled) method.
  634. pub fn nagle_enabled(&self) -> bool {
  635. self.nagle
  636. }
  637. /// Return the current window field value, including scaling according to RFC 1323.
  638. ///
  639. /// Used in internal calculations as well as packet generation.
  640. #[inline]
  641. fn scaled_window(&self) -> u16 {
  642. u16::try_from(self.rx_buffer.window() >> self.remote_win_shift).unwrap_or(u16::MAX)
  643. }
  644. /// Return the last window field value, including scaling according to RFC 1323.
  645. ///
  646. /// Used in internal calculations as well as packet generation.
  647. ///
  648. /// Unlike `remote_last_win`, we take into account new packets received (but not acknowledged)
  649. /// since the last window update and adjust the window length accordingly. This ensures a fair
  650. /// comparison between the last window length and the new window length we're going to
  651. /// advertise.
  652. #[inline]
  653. fn last_scaled_window(&self) -> Option<u16> {
  654. let last_ack = self.remote_last_ack?;
  655. let next_ack = self.remote_seq_no + self.rx_buffer.len();
  656. let last_win = (self.remote_last_win as usize) << self.remote_win_shift;
  657. let last_win_adjusted = last_ack + last_win - next_ack;
  658. Some(u16::try_from(last_win_adjusted >> self.remote_win_shift).unwrap_or(u16::MAX))
  659. }
  660. /// Set the timeout duration.
  661. ///
  662. /// A socket with a timeout duration set will abort the connection if either of the following
  663. /// occurs:
  664. ///
  665. /// * After a [connect](#method.connect) call, the remote endpoint does not respond within
  666. /// the specified duration;
  667. /// * After establishing a connection, there is data in the transmit buffer and the remote
  668. /// endpoint exceeds the specified duration between any two packets it sends;
  669. /// * After enabling [keep-alive](#method.set_keep_alive), the remote endpoint exceeds
  670. /// the specified duration between any two packets it sends.
  671. pub fn set_timeout(&mut self, duration: Option<Duration>) {
  672. self.timeout = duration
  673. }
  674. /// Set the ACK delay duration.
  675. ///
  676. /// By default, the ACK delay is set to 10ms.
  677. pub fn set_ack_delay(&mut self, duration: Option<Duration>) {
  678. self.ack_delay = duration
  679. }
  680. /// Enable or disable Nagle's Algorithm.
  681. ///
  682. /// Also known as "tinygram prevention". By default, it is enabled.
  683. /// Disabling it is equivalent to Linux's TCP_NODELAY flag.
  684. ///
  685. /// When enabled, Nagle's Algorithm prevents sending segments smaller than MSS if
  686. /// there is data in flight (sent but not acknowledged). In other words, it ensures
  687. /// at most only one segment smaller than MSS is in flight at a time.
  688. ///
  689. /// It ensures better network utilization by preventing sending many very small packets,
  690. /// at the cost of increased latency in some situations, particularly when the remote peer
  691. /// has ACK delay enabled.
  692. pub fn set_nagle_enabled(&mut self, enabled: bool) {
  693. self.nagle = enabled
  694. }
  695. /// Return the keep-alive interval.
  696. ///
  697. /// See also the [set_keep_alive](#method.set_keep_alive) method.
  698. pub fn keep_alive(&self) -> Option<Duration> {
  699. self.keep_alive
  700. }
  701. /// Set the keep-alive interval.
  702. ///
  703. /// An idle socket with a keep-alive interval set will transmit a "keep-alive ACK" packet
  704. /// every time it receives no communication during that interval. As a result, three things
  705. /// may happen:
  706. ///
  707. /// * The remote endpoint is fine and answers with an ACK packet.
  708. /// * The remote endpoint has rebooted and answers with an RST packet.
  709. /// * The remote endpoint has crashed and does not answer.
  710. ///
  711. /// The keep-alive functionality together with the timeout functionality allows to react
  712. /// to these error conditions.
  713. pub fn set_keep_alive(&mut self, interval: Option<Duration>) {
  714. self.keep_alive = interval;
  715. if self.keep_alive.is_some() {
  716. // If the connection is idle and we've just set the option, it would not take effect
  717. // until the next packet, unless we wind up the timer explicitly.
  718. self.timer.set_keep_alive();
  719. }
  720. }
  721. /// Return the time-to-live (IPv4) or hop limit (IPv6) value used in outgoing packets.
  722. ///
  723. /// See also the [set_hop_limit](#method.set_hop_limit) method
  724. pub fn hop_limit(&self) -> Option<u8> {
  725. self.hop_limit
  726. }
  727. /// Set the time-to-live (IPv4) or hop limit (IPv6) value used in outgoing packets.
  728. ///
  729. /// A socket without an explicitly set hop limit value uses the default [IANA recommended]
  730. /// value (64).
  731. ///
  732. /// # Panics
  733. ///
  734. /// This function panics if a hop limit value of 0 is given. See [RFC 1122 § 3.2.1.7].
  735. ///
  736. /// [IANA recommended]: https://www.iana.org/assignments/ip-parameters/ip-parameters.xhtml
  737. /// [RFC 1122 § 3.2.1.7]: https://tools.ietf.org/html/rfc1122#section-3.2.1.7
  738. pub fn set_hop_limit(&mut self, hop_limit: Option<u8>) {
  739. // A host MUST NOT send a datagram with a hop limit value of 0
  740. if let Some(0) = hop_limit {
  741. panic!("the time-to-live value of a packet must not be zero")
  742. }
  743. self.hop_limit = hop_limit
  744. }
  745. /// Return the listen endpoint
  746. #[inline]
  747. pub fn listen_endpoint(&self) -> IpListenEndpoint {
  748. self.listen_endpoint
  749. }
  750. /// Return the local endpoint, or None if not connected.
  751. #[inline]
  752. pub fn local_endpoint(&self) -> Option<IpEndpoint> {
  753. Some(self.tuple?.local)
  754. }
  755. /// Return the remote endpoint, or None if not connected.
  756. #[inline]
  757. pub fn remote_endpoint(&self) -> Option<IpEndpoint> {
  758. Some(self.tuple?.remote)
  759. }
  760. /// Return the connection state, in terms of the TCP state machine.
  761. #[inline]
  762. pub fn state(&self) -> State {
  763. self.state
  764. }
  765. fn reset(&mut self) {
  766. let rx_cap_log2 =
  767. mem::size_of::<usize>() * 8 - self.rx_buffer.capacity().leading_zeros() as usize;
  768. self.state = State::Closed;
  769. self.timer = Timer::new();
  770. self.rtte = RttEstimator::default();
  771. self.assembler = Assembler::new();
  772. self.tx_buffer.clear();
  773. self.rx_buffer.clear();
  774. self.rx_fin_received = false;
  775. self.listen_endpoint = IpListenEndpoint::default();
  776. self.tuple = None;
  777. self.local_seq_no = TcpSeqNumber::default();
  778. self.remote_seq_no = TcpSeqNumber::default();
  779. self.remote_last_seq = TcpSeqNumber::default();
  780. self.remote_last_ack = None;
  781. self.remote_last_win = 0;
  782. self.remote_win_len = 0;
  783. self.remote_win_scale = None;
  784. self.remote_win_shift = rx_cap_log2.saturating_sub(16) as u8;
  785. self.remote_mss = DEFAULT_MSS;
  786. self.remote_last_ts = None;
  787. self.ack_delay_timer = AckDelayTimer::Idle;
  788. self.challenge_ack_timer = Instant::from_secs(0);
  789. #[cfg(feature = "async")]
  790. {
  791. self.rx_waker.wake();
  792. self.tx_waker.wake();
  793. }
  794. }
  795. /// Start listening on the given endpoint.
  796. ///
  797. /// This function returns `Err(Error::InvalidState)` if the socket was already open
  798. /// (see [is_open](#method.is_open)), and `Err(Error::Unaddressable)`
  799. /// if the port in the given endpoint is zero.
  800. pub fn listen<T>(&mut self, local_endpoint: T) -> Result<(), ListenError>
  801. where
  802. T: Into<IpListenEndpoint>,
  803. {
  804. let local_endpoint = local_endpoint.into();
  805. if local_endpoint.port == 0 {
  806. return Err(ListenError::Unaddressable);
  807. }
  808. if self.is_open() {
  809. // If we were already listening to same endpoint there is nothing to do; exit early.
  810. //
  811. // In the past listening on an socket that was already listening was an error,
  812. // however this makes writing an acceptor loop with multiple sockets impossible.
  813. // Without this early exit, if you tried to listen on a socket that's already listening you'll
  814. // immediately get an error. The only way around this is to abort the socket first
  815. // before listening again, but this means that incoming connections can actually
  816. // get aborted between the abort() and the next listen().
  817. if matches!(self.state, State::Listen) && self.listen_endpoint == local_endpoint {
  818. return Ok(());
  819. } else {
  820. return Err(ListenError::InvalidState);
  821. }
  822. }
  823. self.reset();
  824. self.listen_endpoint = local_endpoint;
  825. self.tuple = None;
  826. self.set_state(State::Listen);
  827. Ok(())
  828. }
  829. /// Connect to a given endpoint.
  830. ///
  831. /// The local port must be provided explicitly. Assuming `fn get_ephemeral_port() -> u16`
  832. /// allocates a port between 49152 and 65535, a connection may be established as follows:
  833. ///
  834. /// ```no_run
  835. /// # #[cfg(all(
  836. /// # feature = "medium-ethernet",
  837. /// # feature = "proto-ipv4",
  838. /// # ))]
  839. /// # {
  840. /// # use smoltcp::socket::tcp::{Socket, SocketBuffer};
  841. /// # use smoltcp::iface::Interface;
  842. /// # use smoltcp::wire::IpAddress;
  843. /// #
  844. /// # fn get_ephemeral_port() -> u16 {
  845. /// # 49152
  846. /// # }
  847. /// #
  848. /// # let mut socket = Socket::new(
  849. /// # SocketBuffer::new(vec![0; 1200]),
  850. /// # SocketBuffer::new(vec![0; 1200])
  851. /// # );
  852. /// #
  853. /// # let mut iface: Interface = todo!();
  854. /// #
  855. /// socket.connect(
  856. /// iface.context(),
  857. /// (IpAddress::v4(10, 0, 0, 1), 80),
  858. /// get_ephemeral_port()
  859. /// ).unwrap();
  860. /// # }
  861. /// ```
  862. ///
  863. /// The local address may optionally be provided.
  864. ///
  865. /// This function returns an error if the socket was open; see [is_open](#method.is_open).
  866. /// It also returns an error if the local or remote port is zero, or if the remote address
  867. /// is unspecified.
  868. pub fn connect<T, U>(
  869. &mut self,
  870. cx: &mut Context,
  871. remote_endpoint: T,
  872. local_endpoint: U,
  873. ) -> Result<(), ConnectError>
  874. where
  875. T: Into<IpEndpoint>,
  876. U: Into<IpListenEndpoint>,
  877. {
  878. let remote_endpoint: IpEndpoint = remote_endpoint.into();
  879. let local_endpoint: IpListenEndpoint = local_endpoint.into();
  880. if self.is_open() {
  881. return Err(ConnectError::InvalidState);
  882. }
  883. if remote_endpoint.port == 0 || remote_endpoint.addr.is_unspecified() {
  884. return Err(ConnectError::Unaddressable);
  885. }
  886. if local_endpoint.port == 0 {
  887. return Err(ConnectError::Unaddressable);
  888. }
  889. // If local address is not provided, choose it automatically.
  890. let local_endpoint = IpEndpoint {
  891. addr: match local_endpoint.addr {
  892. Some(addr) => {
  893. if addr.is_unspecified() {
  894. return Err(ConnectError::Unaddressable);
  895. }
  896. addr
  897. }
  898. None => cx
  899. .get_source_address(&remote_endpoint.addr)
  900. .ok_or(ConnectError::Unaddressable)?,
  901. },
  902. port: local_endpoint.port,
  903. };
  904. if local_endpoint.addr.version() != remote_endpoint.addr.version() {
  905. return Err(ConnectError::Unaddressable);
  906. }
  907. self.reset();
  908. self.tuple = Some(Tuple {
  909. local: local_endpoint,
  910. remote: remote_endpoint,
  911. });
  912. self.set_state(State::SynSent);
  913. let seq = Self::random_seq_no(cx);
  914. self.local_seq_no = seq;
  915. self.remote_last_seq = seq;
  916. Ok(())
  917. }
  918. #[cfg(test)]
  919. fn random_seq_no(_cx: &mut Context) -> TcpSeqNumber {
  920. TcpSeqNumber(10000)
  921. }
  922. #[cfg(not(test))]
  923. fn random_seq_no(cx: &mut Context) -> TcpSeqNumber {
  924. TcpSeqNumber(cx.rand().rand_u32() as i32)
  925. }
  926. /// Close the transmit half of the full-duplex connection.
  927. ///
  928. /// Note that there is no corresponding function for the receive half of the full-duplex
  929. /// connection; only the remote end can close it. If you no longer wish to receive any
  930. /// data and would like to reuse the socket right away, use [abort](#method.abort).
  931. pub fn close(&mut self) {
  932. match self.state {
  933. // In the LISTEN state there is no established connection.
  934. State::Listen => self.set_state(State::Closed),
  935. // In the SYN-SENT state the remote endpoint is not yet synchronized and, upon
  936. // receiving an RST, will abort the connection.
  937. State::SynSent => self.set_state(State::Closed),
  938. // In the SYN-RECEIVED, ESTABLISHED and CLOSE-WAIT states the transmit half
  939. // of the connection is open, and needs to be explicitly closed with a FIN.
  940. State::SynReceived | State::Established => self.set_state(State::FinWait1),
  941. State::CloseWait => self.set_state(State::LastAck),
  942. // In the FIN-WAIT-1, FIN-WAIT-2, CLOSING, LAST-ACK, TIME-WAIT and CLOSED states,
  943. // the transmit half of the connection is already closed, and no further
  944. // action is needed.
  945. State::FinWait1
  946. | State::FinWait2
  947. | State::Closing
  948. | State::TimeWait
  949. | State::LastAck
  950. | State::Closed => (),
  951. }
  952. }
  953. /// Aborts the connection, if any.
  954. ///
  955. /// This function instantly closes the socket. One reset packet will be sent to the remote
  956. /// endpoint.
  957. ///
  958. /// In terms of the TCP state machine, the socket may be in any state and is moved to
  959. /// the `CLOSED` state.
  960. pub fn abort(&mut self) {
  961. self.set_state(State::Closed);
  962. }
  963. /// Return whether the socket is passively listening for incoming connections.
  964. ///
  965. /// In terms of the TCP state machine, the socket must be in the `LISTEN` state.
  966. #[inline]
  967. pub fn is_listening(&self) -> bool {
  968. match self.state {
  969. State::Listen => true,
  970. _ => false,
  971. }
  972. }
  973. /// Return whether the socket is open.
  974. ///
  975. /// This function returns true if the socket will process incoming or dispatch outgoing
  976. /// packets. Note that this does not mean that it is possible to send or receive data through
  977. /// the socket; for that, use [can_send](#method.can_send) or [can_recv](#method.can_recv).
  978. ///
  979. /// In terms of the TCP state machine, the socket must not be in the `CLOSED`
  980. /// or `TIME-WAIT` states.
  981. #[inline]
  982. pub fn is_open(&self) -> bool {
  983. match self.state {
  984. State::Closed => false,
  985. State::TimeWait => false,
  986. _ => true,
  987. }
  988. }
  989. /// Return whether a connection is active.
  990. ///
  991. /// This function returns true if the socket is actively exchanging packets with
  992. /// a remote endpoint. Note that this does not mean that it is possible to send or receive
  993. /// data through the socket; for that, use [can_send](#method.can_send) or
  994. /// [can_recv](#method.can_recv).
  995. ///
  996. /// If a connection is established, [abort](#method.close) will send a reset to
  997. /// the remote endpoint.
  998. ///
  999. /// In terms of the TCP state machine, the socket must not be in the `CLOSED`, `TIME-WAIT`,
  1000. /// or `LISTEN` state.
  1001. #[inline]
  1002. pub fn is_active(&self) -> bool {
  1003. match self.state {
  1004. State::Closed => false,
  1005. State::TimeWait => false,
  1006. State::Listen => false,
  1007. _ => true,
  1008. }
  1009. }
  1010. /// Return whether the transmit half of the full-duplex connection is open.
  1011. ///
  1012. /// This function returns true if it's possible to send data and have it arrive
  1013. /// to the remote endpoint. However, it does not make any guarantees about the state
  1014. /// of the transmit buffer, and even if it returns true, [send](#method.send) may
  1015. /// not be able to enqueue any octets.
  1016. ///
  1017. /// In terms of the TCP state machine, the socket must be in the `ESTABLISHED` or
  1018. /// `CLOSE-WAIT` state.
  1019. #[inline]
  1020. pub fn may_send(&self) -> bool {
  1021. match self.state {
  1022. State::Established => true,
  1023. // In CLOSE-WAIT, the remote endpoint has closed our receive half of the connection
  1024. // but we still can transmit indefinitely.
  1025. State::CloseWait => true,
  1026. _ => false,
  1027. }
  1028. }
  1029. /// Return whether the receive half of the full-duplex connection is open.
  1030. ///
  1031. /// This function returns true if it's possible to receive data from the remote endpoint.
  1032. /// It will return true while there is data in the receive buffer, and if there isn't,
  1033. /// as long as the remote endpoint has not closed the connection.
  1034. ///
  1035. /// In terms of the TCP state machine, the socket must be in the `ESTABLISHED`,
  1036. /// `FIN-WAIT-1`, or `FIN-WAIT-2` state, or have data in the receive buffer instead.
  1037. #[inline]
  1038. pub fn may_recv(&self) -> bool {
  1039. match self.state {
  1040. State::Established => true,
  1041. // In FIN-WAIT-1/2, we have closed our transmit half of the connection but
  1042. // we still can receive indefinitely.
  1043. State::FinWait1 | State::FinWait2 => true,
  1044. // If we have something in the receive buffer, we can receive that.
  1045. _ if !self.rx_buffer.is_empty() => true,
  1046. _ => false,
  1047. }
  1048. }
  1049. /// Check whether the transmit half of the full-duplex connection is open
  1050. /// (see [may_send](#method.may_send)), and the transmit buffer is not full.
  1051. #[inline]
  1052. pub fn can_send(&self) -> bool {
  1053. if !self.may_send() {
  1054. return false;
  1055. }
  1056. !self.tx_buffer.is_full()
  1057. }
  1058. /// Return the maximum number of bytes inside the recv buffer.
  1059. #[inline]
  1060. pub fn recv_capacity(&self) -> usize {
  1061. self.rx_buffer.capacity()
  1062. }
  1063. /// Return the maximum number of bytes inside the transmit buffer.
  1064. #[inline]
  1065. pub fn send_capacity(&self) -> usize {
  1066. self.tx_buffer.capacity()
  1067. }
  1068. /// Check whether the receive half of the full-duplex connection buffer is open
  1069. /// (see [may_recv](#method.may_recv)), and the receive buffer is not empty.
  1070. #[inline]
  1071. pub fn can_recv(&self) -> bool {
  1072. if !self.may_recv() {
  1073. return false;
  1074. }
  1075. !self.rx_buffer.is_empty()
  1076. }
  1077. fn send_impl<'b, F, R>(&'b mut self, f: F) -> Result<R, SendError>
  1078. where
  1079. F: FnOnce(&'b mut SocketBuffer<'a>) -> (usize, R),
  1080. {
  1081. if !self.may_send() {
  1082. return Err(SendError::InvalidState);
  1083. }
  1084. let old_length = self.tx_buffer.len();
  1085. let (size, result) = f(&mut self.tx_buffer);
  1086. if size > 0 {
  1087. // The connection might have been idle for a long time, and so remote_last_ts
  1088. // would be far in the past. Unless we clear it here, we'll abort the connection
  1089. // down over in dispatch() by erroneously detecting it as timed out.
  1090. if old_length == 0 {
  1091. self.remote_last_ts = None
  1092. }
  1093. // if remote win is zero and we go from having no data to some data pending to
  1094. // send, start the zero window probe timer.
  1095. if self.remote_win_len == 0 && self.timer.is_idle() {
  1096. let delay = self.rtte.retransmission_timeout();
  1097. tcp_trace!("starting zero-window-probe timer for t+{}", delay);
  1098. // We don't have access to the current time here, so use Instant::ZERO instead.
  1099. // this will cause the first ZWP to be sent immediately, but that's okay.
  1100. self.timer.set_for_zero_window_probe(Instant::ZERO, delay);
  1101. }
  1102. #[cfg(any(test, feature = "verbose"))]
  1103. tcp_trace!(
  1104. "tx buffer: enqueueing {} octets (now {})",
  1105. size,
  1106. old_length + size
  1107. );
  1108. }
  1109. Ok(result)
  1110. }
  1111. /// Call `f` with the largest contiguous slice of octets in the transmit buffer,
  1112. /// and enqueue the amount of elements returned by `f`.
  1113. ///
  1114. /// This function returns `Err(Error::Illegal)` if the transmit half of
  1115. /// the connection is not open; see [may_send](#method.may_send).
  1116. pub fn send<'b, F, R>(&'b mut self, f: F) -> Result<R, SendError>
  1117. where
  1118. F: FnOnce(&'b mut [u8]) -> (usize, R),
  1119. {
  1120. self.send_impl(|tx_buffer| tx_buffer.enqueue_many_with(f))
  1121. }
  1122. /// Enqueue a sequence of octets to be sent, and fill it from a slice.
  1123. ///
  1124. /// This function returns the amount of octets actually enqueued, which is limited
  1125. /// by the amount of free space in the transmit buffer; down to zero.
  1126. ///
  1127. /// See also [send](#method.send).
  1128. pub fn send_slice(&mut self, data: &[u8]) -> Result<usize, SendError> {
  1129. self.send_impl(|tx_buffer| {
  1130. let size = tx_buffer.enqueue_slice(data);
  1131. (size, size)
  1132. })
  1133. }
  1134. fn recv_error_check(&mut self) -> Result<(), RecvError> {
  1135. // We may have received some data inside the initial SYN, but until the connection
  1136. // is fully open we must not dequeue any data, as it may be overwritten by e.g.
  1137. // another (stale) SYN. (We do not support TCP Fast Open.)
  1138. if !self.may_recv() {
  1139. if self.rx_fin_received {
  1140. return Err(RecvError::Finished);
  1141. }
  1142. return Err(RecvError::InvalidState);
  1143. }
  1144. Ok(())
  1145. }
  1146. fn recv_impl<'b, F, R>(&'b mut self, f: F) -> Result<R, RecvError>
  1147. where
  1148. F: FnOnce(&'b mut SocketBuffer<'a>) -> (usize, R),
  1149. {
  1150. self.recv_error_check()?;
  1151. let _old_length = self.rx_buffer.len();
  1152. let (size, result) = f(&mut self.rx_buffer);
  1153. self.remote_seq_no += size;
  1154. if size > 0 {
  1155. #[cfg(any(test, feature = "verbose"))]
  1156. tcp_trace!(
  1157. "rx buffer: dequeueing {} octets (now {})",
  1158. size,
  1159. _old_length - size
  1160. );
  1161. }
  1162. Ok(result)
  1163. }
  1164. /// Call `f` with the largest contiguous slice of octets in the receive buffer,
  1165. /// and dequeue the amount of elements returned by `f`.
  1166. ///
  1167. /// This function errors if the receive half of the connection is not open.
  1168. ///
  1169. /// If the receive half has been gracefully closed (with a FIN packet), `Err(Error::Finished)`
  1170. /// is returned. In this case, the previously received data is guaranteed to be complete.
  1171. ///
  1172. /// In all other cases, `Err(Error::Illegal)` is returned and previously received data (if any)
  1173. /// may be incomplete (truncated).
  1174. pub fn recv<'b, F, R>(&'b mut self, f: F) -> Result<R, RecvError>
  1175. where
  1176. F: FnOnce(&'b mut [u8]) -> (usize, R),
  1177. {
  1178. self.recv_impl(|rx_buffer| rx_buffer.dequeue_many_with(f))
  1179. }
  1180. /// Dequeue a sequence of received octets, and fill a slice from it.
  1181. ///
  1182. /// This function returns the amount of octets actually dequeued, which is limited
  1183. /// by the amount of occupied space in the receive buffer; down to zero.
  1184. ///
  1185. /// See also [recv](#method.recv).
  1186. pub fn recv_slice(&mut self, data: &mut [u8]) -> Result<usize, RecvError> {
  1187. self.recv_impl(|rx_buffer| {
  1188. let size = rx_buffer.dequeue_slice(data);
  1189. (size, size)
  1190. })
  1191. }
  1192. /// Peek at a sequence of received octets without removing them from
  1193. /// the receive buffer, and return a pointer to it.
  1194. ///
  1195. /// This function otherwise behaves identically to [recv](#method.recv).
  1196. pub fn peek(&mut self, size: usize) -> Result<&[u8], RecvError> {
  1197. self.recv_error_check()?;
  1198. let buffer = self.rx_buffer.get_allocated(0, size);
  1199. if !buffer.is_empty() {
  1200. #[cfg(any(test, feature = "verbose"))]
  1201. tcp_trace!("rx buffer: peeking at {} octets", buffer.len());
  1202. }
  1203. Ok(buffer)
  1204. }
  1205. /// Peek at a sequence of received octets without removing them from
  1206. /// the receive buffer, and fill a slice from it.
  1207. ///
  1208. /// This function otherwise behaves identically to [recv_slice](#method.recv_slice).
  1209. pub fn peek_slice(&mut self, data: &mut [u8]) -> Result<usize, RecvError> {
  1210. Ok(self.rx_buffer.read_allocated(0, data))
  1211. }
  1212. /// Return the amount of octets queued in the transmit buffer.
  1213. ///
  1214. /// Note that the Berkeley sockets interface does not have an equivalent of this API.
  1215. pub fn send_queue(&self) -> usize {
  1216. self.tx_buffer.len()
  1217. }
  1218. /// Return the amount of octets queued in the receive buffer. This value can be larger than
  1219. /// the slice read by the next `recv` or `peek` call because it includes all queued octets,
  1220. /// and not only the octets that may be returned as a contiguous slice.
  1221. ///
  1222. /// Note that the Berkeley sockets interface does not have an equivalent of this API.
  1223. pub fn recv_queue(&self) -> usize {
  1224. self.rx_buffer.len()
  1225. }
  1226. fn set_state(&mut self, state: State) {
  1227. if self.state != state {
  1228. tcp_trace!("state={}=>{}", self.state, state);
  1229. }
  1230. self.state = state;
  1231. #[cfg(feature = "async")]
  1232. {
  1233. // Wake all tasks waiting. Even if we haven't received/sent data, this
  1234. // is needed because return values of functions may change depending on the state.
  1235. // For example, a pending read has to fail with an error if the socket is closed.
  1236. self.rx_waker.wake();
  1237. self.tx_waker.wake();
  1238. }
  1239. }
  1240. pub(crate) fn reply(ip_repr: &IpRepr, repr: &TcpRepr) -> (IpRepr, TcpRepr<'static>) {
  1241. let reply_repr = TcpRepr {
  1242. src_port: repr.dst_port,
  1243. dst_port: repr.src_port,
  1244. control: TcpControl::None,
  1245. seq_number: TcpSeqNumber(0),
  1246. ack_number: None,
  1247. window_len: 0,
  1248. window_scale: None,
  1249. max_seg_size: None,
  1250. sack_permitted: false,
  1251. sack_ranges: [None, None, None],
  1252. timestamp: None,
  1253. payload: &[],
  1254. };
  1255. let ip_reply_repr = IpRepr::new(
  1256. ip_repr.dst_addr(),
  1257. ip_repr.src_addr(),
  1258. IpProtocol::Tcp,
  1259. reply_repr.buffer_len(),
  1260. 64,
  1261. );
  1262. (ip_reply_repr, reply_repr)
  1263. }
  1264. pub(crate) fn rst_reply(ip_repr: &IpRepr, repr: &TcpRepr) -> (IpRepr, TcpRepr<'static>) {
  1265. debug_assert!(repr.control != TcpControl::Rst);
  1266. let (ip_reply_repr, mut reply_repr) = Self::reply(ip_repr, repr);
  1267. // See https://www.snellman.net/blog/archive/2016-02-01-tcp-rst/ for explanation
  1268. // of why we sometimes send an RST and sometimes an RST|ACK
  1269. reply_repr.control = TcpControl::Rst;
  1270. reply_repr.seq_number = repr.ack_number.unwrap_or_default();
  1271. if repr.control == TcpControl::Syn && repr.ack_number.is_none() {
  1272. reply_repr.ack_number = Some(repr.seq_number + repr.segment_len());
  1273. }
  1274. (ip_reply_repr, reply_repr)
  1275. }
  1276. fn ack_reply(&mut self, ip_repr: &IpRepr, repr: &TcpRepr) -> (IpRepr, TcpRepr<'static>) {
  1277. let (mut ip_reply_repr, mut reply_repr) = Self::reply(ip_repr, repr);
  1278. reply_repr.timestamp = repr
  1279. .timestamp
  1280. .and_then(|tcp_ts| tcp_ts.generate_reply(self.tsval_generator));
  1281. // From RFC 793:
  1282. // [...] an empty acknowledgment segment containing the current send-sequence number
  1283. // and an acknowledgment indicating the next sequence number expected
  1284. // to be received.
  1285. reply_repr.seq_number = self.remote_last_seq;
  1286. reply_repr.ack_number = Some(self.remote_seq_no + self.rx_buffer.len());
  1287. self.remote_last_ack = reply_repr.ack_number;
  1288. // From RFC 1323:
  1289. // The window field [...] of every outgoing segment, with the exception of SYN
  1290. // segments, is right-shifted by [advertised scale value] bits[...]
  1291. reply_repr.window_len = self.scaled_window();
  1292. self.remote_last_win = reply_repr.window_len;
  1293. // If the remote supports selective acknowledgement, add the option to the outgoing
  1294. // segment.
  1295. if self.remote_has_sack {
  1296. net_debug!("sending sACK option with current assembler ranges");
  1297. // RFC 2018: The first SACK block (i.e., the one immediately following the kind and
  1298. // length fields in the option) MUST specify the contiguous block of data containing
  1299. // the segment which triggered this ACK, unless that segment advanced the
  1300. // Acknowledgment Number field in the header.
  1301. reply_repr.sack_ranges[0] = None;
  1302. if let Some(last_seg_seq) = self.local_rx_last_seq.map(|s| s.0 as u32) {
  1303. reply_repr.sack_ranges[0] = self
  1304. .assembler
  1305. .iter_data(reply_repr.ack_number.map(|s| s.0 as usize).unwrap_or(0))
  1306. .map(|(left, right)| (left as u32, right as u32))
  1307. .find(|(left, right)| *left <= last_seg_seq && *right >= last_seg_seq);
  1308. }
  1309. if reply_repr.sack_ranges[0].is_none() {
  1310. // The matching segment was removed from the assembler, meaning the acknowledgement
  1311. // number has advanced, or there was no previous sACK.
  1312. //
  1313. // While the RFC says we SHOULD keep a list of reported sACK ranges, and iterate
  1314. // through those, that is currently infeasible. Instead, we offer the range with
  1315. // the lowest sequence number (if one exists) to hint at what segments would
  1316. // most quickly advance the acknowledgement number.
  1317. reply_repr.sack_ranges[0] = self
  1318. .assembler
  1319. .iter_data(reply_repr.ack_number.map(|s| s.0 as usize).unwrap_or(0))
  1320. .map(|(left, right)| (left as u32, right as u32))
  1321. .next();
  1322. }
  1323. }
  1324. // Since the sACK option may have changed the length of the payload, update that.
  1325. ip_reply_repr.set_payload_len(reply_repr.buffer_len());
  1326. (ip_reply_repr, reply_repr)
  1327. }
  1328. fn challenge_ack_reply(
  1329. &mut self,
  1330. cx: &mut Context,
  1331. ip_repr: &IpRepr,
  1332. repr: &TcpRepr,
  1333. ) -> Option<(IpRepr, TcpRepr<'static>)> {
  1334. if cx.now() < self.challenge_ack_timer {
  1335. return None;
  1336. }
  1337. // Rate-limit to 1 per second max.
  1338. self.challenge_ack_timer = cx.now() + Duration::from_secs(1);
  1339. Some(self.ack_reply(ip_repr, repr))
  1340. }
  1341. pub(crate) fn accepts(&self, _cx: &mut Context, ip_repr: &IpRepr, repr: &TcpRepr) -> bool {
  1342. if self.state == State::Closed {
  1343. return false;
  1344. }
  1345. // If we're still listening for SYNs and the packet has an ACK or a RST,
  1346. // it cannot be destined to this socket, but another one may well listen
  1347. // on the same local endpoint.
  1348. if self.state == State::Listen
  1349. && (repr.ack_number.is_some() || repr.control == TcpControl::Rst)
  1350. {
  1351. return false;
  1352. }
  1353. if let Some(tuple) = &self.tuple {
  1354. // Reject packets not matching the 4-tuple
  1355. ip_repr.dst_addr() == tuple.local.addr
  1356. && repr.dst_port == tuple.local.port
  1357. && ip_repr.src_addr() == tuple.remote.addr
  1358. && repr.src_port == tuple.remote.port
  1359. } else {
  1360. // We're listening, reject packets not matching the listen endpoint.
  1361. let addr_ok = match self.listen_endpoint.addr {
  1362. Some(addr) => ip_repr.dst_addr() == addr,
  1363. None => true,
  1364. };
  1365. addr_ok && repr.dst_port != 0 && repr.dst_port == self.listen_endpoint.port
  1366. }
  1367. }
  1368. pub(crate) fn process(
  1369. &mut self,
  1370. cx: &mut Context,
  1371. ip_repr: &IpRepr,
  1372. repr: &TcpRepr,
  1373. ) -> Option<(IpRepr, TcpRepr<'static>)> {
  1374. debug_assert!(self.accepts(cx, ip_repr, repr));
  1375. // Consider how much the sequence number space differs from the transmit buffer space.
  1376. let (sent_syn, sent_fin) = match self.state {
  1377. // In SYN-SENT or SYN-RECEIVED, we've just sent a SYN.
  1378. State::SynSent | State::SynReceived => (true, false),
  1379. // In FIN-WAIT-1, LAST-ACK, or CLOSING, we've just sent a FIN.
  1380. State::FinWait1 | State::LastAck | State::Closing => (false, true),
  1381. // In all other states we've already got acknowledgements for
  1382. // all of the control flags we sent.
  1383. _ => (false, false),
  1384. };
  1385. let control_len = (sent_syn as usize) + (sent_fin as usize);
  1386. // Reject unacceptable acknowledgements.
  1387. match (self.state, repr.control, repr.ack_number) {
  1388. // An RST received in response to initial SYN is acceptable if it acknowledges
  1389. // the initial SYN.
  1390. (State::SynSent, TcpControl::Rst, None) => {
  1391. net_debug!("unacceptable RST (expecting RST|ACK) in response to initial SYN");
  1392. return None;
  1393. }
  1394. (State::SynSent, TcpControl::Rst, Some(ack_number)) => {
  1395. if ack_number != self.local_seq_no + 1 {
  1396. net_debug!("unacceptable RST|ACK in response to initial SYN");
  1397. return None;
  1398. }
  1399. }
  1400. // Any other RST need only have a valid sequence number.
  1401. (_, TcpControl::Rst, _) => (),
  1402. // The initial SYN cannot contain an acknowledgement.
  1403. (State::Listen, _, None) => (),
  1404. // This case is handled in `accepts()`.
  1405. (State::Listen, _, Some(_)) => unreachable!(),
  1406. // SYN|ACK in the SYN-SENT state must have the exact ACK number.
  1407. (State::SynSent, TcpControl::Syn, Some(ack_number)) => {
  1408. if ack_number != self.local_seq_no + 1 {
  1409. net_debug!("unacceptable SYN|ACK in response to initial SYN");
  1410. return Some(Self::rst_reply(ip_repr, repr));
  1411. }
  1412. }
  1413. // TCP simultaneous open.
  1414. // This is required by RFC 9293, which states "A TCP implementation MUST support
  1415. // simultaneous open attempts (MUST-10)."
  1416. (State::SynSent, TcpControl::Syn, None) => (),
  1417. // ACKs in the SYN-SENT state are invalid.
  1418. (State::SynSent, TcpControl::None, Some(ack_number)) => {
  1419. // If the sequence number matches, ignore it instead of RSTing.
  1420. // I'm not sure why, I think it may be a workaround for broken TCP
  1421. // servers, or a defense against reordering. Either way, if Linux
  1422. // does it, we do too.
  1423. if ack_number == self.local_seq_no + 1 {
  1424. net_debug!(
  1425. "expecting a SYN|ACK, received an ACK with the right ack_number, ignoring."
  1426. );
  1427. return None;
  1428. }
  1429. net_debug!(
  1430. "expecting a SYN|ACK, received an ACK with the wrong ack_number, sending RST."
  1431. );
  1432. return Some(Self::rst_reply(ip_repr, repr));
  1433. }
  1434. // Anything else in the SYN-SENT state is invalid.
  1435. (State::SynSent, _, _) => {
  1436. net_debug!("expecting a SYN|ACK");
  1437. return None;
  1438. }
  1439. // Every packet after the initial SYN must be an acknowledgement.
  1440. (_, _, None) => {
  1441. net_debug!("expecting an ACK");
  1442. return None;
  1443. }
  1444. // ACK in the SYN-RECEIVED state must have the exact ACK number, or we RST it.
  1445. (State::SynReceived, _, Some(ack_number)) => {
  1446. if ack_number != self.local_seq_no + 1 {
  1447. net_debug!("unacceptable ACK in response to SYN|ACK");
  1448. return Some(Self::rst_reply(ip_repr, repr));
  1449. }
  1450. }
  1451. // Every acknowledgement must be for transmitted but unacknowledged data.
  1452. (_, _, Some(ack_number)) => {
  1453. let unacknowledged = self.tx_buffer.len() + control_len;
  1454. // Acceptable ACK range (both inclusive)
  1455. let mut ack_min = self.local_seq_no;
  1456. let ack_max = self.local_seq_no + unacknowledged;
  1457. // If we have sent a SYN, it MUST be acknowledged.
  1458. if sent_syn {
  1459. ack_min += 1;
  1460. }
  1461. if ack_number < ack_min {
  1462. net_debug!(
  1463. "duplicate ACK ({} not in {}...{})",
  1464. ack_number,
  1465. ack_min,
  1466. ack_max
  1467. );
  1468. return None;
  1469. }
  1470. if ack_number > ack_max {
  1471. net_debug!(
  1472. "unacceptable ACK ({} not in {}...{})",
  1473. ack_number,
  1474. ack_min,
  1475. ack_max
  1476. );
  1477. return self.challenge_ack_reply(cx, ip_repr, repr);
  1478. }
  1479. }
  1480. }
  1481. let window_start = self.remote_seq_no + self.rx_buffer.len();
  1482. let window_end = self.remote_seq_no + self.rx_buffer.capacity();
  1483. let segment_start = repr.seq_number;
  1484. let segment_end = repr.seq_number + repr.payload.len();
  1485. let (payload, payload_offset) = match self.state {
  1486. // In LISTEN and SYN-SENT states, we have not yet synchronized with the remote end.
  1487. State::Listen | State::SynSent => (&[][..], 0),
  1488. _ => {
  1489. // https://www.rfc-editor.org/rfc/rfc9293.html#name-segment-acceptability-tests
  1490. let segment_in_window = match (
  1491. segment_start == segment_end,
  1492. window_start == window_end,
  1493. ) {
  1494. (true, _) if segment_end == window_start - 1 => {
  1495. net_debug!(
  1496. "received a keep-alive or window probe packet, will send an ACK"
  1497. );
  1498. false
  1499. }
  1500. (true, true) => {
  1501. if window_start == segment_start {
  1502. true
  1503. } else {
  1504. net_debug!(
  1505. "zero-length segment not inside zero-length window, will send an ACK."
  1506. );
  1507. false
  1508. }
  1509. }
  1510. (true, false) => {
  1511. if window_start <= segment_start && segment_start < window_end {
  1512. true
  1513. } else {
  1514. net_debug!("zero-length segment not inside window, will send an ACK.");
  1515. false
  1516. }
  1517. }
  1518. (false, true) => {
  1519. net_debug!(
  1520. "non-zero-length segment with zero receive window, will only send an ACK"
  1521. );
  1522. false
  1523. }
  1524. (false, false) => {
  1525. if (window_start <= segment_start && segment_start < window_end)
  1526. || (window_start < segment_end && segment_end <= window_end)
  1527. {
  1528. true
  1529. } else {
  1530. net_debug!(
  1531. "segment not in receive window ({}..{} not intersecting {}..{}), will send challenge ACK",
  1532. segment_start,
  1533. segment_end,
  1534. window_start,
  1535. window_end
  1536. );
  1537. false
  1538. }
  1539. }
  1540. };
  1541. if segment_in_window {
  1542. let overlap_start = window_start.max(segment_start);
  1543. let overlap_end = window_end.min(segment_end);
  1544. // the checks done above imply this.
  1545. debug_assert!(overlap_start <= overlap_end);
  1546. self.local_rx_last_seq = Some(repr.seq_number);
  1547. (
  1548. &repr.payload[overlap_start - segment_start..overlap_end - segment_start],
  1549. overlap_start - window_start,
  1550. )
  1551. } else {
  1552. // If we're in the TIME-WAIT state, restart the TIME-WAIT timeout, since
  1553. // the remote end may not have realized we've closed the connection.
  1554. if self.state == State::TimeWait {
  1555. self.timer.set_for_close(cx.now());
  1556. }
  1557. return self.challenge_ack_reply(cx, ip_repr, repr);
  1558. }
  1559. }
  1560. };
  1561. // Compute the amount of acknowledged octets, removing the SYN and FIN bits
  1562. // from the sequence space.
  1563. let mut ack_len = 0;
  1564. let mut ack_of_fin = false;
  1565. let mut ack_all = false;
  1566. if repr.control != TcpControl::Rst {
  1567. if let Some(ack_number) = repr.ack_number {
  1568. // Sequence number corresponding to the first byte in `tx_buffer`.
  1569. // This normally equals `local_seq_no`, but is 1 higher if we have sent a SYN,
  1570. // as the SYN occupies 1 sequence number "before" the data.
  1571. let tx_buffer_start_seq = self.local_seq_no + (sent_syn as usize);
  1572. if ack_number >= tx_buffer_start_seq {
  1573. ack_len = ack_number - tx_buffer_start_seq;
  1574. // We could've sent data before the FIN, so only remove FIN from the sequence
  1575. // space if all of that data is acknowledged.
  1576. if sent_fin && self.tx_buffer.len() + 1 == ack_len {
  1577. ack_len -= 1;
  1578. tcp_trace!("received ACK of FIN");
  1579. ack_of_fin = true;
  1580. }
  1581. ack_all = self.remote_last_seq <= ack_number;
  1582. }
  1583. self.rtte.on_ack(cx.now(), ack_number);
  1584. self.congestion_controller
  1585. .inner_mut()
  1586. .on_ack(cx.now(), ack_len, &self.rtte);
  1587. }
  1588. }
  1589. // Disregard control flags we don't care about or shouldn't act on yet.
  1590. let mut control = repr.control;
  1591. control = control.quash_psh();
  1592. // If a FIN is received at the end of the current segment, but
  1593. // we have a hole in the assembler before the current segment, disregard this FIN.
  1594. if control == TcpControl::Fin && window_start < segment_start {
  1595. tcp_trace!("ignoring FIN because we don't have full data yet. window_start={} segment_start={}", window_start, segment_start);
  1596. control = TcpControl::None;
  1597. }
  1598. // Validate and update the state.
  1599. match (self.state, control) {
  1600. // RSTs are not accepted in the LISTEN state.
  1601. (State::Listen, TcpControl::Rst) => return None,
  1602. // RSTs in SYN-RECEIVED flip the socket back to the LISTEN state.
  1603. // Here we need to additionally check `listen_endpoint`, because we want to make sure
  1604. // that SYN-RECEIVED was actually converted from the LISTEN state (another possible
  1605. // reason is TCP simultaneous open).
  1606. (State::SynReceived, TcpControl::Rst) if self.listen_endpoint.port != 0 => {
  1607. tcp_trace!("received RST");
  1608. self.tuple = None;
  1609. self.set_state(State::Listen);
  1610. return None;
  1611. }
  1612. // RSTs in any other state close the socket.
  1613. (_, TcpControl::Rst) => {
  1614. tcp_trace!("received RST");
  1615. self.set_state(State::Closed);
  1616. self.tuple = None;
  1617. return None;
  1618. }
  1619. // SYN packets in the LISTEN state change it to SYN-RECEIVED.
  1620. (State::Listen, TcpControl::Syn) => {
  1621. tcp_trace!("received SYN");
  1622. if let Some(max_seg_size) = repr.max_seg_size {
  1623. if max_seg_size == 0 {
  1624. tcp_trace!("received SYNACK with zero MSS, ignoring");
  1625. return None;
  1626. }
  1627. self.congestion_controller
  1628. .inner_mut()
  1629. .set_mss(max_seg_size as usize);
  1630. self.remote_mss = max_seg_size as usize
  1631. }
  1632. self.tuple = Some(Tuple {
  1633. local: IpEndpoint::new(ip_repr.dst_addr(), repr.dst_port),
  1634. remote: IpEndpoint::new(ip_repr.src_addr(), repr.src_port),
  1635. });
  1636. self.local_seq_no = Self::random_seq_no(cx);
  1637. self.remote_seq_no = repr.seq_number + 1;
  1638. self.remote_last_seq = self.local_seq_no;
  1639. self.remote_has_sack = repr.sack_permitted;
  1640. self.remote_win_scale = repr.window_scale;
  1641. // Remote doesn't support window scaling, don't do it.
  1642. if self.remote_win_scale.is_none() {
  1643. self.remote_win_shift = 0;
  1644. }
  1645. // Remote doesn't support timestamping, don't do it.
  1646. if repr.timestamp.is_none() {
  1647. self.tsval_generator = None;
  1648. }
  1649. self.set_state(State::SynReceived);
  1650. self.timer.set_for_idle(cx.now(), self.keep_alive);
  1651. }
  1652. // ACK packets in the SYN-RECEIVED state change it to ESTABLISHED.
  1653. (State::SynReceived, TcpControl::None) => {
  1654. self.set_state(State::Established);
  1655. }
  1656. // FIN packets in the SYN-RECEIVED state change it to CLOSE-WAIT.
  1657. // It's not obvious from RFC 793 that this is permitted, but
  1658. // 7th and 8th steps in the "SEGMENT ARRIVES" event describe this behavior.
  1659. (State::SynReceived, TcpControl::Fin) => {
  1660. self.remote_seq_no += 1;
  1661. self.rx_fin_received = true;
  1662. self.set_state(State::CloseWait);
  1663. }
  1664. // SYN|ACK packets in the SYN-SENT state change it to ESTABLISHED.
  1665. // SYN packets in the SYN-SENT state change it to SYN-RECEIVED.
  1666. (State::SynSent, TcpControl::Syn) => {
  1667. if repr.ack_number.is_some() {
  1668. tcp_trace!("received SYN|ACK");
  1669. } else {
  1670. tcp_trace!("received SYN");
  1671. }
  1672. if let Some(max_seg_size) = repr.max_seg_size {
  1673. if max_seg_size == 0 {
  1674. tcp_trace!("received SYNACK with zero MSS, ignoring");
  1675. return None;
  1676. }
  1677. self.remote_mss = max_seg_size as usize;
  1678. self.congestion_controller
  1679. .inner_mut()
  1680. .set_mss(self.remote_mss);
  1681. }
  1682. self.remote_seq_no = repr.seq_number + 1;
  1683. self.remote_last_seq = self.local_seq_no + 1;
  1684. self.remote_last_ack = Some(repr.seq_number);
  1685. self.remote_has_sack = repr.sack_permitted;
  1686. self.remote_win_scale = repr.window_scale;
  1687. // Remote doesn't support window scaling, don't do it.
  1688. if self.remote_win_scale.is_none() {
  1689. self.remote_win_shift = 0;
  1690. }
  1691. // Remote doesn't support timestamping, don't do it.
  1692. if repr.timestamp.is_none() {
  1693. self.tsval_generator = None;
  1694. }
  1695. if repr.ack_number.is_some() {
  1696. self.set_state(State::Established);
  1697. } else {
  1698. self.set_state(State::SynReceived);
  1699. }
  1700. }
  1701. (State::Established, TcpControl::None) => {}
  1702. // FIN packets in ESTABLISHED state indicate the remote side has closed.
  1703. (State::Established, TcpControl::Fin) => {
  1704. self.remote_seq_no += 1;
  1705. self.rx_fin_received = true;
  1706. self.set_state(State::CloseWait);
  1707. }
  1708. // ACK packets in FIN-WAIT-1 state change it to FIN-WAIT-2, if we've already
  1709. // sent everything in the transmit buffer. If not, they reset the retransmit timer.
  1710. (State::FinWait1, TcpControl::None) => {
  1711. if ack_of_fin {
  1712. self.set_state(State::FinWait2);
  1713. }
  1714. }
  1715. // FIN packets in FIN-WAIT-1 state change it to CLOSING, or to TIME-WAIT
  1716. // if they also acknowledge our FIN.
  1717. (State::FinWait1, TcpControl::Fin) => {
  1718. self.remote_seq_no += 1;
  1719. self.rx_fin_received = true;
  1720. if ack_of_fin {
  1721. self.set_state(State::TimeWait);
  1722. self.timer.set_for_close(cx.now());
  1723. } else {
  1724. self.set_state(State::Closing);
  1725. }
  1726. }
  1727. (State::FinWait2, TcpControl::None) => {}
  1728. // FIN packets in FIN-WAIT-2 state change it to TIME-WAIT.
  1729. (State::FinWait2, TcpControl::Fin) => {
  1730. self.remote_seq_no += 1;
  1731. self.rx_fin_received = true;
  1732. self.set_state(State::TimeWait);
  1733. self.timer.set_for_close(cx.now());
  1734. }
  1735. // ACK packets in CLOSING state change it to TIME-WAIT.
  1736. (State::Closing, TcpControl::None) => {
  1737. if ack_of_fin {
  1738. self.set_state(State::TimeWait);
  1739. self.timer.set_for_close(cx.now());
  1740. }
  1741. }
  1742. (State::CloseWait, TcpControl::None) => {}
  1743. // ACK packets in LAST-ACK state change it to CLOSED.
  1744. (State::LastAck, TcpControl::None) => {
  1745. if ack_of_fin {
  1746. // Clear the remote endpoint, or we'll send an RST there.
  1747. self.set_state(State::Closed);
  1748. self.tuple = None;
  1749. }
  1750. }
  1751. _ => {
  1752. net_debug!("unexpected packet {}", repr);
  1753. return None;
  1754. }
  1755. }
  1756. // Update remote state.
  1757. self.remote_last_ts = Some(cx.now());
  1758. // RFC 1323: The window field (SEG.WND) in the header of every incoming segment, with the
  1759. // exception of SYN segments, is left-shifted by Snd.Wind.Scale bits before updating SND.WND.
  1760. let scale = match repr.control {
  1761. TcpControl::Syn => 0,
  1762. _ => self.remote_win_scale.unwrap_or(0),
  1763. };
  1764. let new_remote_win_len = (repr.window_len as usize) << (scale as usize);
  1765. let is_window_update = new_remote_win_len != self.remote_win_len;
  1766. self.remote_win_len = new_remote_win_len;
  1767. self.congestion_controller
  1768. .inner_mut()
  1769. .set_remote_window(new_remote_win_len);
  1770. if ack_len > 0 {
  1771. // Dequeue acknowledged octets.
  1772. debug_assert!(self.tx_buffer.len() >= ack_len);
  1773. tcp_trace!(
  1774. "tx buffer: dequeueing {} octets (now {})",
  1775. ack_len,
  1776. self.tx_buffer.len() - ack_len
  1777. );
  1778. self.tx_buffer.dequeue_allocated(ack_len);
  1779. // There's new room available in tx_buffer, wake the waiting task if any.
  1780. #[cfg(feature = "async")]
  1781. self.tx_waker.wake();
  1782. }
  1783. if let Some(ack_number) = repr.ack_number {
  1784. // TODO: When flow control is implemented,
  1785. // refractor the following block within that implementation
  1786. // Detect and react to duplicate ACKs by:
  1787. // 1. Check if duplicate ACK and change self.local_rx_dup_acks accordingly
  1788. // 2. If exactly 3 duplicate ACKs received, set for fast retransmit
  1789. // 3. Update the last received ACK (self.local_rx_last_ack)
  1790. match self.local_rx_last_ack {
  1791. // Duplicate ACK if payload empty and ACK doesn't move send window ->
  1792. // Increment duplicate ACK count and set for retransmit if we just received
  1793. // the third duplicate ACK
  1794. Some(last_rx_ack)
  1795. if repr.payload.is_empty()
  1796. && last_rx_ack == ack_number
  1797. && ack_number < self.remote_last_seq
  1798. && !is_window_update =>
  1799. {
  1800. // Increment duplicate ACK count
  1801. self.local_rx_dup_acks = self.local_rx_dup_acks.saturating_add(1);
  1802. // Inform congestion controller of duplicate ACK
  1803. self.congestion_controller
  1804. .inner_mut()
  1805. .on_duplicate_ack(cx.now());
  1806. net_debug!(
  1807. "received duplicate ACK for seq {} (duplicate nr {}{})",
  1808. ack_number,
  1809. self.local_rx_dup_acks,
  1810. if self.local_rx_dup_acks == u8::MAX {
  1811. "+"
  1812. } else {
  1813. ""
  1814. }
  1815. );
  1816. if self.local_rx_dup_acks == 3 {
  1817. self.timer.set_for_fast_retransmit();
  1818. net_debug!("started fast retransmit");
  1819. }
  1820. }
  1821. // No duplicate ACK -> Reset state and update last received ACK
  1822. _ => {
  1823. if self.local_rx_dup_acks > 0 {
  1824. self.local_rx_dup_acks = 0;
  1825. net_debug!("reset duplicate ACK count");
  1826. }
  1827. self.local_rx_last_ack = Some(ack_number);
  1828. }
  1829. };
  1830. // We've processed everything in the incoming segment, so advance the local
  1831. // sequence number past it.
  1832. self.local_seq_no = ack_number;
  1833. // During retransmission, if an earlier segment got lost but later was
  1834. // successfully received, self.local_seq_no can move past self.remote_last_seq.
  1835. // Do not attempt to retransmit the latter segments; not only this is pointless
  1836. // in theory but also impossible in practice, since they have been already
  1837. // deallocated from the buffer.
  1838. if self.remote_last_seq < self.local_seq_no {
  1839. self.remote_last_seq = self.local_seq_no
  1840. }
  1841. }
  1842. // update last remote tsval
  1843. if let Some(timestamp) = repr.timestamp {
  1844. self.last_remote_tsval = timestamp.tsval;
  1845. }
  1846. // update timers.
  1847. match self.timer {
  1848. Timer::Retransmit { .. } | Timer::FastRetransmit => {
  1849. if ack_all {
  1850. // RFC 6298: (5.2) ACK of all outstanding data turn off the retransmit timer.
  1851. self.timer.set_for_idle(cx.now(), self.keep_alive);
  1852. } else if ack_len > 0 {
  1853. // (5.3) ACK of new data in ESTABLISHED state restart the retransmit timer.
  1854. let rto = self.rtte.retransmission_timeout();
  1855. self.timer.set_for_retransmit(cx.now(), rto);
  1856. }
  1857. }
  1858. Timer::Idle { .. } => {
  1859. // any packet on idle refresh the keepalive timer.
  1860. self.timer.set_for_idle(cx.now(), self.keep_alive);
  1861. }
  1862. _ => {}
  1863. }
  1864. // start/stop the Zero Window Probe timer.
  1865. if self.remote_win_len == 0
  1866. && !self.tx_buffer.is_empty()
  1867. && (self.timer.is_idle() || ack_len > 0)
  1868. {
  1869. let delay = self.rtte.retransmission_timeout();
  1870. tcp_trace!("starting zero-window-probe timer for t+{}", delay);
  1871. self.timer.set_for_zero_window_probe(cx.now(), delay);
  1872. }
  1873. if self.remote_win_len != 0 && self.timer.is_zero_window_probe() {
  1874. tcp_trace!("stopping zero-window-probe timer");
  1875. self.timer.set_for_idle(cx.now(), self.keep_alive);
  1876. }
  1877. let payload_len = payload.len();
  1878. if payload_len == 0 {
  1879. return None;
  1880. }
  1881. let assembler_was_empty = self.assembler.is_empty();
  1882. // Try adding payload octets to the assembler.
  1883. let Ok(contig_len) = self
  1884. .assembler
  1885. .add_then_remove_front(payload_offset, payload_len)
  1886. else {
  1887. net_debug!(
  1888. "assembler: too many holes to add {} octets at offset {}",
  1889. payload_len,
  1890. payload_offset
  1891. );
  1892. return None;
  1893. };
  1894. // Place payload octets into the buffer.
  1895. tcp_trace!(
  1896. "rx buffer: receiving {} octets at offset {}",
  1897. payload_len,
  1898. payload_offset
  1899. );
  1900. let len_written = self.rx_buffer.write_unallocated(payload_offset, payload);
  1901. debug_assert!(len_written == payload_len);
  1902. if contig_len != 0 {
  1903. // Enqueue the contiguous data octets in front of the buffer.
  1904. tcp_trace!(
  1905. "rx buffer: enqueueing {} octets (now {})",
  1906. contig_len,
  1907. self.rx_buffer.len() + contig_len
  1908. );
  1909. self.rx_buffer.enqueue_unallocated(contig_len);
  1910. // There's new data in rx_buffer, notify waiting task if any.
  1911. #[cfg(feature = "async")]
  1912. self.rx_waker.wake();
  1913. }
  1914. if !self.assembler.is_empty() {
  1915. // Print the ranges recorded in the assembler.
  1916. tcp_trace!("assembler: {}", self.assembler);
  1917. }
  1918. // Handle delayed acks
  1919. if let Some(ack_delay) = self.ack_delay {
  1920. if self.ack_to_transmit() {
  1921. self.ack_delay_timer = match self.ack_delay_timer {
  1922. AckDelayTimer::Idle => {
  1923. tcp_trace!("starting delayed ack timer");
  1924. AckDelayTimer::Waiting(cx.now() + ack_delay)
  1925. }
  1926. AckDelayTimer::Waiting(_) if self.immediate_ack_to_transmit() => {
  1927. tcp_trace!("delayed ack timer already started, forcing expiry");
  1928. AckDelayTimer::Immediate
  1929. }
  1930. timer @ AckDelayTimer::Waiting(_) => {
  1931. tcp_trace!("waiting until delayed ack timer expires");
  1932. timer
  1933. }
  1934. AckDelayTimer::Immediate => {
  1935. tcp_trace!("delayed ack timer already force-expired");
  1936. AckDelayTimer::Immediate
  1937. }
  1938. };
  1939. }
  1940. }
  1941. // Per RFC 5681, we should send an immediate ACK when either:
  1942. // 1) an out-of-order segment is received, or
  1943. // 2) a segment arrives that fills in all or part of a gap in sequence space.
  1944. if !self.assembler.is_empty() || !assembler_was_empty {
  1945. // Note that we change the transmitter state here.
  1946. // This is fine because smoltcp assumes that it can always transmit zero or one
  1947. // packets for every packet it receives.
  1948. tcp_trace!("ACKing incoming segment");
  1949. Some(self.ack_reply(ip_repr, repr))
  1950. } else {
  1951. None
  1952. }
  1953. }
  1954. fn timed_out(&self, timestamp: Instant) -> bool {
  1955. match (self.remote_last_ts, self.timeout) {
  1956. (Some(remote_last_ts), Some(timeout)) => timestamp >= remote_last_ts + timeout,
  1957. (_, _) => false,
  1958. }
  1959. }
  1960. fn seq_to_transmit(&self, cx: &mut Context) -> bool {
  1961. let ip_header_len = match self.tuple.unwrap().local.addr {
  1962. #[cfg(feature = "proto-ipv4")]
  1963. IpAddress::Ipv4(_) => crate::wire::IPV4_HEADER_LEN,
  1964. #[cfg(feature = "proto-ipv6")]
  1965. IpAddress::Ipv6(_) => crate::wire::IPV6_HEADER_LEN,
  1966. };
  1967. // Max segment size we're able to send due to MTU limitations.
  1968. let local_mss = cx.ip_mtu() - ip_header_len - TCP_HEADER_LEN;
  1969. // The effective max segment size, taking into account our and remote's limits.
  1970. let effective_mss = local_mss.min(self.remote_mss);
  1971. // Have we sent data that hasn't been ACKed yet?
  1972. let data_in_flight = self.remote_last_seq != self.local_seq_no;
  1973. // If we want to send a SYN and we haven't done so, do it!
  1974. if matches!(self.state, State::SynSent | State::SynReceived) && !data_in_flight {
  1975. return true;
  1976. }
  1977. // max sequence number we can send.
  1978. let max_send_seq =
  1979. self.local_seq_no + core::cmp::min(self.remote_win_len, self.tx_buffer.len());
  1980. // Max amount of octets we can send.
  1981. let max_send = if max_send_seq >= self.remote_last_seq {
  1982. max_send_seq - self.remote_last_seq
  1983. } else {
  1984. 0
  1985. };
  1986. // Compare max_send with the congestion window.
  1987. let max_send = max_send.min(self.congestion_controller.inner().window());
  1988. // Can we send at least 1 octet?
  1989. let mut can_send = max_send != 0;
  1990. // Can we send at least 1 full segment?
  1991. let can_send_full = max_send >= effective_mss;
  1992. // Do we have to send a FIN?
  1993. let want_fin = match self.state {
  1994. State::FinWait1 => true,
  1995. State::Closing => true,
  1996. State::LastAck => true,
  1997. _ => false,
  1998. };
  1999. // If we're applying the Nagle algorithm we don't want to send more
  2000. // until one of:
  2001. // * There's no data in flight
  2002. // * We can send a full packet
  2003. // * We have all the data we'll ever send (we're closing send)
  2004. if self.nagle && data_in_flight && !can_send_full && !want_fin {
  2005. can_send = false;
  2006. }
  2007. // Can we actually send the FIN? We can send it if:
  2008. // 1. We have unsent data that fits in the remote window.
  2009. // 2. We have no unsent data.
  2010. // This condition matches only if #2, because #1 is already covered by can_data and we're ORing them.
  2011. let can_fin = want_fin && self.remote_last_seq == self.local_seq_no + self.tx_buffer.len();
  2012. can_send || can_fin
  2013. }
  2014. fn delayed_ack_expired(&self, timestamp: Instant) -> bool {
  2015. match self.ack_delay_timer {
  2016. AckDelayTimer::Idle => true,
  2017. AckDelayTimer::Waiting(t) => t <= timestamp,
  2018. AckDelayTimer::Immediate => true,
  2019. }
  2020. }
  2021. fn ack_to_transmit(&self) -> bool {
  2022. if let Some(remote_last_ack) = self.remote_last_ack {
  2023. remote_last_ack < self.remote_seq_no + self.rx_buffer.len()
  2024. } else {
  2025. false
  2026. }
  2027. }
  2028. /// Return whether to send ACK immediately due to the amount of unacknowledged data.
  2029. ///
  2030. /// RFC 9293 states "An ACK SHOULD be generated for at least every second full-sized segment or
  2031. /// 2*RMSS bytes of new data (where RMSS is the MSS specified by the TCP endpoint receiving the
  2032. /// segments to be acknowledged, or the default value if not specified) (SHLD-19)."
  2033. ///
  2034. /// Note that the RFC above only says "at least 2*RMSS bytes", which is not a hard requirement.
  2035. /// In practice, we follow the Linux kernel's empirical value of sending an ACK for every RMSS
  2036. /// byte of new data. For details, see
  2037. /// <https://elixir.bootlin.com/linux/v6.11.4/source/net/ipv4/tcp_input.c#L5747>.
  2038. fn immediate_ack_to_transmit(&self) -> bool {
  2039. if let Some(remote_last_ack) = self.remote_last_ack {
  2040. remote_last_ack + self.remote_mss < self.remote_seq_no + self.rx_buffer.len()
  2041. } else {
  2042. false
  2043. }
  2044. }
  2045. /// Return whether we should send ACK immediately due to significant window updates.
  2046. ///
  2047. /// ACKs with significant window updates should be sent immediately to let the sender know that
  2048. /// more data can be sent. According to the Linux kernel implementation, "significant" means
  2049. /// doubling the receive window. The Linux kernel implementation can be found at
  2050. /// <https://elixir.bootlin.com/linux/v6.9.9/source/net/ipv4/tcp.c#L1472>.
  2051. fn window_to_update(&self) -> bool {
  2052. match self.state {
  2053. State::SynSent
  2054. | State::SynReceived
  2055. | State::Established
  2056. | State::FinWait1
  2057. | State::FinWait2 => {
  2058. let new_win = self.scaled_window();
  2059. if let Some(last_win) = self.last_scaled_window() {
  2060. new_win > 0 && new_win / 2 >= last_win
  2061. } else {
  2062. false
  2063. }
  2064. }
  2065. _ => false,
  2066. }
  2067. }
  2068. pub(crate) fn dispatch<F, E>(&mut self, cx: &mut Context, emit: F) -> Result<(), E>
  2069. where
  2070. F: FnOnce(&mut Context, (IpRepr, TcpRepr)) -> Result<(), E>,
  2071. {
  2072. if self.tuple.is_none() {
  2073. return Ok(());
  2074. }
  2075. if self.remote_last_ts.is_none() {
  2076. // We get here in exactly two cases:
  2077. // 1) This socket just transitioned into SYN-SENT.
  2078. // 2) This socket had an empty transmit buffer and some data was added there.
  2079. // Both are similar in that the socket has been quiet for an indefinite
  2080. // period of time, it isn't anymore, and the local endpoint is talking.
  2081. // So, we start counting the timeout not from the last received packet
  2082. // but from the first transmitted one.
  2083. self.remote_last_ts = Some(cx.now());
  2084. }
  2085. self.congestion_controller
  2086. .inner_mut()
  2087. .pre_transmit(cx.now());
  2088. // Check if any state needs to be changed because of a timer.
  2089. if self.timed_out(cx.now()) {
  2090. // If a timeout expires, we should abort the connection.
  2091. net_debug!("timeout exceeded");
  2092. self.set_state(State::Closed);
  2093. } else if !self.seq_to_transmit(cx) && self.timer.should_retransmit(cx.now()) {
  2094. // If a retransmit timer expired, we should resend data starting at the last ACK.
  2095. net_debug!("retransmitting");
  2096. // Rewind "last sequence number sent", as if we never
  2097. // had sent them. This will cause all data in the queue
  2098. // to be sent again.
  2099. self.remote_last_seq = self.local_seq_no;
  2100. // Clear the `should_retransmit` state. If we can't retransmit right
  2101. // now for whatever reason (like zero window), this avoids an
  2102. // infinite polling loop where `poll_at` returns `Now` but `dispatch`
  2103. // can't actually do anything.
  2104. self.timer.set_for_idle(cx.now(), self.keep_alive);
  2105. // Inform RTTE, so that it can avoid bogus measurements.
  2106. self.rtte.on_retransmit();
  2107. // Inform the congestion controller that we're retransmitting.
  2108. self.congestion_controller
  2109. .inner_mut()
  2110. .on_retransmit(cx.now());
  2111. }
  2112. // Decide whether we're sending a packet.
  2113. if self.seq_to_transmit(cx) {
  2114. // If we have data to transmit and it fits into partner's window, do it.
  2115. tcp_trace!("outgoing segment will send data or flags");
  2116. } else if self.ack_to_transmit() && self.delayed_ack_expired(cx.now()) {
  2117. // If we have data to acknowledge, do it.
  2118. tcp_trace!("outgoing segment will acknowledge");
  2119. } else if self.window_to_update() {
  2120. // If we have window length increase to advertise, do it.
  2121. tcp_trace!("outgoing segment will update window");
  2122. } else if self.state == State::Closed {
  2123. // If we need to abort the connection, do it.
  2124. tcp_trace!("outgoing segment will abort connection");
  2125. } else if self.timer.should_keep_alive(cx.now()) {
  2126. // If we need to transmit a keep-alive packet, do it.
  2127. tcp_trace!("keep-alive timer expired");
  2128. } else if self.timer.should_zero_window_probe(cx.now()) {
  2129. tcp_trace!("sending zero-window probe");
  2130. } else if self.timer.should_close(cx.now()) {
  2131. // If we have spent enough time in the TIME-WAIT state, close the socket.
  2132. tcp_trace!("TIME-WAIT timer expired");
  2133. self.reset();
  2134. return Ok(());
  2135. } else {
  2136. return Ok(());
  2137. }
  2138. // NOTE(unwrap): we check tuple is not None the first thing in this function.
  2139. let tuple = self.tuple.unwrap();
  2140. // Construct the lowered IP representation.
  2141. // We might need this to calculate the MSS, so do it early.
  2142. let mut ip_repr = IpRepr::new(
  2143. tuple.local.addr,
  2144. tuple.remote.addr,
  2145. IpProtocol::Tcp,
  2146. 0,
  2147. self.hop_limit.unwrap_or(64),
  2148. );
  2149. // Construct the basic TCP representation, an empty ACK packet.
  2150. // We'll adjust this to be more specific as needed.
  2151. let mut repr = TcpRepr {
  2152. src_port: tuple.local.port,
  2153. dst_port: tuple.remote.port,
  2154. control: TcpControl::None,
  2155. seq_number: self.remote_last_seq,
  2156. ack_number: Some(self.remote_seq_no + self.rx_buffer.len()),
  2157. window_len: self.scaled_window(),
  2158. window_scale: None,
  2159. max_seg_size: None,
  2160. sack_permitted: false,
  2161. sack_ranges: [None, None, None],
  2162. timestamp: TcpTimestampRepr::generate_reply_with_tsval(
  2163. self.tsval_generator,
  2164. self.last_remote_tsval,
  2165. ),
  2166. payload: &[],
  2167. };
  2168. let mut is_zero_window_probe = false;
  2169. match self.state {
  2170. // We transmit an RST in the CLOSED state. If we ended up in the CLOSED state
  2171. // with a specified endpoint, it means that the socket was aborted.
  2172. State::Closed => {
  2173. repr.control = TcpControl::Rst;
  2174. }
  2175. // We never transmit anything in the LISTEN state.
  2176. State::Listen => return Ok(()),
  2177. // We transmit a SYN in the SYN-SENT state.
  2178. // We transmit a SYN|ACK in the SYN-RECEIVED state.
  2179. State::SynSent | State::SynReceived => {
  2180. repr.control = TcpControl::Syn;
  2181. repr.seq_number = self.local_seq_no;
  2182. // window len must NOT be scaled in SYNs.
  2183. repr.window_len = u16::try_from(self.rx_buffer.window()).unwrap_or(u16::MAX);
  2184. if self.state == State::SynSent {
  2185. repr.ack_number = None;
  2186. repr.window_scale = Some(self.remote_win_shift);
  2187. repr.sack_permitted = true;
  2188. } else {
  2189. repr.sack_permitted = self.remote_has_sack;
  2190. repr.window_scale = self.remote_win_scale.map(|_| self.remote_win_shift);
  2191. }
  2192. }
  2193. // We transmit data in all states where we may have data in the buffer,
  2194. // or the transmit half of the connection is still open.
  2195. State::Established
  2196. | State::FinWait1
  2197. | State::Closing
  2198. | State::CloseWait
  2199. | State::LastAck => {
  2200. // Extract as much data as the remote side can receive in this packet
  2201. // from the transmit buffer.
  2202. // Right edge of window, ie the max sequence number we're allowed to send.
  2203. let win_right_edge = self.local_seq_no + self.remote_win_len;
  2204. // Max amount of octets we're allowed to send according to the remote window.
  2205. let mut win_limit = if win_right_edge >= self.remote_last_seq {
  2206. win_right_edge - self.remote_last_seq
  2207. } else {
  2208. // This can happen if we've sent some data and later the remote side
  2209. // has shrunk its window so that data is no longer inside the window.
  2210. // This should be very rare and is strongly discouraged by the RFCs,
  2211. // but it does happen in practice.
  2212. // http://www.tcpipguide.com/free/t_TCPWindowManagementIssues.htm
  2213. 0
  2214. };
  2215. // To send a zero-window-probe, force the window limit to at least 1 byte.
  2216. if win_limit == 0 && self.timer.should_zero_window_probe(cx.now()) {
  2217. win_limit = 1;
  2218. is_zero_window_probe = true;
  2219. }
  2220. // Maximum size we're allowed to send. This can be limited by 3 factors:
  2221. // 1. remote window
  2222. // 2. MSS the remote is willing to accept, probably determined by their MTU
  2223. // 3. MSS we can send, determined by our MTU.
  2224. let size = win_limit
  2225. .min(self.remote_mss)
  2226. .min(cx.ip_mtu() - ip_repr.header_len() - TCP_HEADER_LEN);
  2227. let offset = self.remote_last_seq - self.local_seq_no;
  2228. repr.payload = self.tx_buffer.get_allocated(offset, size);
  2229. // If we've sent everything we had in the buffer, follow it with the PSH or FIN
  2230. // flags, depending on whether the transmit half of the connection is open.
  2231. if offset + repr.payload.len() == self.tx_buffer.len() {
  2232. match self.state {
  2233. State::FinWait1 | State::LastAck | State::Closing => {
  2234. repr.control = TcpControl::Fin
  2235. }
  2236. State::Established | State::CloseWait if !repr.payload.is_empty() => {
  2237. repr.control = TcpControl::Psh
  2238. }
  2239. _ => (),
  2240. }
  2241. }
  2242. }
  2243. // In FIN-WAIT-2 and TIME-WAIT states we may only transmit ACKs for incoming data or FIN
  2244. State::FinWait2 | State::TimeWait => {}
  2245. }
  2246. // There might be more than one reason to send a packet. E.g. the keep-alive timer
  2247. // has expired, and we also have data in transmit buffer. Since any packet that occupies
  2248. // sequence space will elicit an ACK, we only need to send an explicit packet if we
  2249. // couldn't fill the sequence space with anything.
  2250. let is_keep_alive;
  2251. if self.timer.should_keep_alive(cx.now()) && repr.is_empty() {
  2252. repr.seq_number = repr.seq_number - 1;
  2253. repr.payload = b"\x00"; // RFC 1122 says we should do this
  2254. is_keep_alive = true;
  2255. } else {
  2256. is_keep_alive = false;
  2257. }
  2258. // Trace a summary of what will be sent.
  2259. if is_keep_alive {
  2260. tcp_trace!("sending a keep-alive");
  2261. } else if !repr.payload.is_empty() {
  2262. tcp_trace!(
  2263. "tx buffer: sending {} octets at offset {}",
  2264. repr.payload.len(),
  2265. self.remote_last_seq - self.local_seq_no
  2266. );
  2267. }
  2268. if repr.control != TcpControl::None || repr.payload.is_empty() {
  2269. let flags = match (repr.control, repr.ack_number) {
  2270. (TcpControl::Syn, None) => "SYN",
  2271. (TcpControl::Syn, Some(_)) => "SYN|ACK",
  2272. (TcpControl::Fin, Some(_)) => "FIN|ACK",
  2273. (TcpControl::Rst, Some(_)) => "RST|ACK",
  2274. (TcpControl::Psh, Some(_)) => "PSH|ACK",
  2275. (TcpControl::None, Some(_)) => "ACK",
  2276. _ => "<unreachable>",
  2277. };
  2278. tcp_trace!("sending {}", flags);
  2279. }
  2280. if repr.control == TcpControl::Syn {
  2281. // Fill the MSS option. See RFC 6691 for an explanation of this calculation.
  2282. let max_segment_size = cx.ip_mtu() - ip_repr.header_len() - TCP_HEADER_LEN;
  2283. repr.max_seg_size = Some(max_segment_size as u16);
  2284. }
  2285. // Actually send the packet. If this succeeds, it means the packet is in
  2286. // the device buffer, and its transmission is imminent. If not, we might have
  2287. // a number of problems, e.g. we need neighbor discovery.
  2288. //
  2289. // Bailing out if the packet isn't placed in the device buffer allows us
  2290. // to not waste time waiting for the retransmit timer on packets that we know
  2291. // for sure will not be successfully transmitted.
  2292. ip_repr.set_payload_len(repr.buffer_len());
  2293. emit(cx, (ip_repr, repr))?;
  2294. // We've sent something, whether useful data or a keep-alive packet, so rewind
  2295. // the keep-alive timer.
  2296. self.timer.rewind_keep_alive(cx.now(), self.keep_alive);
  2297. // Reset delayed-ack timer
  2298. match self.ack_delay_timer {
  2299. AckDelayTimer::Idle => {}
  2300. AckDelayTimer::Waiting(_) => {
  2301. tcp_trace!("stop delayed ack timer")
  2302. }
  2303. AckDelayTimer::Immediate => {
  2304. tcp_trace!("stop delayed ack timer (was force-expired)")
  2305. }
  2306. }
  2307. self.ack_delay_timer = AckDelayTimer::Idle;
  2308. // Leave the rest of the state intact if sending a zero-window probe.
  2309. if is_zero_window_probe {
  2310. self.timer.rewind_zero_window_probe(cx.now());
  2311. return Ok(());
  2312. }
  2313. // Leave the rest of the state intact if sending a keep-alive packet, since those
  2314. // carry a fake segment.
  2315. if is_keep_alive {
  2316. return Ok(());
  2317. }
  2318. // We've sent a packet successfully, so we can update the internal state now.
  2319. self.remote_last_seq = repr.seq_number + repr.segment_len();
  2320. self.remote_last_ack = repr.ack_number;
  2321. self.remote_last_win = repr.window_len;
  2322. if repr.segment_len() > 0 {
  2323. self.rtte
  2324. .on_send(cx.now(), repr.seq_number + repr.segment_len());
  2325. self.congestion_controller
  2326. .inner_mut()
  2327. .post_transmit(cx.now(), repr.segment_len());
  2328. }
  2329. if repr.segment_len() > 0 && !self.timer.is_retransmit() {
  2330. // RFC 6298 (5.1) Every time a packet containing data is sent (including a
  2331. // retransmission), if the timer is not running, start it running
  2332. // so that it will expire after RTO seconds.
  2333. let rto = self.rtte.retransmission_timeout();
  2334. self.timer.set_for_retransmit(cx.now(), rto);
  2335. }
  2336. if self.state == State::Closed {
  2337. // When aborting a connection, forget about it after sending a single RST packet.
  2338. self.tuple = None;
  2339. #[cfg(feature = "async")]
  2340. {
  2341. // Wake tx now so that async users can wait for the RST to be sent
  2342. self.tx_waker.wake();
  2343. }
  2344. }
  2345. Ok(())
  2346. }
  2347. #[allow(clippy::if_same_then_else)]
  2348. pub(crate) fn poll_at(&self, cx: &mut Context) -> PollAt {
  2349. // The logic here mirrors the beginning of dispatch() closely.
  2350. if self.tuple.is_none() {
  2351. // No one to talk to, nothing to transmit.
  2352. PollAt::Ingress
  2353. } else if self.remote_last_ts.is_none() {
  2354. // Socket stopped being quiet recently, we need to acquire a timestamp.
  2355. PollAt::Now
  2356. } else if self.state == State::Closed {
  2357. // Socket was aborted, we have an RST packet to transmit.
  2358. PollAt::Now
  2359. } else if self.seq_to_transmit(cx) {
  2360. // We have a data or flag packet to transmit.
  2361. PollAt::Now
  2362. } else if self.window_to_update() {
  2363. // The receive window has been raised significantly.
  2364. PollAt::Now
  2365. } else {
  2366. let want_ack = self.ack_to_transmit();
  2367. let delayed_ack_poll_at = match (want_ack, self.ack_delay_timer) {
  2368. (false, _) => PollAt::Ingress,
  2369. (true, AckDelayTimer::Idle) => PollAt::Now,
  2370. (true, AckDelayTimer::Waiting(t)) => PollAt::Time(t),
  2371. (true, AckDelayTimer::Immediate) => PollAt::Now,
  2372. };
  2373. let timeout_poll_at = match (self.remote_last_ts, self.timeout) {
  2374. // If we're transmitting or retransmitting data, we need to poll at the moment
  2375. // when the timeout would expire.
  2376. (Some(remote_last_ts), Some(timeout)) => PollAt::Time(remote_last_ts + timeout),
  2377. // Otherwise we have no timeout.
  2378. (_, _) => PollAt::Ingress,
  2379. };
  2380. // We wait for the earliest of our timers to fire.
  2381. *[self.timer.poll_at(), timeout_poll_at, delayed_ack_poll_at]
  2382. .iter()
  2383. .min()
  2384. .unwrap_or(&PollAt::Ingress)
  2385. }
  2386. }
  2387. }
  2388. impl<'a> fmt::Write for Socket<'a> {
  2389. fn write_str(&mut self, slice: &str) -> fmt::Result {
  2390. let slice = slice.as_bytes();
  2391. if self.send_slice(slice) == Ok(slice.len()) {
  2392. Ok(())
  2393. } else {
  2394. Err(fmt::Error)
  2395. }
  2396. }
  2397. }
  2398. // TODO: TCP should work for all features. For now, we only test with the IP feature. We could do
  2399. // it for other features as well with rstest, however, this means we have to modify a lot of the
  2400. // tests in here, which I didn't had the time for at the moment.
  2401. #[cfg(all(test, feature = "medium-ip"))]
  2402. mod test {
  2403. use super::*;
  2404. use crate::wire::IpRepr;
  2405. use std::ops::{Deref, DerefMut};
  2406. use std::vec::Vec;
  2407. // =========================================================================================//
  2408. // Constants
  2409. // =========================================================================================//
  2410. const LOCAL_PORT: u16 = 80;
  2411. const REMOTE_PORT: u16 = 49500;
  2412. const LISTEN_END: IpListenEndpoint = IpListenEndpoint {
  2413. addr: None,
  2414. port: LOCAL_PORT,
  2415. };
  2416. const TUPLE: Tuple = Tuple {
  2417. local: LOCAL_END,
  2418. remote: REMOTE_END,
  2419. };
  2420. const LOCAL_SEQ: TcpSeqNumber = TcpSeqNumber(10000);
  2421. const REMOTE_SEQ: TcpSeqNumber = TcpSeqNumber(-10001);
  2422. cfg_if::cfg_if! {
  2423. if #[cfg(feature = "proto-ipv4")] {
  2424. use crate::wire::Ipv4Address as IpvXAddress;
  2425. use crate::wire::Ipv4Repr as IpvXRepr;
  2426. use IpRepr::Ipv4 as IpReprIpvX;
  2427. const LOCAL_ADDR: IpvXAddress = IpvXAddress::new(192, 168, 1, 1);
  2428. const REMOTE_ADDR: IpvXAddress = IpvXAddress::new(192, 168, 1, 2);
  2429. const OTHER_ADDR: IpvXAddress = IpvXAddress::new(192, 168, 1, 3);
  2430. const BASE_MSS: u16 = 1460;
  2431. const LOCAL_END: IpEndpoint = IpEndpoint {
  2432. addr: IpAddress::Ipv4(LOCAL_ADDR),
  2433. port: LOCAL_PORT,
  2434. };
  2435. const REMOTE_END: IpEndpoint = IpEndpoint {
  2436. addr: IpAddress::Ipv4(REMOTE_ADDR),
  2437. port: REMOTE_PORT,
  2438. };
  2439. } else {
  2440. use crate::wire::Ipv6Address as IpvXAddress;
  2441. use crate::wire::Ipv6Repr as IpvXRepr;
  2442. use IpRepr::Ipv6 as IpReprIpvX;
  2443. const LOCAL_ADDR: IpvXAddress = IpvXAddress::new(0xfe80, 0, 0, 0, 0, 0, 0, 1);
  2444. const REMOTE_ADDR: IpvXAddress = IpvXAddress::new(0xfe80, 0, 0, 0, 0, 0, 0, 2);
  2445. const OTHER_ADDR: IpvXAddress = IpvXAddress::new(0xfe80, 0, 0, 0, 0, 0, 0, 3);
  2446. const BASE_MSS: u16 = 1440;
  2447. const LOCAL_END: IpEndpoint = IpEndpoint {
  2448. addr: IpAddress::Ipv6(LOCAL_ADDR),
  2449. port: LOCAL_PORT,
  2450. };
  2451. const REMOTE_END: IpEndpoint = IpEndpoint {
  2452. addr: IpAddress::Ipv6(REMOTE_ADDR),
  2453. port: REMOTE_PORT,
  2454. };
  2455. }
  2456. }
  2457. const SEND_IP_TEMPL: IpRepr = IpReprIpvX(IpvXRepr {
  2458. src_addr: LOCAL_ADDR,
  2459. dst_addr: REMOTE_ADDR,
  2460. next_header: IpProtocol::Tcp,
  2461. payload_len: 20,
  2462. hop_limit: 64,
  2463. });
  2464. const SEND_TEMPL: TcpRepr<'static> = TcpRepr {
  2465. src_port: REMOTE_PORT,
  2466. dst_port: LOCAL_PORT,
  2467. control: TcpControl::None,
  2468. seq_number: TcpSeqNumber(0),
  2469. ack_number: Some(TcpSeqNumber(0)),
  2470. window_len: 256,
  2471. window_scale: None,
  2472. max_seg_size: None,
  2473. sack_permitted: false,
  2474. sack_ranges: [None, None, None],
  2475. timestamp: None,
  2476. payload: &[],
  2477. };
  2478. const _RECV_IP_TEMPL: IpRepr = IpReprIpvX(IpvXRepr {
  2479. src_addr: LOCAL_ADDR,
  2480. dst_addr: REMOTE_ADDR,
  2481. next_header: IpProtocol::Tcp,
  2482. payload_len: 20,
  2483. hop_limit: 64,
  2484. });
  2485. const RECV_TEMPL: TcpRepr<'static> = TcpRepr {
  2486. src_port: LOCAL_PORT,
  2487. dst_port: REMOTE_PORT,
  2488. control: TcpControl::None,
  2489. seq_number: TcpSeqNumber(0),
  2490. ack_number: Some(TcpSeqNumber(0)),
  2491. window_len: 64,
  2492. window_scale: None,
  2493. max_seg_size: None,
  2494. sack_permitted: false,
  2495. sack_ranges: [None, None, None],
  2496. timestamp: None,
  2497. payload: &[],
  2498. };
  2499. // =========================================================================================//
  2500. // Helper functions
  2501. // =========================================================================================//
  2502. struct TestSocket {
  2503. socket: Socket<'static>,
  2504. cx: Context,
  2505. }
  2506. impl Deref for TestSocket {
  2507. type Target = Socket<'static>;
  2508. fn deref(&self) -> &Self::Target {
  2509. &self.socket
  2510. }
  2511. }
  2512. impl DerefMut for TestSocket {
  2513. fn deref_mut(&mut self) -> &mut Self::Target {
  2514. &mut self.socket
  2515. }
  2516. }
  2517. #[track_caller]
  2518. fn send(
  2519. socket: &mut TestSocket,
  2520. timestamp: Instant,
  2521. repr: &TcpRepr,
  2522. ) -> Option<TcpRepr<'static>> {
  2523. socket.cx.set_now(timestamp);
  2524. let ip_repr = IpReprIpvX(IpvXRepr {
  2525. src_addr: REMOTE_ADDR,
  2526. dst_addr: LOCAL_ADDR,
  2527. next_header: IpProtocol::Tcp,
  2528. payload_len: repr.buffer_len(),
  2529. hop_limit: 64,
  2530. });
  2531. net_trace!("send: {}", repr);
  2532. assert!(socket.socket.accepts(&mut socket.cx, &ip_repr, repr));
  2533. match socket.socket.process(&mut socket.cx, &ip_repr, repr) {
  2534. Some((_ip_repr, repr)) => {
  2535. net_trace!("recv: {}", repr);
  2536. Some(repr)
  2537. }
  2538. None => None,
  2539. }
  2540. }
  2541. #[track_caller]
  2542. fn recv<F>(socket: &mut TestSocket, timestamp: Instant, mut f: F)
  2543. where
  2544. F: FnMut(Result<TcpRepr, ()>),
  2545. {
  2546. socket.cx.set_now(timestamp);
  2547. let mut sent = 0;
  2548. let result = socket
  2549. .socket
  2550. .dispatch(&mut socket.cx, |_, (ip_repr, tcp_repr)| {
  2551. assert_eq!(ip_repr.next_header(), IpProtocol::Tcp);
  2552. assert_eq!(ip_repr.src_addr(), LOCAL_ADDR.into());
  2553. assert_eq!(ip_repr.dst_addr(), REMOTE_ADDR.into());
  2554. assert_eq!(ip_repr.payload_len(), tcp_repr.buffer_len());
  2555. net_trace!("recv: {}", tcp_repr);
  2556. sent += 1;
  2557. Ok(f(Ok(tcp_repr)))
  2558. });
  2559. match result {
  2560. Ok(()) => assert_eq!(sent, 1, "Exactly one packet should be sent"),
  2561. Err(e) => f(Err(e)),
  2562. }
  2563. }
  2564. #[track_caller]
  2565. fn recv_nothing(socket: &mut TestSocket, timestamp: Instant) {
  2566. socket.cx.set_now(timestamp);
  2567. let mut fail = false;
  2568. let result: Result<(), ()> = socket.socket.dispatch(&mut socket.cx, |_, _| {
  2569. fail = true;
  2570. Ok(())
  2571. });
  2572. if fail {
  2573. panic!("Should not send a packet")
  2574. }
  2575. assert_eq!(result, Ok(()))
  2576. }
  2577. #[collapse_debuginfo(yes)]
  2578. macro_rules! send {
  2579. ($socket:ident, $repr:expr) =>
  2580. (send!($socket, time 0, $repr));
  2581. ($socket:ident, $repr:expr, $result:expr) =>
  2582. (send!($socket, time 0, $repr, $result));
  2583. ($socket:ident, time $time:expr, $repr:expr) =>
  2584. (send!($socket, time $time, $repr, None));
  2585. ($socket:ident, time $time:expr, $repr:expr, $result:expr) =>
  2586. (assert_eq!(send(&mut $socket, Instant::from_millis($time), &$repr), $result));
  2587. }
  2588. #[collapse_debuginfo(yes)]
  2589. macro_rules! recv {
  2590. ($socket:ident, [$( $repr:expr ),*]) => ({
  2591. $( recv!($socket, Ok($repr)); )*
  2592. recv_nothing!($socket)
  2593. });
  2594. ($socket:ident, time $time:expr, [$( $repr:expr ),*]) => ({
  2595. $( recv!($socket, time $time, Ok($repr)); )*
  2596. recv_nothing!($socket, time $time)
  2597. });
  2598. ($socket:ident, $result:expr) =>
  2599. (recv!($socket, time 0, $result));
  2600. ($socket:ident, time $time:expr, $result:expr) =>
  2601. (recv(&mut $socket, Instant::from_millis($time), |result| {
  2602. // Most of the time we don't care about the PSH flag.
  2603. let result = result.map(|mut repr| {
  2604. repr.control = repr.control.quash_psh();
  2605. repr
  2606. });
  2607. assert_eq!(result, $result)
  2608. }));
  2609. ($socket:ident, time $time:expr, $result:expr, exact) =>
  2610. (recv(&mut $socket, Instant::from_millis($time), |repr| assert_eq!(repr, $result)));
  2611. }
  2612. #[collapse_debuginfo(yes)]
  2613. macro_rules! recv_nothing {
  2614. ($socket:ident) => (recv_nothing!($socket, time 0));
  2615. ($socket:ident, time $time:expr) => (recv_nothing(&mut $socket, Instant::from_millis($time)));
  2616. }
  2617. #[collapse_debuginfo(yes)]
  2618. macro_rules! sanity {
  2619. ($socket1:expr, $socket2:expr) => {{
  2620. let (s1, s2) = ($socket1, $socket2);
  2621. assert_eq!(s1.state, s2.state, "state");
  2622. assert_eq!(s1.tuple, s2.tuple, "tuple");
  2623. assert_eq!(s1.local_seq_no, s2.local_seq_no, "local_seq_no");
  2624. assert_eq!(s1.remote_seq_no, s2.remote_seq_no, "remote_seq_no");
  2625. assert_eq!(s1.remote_last_seq, s2.remote_last_seq, "remote_last_seq");
  2626. assert_eq!(s1.remote_last_ack, s2.remote_last_ack, "remote_last_ack");
  2627. assert_eq!(s1.remote_last_win, s2.remote_last_win, "remote_last_win");
  2628. assert_eq!(s1.remote_win_len, s2.remote_win_len, "remote_win_len");
  2629. assert_eq!(s1.timer, s2.timer, "timer");
  2630. }};
  2631. }
  2632. fn socket() -> TestSocket {
  2633. socket_with_buffer_sizes(64, 64)
  2634. }
  2635. fn socket_with_buffer_sizes(tx_len: usize, rx_len: usize) -> TestSocket {
  2636. let (iface, _, _) = crate::tests::setup(crate::phy::Medium::Ip);
  2637. let rx_buffer = SocketBuffer::new(vec![0; rx_len]);
  2638. let tx_buffer = SocketBuffer::new(vec![0; tx_len]);
  2639. let mut socket = Socket::new(rx_buffer, tx_buffer);
  2640. socket.set_ack_delay(None);
  2641. TestSocket {
  2642. socket,
  2643. cx: iface.inner,
  2644. }
  2645. }
  2646. fn socket_syn_received_with_buffer_sizes(tx_len: usize, rx_len: usize) -> TestSocket {
  2647. let mut s = socket_with_buffer_sizes(tx_len, rx_len);
  2648. s.state = State::SynReceived;
  2649. s.tuple = Some(TUPLE);
  2650. s.local_seq_no = LOCAL_SEQ;
  2651. s.remote_seq_no = REMOTE_SEQ + 1;
  2652. s.remote_last_seq = LOCAL_SEQ;
  2653. s.remote_win_len = 256;
  2654. s
  2655. }
  2656. fn socket_syn_received() -> TestSocket {
  2657. socket_syn_received_with_buffer_sizes(64, 64)
  2658. }
  2659. fn socket_syn_sent_with_buffer_sizes(tx_len: usize, rx_len: usize) -> TestSocket {
  2660. let mut s = socket_with_buffer_sizes(tx_len, rx_len);
  2661. s.state = State::SynSent;
  2662. s.tuple = Some(TUPLE);
  2663. s.local_seq_no = LOCAL_SEQ;
  2664. s.remote_last_seq = LOCAL_SEQ;
  2665. s
  2666. }
  2667. fn socket_syn_sent() -> TestSocket {
  2668. socket_syn_sent_with_buffer_sizes(64, 64)
  2669. }
  2670. fn socket_established_with_buffer_sizes(tx_len: usize, rx_len: usize) -> TestSocket {
  2671. let mut s = socket_syn_received_with_buffer_sizes(tx_len, rx_len);
  2672. s.state = State::Established;
  2673. s.local_seq_no = LOCAL_SEQ + 1;
  2674. s.remote_last_seq = LOCAL_SEQ + 1;
  2675. s.remote_last_ack = Some(REMOTE_SEQ + 1);
  2676. s.remote_last_win = s.scaled_window();
  2677. s
  2678. }
  2679. fn socket_established() -> TestSocket {
  2680. socket_established_with_buffer_sizes(64, 64)
  2681. }
  2682. fn socket_fin_wait_1() -> TestSocket {
  2683. let mut s = socket_established();
  2684. s.state = State::FinWait1;
  2685. s
  2686. }
  2687. fn socket_fin_wait_2() -> TestSocket {
  2688. let mut s = socket_fin_wait_1();
  2689. s.state = State::FinWait2;
  2690. s.local_seq_no = LOCAL_SEQ + 1 + 1;
  2691. s.remote_last_seq = LOCAL_SEQ + 1 + 1;
  2692. s
  2693. }
  2694. fn socket_closing() -> TestSocket {
  2695. let mut s = socket_fin_wait_1();
  2696. s.state = State::Closing;
  2697. s.remote_last_seq = LOCAL_SEQ + 1 + 1;
  2698. s.remote_seq_no = REMOTE_SEQ + 1 + 1;
  2699. s.timer = Timer::Retransmit {
  2700. expires_at: Instant::from_millis_const(1000),
  2701. };
  2702. s
  2703. }
  2704. fn socket_time_wait(from_closing: bool) -> TestSocket {
  2705. let mut s = socket_fin_wait_2();
  2706. s.state = State::TimeWait;
  2707. s.remote_seq_no = REMOTE_SEQ + 1 + 1;
  2708. if from_closing {
  2709. s.remote_last_ack = Some(REMOTE_SEQ + 1 + 1);
  2710. }
  2711. s.timer = Timer::Close {
  2712. expires_at: Instant::from_secs(1) + CLOSE_DELAY,
  2713. };
  2714. s
  2715. }
  2716. fn socket_close_wait() -> TestSocket {
  2717. let mut s = socket_established();
  2718. s.state = State::CloseWait;
  2719. s.remote_seq_no = REMOTE_SEQ + 1 + 1;
  2720. s.remote_last_ack = Some(REMOTE_SEQ + 1 + 1);
  2721. s
  2722. }
  2723. fn socket_last_ack() -> TestSocket {
  2724. let mut s = socket_close_wait();
  2725. s.state = State::LastAck;
  2726. s
  2727. }
  2728. fn socket_recved() -> TestSocket {
  2729. let mut s = socket_established();
  2730. send!(
  2731. s,
  2732. TcpRepr {
  2733. seq_number: REMOTE_SEQ + 1,
  2734. ack_number: Some(LOCAL_SEQ + 1),
  2735. payload: &b"abcdef"[..],
  2736. ..SEND_TEMPL
  2737. }
  2738. );
  2739. recv!(
  2740. s,
  2741. [TcpRepr {
  2742. seq_number: LOCAL_SEQ + 1,
  2743. ack_number: Some(REMOTE_SEQ + 1 + 6),
  2744. window_len: 58,
  2745. ..RECV_TEMPL
  2746. }]
  2747. );
  2748. s
  2749. }
  2750. // =========================================================================================//
  2751. // Tests for the CLOSED state.
  2752. // =========================================================================================//
  2753. #[test]
  2754. fn test_closed_reject() {
  2755. let mut s = socket();
  2756. assert_eq!(s.state, State::Closed);
  2757. let tcp_repr = TcpRepr {
  2758. control: TcpControl::Syn,
  2759. ..SEND_TEMPL
  2760. };
  2761. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  2762. }
  2763. #[test]
  2764. fn test_closed_reject_after_listen() {
  2765. let mut s = socket();
  2766. s.listen(LOCAL_END).unwrap();
  2767. s.close();
  2768. let tcp_repr = TcpRepr {
  2769. control: TcpControl::Syn,
  2770. ..SEND_TEMPL
  2771. };
  2772. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  2773. }
  2774. #[test]
  2775. fn test_closed_close() {
  2776. let mut s = socket();
  2777. s.close();
  2778. assert_eq!(s.state, State::Closed);
  2779. }
  2780. // =========================================================================================//
  2781. // Tests for the LISTEN state.
  2782. // =========================================================================================//
  2783. fn socket_listen() -> TestSocket {
  2784. let mut s = socket();
  2785. s.state = State::Listen;
  2786. s.listen_endpoint = LISTEN_END;
  2787. s
  2788. }
  2789. #[test]
  2790. fn test_listen_sack_option() {
  2791. let mut s = socket_listen();
  2792. send!(
  2793. s,
  2794. TcpRepr {
  2795. control: TcpControl::Syn,
  2796. seq_number: REMOTE_SEQ,
  2797. ack_number: None,
  2798. sack_permitted: false,
  2799. ..SEND_TEMPL
  2800. }
  2801. );
  2802. assert!(!s.remote_has_sack);
  2803. recv!(
  2804. s,
  2805. [TcpRepr {
  2806. control: TcpControl::Syn,
  2807. seq_number: LOCAL_SEQ,
  2808. ack_number: Some(REMOTE_SEQ + 1),
  2809. max_seg_size: Some(BASE_MSS),
  2810. ..RECV_TEMPL
  2811. }]
  2812. );
  2813. let mut s = socket_listen();
  2814. send!(
  2815. s,
  2816. TcpRepr {
  2817. control: TcpControl::Syn,
  2818. seq_number: REMOTE_SEQ,
  2819. ack_number: None,
  2820. sack_permitted: true,
  2821. ..SEND_TEMPL
  2822. }
  2823. );
  2824. assert!(s.remote_has_sack);
  2825. recv!(
  2826. s,
  2827. [TcpRepr {
  2828. control: TcpControl::Syn,
  2829. seq_number: LOCAL_SEQ,
  2830. ack_number: Some(REMOTE_SEQ + 1),
  2831. max_seg_size: Some(BASE_MSS),
  2832. sack_permitted: true,
  2833. ..RECV_TEMPL
  2834. }]
  2835. );
  2836. }
  2837. #[test]
  2838. fn test_listen_syn_win_scale_buffers() {
  2839. for (buffer_size, shift_amt) in &[
  2840. (64, 0),
  2841. (128, 0),
  2842. (1024, 0),
  2843. (65535, 0),
  2844. (65536, 1),
  2845. (65537, 1),
  2846. (131071, 1),
  2847. (131072, 2),
  2848. (524287, 3),
  2849. (524288, 4),
  2850. (655350, 4),
  2851. (1048576, 5),
  2852. ] {
  2853. let mut s = socket_with_buffer_sizes(64, *buffer_size);
  2854. s.state = State::Listen;
  2855. s.listen_endpoint = LISTEN_END;
  2856. assert_eq!(s.remote_win_shift, *shift_amt);
  2857. send!(
  2858. s,
  2859. TcpRepr {
  2860. control: TcpControl::Syn,
  2861. seq_number: REMOTE_SEQ,
  2862. ack_number: None,
  2863. window_scale: Some(0),
  2864. ..SEND_TEMPL
  2865. }
  2866. );
  2867. assert_eq!(s.remote_win_shift, *shift_amt);
  2868. recv!(
  2869. s,
  2870. [TcpRepr {
  2871. control: TcpControl::Syn,
  2872. seq_number: LOCAL_SEQ,
  2873. ack_number: Some(REMOTE_SEQ + 1),
  2874. max_seg_size: Some(BASE_MSS),
  2875. window_scale: Some(*shift_amt),
  2876. window_len: u16::try_from(*buffer_size).unwrap_or(u16::MAX),
  2877. ..RECV_TEMPL
  2878. }]
  2879. );
  2880. }
  2881. }
  2882. #[test]
  2883. fn test_listen_sanity() {
  2884. let mut s = socket();
  2885. s.listen(LOCAL_PORT).unwrap();
  2886. sanity!(s, socket_listen());
  2887. }
  2888. #[test]
  2889. fn test_listen_validation() {
  2890. let mut s = socket();
  2891. assert_eq!(s.listen(0), Err(ListenError::Unaddressable));
  2892. }
  2893. #[test]
  2894. fn test_listen_twice() {
  2895. let mut s = socket();
  2896. assert_eq!(s.listen(80), Ok(()));
  2897. // multiple calls to listen are okay if its the same local endpoint and the state is still in listening
  2898. assert_eq!(s.listen(80), Ok(()));
  2899. s.set_state(State::SynReceived); // state change, simulate incoming connection
  2900. assert_eq!(s.listen(80), Err(ListenError::InvalidState));
  2901. }
  2902. #[test]
  2903. fn test_listen_syn() {
  2904. let mut s = socket_listen();
  2905. send!(
  2906. s,
  2907. TcpRepr {
  2908. control: TcpControl::Syn,
  2909. seq_number: REMOTE_SEQ,
  2910. ack_number: None,
  2911. ..SEND_TEMPL
  2912. }
  2913. );
  2914. sanity!(s, socket_syn_received());
  2915. }
  2916. #[test]
  2917. fn test_listen_syn_reject_ack() {
  2918. let mut s = socket_listen();
  2919. let tcp_repr = TcpRepr {
  2920. control: TcpControl::Syn,
  2921. seq_number: REMOTE_SEQ,
  2922. ack_number: Some(LOCAL_SEQ),
  2923. ..SEND_TEMPL
  2924. };
  2925. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  2926. assert_eq!(s.state, State::Listen);
  2927. }
  2928. #[test]
  2929. fn test_listen_rst() {
  2930. let mut s = socket_listen();
  2931. let tcp_repr = TcpRepr {
  2932. control: TcpControl::Rst,
  2933. seq_number: REMOTE_SEQ,
  2934. ack_number: None,
  2935. ..SEND_TEMPL
  2936. };
  2937. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  2938. assert_eq!(s.state, State::Listen);
  2939. }
  2940. #[test]
  2941. fn test_listen_close() {
  2942. let mut s = socket_listen();
  2943. s.close();
  2944. assert_eq!(s.state, State::Closed);
  2945. }
  2946. // =========================================================================================//
  2947. // Tests for the SYN-RECEIVED state.
  2948. // =========================================================================================//
  2949. #[test]
  2950. fn test_syn_received_ack() {
  2951. let mut s = socket_syn_received();
  2952. recv!(
  2953. s,
  2954. [TcpRepr {
  2955. control: TcpControl::Syn,
  2956. seq_number: LOCAL_SEQ,
  2957. ack_number: Some(REMOTE_SEQ + 1),
  2958. max_seg_size: Some(BASE_MSS),
  2959. ..RECV_TEMPL
  2960. }]
  2961. );
  2962. send!(
  2963. s,
  2964. TcpRepr {
  2965. seq_number: REMOTE_SEQ + 1,
  2966. ack_number: Some(LOCAL_SEQ + 1),
  2967. ..SEND_TEMPL
  2968. }
  2969. );
  2970. assert_eq!(s.state, State::Established);
  2971. sanity!(s, socket_established());
  2972. }
  2973. #[test]
  2974. fn test_syn_received_ack_too_low() {
  2975. let mut s = socket_syn_received();
  2976. recv!(
  2977. s,
  2978. [TcpRepr {
  2979. control: TcpControl::Syn,
  2980. seq_number: LOCAL_SEQ,
  2981. ack_number: Some(REMOTE_SEQ + 1),
  2982. max_seg_size: Some(BASE_MSS),
  2983. ..RECV_TEMPL
  2984. }]
  2985. );
  2986. send!(
  2987. s,
  2988. TcpRepr {
  2989. seq_number: REMOTE_SEQ + 1,
  2990. ack_number: Some(LOCAL_SEQ), // wrong
  2991. ..SEND_TEMPL
  2992. },
  2993. Some(TcpRepr {
  2994. control: TcpControl::Rst,
  2995. seq_number: LOCAL_SEQ,
  2996. ack_number: None,
  2997. window_len: 0,
  2998. ..RECV_TEMPL
  2999. })
  3000. );
  3001. assert_eq!(s.state, State::SynReceived);
  3002. }
  3003. #[test]
  3004. fn test_syn_received_ack_too_high() {
  3005. let mut s = socket_syn_received();
  3006. recv!(
  3007. s,
  3008. [TcpRepr {
  3009. control: TcpControl::Syn,
  3010. seq_number: LOCAL_SEQ,
  3011. ack_number: Some(REMOTE_SEQ + 1),
  3012. max_seg_size: Some(BASE_MSS),
  3013. ..RECV_TEMPL
  3014. }]
  3015. );
  3016. send!(
  3017. s,
  3018. TcpRepr {
  3019. seq_number: REMOTE_SEQ + 1,
  3020. ack_number: Some(LOCAL_SEQ + 2), // wrong
  3021. ..SEND_TEMPL
  3022. },
  3023. Some(TcpRepr {
  3024. control: TcpControl::Rst,
  3025. seq_number: LOCAL_SEQ + 2,
  3026. ack_number: None,
  3027. window_len: 0,
  3028. ..RECV_TEMPL
  3029. })
  3030. );
  3031. assert_eq!(s.state, State::SynReceived);
  3032. }
  3033. #[test]
  3034. fn test_syn_received_fin() {
  3035. let mut s = socket_syn_received();
  3036. recv!(
  3037. s,
  3038. [TcpRepr {
  3039. control: TcpControl::Syn,
  3040. seq_number: LOCAL_SEQ,
  3041. ack_number: Some(REMOTE_SEQ + 1),
  3042. max_seg_size: Some(BASE_MSS),
  3043. ..RECV_TEMPL
  3044. }]
  3045. );
  3046. send!(
  3047. s,
  3048. TcpRepr {
  3049. control: TcpControl::Fin,
  3050. seq_number: REMOTE_SEQ + 1,
  3051. ack_number: Some(LOCAL_SEQ + 1),
  3052. payload: &b"abcdef"[..],
  3053. ..SEND_TEMPL
  3054. }
  3055. );
  3056. recv!(
  3057. s,
  3058. [TcpRepr {
  3059. seq_number: LOCAL_SEQ + 1,
  3060. ack_number: Some(REMOTE_SEQ + 1 + 6 + 1),
  3061. window_len: 58,
  3062. ..RECV_TEMPL
  3063. }]
  3064. );
  3065. assert_eq!(s.state, State::CloseWait);
  3066. let mut s2 = socket_close_wait();
  3067. s2.remote_last_ack = Some(REMOTE_SEQ + 1 + 6 + 1);
  3068. s2.remote_last_win = 58;
  3069. sanity!(s, s2);
  3070. }
  3071. #[test]
  3072. fn test_syn_received_rst() {
  3073. let mut s = socket_syn_received();
  3074. s.listen_endpoint = LISTEN_END;
  3075. recv!(
  3076. s,
  3077. [TcpRepr {
  3078. control: TcpControl::Syn,
  3079. seq_number: LOCAL_SEQ,
  3080. ack_number: Some(REMOTE_SEQ + 1),
  3081. max_seg_size: Some(BASE_MSS),
  3082. ..RECV_TEMPL
  3083. }]
  3084. );
  3085. send!(
  3086. s,
  3087. TcpRepr {
  3088. control: TcpControl::Rst,
  3089. seq_number: REMOTE_SEQ + 1,
  3090. ack_number: Some(LOCAL_SEQ),
  3091. ..SEND_TEMPL
  3092. }
  3093. );
  3094. assert_eq!(s.state, State::Listen);
  3095. assert_eq!(s.listen_endpoint, LISTEN_END);
  3096. assert_eq!(s.tuple, None);
  3097. }
  3098. #[test]
  3099. fn test_syn_received_no_window_scaling() {
  3100. let mut s = socket_listen();
  3101. send!(
  3102. s,
  3103. TcpRepr {
  3104. control: TcpControl::Syn,
  3105. seq_number: REMOTE_SEQ,
  3106. ack_number: None,
  3107. ..SEND_TEMPL
  3108. }
  3109. );
  3110. assert_eq!(s.state(), State::SynReceived);
  3111. assert_eq!(s.tuple, Some(TUPLE));
  3112. recv!(
  3113. s,
  3114. [TcpRepr {
  3115. control: TcpControl::Syn,
  3116. seq_number: LOCAL_SEQ,
  3117. ack_number: Some(REMOTE_SEQ + 1),
  3118. max_seg_size: Some(BASE_MSS),
  3119. window_scale: None,
  3120. ..RECV_TEMPL
  3121. }]
  3122. );
  3123. send!(
  3124. s,
  3125. TcpRepr {
  3126. seq_number: REMOTE_SEQ + 1,
  3127. ack_number: Some(LOCAL_SEQ + 1),
  3128. window_scale: None,
  3129. ..SEND_TEMPL
  3130. }
  3131. );
  3132. assert_eq!(s.remote_win_shift, 0);
  3133. assert_eq!(s.remote_win_scale, None);
  3134. }
  3135. #[test]
  3136. fn test_syn_received_window_scaling() {
  3137. for scale in 0..14 {
  3138. let mut s = socket_listen();
  3139. send!(
  3140. s,
  3141. TcpRepr {
  3142. control: TcpControl::Syn,
  3143. seq_number: REMOTE_SEQ,
  3144. ack_number: None,
  3145. window_scale: Some(scale),
  3146. ..SEND_TEMPL
  3147. }
  3148. );
  3149. assert_eq!(s.state(), State::SynReceived);
  3150. assert_eq!(s.tuple, Some(TUPLE));
  3151. recv!(
  3152. s,
  3153. [TcpRepr {
  3154. control: TcpControl::Syn,
  3155. seq_number: LOCAL_SEQ,
  3156. ack_number: Some(REMOTE_SEQ + 1),
  3157. max_seg_size: Some(BASE_MSS),
  3158. window_scale: Some(0),
  3159. ..RECV_TEMPL
  3160. }]
  3161. );
  3162. send!(
  3163. s,
  3164. TcpRepr {
  3165. seq_number: REMOTE_SEQ + 1,
  3166. ack_number: Some(LOCAL_SEQ + 1),
  3167. window_scale: None,
  3168. ..SEND_TEMPL
  3169. }
  3170. );
  3171. assert_eq!(s.remote_win_scale, Some(scale));
  3172. }
  3173. }
  3174. #[test]
  3175. fn test_syn_received_close() {
  3176. let mut s = socket_syn_received();
  3177. s.close();
  3178. assert_eq!(s.state, State::FinWait1);
  3179. }
  3180. // =========================================================================================//
  3181. // Tests for the SYN-SENT state.
  3182. // =========================================================================================//
  3183. #[test]
  3184. fn test_connect_validation() {
  3185. let mut s = socket();
  3186. assert_eq!(
  3187. s.socket
  3188. .connect(&mut s.cx, REMOTE_END, (IpvXAddress::UNSPECIFIED, 0)),
  3189. Err(ConnectError::Unaddressable)
  3190. );
  3191. assert_eq!(
  3192. s.socket
  3193. .connect(&mut s.cx, REMOTE_END, (IpvXAddress::UNSPECIFIED, 1024)),
  3194. Err(ConnectError::Unaddressable)
  3195. );
  3196. assert_eq!(
  3197. s.socket
  3198. .connect(&mut s.cx, (IpvXAddress::UNSPECIFIED, 0), LOCAL_END),
  3199. Err(ConnectError::Unaddressable)
  3200. );
  3201. s.socket
  3202. .connect(&mut s.cx, REMOTE_END, LOCAL_END)
  3203. .expect("Connect failed with valid parameters");
  3204. assert_eq!(s.tuple, Some(TUPLE));
  3205. }
  3206. #[test]
  3207. fn test_connect() {
  3208. let mut s = socket();
  3209. s.local_seq_no = LOCAL_SEQ;
  3210. s.socket
  3211. .connect(&mut s.cx, REMOTE_END, LOCAL_END.port)
  3212. .unwrap();
  3213. assert_eq!(s.tuple, Some(TUPLE));
  3214. recv!(
  3215. s,
  3216. [TcpRepr {
  3217. control: TcpControl::Syn,
  3218. seq_number: LOCAL_SEQ,
  3219. ack_number: None,
  3220. max_seg_size: Some(BASE_MSS),
  3221. window_scale: Some(0),
  3222. sack_permitted: true,
  3223. ..RECV_TEMPL
  3224. }]
  3225. );
  3226. send!(
  3227. s,
  3228. TcpRepr {
  3229. control: TcpControl::Syn,
  3230. seq_number: REMOTE_SEQ,
  3231. ack_number: Some(LOCAL_SEQ + 1),
  3232. max_seg_size: Some(BASE_MSS - 80),
  3233. window_scale: Some(0),
  3234. ..SEND_TEMPL
  3235. }
  3236. );
  3237. assert_eq!(s.tuple, Some(TUPLE));
  3238. }
  3239. #[test]
  3240. fn test_connect_unspecified_local() {
  3241. let mut s = socket();
  3242. assert_eq!(s.socket.connect(&mut s.cx, REMOTE_END, 80), Ok(()));
  3243. }
  3244. #[test]
  3245. fn test_connect_specified_local() {
  3246. let mut s = socket();
  3247. assert_eq!(
  3248. s.socket.connect(&mut s.cx, REMOTE_END, (REMOTE_ADDR, 80)),
  3249. Ok(())
  3250. );
  3251. }
  3252. #[test]
  3253. fn test_connect_twice() {
  3254. let mut s = socket();
  3255. assert_eq!(s.socket.connect(&mut s.cx, REMOTE_END, 80), Ok(()));
  3256. assert_eq!(
  3257. s.socket.connect(&mut s.cx, REMOTE_END, 80),
  3258. Err(ConnectError::InvalidState)
  3259. );
  3260. }
  3261. #[test]
  3262. fn test_syn_sent_sanity() {
  3263. let mut s = socket();
  3264. s.local_seq_no = LOCAL_SEQ;
  3265. s.socket.connect(&mut s.cx, REMOTE_END, LOCAL_END).unwrap();
  3266. sanity!(s, socket_syn_sent());
  3267. }
  3268. #[test]
  3269. fn test_syn_sent_syn_ack() {
  3270. let mut s = socket_syn_sent();
  3271. recv!(
  3272. s,
  3273. [TcpRepr {
  3274. control: TcpControl::Syn,
  3275. seq_number: LOCAL_SEQ,
  3276. ack_number: None,
  3277. max_seg_size: Some(BASE_MSS),
  3278. window_scale: Some(0),
  3279. sack_permitted: true,
  3280. ..RECV_TEMPL
  3281. }]
  3282. );
  3283. send!(
  3284. s,
  3285. TcpRepr {
  3286. control: TcpControl::Syn,
  3287. seq_number: REMOTE_SEQ,
  3288. ack_number: Some(LOCAL_SEQ + 1),
  3289. max_seg_size: Some(BASE_MSS - 80),
  3290. window_scale: Some(0),
  3291. ..SEND_TEMPL
  3292. }
  3293. );
  3294. recv!(
  3295. s,
  3296. [TcpRepr {
  3297. seq_number: LOCAL_SEQ + 1,
  3298. ack_number: Some(REMOTE_SEQ + 1),
  3299. ..RECV_TEMPL
  3300. }]
  3301. );
  3302. recv_nothing!(s, time 1000);
  3303. assert_eq!(s.state, State::Established);
  3304. sanity!(s, socket_established());
  3305. }
  3306. #[test]
  3307. fn test_syn_sent_syn_received_ack() {
  3308. let mut s = socket_syn_sent();
  3309. recv!(
  3310. s,
  3311. [TcpRepr {
  3312. control: TcpControl::Syn,
  3313. seq_number: LOCAL_SEQ,
  3314. ack_number: None,
  3315. max_seg_size: Some(BASE_MSS),
  3316. window_scale: Some(0),
  3317. sack_permitted: true,
  3318. ..RECV_TEMPL
  3319. }]
  3320. );
  3321. // A SYN packet changes the SYN-SENT state to SYN-RECEIVED.
  3322. send!(
  3323. s,
  3324. TcpRepr {
  3325. control: TcpControl::Syn,
  3326. seq_number: REMOTE_SEQ,
  3327. ack_number: None,
  3328. max_seg_size: Some(BASE_MSS - 80),
  3329. window_scale: Some(0),
  3330. ..SEND_TEMPL
  3331. }
  3332. );
  3333. assert_eq!(s.state, State::SynReceived);
  3334. // The socket will then send a SYN|ACK packet.
  3335. recv!(
  3336. s,
  3337. [TcpRepr {
  3338. control: TcpControl::Syn,
  3339. seq_number: LOCAL_SEQ,
  3340. ack_number: Some(REMOTE_SEQ + 1),
  3341. max_seg_size: Some(BASE_MSS),
  3342. window_scale: Some(0),
  3343. ..RECV_TEMPL
  3344. }]
  3345. );
  3346. recv_nothing!(s);
  3347. // The socket may retransmit the SYN|ACK packet.
  3348. recv!(
  3349. s,
  3350. time 1001,
  3351. Ok(TcpRepr {
  3352. control: TcpControl::Syn,
  3353. seq_number: LOCAL_SEQ,
  3354. ack_number: Some(REMOTE_SEQ + 1),
  3355. max_seg_size: Some(BASE_MSS),
  3356. window_scale: Some(0),
  3357. ..RECV_TEMPL
  3358. })
  3359. );
  3360. // An ACK packet changes the SYN-RECEIVED state to ESTABLISHED.
  3361. send!(
  3362. s,
  3363. TcpRepr {
  3364. control: TcpControl::None,
  3365. seq_number: REMOTE_SEQ + 1,
  3366. ack_number: Some(LOCAL_SEQ + 1),
  3367. ..SEND_TEMPL
  3368. }
  3369. );
  3370. assert_eq!(s.state, State::Established);
  3371. sanity!(s, socket_established());
  3372. }
  3373. #[test]
  3374. fn test_syn_sent_syn_ack_not_incremented() {
  3375. let mut s = socket_syn_sent();
  3376. recv!(
  3377. s,
  3378. [TcpRepr {
  3379. control: TcpControl::Syn,
  3380. seq_number: LOCAL_SEQ,
  3381. ack_number: None,
  3382. max_seg_size: Some(BASE_MSS),
  3383. window_scale: Some(0),
  3384. sack_permitted: true,
  3385. ..RECV_TEMPL
  3386. }]
  3387. );
  3388. send!(
  3389. s,
  3390. TcpRepr {
  3391. control: TcpControl::Syn,
  3392. seq_number: REMOTE_SEQ,
  3393. ack_number: Some(LOCAL_SEQ), // WRONG
  3394. max_seg_size: Some(BASE_MSS - 80),
  3395. window_scale: Some(0),
  3396. ..SEND_TEMPL
  3397. },
  3398. Some(TcpRepr {
  3399. control: TcpControl::Rst,
  3400. seq_number: LOCAL_SEQ,
  3401. ack_number: None,
  3402. window_len: 0,
  3403. ..RECV_TEMPL
  3404. })
  3405. );
  3406. assert_eq!(s.state, State::SynSent);
  3407. }
  3408. #[test]
  3409. fn test_syn_sent_syn_received_rst() {
  3410. let mut s = socket_syn_sent();
  3411. recv!(
  3412. s,
  3413. [TcpRepr {
  3414. control: TcpControl::Syn,
  3415. seq_number: LOCAL_SEQ,
  3416. ack_number: None,
  3417. max_seg_size: Some(BASE_MSS),
  3418. window_scale: Some(0),
  3419. sack_permitted: true,
  3420. ..RECV_TEMPL
  3421. }]
  3422. );
  3423. // A SYN packet changes the SYN-SENT state to SYN-RECEIVED.
  3424. send!(
  3425. s,
  3426. TcpRepr {
  3427. control: TcpControl::Syn,
  3428. seq_number: REMOTE_SEQ,
  3429. ack_number: None,
  3430. max_seg_size: Some(BASE_MSS - 80),
  3431. window_scale: Some(0),
  3432. ..SEND_TEMPL
  3433. }
  3434. );
  3435. assert_eq!(s.state, State::SynReceived);
  3436. // A RST packet changes the SYN-RECEIVED state to CLOSED.
  3437. send!(
  3438. s,
  3439. TcpRepr {
  3440. control: TcpControl::Rst,
  3441. seq_number: REMOTE_SEQ + 1,
  3442. ack_number: Some(LOCAL_SEQ),
  3443. ..SEND_TEMPL
  3444. }
  3445. );
  3446. assert_eq!(s.state, State::Closed);
  3447. }
  3448. #[test]
  3449. fn test_syn_sent_rst() {
  3450. let mut s = socket_syn_sent();
  3451. send!(
  3452. s,
  3453. TcpRepr {
  3454. control: TcpControl::Rst,
  3455. seq_number: REMOTE_SEQ,
  3456. ack_number: Some(LOCAL_SEQ + 1),
  3457. ..SEND_TEMPL
  3458. }
  3459. );
  3460. assert_eq!(s.state, State::Closed);
  3461. }
  3462. #[test]
  3463. fn test_syn_sent_rst_no_ack() {
  3464. let mut s = socket_syn_sent();
  3465. send!(
  3466. s,
  3467. TcpRepr {
  3468. control: TcpControl::Rst,
  3469. seq_number: REMOTE_SEQ,
  3470. ack_number: None,
  3471. ..SEND_TEMPL
  3472. }
  3473. );
  3474. assert_eq!(s.state, State::SynSent);
  3475. }
  3476. #[test]
  3477. fn test_syn_sent_rst_bad_ack() {
  3478. let mut s = socket_syn_sent();
  3479. send!(
  3480. s,
  3481. TcpRepr {
  3482. control: TcpControl::Rst,
  3483. seq_number: REMOTE_SEQ,
  3484. ack_number: Some(TcpSeqNumber(1234)),
  3485. ..SEND_TEMPL
  3486. }
  3487. );
  3488. assert_eq!(s.state, State::SynSent);
  3489. }
  3490. #[test]
  3491. fn test_syn_sent_bad_ack() {
  3492. let mut s = socket_syn_sent();
  3493. recv!(
  3494. s,
  3495. [TcpRepr {
  3496. control: TcpControl::Syn,
  3497. seq_number: LOCAL_SEQ,
  3498. ack_number: None,
  3499. max_seg_size: Some(BASE_MSS),
  3500. window_scale: Some(0),
  3501. sack_permitted: true,
  3502. ..RECV_TEMPL
  3503. }]
  3504. );
  3505. send!(
  3506. s,
  3507. TcpRepr {
  3508. control: TcpControl::None, // Unexpected
  3509. seq_number: REMOTE_SEQ,
  3510. ack_number: Some(LOCAL_SEQ + 1), // Correct
  3511. ..SEND_TEMPL
  3512. }
  3513. );
  3514. // It should trigger no response and change no state
  3515. recv!(s, []);
  3516. assert_eq!(s.state, State::SynSent);
  3517. }
  3518. #[test]
  3519. fn test_syn_sent_bad_ack_seq_1() {
  3520. let mut s = socket_syn_sent();
  3521. recv!(
  3522. s,
  3523. [TcpRepr {
  3524. control: TcpControl::Syn,
  3525. seq_number: LOCAL_SEQ,
  3526. ack_number: None,
  3527. max_seg_size: Some(BASE_MSS),
  3528. window_scale: Some(0),
  3529. sack_permitted: true,
  3530. ..RECV_TEMPL
  3531. }]
  3532. );
  3533. send!(
  3534. s,
  3535. TcpRepr {
  3536. control: TcpControl::None,
  3537. seq_number: REMOTE_SEQ,
  3538. ack_number: Some(LOCAL_SEQ), // WRONG
  3539. ..SEND_TEMPL
  3540. },
  3541. Some(TcpRepr {
  3542. control: TcpControl::Rst,
  3543. seq_number: LOCAL_SEQ, // matching the ack_number of the unexpected ack
  3544. ack_number: None,
  3545. window_len: 0,
  3546. ..RECV_TEMPL
  3547. })
  3548. );
  3549. // It should trigger a RST, and change no state
  3550. assert_eq!(s.state, State::SynSent);
  3551. }
  3552. #[test]
  3553. fn test_syn_sent_bad_ack_seq_2() {
  3554. let mut s = socket_syn_sent();
  3555. recv!(
  3556. s,
  3557. [TcpRepr {
  3558. control: TcpControl::Syn,
  3559. seq_number: LOCAL_SEQ,
  3560. ack_number: None,
  3561. max_seg_size: Some(BASE_MSS),
  3562. window_scale: Some(0),
  3563. sack_permitted: true,
  3564. ..RECV_TEMPL
  3565. }]
  3566. );
  3567. send!(
  3568. s,
  3569. TcpRepr {
  3570. control: TcpControl::None,
  3571. seq_number: REMOTE_SEQ,
  3572. ack_number: Some(LOCAL_SEQ + 123456), // WRONG
  3573. ..SEND_TEMPL
  3574. },
  3575. Some(TcpRepr {
  3576. control: TcpControl::Rst,
  3577. seq_number: LOCAL_SEQ + 123456, // matching the ack_number of the unexpected ack
  3578. ack_number: None,
  3579. window_len: 0,
  3580. ..RECV_TEMPL
  3581. })
  3582. );
  3583. // It should trigger a RST, and change no state
  3584. assert_eq!(s.state, State::SynSent);
  3585. }
  3586. #[test]
  3587. fn test_syn_sent_close() {
  3588. let mut s = socket();
  3589. s.close();
  3590. assert_eq!(s.state, State::Closed);
  3591. }
  3592. #[test]
  3593. fn test_syn_sent_sack_option() {
  3594. let mut s = socket_syn_sent();
  3595. recv!(
  3596. s,
  3597. [TcpRepr {
  3598. control: TcpControl::Syn,
  3599. seq_number: LOCAL_SEQ,
  3600. ack_number: None,
  3601. max_seg_size: Some(BASE_MSS),
  3602. window_scale: Some(0),
  3603. sack_permitted: true,
  3604. ..RECV_TEMPL
  3605. }]
  3606. );
  3607. send!(
  3608. s,
  3609. TcpRepr {
  3610. control: TcpControl::Syn,
  3611. seq_number: REMOTE_SEQ,
  3612. ack_number: Some(LOCAL_SEQ + 1),
  3613. max_seg_size: Some(BASE_MSS - 80),
  3614. window_scale: Some(0),
  3615. sack_permitted: true,
  3616. ..SEND_TEMPL
  3617. }
  3618. );
  3619. assert!(s.remote_has_sack);
  3620. let mut s = socket_syn_sent();
  3621. recv!(
  3622. s,
  3623. [TcpRepr {
  3624. control: TcpControl::Syn,
  3625. seq_number: LOCAL_SEQ,
  3626. ack_number: None,
  3627. max_seg_size: Some(BASE_MSS),
  3628. window_scale: Some(0),
  3629. sack_permitted: true,
  3630. ..RECV_TEMPL
  3631. }]
  3632. );
  3633. send!(
  3634. s,
  3635. TcpRepr {
  3636. control: TcpControl::Syn,
  3637. seq_number: REMOTE_SEQ,
  3638. ack_number: Some(LOCAL_SEQ + 1),
  3639. max_seg_size: Some(BASE_MSS - 80),
  3640. window_scale: Some(0),
  3641. sack_permitted: false,
  3642. ..SEND_TEMPL
  3643. }
  3644. );
  3645. assert!(!s.remote_has_sack);
  3646. }
  3647. #[test]
  3648. fn test_syn_sent_win_scale_buffers() {
  3649. for (buffer_size, shift_amt) in &[
  3650. (64, 0),
  3651. (128, 0),
  3652. (1024, 0),
  3653. (65535, 0),
  3654. (65536, 1),
  3655. (65537, 1),
  3656. (131071, 1),
  3657. (131072, 2),
  3658. (524287, 3),
  3659. (524288, 4),
  3660. (655350, 4),
  3661. (1048576, 5),
  3662. ] {
  3663. let mut s = socket_with_buffer_sizes(64, *buffer_size);
  3664. s.local_seq_no = LOCAL_SEQ;
  3665. assert_eq!(s.remote_win_shift, *shift_amt);
  3666. s.socket.connect(&mut s.cx, REMOTE_END, LOCAL_END).unwrap();
  3667. recv!(
  3668. s,
  3669. [TcpRepr {
  3670. control: TcpControl::Syn,
  3671. seq_number: LOCAL_SEQ,
  3672. ack_number: None,
  3673. max_seg_size: Some(BASE_MSS),
  3674. window_scale: Some(*shift_amt),
  3675. window_len: u16::try_from(*buffer_size).unwrap_or(u16::MAX),
  3676. sack_permitted: true,
  3677. ..RECV_TEMPL
  3678. }]
  3679. );
  3680. }
  3681. }
  3682. #[test]
  3683. fn test_syn_sent_syn_ack_no_window_scaling() {
  3684. let mut s = socket_syn_sent_with_buffer_sizes(1048576, 1048576);
  3685. recv!(
  3686. s,
  3687. [TcpRepr {
  3688. control: TcpControl::Syn,
  3689. seq_number: LOCAL_SEQ,
  3690. ack_number: None,
  3691. max_seg_size: Some(BASE_MSS),
  3692. // scaling does NOT apply to the window value in SYN packets
  3693. window_len: 65535,
  3694. window_scale: Some(5),
  3695. sack_permitted: true,
  3696. ..RECV_TEMPL
  3697. }]
  3698. );
  3699. assert_eq!(s.remote_win_shift, 5);
  3700. send!(
  3701. s,
  3702. TcpRepr {
  3703. control: TcpControl::Syn,
  3704. seq_number: REMOTE_SEQ,
  3705. ack_number: Some(LOCAL_SEQ + 1),
  3706. max_seg_size: Some(BASE_MSS - 80),
  3707. window_scale: None,
  3708. window_len: 42,
  3709. ..SEND_TEMPL
  3710. }
  3711. );
  3712. assert_eq!(s.state, State::Established);
  3713. assert_eq!(s.remote_win_shift, 0);
  3714. assert_eq!(s.remote_win_scale, None);
  3715. assert_eq!(s.remote_win_len, 42);
  3716. }
  3717. #[test]
  3718. fn test_syn_sent_syn_ack_window_scaling() {
  3719. let mut s = socket_syn_sent();
  3720. recv!(
  3721. s,
  3722. [TcpRepr {
  3723. control: TcpControl::Syn,
  3724. seq_number: LOCAL_SEQ,
  3725. ack_number: None,
  3726. max_seg_size: Some(BASE_MSS),
  3727. window_scale: Some(0),
  3728. sack_permitted: true,
  3729. ..RECV_TEMPL
  3730. }]
  3731. );
  3732. send!(
  3733. s,
  3734. TcpRepr {
  3735. control: TcpControl::Syn,
  3736. seq_number: REMOTE_SEQ,
  3737. ack_number: Some(LOCAL_SEQ + 1),
  3738. max_seg_size: Some(BASE_MSS - 80),
  3739. window_scale: Some(7),
  3740. window_len: 42,
  3741. ..SEND_TEMPL
  3742. }
  3743. );
  3744. assert_eq!(s.state, State::Established);
  3745. assert_eq!(s.remote_win_scale, Some(7));
  3746. // scaling does NOT apply to the window value in SYN packets
  3747. assert_eq!(s.remote_win_len, 42);
  3748. }
  3749. // =========================================================================================//
  3750. // Tests for the ESTABLISHED state.
  3751. // =========================================================================================//
  3752. #[test]
  3753. fn test_established_recv() {
  3754. let mut s = socket_established();
  3755. send!(
  3756. s,
  3757. TcpRepr {
  3758. seq_number: REMOTE_SEQ + 1,
  3759. ack_number: Some(LOCAL_SEQ + 1),
  3760. payload: &b"abcdef"[..],
  3761. ..SEND_TEMPL
  3762. }
  3763. );
  3764. recv!(
  3765. s,
  3766. [TcpRepr {
  3767. seq_number: LOCAL_SEQ + 1,
  3768. ack_number: Some(REMOTE_SEQ + 1 + 6),
  3769. window_len: 58,
  3770. ..RECV_TEMPL
  3771. }]
  3772. );
  3773. assert_eq!(s.rx_buffer.dequeue_many(6), &b"abcdef"[..]);
  3774. }
  3775. #[test]
  3776. fn test_peek_slice() {
  3777. const BUF_SIZE: usize = 10;
  3778. let send_buf = b"0123456";
  3779. let mut s = socket_established_with_buffer_sizes(BUF_SIZE, BUF_SIZE);
  3780. // Populate the recv buffer
  3781. send!(
  3782. s,
  3783. TcpRepr {
  3784. seq_number: REMOTE_SEQ + 1,
  3785. ack_number: Some(LOCAL_SEQ + 1),
  3786. payload: &send_buf[..],
  3787. ..SEND_TEMPL
  3788. }
  3789. );
  3790. // Peek into the recv buffer
  3791. let mut peeked_buf = [0u8; BUF_SIZE];
  3792. let actually_peeked = s.peek_slice(&mut peeked_buf[..]).unwrap();
  3793. let mut recv_buf = [0u8; BUF_SIZE];
  3794. let actually_recvd = s.recv_slice(&mut recv_buf[..]).unwrap();
  3795. assert_eq!(
  3796. &mut peeked_buf[..actually_peeked],
  3797. &mut recv_buf[..actually_recvd]
  3798. );
  3799. }
  3800. #[test]
  3801. fn test_peek_slice_buffer_wrap() {
  3802. const BUF_SIZE: usize = 10;
  3803. let send_buf = b"0123456789";
  3804. let mut s = socket_established_with_buffer_sizes(BUF_SIZE, BUF_SIZE);
  3805. let _ = s.rx_buffer.enqueue_slice(&send_buf[..8]);
  3806. let _ = s.rx_buffer.dequeue_many(6);
  3807. let _ = s.rx_buffer.enqueue_slice(&send_buf[..5]);
  3808. let mut peeked_buf = [0u8; BUF_SIZE];
  3809. let actually_peeked = s.peek_slice(&mut peeked_buf[..]).unwrap();
  3810. let mut recv_buf = [0u8; BUF_SIZE];
  3811. let actually_recvd = s.recv_slice(&mut recv_buf[..]).unwrap();
  3812. assert_eq!(
  3813. &mut peeked_buf[..actually_peeked],
  3814. &mut recv_buf[..actually_recvd]
  3815. );
  3816. }
  3817. fn setup_rfc2018_cases() -> (TestSocket, Vec<u8>) {
  3818. // This is a utility function used by the tests for RFC 2018 cases. It configures a socket
  3819. // in a particular way suitable for those cases.
  3820. //
  3821. // RFC 2018: Assume the left window edge is 5000 and that the data transmitter sends [...]
  3822. // segments, each containing 500 data bytes.
  3823. let mut s = socket_established_with_buffer_sizes(4000, 4000);
  3824. s.remote_has_sack = true;
  3825. // create a segment that is 500 bytes long
  3826. let mut segment: Vec<u8> = Vec::with_capacity(500);
  3827. // move the last ack to 5000 by sending ten of them
  3828. for _ in 0..50 {
  3829. segment.extend_from_slice(b"abcdefghij")
  3830. }
  3831. for offset in (0..5000).step_by(500) {
  3832. send!(
  3833. s,
  3834. TcpRepr {
  3835. seq_number: REMOTE_SEQ + 1 + offset,
  3836. ack_number: Some(LOCAL_SEQ + 1),
  3837. payload: &segment,
  3838. ..SEND_TEMPL
  3839. }
  3840. );
  3841. recv!(
  3842. s,
  3843. [TcpRepr {
  3844. seq_number: LOCAL_SEQ + 1,
  3845. ack_number: Some(REMOTE_SEQ + 1 + offset + 500),
  3846. window_len: 3500,
  3847. ..RECV_TEMPL
  3848. }]
  3849. );
  3850. s.recv(|data| {
  3851. assert_eq!(data.len(), 500);
  3852. assert_eq!(data, segment.as_slice());
  3853. (500, ())
  3854. })
  3855. .unwrap();
  3856. }
  3857. assert_eq!(s.remote_last_win, 3500);
  3858. (s, segment)
  3859. }
  3860. #[test]
  3861. fn test_established_rfc2018_cases() {
  3862. // This test case verifies the exact scenarios described on pages 8-9 of RFC 2018. Please
  3863. // ensure its behavior does not deviate from those scenarios.
  3864. let (mut s, segment) = setup_rfc2018_cases();
  3865. // RFC 2018:
  3866. //
  3867. // Case 2: The first segment is dropped but the remaining 7 are received.
  3868. //
  3869. // Upon receiving each of the last seven packets, the data receiver will return a TCP ACK
  3870. // segment that acknowledges sequence number 5000 and contains a SACK option specifying one
  3871. // block of queued data:
  3872. //
  3873. // Triggering ACK Left Edge Right Edge
  3874. // Segment
  3875. //
  3876. // 5000 (lost)
  3877. // 5500 5000 5500 6000
  3878. // 6000 5000 5500 6500
  3879. // 6500 5000 5500 7000
  3880. // 7000 5000 5500 7500
  3881. // 7500 5000 5500 8000
  3882. // 8000 5000 5500 8500
  3883. // 8500 5000 5500 9000
  3884. //
  3885. for offset in (500..3500).step_by(500) {
  3886. send!(
  3887. s,
  3888. TcpRepr {
  3889. seq_number: REMOTE_SEQ + 1 + offset + 5000,
  3890. ack_number: Some(LOCAL_SEQ + 1),
  3891. payload: &segment,
  3892. ..SEND_TEMPL
  3893. },
  3894. Some(TcpRepr {
  3895. seq_number: LOCAL_SEQ + 1,
  3896. ack_number: Some(REMOTE_SEQ + 1 + 5000),
  3897. window_len: 4000,
  3898. sack_ranges: [
  3899. Some((
  3900. REMOTE_SEQ.0 as u32 + 1 + 5500,
  3901. REMOTE_SEQ.0 as u32 + 1 + 5500 + offset as u32
  3902. )),
  3903. None,
  3904. None
  3905. ],
  3906. ..RECV_TEMPL
  3907. })
  3908. );
  3909. }
  3910. }
  3911. #[test]
  3912. fn test_established_sliding_window_recv() {
  3913. let mut s = socket_established();
  3914. // Update our scaling parameters for a TCP with a scaled buffer.
  3915. assert_eq!(s.rx_buffer.len(), 0);
  3916. s.rx_buffer = SocketBuffer::new(vec![0; 262143]);
  3917. s.assembler = Assembler::new();
  3918. s.remote_win_scale = Some(0);
  3919. s.remote_last_win = 65535;
  3920. s.remote_win_shift = 2;
  3921. // Create a TCP segment that will mostly fill an IP frame.
  3922. let mut segment: Vec<u8> = Vec::with_capacity(1400);
  3923. for _ in 0..100 {
  3924. segment.extend_from_slice(b"abcdefghijklmn")
  3925. }
  3926. assert_eq!(segment.len(), 1400);
  3927. // Send the frame
  3928. send!(
  3929. s,
  3930. TcpRepr {
  3931. seq_number: REMOTE_SEQ + 1,
  3932. ack_number: Some(LOCAL_SEQ + 1),
  3933. payload: &segment,
  3934. ..SEND_TEMPL
  3935. }
  3936. );
  3937. // Ensure that the received window size is shifted right by 2.
  3938. recv!(
  3939. s,
  3940. [TcpRepr {
  3941. seq_number: LOCAL_SEQ + 1,
  3942. ack_number: Some(REMOTE_SEQ + 1 + 1400),
  3943. window_len: 65185,
  3944. ..RECV_TEMPL
  3945. }]
  3946. );
  3947. }
  3948. #[test]
  3949. fn test_established_send() {
  3950. let mut s = socket_established();
  3951. // First roundtrip after establishing.
  3952. s.send_slice(b"abcdef").unwrap();
  3953. recv!(
  3954. s,
  3955. [TcpRepr {
  3956. seq_number: LOCAL_SEQ + 1,
  3957. ack_number: Some(REMOTE_SEQ + 1),
  3958. payload: &b"abcdef"[..],
  3959. ..RECV_TEMPL
  3960. }]
  3961. );
  3962. assert_eq!(s.tx_buffer.len(), 6);
  3963. send!(
  3964. s,
  3965. TcpRepr {
  3966. seq_number: REMOTE_SEQ + 1,
  3967. ack_number: Some(LOCAL_SEQ + 1 + 6),
  3968. ..SEND_TEMPL
  3969. }
  3970. );
  3971. assert_eq!(s.tx_buffer.len(), 0);
  3972. // Second roundtrip.
  3973. s.send_slice(b"foobar").unwrap();
  3974. recv!(
  3975. s,
  3976. [TcpRepr {
  3977. seq_number: LOCAL_SEQ + 1 + 6,
  3978. ack_number: Some(REMOTE_SEQ + 1),
  3979. payload: &b"foobar"[..],
  3980. ..RECV_TEMPL
  3981. }]
  3982. );
  3983. send!(
  3984. s,
  3985. TcpRepr {
  3986. seq_number: REMOTE_SEQ + 1,
  3987. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  3988. ..SEND_TEMPL
  3989. }
  3990. );
  3991. assert_eq!(s.tx_buffer.len(), 0);
  3992. }
  3993. #[test]
  3994. fn test_established_send_no_ack_send() {
  3995. let mut s = socket_established();
  3996. s.set_nagle_enabled(false);
  3997. s.send_slice(b"abcdef").unwrap();
  3998. recv!(
  3999. s,
  4000. [TcpRepr {
  4001. seq_number: LOCAL_SEQ + 1,
  4002. ack_number: Some(REMOTE_SEQ + 1),
  4003. payload: &b"abcdef"[..],
  4004. ..RECV_TEMPL
  4005. }]
  4006. );
  4007. s.send_slice(b"foobar").unwrap();
  4008. recv!(
  4009. s,
  4010. [TcpRepr {
  4011. seq_number: LOCAL_SEQ + 1 + 6,
  4012. ack_number: Some(REMOTE_SEQ + 1),
  4013. payload: &b"foobar"[..],
  4014. ..RECV_TEMPL
  4015. }]
  4016. );
  4017. }
  4018. #[test]
  4019. fn test_established_send_buf_gt_win() {
  4020. let mut data = [0; 32];
  4021. for (i, elem) in data.iter_mut().enumerate() {
  4022. *elem = i as u8
  4023. }
  4024. let mut s = socket_established();
  4025. s.remote_win_len = 16;
  4026. s.send_slice(&data[..]).unwrap();
  4027. recv!(
  4028. s,
  4029. [TcpRepr {
  4030. seq_number: LOCAL_SEQ + 1,
  4031. ack_number: Some(REMOTE_SEQ + 1),
  4032. payload: &data[0..16],
  4033. ..RECV_TEMPL
  4034. }]
  4035. );
  4036. }
  4037. #[test]
  4038. fn test_established_send_window_shrink() {
  4039. let mut s = socket_established();
  4040. // 6 octets fit on the remote side's window, so we send them.
  4041. s.send_slice(b"abcdef").unwrap();
  4042. recv!(
  4043. s,
  4044. [TcpRepr {
  4045. seq_number: LOCAL_SEQ + 1,
  4046. ack_number: Some(REMOTE_SEQ + 1),
  4047. payload: &b"abcdef"[..],
  4048. ..RECV_TEMPL
  4049. }]
  4050. );
  4051. assert_eq!(s.tx_buffer.len(), 6);
  4052. println!(
  4053. "local_seq_no={} remote_win_len={} remote_last_seq={}",
  4054. s.local_seq_no, s.remote_win_len, s.remote_last_seq
  4055. );
  4056. // - Peer doesn't ack them yet
  4057. // - Sends data so we need to reply with an ACK
  4058. // - ...AND and sends a window announcement that SHRINKS the window, so data we've
  4059. // previously sent is now outside the window. Yes, this is allowed by TCP.
  4060. send!(
  4061. s,
  4062. TcpRepr {
  4063. seq_number: REMOTE_SEQ + 1,
  4064. ack_number: Some(LOCAL_SEQ + 1),
  4065. window_len: 3,
  4066. payload: &b"xyzxyz"[..],
  4067. ..SEND_TEMPL
  4068. }
  4069. );
  4070. assert_eq!(s.tx_buffer.len(), 6);
  4071. println!(
  4072. "local_seq_no={} remote_win_len={} remote_last_seq={}",
  4073. s.local_seq_no, s.remote_win_len, s.remote_last_seq
  4074. );
  4075. // More data should not get sent since it doesn't fit in the window
  4076. s.send_slice(b"foobar").unwrap();
  4077. recv!(
  4078. s,
  4079. [TcpRepr {
  4080. seq_number: LOCAL_SEQ + 1 + 6,
  4081. ack_number: Some(REMOTE_SEQ + 1 + 6),
  4082. window_len: 64 - 6,
  4083. ..RECV_TEMPL
  4084. }]
  4085. );
  4086. }
  4087. #[test]
  4088. fn test_established_receive_partially_outside_window() {
  4089. let mut s = socket_established();
  4090. send!(
  4091. s,
  4092. TcpRepr {
  4093. seq_number: REMOTE_SEQ + 1,
  4094. ack_number: Some(LOCAL_SEQ + 1),
  4095. payload: &b"abc"[..],
  4096. ..SEND_TEMPL
  4097. }
  4098. );
  4099. s.recv(|data| {
  4100. assert_eq!(data, b"abc");
  4101. (3, ())
  4102. })
  4103. .unwrap();
  4104. // Peer decides to retransmit (perhaps because the ACK was lost)
  4105. // and also pushed data.
  4106. send!(
  4107. s,
  4108. TcpRepr {
  4109. seq_number: REMOTE_SEQ + 1,
  4110. ack_number: Some(LOCAL_SEQ + 1),
  4111. payload: &b"abcdef"[..],
  4112. ..SEND_TEMPL
  4113. }
  4114. );
  4115. s.recv(|data| {
  4116. assert_eq!(data, b"def");
  4117. (3, ())
  4118. })
  4119. .unwrap();
  4120. }
  4121. #[test]
  4122. fn test_established_receive_partially_outside_window_fin() {
  4123. let mut s = socket_established();
  4124. send!(
  4125. s,
  4126. TcpRepr {
  4127. seq_number: REMOTE_SEQ + 1,
  4128. ack_number: Some(LOCAL_SEQ + 1),
  4129. payload: &b"abc"[..],
  4130. ..SEND_TEMPL
  4131. }
  4132. );
  4133. s.recv(|data| {
  4134. assert_eq!(data, b"abc");
  4135. (3, ())
  4136. })
  4137. .unwrap();
  4138. // Peer decides to retransmit (perhaps because the ACK was lost)
  4139. // and also pushed data, and sent a FIN.
  4140. send!(
  4141. s,
  4142. TcpRepr {
  4143. seq_number: REMOTE_SEQ + 1,
  4144. ack_number: Some(LOCAL_SEQ + 1),
  4145. control: TcpControl::Fin,
  4146. payload: &b"abcdef"[..],
  4147. ..SEND_TEMPL
  4148. }
  4149. );
  4150. s.recv(|data| {
  4151. assert_eq!(data, b"def");
  4152. (3, ())
  4153. })
  4154. .unwrap();
  4155. // We should accept the FIN, because even though the last packet was partially
  4156. // outside the receive window, there is no hole after adding its data to the assembler.
  4157. assert_eq!(s.state, State::CloseWait);
  4158. }
  4159. #[test]
  4160. fn test_established_send_wrap() {
  4161. let mut s = socket_established();
  4162. let local_seq_start = TcpSeqNumber(i32::MAX - 1);
  4163. s.local_seq_no = local_seq_start + 1;
  4164. s.remote_last_seq = local_seq_start + 1;
  4165. s.send_slice(b"abc").unwrap();
  4166. recv!(s, time 1000, Ok(TcpRepr {
  4167. seq_number: local_seq_start + 1,
  4168. ack_number: Some(REMOTE_SEQ + 1),
  4169. payload: &b"abc"[..],
  4170. ..RECV_TEMPL
  4171. }));
  4172. }
  4173. #[test]
  4174. fn test_established_no_ack() {
  4175. let mut s = socket_established();
  4176. send!(
  4177. s,
  4178. TcpRepr {
  4179. seq_number: REMOTE_SEQ + 1,
  4180. ack_number: None,
  4181. ..SEND_TEMPL
  4182. }
  4183. );
  4184. }
  4185. #[test]
  4186. fn test_established_bad_ack() {
  4187. let mut s = socket_established();
  4188. // Already acknowledged data.
  4189. send!(
  4190. s,
  4191. TcpRepr {
  4192. seq_number: REMOTE_SEQ + 1,
  4193. ack_number: Some(TcpSeqNumber(LOCAL_SEQ.0 - 1)),
  4194. ..SEND_TEMPL
  4195. }
  4196. );
  4197. assert_eq!(s.local_seq_no, LOCAL_SEQ + 1);
  4198. // Data not yet transmitted.
  4199. send!(
  4200. s,
  4201. TcpRepr {
  4202. seq_number: REMOTE_SEQ + 1,
  4203. ack_number: Some(LOCAL_SEQ + 10),
  4204. ..SEND_TEMPL
  4205. },
  4206. Some(TcpRepr {
  4207. seq_number: LOCAL_SEQ + 1,
  4208. ack_number: Some(REMOTE_SEQ + 1),
  4209. ..RECV_TEMPL
  4210. })
  4211. );
  4212. assert_eq!(s.local_seq_no, LOCAL_SEQ + 1);
  4213. }
  4214. #[test]
  4215. fn test_established_bad_seq() {
  4216. let mut s = socket_established();
  4217. // Data outside of receive window.
  4218. send!(
  4219. s,
  4220. TcpRepr {
  4221. seq_number: REMOTE_SEQ + 1 + 256,
  4222. ack_number: Some(LOCAL_SEQ + 1),
  4223. ..SEND_TEMPL
  4224. },
  4225. Some(TcpRepr {
  4226. seq_number: LOCAL_SEQ + 1,
  4227. ack_number: Some(REMOTE_SEQ + 1),
  4228. ..RECV_TEMPL
  4229. })
  4230. );
  4231. assert_eq!(s.remote_seq_no, REMOTE_SEQ + 1);
  4232. // Challenge ACKs are rate-limited, we don't get a second one immediately.
  4233. send!(
  4234. s,
  4235. time 100,
  4236. TcpRepr {
  4237. seq_number: REMOTE_SEQ + 1 + 256,
  4238. ack_number: Some(LOCAL_SEQ + 1),
  4239. ..SEND_TEMPL
  4240. }
  4241. );
  4242. // If we wait a bit, we do get a new one.
  4243. send!(
  4244. s,
  4245. time 2000,
  4246. TcpRepr {
  4247. seq_number: REMOTE_SEQ + 1 + 256,
  4248. ack_number: Some(LOCAL_SEQ + 1),
  4249. ..SEND_TEMPL
  4250. },
  4251. Some(TcpRepr {
  4252. seq_number: LOCAL_SEQ + 1,
  4253. ack_number: Some(REMOTE_SEQ + 1),
  4254. ..RECV_TEMPL
  4255. })
  4256. );
  4257. assert_eq!(s.remote_seq_no, REMOTE_SEQ + 1);
  4258. }
  4259. #[test]
  4260. fn test_established_fin() {
  4261. let mut s = socket_established();
  4262. send!(
  4263. s,
  4264. TcpRepr {
  4265. control: TcpControl::Fin,
  4266. seq_number: REMOTE_SEQ + 1,
  4267. ack_number: Some(LOCAL_SEQ + 1),
  4268. ..SEND_TEMPL
  4269. }
  4270. );
  4271. recv!(
  4272. s,
  4273. [TcpRepr {
  4274. seq_number: LOCAL_SEQ + 1,
  4275. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4276. ..RECV_TEMPL
  4277. }]
  4278. );
  4279. assert_eq!(s.state, State::CloseWait);
  4280. sanity!(s, socket_close_wait());
  4281. }
  4282. #[test]
  4283. fn test_established_fin_after_missing() {
  4284. let mut s = socket_established();
  4285. send!(
  4286. s,
  4287. TcpRepr {
  4288. control: TcpControl::Fin,
  4289. seq_number: REMOTE_SEQ + 1 + 6,
  4290. ack_number: Some(LOCAL_SEQ + 1),
  4291. payload: &b"123456"[..],
  4292. ..SEND_TEMPL
  4293. },
  4294. Some(TcpRepr {
  4295. seq_number: LOCAL_SEQ + 1,
  4296. ack_number: Some(REMOTE_SEQ + 1),
  4297. ..RECV_TEMPL
  4298. })
  4299. );
  4300. assert_eq!(s.state, State::Established);
  4301. send!(
  4302. s,
  4303. TcpRepr {
  4304. seq_number: REMOTE_SEQ + 1,
  4305. ack_number: Some(LOCAL_SEQ + 1),
  4306. payload: &b"abcdef"[..],
  4307. ..SEND_TEMPL
  4308. },
  4309. Some(TcpRepr {
  4310. seq_number: LOCAL_SEQ + 1,
  4311. ack_number: Some(REMOTE_SEQ + 1 + 6 + 6),
  4312. window_len: 52,
  4313. ..RECV_TEMPL
  4314. })
  4315. );
  4316. assert_eq!(s.state, State::Established);
  4317. }
  4318. #[test]
  4319. fn test_established_send_fin() {
  4320. let mut s = socket_established();
  4321. s.send_slice(b"abcdef").unwrap();
  4322. send!(
  4323. s,
  4324. TcpRepr {
  4325. control: TcpControl::Fin,
  4326. seq_number: REMOTE_SEQ + 1,
  4327. ack_number: Some(LOCAL_SEQ + 1),
  4328. ..SEND_TEMPL
  4329. }
  4330. );
  4331. assert_eq!(s.state, State::CloseWait);
  4332. recv!(
  4333. s,
  4334. [TcpRepr {
  4335. seq_number: LOCAL_SEQ + 1,
  4336. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4337. payload: &b"abcdef"[..],
  4338. ..RECV_TEMPL
  4339. }]
  4340. );
  4341. }
  4342. #[test]
  4343. fn test_established_rst() {
  4344. let mut s = socket_established();
  4345. send!(
  4346. s,
  4347. TcpRepr {
  4348. control: TcpControl::Rst,
  4349. seq_number: REMOTE_SEQ + 1,
  4350. ack_number: Some(LOCAL_SEQ + 1),
  4351. ..SEND_TEMPL
  4352. }
  4353. );
  4354. assert_eq!(s.state, State::Closed);
  4355. }
  4356. #[test]
  4357. fn test_established_rst_no_ack() {
  4358. let mut s = socket_established();
  4359. send!(
  4360. s,
  4361. TcpRepr {
  4362. control: TcpControl::Rst,
  4363. seq_number: REMOTE_SEQ + 1,
  4364. ack_number: None,
  4365. ..SEND_TEMPL
  4366. }
  4367. );
  4368. assert_eq!(s.state, State::Closed);
  4369. }
  4370. #[test]
  4371. fn test_established_close() {
  4372. let mut s = socket_established();
  4373. s.close();
  4374. assert_eq!(s.state, State::FinWait1);
  4375. sanity!(s, socket_fin_wait_1());
  4376. }
  4377. #[test]
  4378. fn test_established_abort() {
  4379. let mut s = socket_established();
  4380. s.abort();
  4381. assert_eq!(s.state, State::Closed);
  4382. recv!(
  4383. s,
  4384. [TcpRepr {
  4385. control: TcpControl::Rst,
  4386. seq_number: LOCAL_SEQ + 1,
  4387. ack_number: Some(REMOTE_SEQ + 1),
  4388. ..RECV_TEMPL
  4389. }]
  4390. );
  4391. }
  4392. #[test]
  4393. fn test_established_rst_bad_seq() {
  4394. let mut s = socket_established();
  4395. send!(
  4396. s,
  4397. TcpRepr {
  4398. control: TcpControl::Rst,
  4399. seq_number: REMOTE_SEQ, // Wrong seq
  4400. ack_number: None,
  4401. ..SEND_TEMPL
  4402. },
  4403. Some(TcpRepr {
  4404. seq_number: LOCAL_SEQ + 1,
  4405. ack_number: Some(REMOTE_SEQ + 1),
  4406. ..RECV_TEMPL
  4407. })
  4408. );
  4409. assert_eq!(s.state, State::Established);
  4410. // Send something to advance seq by 1
  4411. send!(
  4412. s,
  4413. TcpRepr {
  4414. seq_number: REMOTE_SEQ + 1, // correct seq
  4415. ack_number: Some(LOCAL_SEQ + 1),
  4416. payload: &b"a"[..],
  4417. ..SEND_TEMPL
  4418. }
  4419. );
  4420. // Send wrong rst again, check that the challenge ack is correctly updated
  4421. // The ack number must be updated even if we don't call dispatch on the socket
  4422. // See https://github.com/smoltcp-rs/smoltcp/issues/338
  4423. send!(
  4424. s,
  4425. time 2000,
  4426. TcpRepr {
  4427. control: TcpControl::Rst,
  4428. seq_number: REMOTE_SEQ, // Wrong seq
  4429. ack_number: None,
  4430. ..SEND_TEMPL
  4431. },
  4432. Some(TcpRepr {
  4433. seq_number: LOCAL_SEQ + 1,
  4434. ack_number: Some(REMOTE_SEQ + 2), // this has changed
  4435. window_len: 63,
  4436. ..RECV_TEMPL
  4437. })
  4438. );
  4439. }
  4440. // =========================================================================================//
  4441. // Tests for the FIN-WAIT-1 state.
  4442. // =========================================================================================//
  4443. #[test]
  4444. fn test_fin_wait_1_fin_ack() {
  4445. let mut s = socket_fin_wait_1();
  4446. recv!(
  4447. s,
  4448. [TcpRepr {
  4449. control: TcpControl::Fin,
  4450. seq_number: LOCAL_SEQ + 1,
  4451. ack_number: Some(REMOTE_SEQ + 1),
  4452. ..RECV_TEMPL
  4453. }]
  4454. );
  4455. send!(
  4456. s,
  4457. TcpRepr {
  4458. seq_number: REMOTE_SEQ + 1,
  4459. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4460. ..SEND_TEMPL
  4461. }
  4462. );
  4463. assert_eq!(s.state, State::FinWait2);
  4464. sanity!(s, socket_fin_wait_2());
  4465. }
  4466. #[test]
  4467. fn test_fin_wait_1_fin_fin() {
  4468. let mut s = socket_fin_wait_1();
  4469. recv!(
  4470. s,
  4471. [TcpRepr {
  4472. control: TcpControl::Fin,
  4473. seq_number: LOCAL_SEQ + 1,
  4474. ack_number: Some(REMOTE_SEQ + 1),
  4475. ..RECV_TEMPL
  4476. }]
  4477. );
  4478. send!(
  4479. s,
  4480. TcpRepr {
  4481. control: TcpControl::Fin,
  4482. seq_number: REMOTE_SEQ + 1,
  4483. ack_number: Some(LOCAL_SEQ + 1),
  4484. ..SEND_TEMPL
  4485. }
  4486. );
  4487. assert_eq!(s.state, State::Closing);
  4488. sanity!(s, socket_closing());
  4489. }
  4490. #[test]
  4491. fn test_fin_wait_1_fin_with_data_queued() {
  4492. let mut s = socket_established();
  4493. s.remote_win_len = 6;
  4494. s.send_slice(b"abcdef123456").unwrap();
  4495. s.close();
  4496. recv!(
  4497. s,
  4498. Ok(TcpRepr {
  4499. seq_number: LOCAL_SEQ + 1,
  4500. ack_number: Some(REMOTE_SEQ + 1),
  4501. payload: &b"abcdef"[..],
  4502. ..RECV_TEMPL
  4503. })
  4504. );
  4505. send!(
  4506. s,
  4507. TcpRepr {
  4508. seq_number: REMOTE_SEQ + 1,
  4509. ack_number: Some(LOCAL_SEQ + 1 + 6),
  4510. ..SEND_TEMPL
  4511. }
  4512. );
  4513. assert_eq!(s.state, State::FinWait1);
  4514. }
  4515. #[test]
  4516. fn test_fin_wait_1_recv() {
  4517. let mut s = socket_fin_wait_1();
  4518. send!(
  4519. s,
  4520. TcpRepr {
  4521. seq_number: REMOTE_SEQ + 1,
  4522. ack_number: Some(LOCAL_SEQ + 1),
  4523. payload: &b"abc"[..],
  4524. ..SEND_TEMPL
  4525. }
  4526. );
  4527. assert_eq!(s.state, State::FinWait1);
  4528. s.recv(|data| {
  4529. assert_eq!(data, b"abc");
  4530. (3, ())
  4531. })
  4532. .unwrap();
  4533. }
  4534. #[test]
  4535. fn test_fin_wait_1_close() {
  4536. let mut s = socket_fin_wait_1();
  4537. s.close();
  4538. assert_eq!(s.state, State::FinWait1);
  4539. }
  4540. // =========================================================================================//
  4541. // Tests for the FIN-WAIT-2 state.
  4542. // =========================================================================================//
  4543. #[test]
  4544. fn test_fin_wait_2_fin() {
  4545. let mut s = socket_fin_wait_2();
  4546. send!(s, time 1_000, TcpRepr {
  4547. control: TcpControl::Fin,
  4548. seq_number: REMOTE_SEQ + 1,
  4549. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4550. ..SEND_TEMPL
  4551. });
  4552. assert_eq!(s.state, State::TimeWait);
  4553. sanity!(s, socket_time_wait(false));
  4554. }
  4555. #[test]
  4556. fn test_fin_wait_2_recv() {
  4557. let mut s = socket_fin_wait_2();
  4558. send!(
  4559. s,
  4560. TcpRepr {
  4561. seq_number: REMOTE_SEQ + 1,
  4562. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4563. payload: &b"abc"[..],
  4564. ..SEND_TEMPL
  4565. }
  4566. );
  4567. assert_eq!(s.state, State::FinWait2);
  4568. s.recv(|data| {
  4569. assert_eq!(data, b"abc");
  4570. (3, ())
  4571. })
  4572. .unwrap();
  4573. recv!(
  4574. s,
  4575. [TcpRepr {
  4576. seq_number: LOCAL_SEQ + 1 + 1,
  4577. ack_number: Some(REMOTE_SEQ + 1 + 3),
  4578. ..RECV_TEMPL
  4579. }]
  4580. );
  4581. }
  4582. #[test]
  4583. fn test_fin_wait_2_close() {
  4584. let mut s = socket_fin_wait_2();
  4585. s.close();
  4586. assert_eq!(s.state, State::FinWait2);
  4587. }
  4588. // =========================================================================================//
  4589. // Tests for the CLOSING state.
  4590. // =========================================================================================//
  4591. #[test]
  4592. fn test_closing_ack_fin() {
  4593. let mut s = socket_closing();
  4594. recv!(
  4595. s,
  4596. [TcpRepr {
  4597. seq_number: LOCAL_SEQ + 1 + 1,
  4598. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4599. ..RECV_TEMPL
  4600. }]
  4601. );
  4602. send!(s, time 1_000, TcpRepr {
  4603. seq_number: REMOTE_SEQ + 1 + 1,
  4604. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4605. ..SEND_TEMPL
  4606. });
  4607. assert_eq!(s.state, State::TimeWait);
  4608. sanity!(s, socket_time_wait(true));
  4609. }
  4610. #[test]
  4611. fn test_closing_close() {
  4612. let mut s = socket_closing();
  4613. s.close();
  4614. assert_eq!(s.state, State::Closing);
  4615. }
  4616. // =========================================================================================//
  4617. // Tests for the TIME-WAIT state.
  4618. // =========================================================================================//
  4619. #[test]
  4620. fn test_time_wait_from_fin_wait_2_ack() {
  4621. let mut s = socket_time_wait(false);
  4622. recv!(
  4623. s,
  4624. [TcpRepr {
  4625. seq_number: LOCAL_SEQ + 1 + 1,
  4626. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4627. ..RECV_TEMPL
  4628. }]
  4629. );
  4630. }
  4631. #[test]
  4632. fn test_time_wait_from_closing_no_ack() {
  4633. let mut s = socket_time_wait(true);
  4634. recv!(s, []);
  4635. }
  4636. #[test]
  4637. fn test_time_wait_close() {
  4638. let mut s = socket_time_wait(false);
  4639. s.close();
  4640. assert_eq!(s.state, State::TimeWait);
  4641. }
  4642. #[test]
  4643. fn test_time_wait_retransmit() {
  4644. let mut s = socket_time_wait(false);
  4645. recv!(
  4646. s,
  4647. [TcpRepr {
  4648. seq_number: LOCAL_SEQ + 1 + 1,
  4649. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4650. ..RECV_TEMPL
  4651. }]
  4652. );
  4653. send!(s, time 5_000, TcpRepr {
  4654. control: TcpControl::Fin,
  4655. seq_number: REMOTE_SEQ + 1,
  4656. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4657. ..SEND_TEMPL
  4658. }, Some(TcpRepr {
  4659. seq_number: LOCAL_SEQ + 1 + 1,
  4660. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4661. ..RECV_TEMPL
  4662. }));
  4663. assert_eq!(
  4664. s.timer,
  4665. Timer::Close {
  4666. expires_at: Instant::from_secs(5) + CLOSE_DELAY
  4667. }
  4668. );
  4669. }
  4670. #[test]
  4671. fn test_time_wait_timeout() {
  4672. let mut s = socket_time_wait(false);
  4673. recv!(
  4674. s,
  4675. [TcpRepr {
  4676. seq_number: LOCAL_SEQ + 1 + 1,
  4677. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4678. ..RECV_TEMPL
  4679. }]
  4680. );
  4681. assert_eq!(s.state, State::TimeWait);
  4682. recv_nothing!(s, time 60_000);
  4683. assert_eq!(s.state, State::Closed);
  4684. }
  4685. // =========================================================================================//
  4686. // Tests for the CLOSE-WAIT state.
  4687. // =========================================================================================//
  4688. #[test]
  4689. fn test_close_wait_ack() {
  4690. let mut s = socket_close_wait();
  4691. s.send_slice(b"abcdef").unwrap();
  4692. recv!(
  4693. s,
  4694. [TcpRepr {
  4695. seq_number: LOCAL_SEQ + 1,
  4696. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4697. payload: &b"abcdef"[..],
  4698. ..RECV_TEMPL
  4699. }]
  4700. );
  4701. send!(
  4702. s,
  4703. TcpRepr {
  4704. seq_number: REMOTE_SEQ + 1 + 1,
  4705. ack_number: Some(LOCAL_SEQ + 1 + 6),
  4706. ..SEND_TEMPL
  4707. }
  4708. );
  4709. }
  4710. #[test]
  4711. fn test_close_wait_close() {
  4712. let mut s = socket_close_wait();
  4713. s.close();
  4714. assert_eq!(s.state, State::LastAck);
  4715. sanity!(s, socket_last_ack());
  4716. }
  4717. // =========================================================================================//
  4718. // Tests for the LAST-ACK state.
  4719. // =========================================================================================//
  4720. #[test]
  4721. fn test_last_ack_fin_ack() {
  4722. let mut s = socket_last_ack();
  4723. recv!(
  4724. s,
  4725. [TcpRepr {
  4726. control: TcpControl::Fin,
  4727. seq_number: LOCAL_SEQ + 1,
  4728. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4729. ..RECV_TEMPL
  4730. }]
  4731. );
  4732. assert_eq!(s.state, State::LastAck);
  4733. send!(
  4734. s,
  4735. TcpRepr {
  4736. seq_number: REMOTE_SEQ + 1 + 1,
  4737. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4738. ..SEND_TEMPL
  4739. }
  4740. );
  4741. assert_eq!(s.state, State::Closed);
  4742. }
  4743. #[test]
  4744. fn test_last_ack_ack_not_of_fin() {
  4745. let mut s = socket_last_ack();
  4746. recv!(
  4747. s,
  4748. [TcpRepr {
  4749. control: TcpControl::Fin,
  4750. seq_number: LOCAL_SEQ + 1,
  4751. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4752. ..RECV_TEMPL
  4753. }]
  4754. );
  4755. assert_eq!(s.state, State::LastAck);
  4756. // ACK received that doesn't ack the FIN: socket should stay in LastAck.
  4757. send!(
  4758. s,
  4759. TcpRepr {
  4760. seq_number: REMOTE_SEQ + 1 + 1,
  4761. ack_number: Some(LOCAL_SEQ + 1),
  4762. ..SEND_TEMPL
  4763. }
  4764. );
  4765. assert_eq!(s.state, State::LastAck);
  4766. // ACK received of fin: socket should change to Closed.
  4767. send!(
  4768. s,
  4769. TcpRepr {
  4770. seq_number: REMOTE_SEQ + 1 + 1,
  4771. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4772. ..SEND_TEMPL
  4773. }
  4774. );
  4775. assert_eq!(s.state, State::Closed);
  4776. }
  4777. #[test]
  4778. fn test_last_ack_close() {
  4779. let mut s = socket_last_ack();
  4780. s.close();
  4781. assert_eq!(s.state, State::LastAck);
  4782. }
  4783. // =========================================================================================//
  4784. // Tests for transitioning through multiple states.
  4785. // =========================================================================================//
  4786. #[test]
  4787. fn test_listen() {
  4788. let mut s = socket();
  4789. s.listen(LISTEN_END).unwrap();
  4790. assert_eq!(s.state, State::Listen);
  4791. }
  4792. #[test]
  4793. fn test_three_way_handshake() {
  4794. let mut s = socket_listen();
  4795. send!(
  4796. s,
  4797. TcpRepr {
  4798. control: TcpControl::Syn,
  4799. seq_number: REMOTE_SEQ,
  4800. ack_number: None,
  4801. ..SEND_TEMPL
  4802. }
  4803. );
  4804. assert_eq!(s.state(), State::SynReceived);
  4805. assert_eq!(s.tuple, Some(TUPLE));
  4806. recv!(
  4807. s,
  4808. [TcpRepr {
  4809. control: TcpControl::Syn,
  4810. seq_number: LOCAL_SEQ,
  4811. ack_number: Some(REMOTE_SEQ + 1),
  4812. max_seg_size: Some(BASE_MSS),
  4813. ..RECV_TEMPL
  4814. }]
  4815. );
  4816. send!(
  4817. s,
  4818. TcpRepr {
  4819. seq_number: REMOTE_SEQ + 1,
  4820. ack_number: Some(LOCAL_SEQ + 1),
  4821. ..SEND_TEMPL
  4822. }
  4823. );
  4824. assert_eq!(s.state(), State::Established);
  4825. assert_eq!(s.local_seq_no, LOCAL_SEQ + 1);
  4826. assert_eq!(s.remote_seq_no, REMOTE_SEQ + 1);
  4827. }
  4828. #[test]
  4829. fn test_remote_close() {
  4830. let mut s = socket_established();
  4831. send!(
  4832. s,
  4833. TcpRepr {
  4834. control: TcpControl::Fin,
  4835. seq_number: REMOTE_SEQ + 1,
  4836. ack_number: Some(LOCAL_SEQ + 1),
  4837. ..SEND_TEMPL
  4838. }
  4839. );
  4840. assert_eq!(s.state, State::CloseWait);
  4841. recv!(
  4842. s,
  4843. [TcpRepr {
  4844. seq_number: LOCAL_SEQ + 1,
  4845. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4846. ..RECV_TEMPL
  4847. }]
  4848. );
  4849. s.close();
  4850. assert_eq!(s.state, State::LastAck);
  4851. recv!(
  4852. s,
  4853. [TcpRepr {
  4854. control: TcpControl::Fin,
  4855. seq_number: LOCAL_SEQ + 1,
  4856. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4857. ..RECV_TEMPL
  4858. }]
  4859. );
  4860. send!(
  4861. s,
  4862. TcpRepr {
  4863. seq_number: REMOTE_SEQ + 1 + 1,
  4864. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4865. ..SEND_TEMPL
  4866. }
  4867. );
  4868. assert_eq!(s.state, State::Closed);
  4869. }
  4870. #[test]
  4871. fn test_local_close() {
  4872. let mut s = socket_established();
  4873. s.close();
  4874. assert_eq!(s.state, State::FinWait1);
  4875. recv!(
  4876. s,
  4877. [TcpRepr {
  4878. control: TcpControl::Fin,
  4879. seq_number: LOCAL_SEQ + 1,
  4880. ack_number: Some(REMOTE_SEQ + 1),
  4881. ..RECV_TEMPL
  4882. }]
  4883. );
  4884. send!(
  4885. s,
  4886. TcpRepr {
  4887. seq_number: REMOTE_SEQ + 1,
  4888. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4889. ..SEND_TEMPL
  4890. }
  4891. );
  4892. assert_eq!(s.state, State::FinWait2);
  4893. send!(
  4894. s,
  4895. TcpRepr {
  4896. control: TcpControl::Fin,
  4897. seq_number: REMOTE_SEQ + 1,
  4898. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4899. ..SEND_TEMPL
  4900. }
  4901. );
  4902. assert_eq!(s.state, State::TimeWait);
  4903. recv!(
  4904. s,
  4905. [TcpRepr {
  4906. seq_number: LOCAL_SEQ + 1 + 1,
  4907. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4908. ..RECV_TEMPL
  4909. }]
  4910. );
  4911. }
  4912. #[test]
  4913. fn test_simultaneous_close() {
  4914. let mut s = socket_established();
  4915. s.close();
  4916. assert_eq!(s.state, State::FinWait1);
  4917. recv!(
  4918. s,
  4919. [TcpRepr {
  4920. // due to reordering, this is logically located...
  4921. control: TcpControl::Fin,
  4922. seq_number: LOCAL_SEQ + 1,
  4923. ack_number: Some(REMOTE_SEQ + 1),
  4924. ..RECV_TEMPL
  4925. }]
  4926. );
  4927. send!(
  4928. s,
  4929. TcpRepr {
  4930. control: TcpControl::Fin,
  4931. seq_number: REMOTE_SEQ + 1,
  4932. ack_number: Some(LOCAL_SEQ + 1),
  4933. ..SEND_TEMPL
  4934. }
  4935. );
  4936. assert_eq!(s.state, State::Closing);
  4937. recv!(
  4938. s,
  4939. [TcpRepr {
  4940. seq_number: LOCAL_SEQ + 1 + 1,
  4941. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4942. ..RECV_TEMPL
  4943. }]
  4944. );
  4945. // ... at this point
  4946. send!(
  4947. s,
  4948. TcpRepr {
  4949. seq_number: REMOTE_SEQ + 1 + 1,
  4950. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4951. ..SEND_TEMPL
  4952. }
  4953. );
  4954. assert_eq!(s.state, State::TimeWait);
  4955. recv!(s, []);
  4956. }
  4957. #[test]
  4958. fn test_simultaneous_close_combined_fin_ack() {
  4959. let mut s = socket_established();
  4960. s.close();
  4961. assert_eq!(s.state, State::FinWait1);
  4962. recv!(
  4963. s,
  4964. [TcpRepr {
  4965. control: TcpControl::Fin,
  4966. seq_number: LOCAL_SEQ + 1,
  4967. ack_number: Some(REMOTE_SEQ + 1),
  4968. ..RECV_TEMPL
  4969. }]
  4970. );
  4971. send!(
  4972. s,
  4973. TcpRepr {
  4974. control: TcpControl::Fin,
  4975. seq_number: REMOTE_SEQ + 1,
  4976. ack_number: Some(LOCAL_SEQ + 1 + 1),
  4977. ..SEND_TEMPL
  4978. }
  4979. );
  4980. assert_eq!(s.state, State::TimeWait);
  4981. recv!(
  4982. s,
  4983. [TcpRepr {
  4984. seq_number: LOCAL_SEQ + 1 + 1,
  4985. ack_number: Some(REMOTE_SEQ + 1 + 1),
  4986. ..RECV_TEMPL
  4987. }]
  4988. );
  4989. }
  4990. #[test]
  4991. fn test_simultaneous_close_raced() {
  4992. let mut s = socket_established();
  4993. s.close();
  4994. assert_eq!(s.state, State::FinWait1);
  4995. // Socket receives FIN before it has a chance to send its own FIN
  4996. send!(
  4997. s,
  4998. TcpRepr {
  4999. control: TcpControl::Fin,
  5000. seq_number: REMOTE_SEQ + 1,
  5001. ack_number: Some(LOCAL_SEQ + 1),
  5002. ..SEND_TEMPL
  5003. }
  5004. );
  5005. assert_eq!(s.state, State::Closing);
  5006. // FIN + ack-of-FIN
  5007. recv!(
  5008. s,
  5009. [TcpRepr {
  5010. control: TcpControl::Fin,
  5011. seq_number: LOCAL_SEQ + 1,
  5012. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5013. ..RECV_TEMPL
  5014. }]
  5015. );
  5016. assert_eq!(s.state, State::Closing);
  5017. send!(
  5018. s,
  5019. TcpRepr {
  5020. seq_number: REMOTE_SEQ + 1 + 1,
  5021. ack_number: Some(LOCAL_SEQ + 1 + 1),
  5022. ..SEND_TEMPL
  5023. }
  5024. );
  5025. assert_eq!(s.state, State::TimeWait);
  5026. recv!(s, []);
  5027. }
  5028. #[test]
  5029. fn test_simultaneous_close_raced_with_data() {
  5030. let mut s = socket_established();
  5031. s.send_slice(b"abcdef").unwrap();
  5032. s.close();
  5033. assert_eq!(s.state, State::FinWait1);
  5034. // Socket receives FIN before it has a chance to send its own data+FIN
  5035. send!(
  5036. s,
  5037. TcpRepr {
  5038. control: TcpControl::Fin,
  5039. seq_number: REMOTE_SEQ + 1,
  5040. ack_number: Some(LOCAL_SEQ + 1),
  5041. ..SEND_TEMPL
  5042. }
  5043. );
  5044. assert_eq!(s.state, State::Closing);
  5045. // data + FIN + ack-of-FIN
  5046. recv!(
  5047. s,
  5048. [TcpRepr {
  5049. control: TcpControl::Fin,
  5050. seq_number: LOCAL_SEQ + 1,
  5051. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5052. payload: &b"abcdef"[..],
  5053. ..RECV_TEMPL
  5054. }]
  5055. );
  5056. assert_eq!(s.state, State::Closing);
  5057. send!(
  5058. s,
  5059. TcpRepr {
  5060. seq_number: REMOTE_SEQ + 1 + 1,
  5061. ack_number: Some(LOCAL_SEQ + 1 + 6 + 1),
  5062. ..SEND_TEMPL
  5063. }
  5064. );
  5065. assert_eq!(s.state, State::TimeWait);
  5066. recv!(s, []);
  5067. }
  5068. #[test]
  5069. fn test_fin_with_data() {
  5070. let mut s = socket_established();
  5071. s.send_slice(b"abcdef").unwrap();
  5072. s.close();
  5073. recv!(
  5074. s,
  5075. [TcpRepr {
  5076. control: TcpControl::Fin,
  5077. seq_number: LOCAL_SEQ + 1,
  5078. ack_number: Some(REMOTE_SEQ + 1),
  5079. payload: &b"abcdef"[..],
  5080. ..RECV_TEMPL
  5081. }]
  5082. )
  5083. }
  5084. #[test]
  5085. fn test_mutual_close_with_data_1() {
  5086. let mut s = socket_established();
  5087. s.send_slice(b"abcdef").unwrap();
  5088. s.close();
  5089. assert_eq!(s.state, State::FinWait1);
  5090. recv!(
  5091. s,
  5092. [TcpRepr {
  5093. control: TcpControl::Fin,
  5094. seq_number: LOCAL_SEQ + 1,
  5095. ack_number: Some(REMOTE_SEQ + 1),
  5096. payload: &b"abcdef"[..],
  5097. ..RECV_TEMPL
  5098. }]
  5099. );
  5100. send!(
  5101. s,
  5102. TcpRepr {
  5103. control: TcpControl::Fin,
  5104. seq_number: REMOTE_SEQ + 1,
  5105. ack_number: Some(LOCAL_SEQ + 1 + 6 + 1),
  5106. ..SEND_TEMPL
  5107. }
  5108. );
  5109. }
  5110. #[test]
  5111. fn test_mutual_close_with_data_2() {
  5112. let mut s = socket_established();
  5113. s.send_slice(b"abcdef").unwrap();
  5114. s.close();
  5115. assert_eq!(s.state, State::FinWait1);
  5116. recv!(
  5117. s,
  5118. [TcpRepr {
  5119. control: TcpControl::Fin,
  5120. seq_number: LOCAL_SEQ + 1,
  5121. ack_number: Some(REMOTE_SEQ + 1),
  5122. payload: &b"abcdef"[..],
  5123. ..RECV_TEMPL
  5124. }]
  5125. );
  5126. send!(
  5127. s,
  5128. TcpRepr {
  5129. seq_number: REMOTE_SEQ + 1,
  5130. ack_number: Some(LOCAL_SEQ + 1 + 6 + 1),
  5131. ..SEND_TEMPL
  5132. }
  5133. );
  5134. assert_eq!(s.state, State::FinWait2);
  5135. send!(
  5136. s,
  5137. TcpRepr {
  5138. control: TcpControl::Fin,
  5139. seq_number: REMOTE_SEQ + 1,
  5140. ack_number: Some(LOCAL_SEQ + 1 + 6 + 1),
  5141. ..SEND_TEMPL
  5142. }
  5143. );
  5144. recv!(
  5145. s,
  5146. [TcpRepr {
  5147. seq_number: LOCAL_SEQ + 1 + 6 + 1,
  5148. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5149. ..RECV_TEMPL
  5150. }]
  5151. );
  5152. assert_eq!(s.state, State::TimeWait);
  5153. }
  5154. // =========================================================================================//
  5155. // Tests for retransmission on packet loss.
  5156. // =========================================================================================//
  5157. #[test]
  5158. fn test_duplicate_seq_ack() {
  5159. let mut s = socket_recved();
  5160. // remote retransmission
  5161. send!(
  5162. s,
  5163. TcpRepr {
  5164. seq_number: REMOTE_SEQ + 1,
  5165. ack_number: Some(LOCAL_SEQ + 1),
  5166. payload: &b"abcdef"[..],
  5167. ..SEND_TEMPL
  5168. },
  5169. Some(TcpRepr {
  5170. seq_number: LOCAL_SEQ + 1,
  5171. ack_number: Some(REMOTE_SEQ + 1 + 6),
  5172. window_len: 58,
  5173. ..RECV_TEMPL
  5174. })
  5175. );
  5176. }
  5177. #[test]
  5178. fn test_data_retransmit() {
  5179. let mut s = socket_established();
  5180. s.send_slice(b"abcdef").unwrap();
  5181. recv!(s, time 1000, Ok(TcpRepr {
  5182. seq_number: LOCAL_SEQ + 1,
  5183. ack_number: Some(REMOTE_SEQ + 1),
  5184. payload: &b"abcdef"[..],
  5185. ..RECV_TEMPL
  5186. }));
  5187. recv_nothing!(s, time 1050);
  5188. recv!(s, time 2000, Ok(TcpRepr {
  5189. seq_number: LOCAL_SEQ + 1,
  5190. ack_number: Some(REMOTE_SEQ + 1),
  5191. payload: &b"abcdef"[..],
  5192. ..RECV_TEMPL
  5193. }));
  5194. }
  5195. #[test]
  5196. fn test_data_retransmit_bursts() {
  5197. let mut s = socket_established();
  5198. s.remote_mss = 6;
  5199. s.send_slice(b"abcdef012345").unwrap();
  5200. recv!(s, time 0, Ok(TcpRepr {
  5201. control: TcpControl::None,
  5202. seq_number: LOCAL_SEQ + 1,
  5203. ack_number: Some(REMOTE_SEQ + 1),
  5204. payload: &b"abcdef"[..],
  5205. ..RECV_TEMPL
  5206. }), exact);
  5207. recv!(s, time 0, Ok(TcpRepr {
  5208. control: TcpControl::Psh,
  5209. seq_number: LOCAL_SEQ + 1 + 6,
  5210. ack_number: Some(REMOTE_SEQ + 1),
  5211. payload: &b"012345"[..],
  5212. ..RECV_TEMPL
  5213. }), exact);
  5214. recv_nothing!(s, time 0);
  5215. recv_nothing!(s, time 50);
  5216. recv!(s, time 1000, Ok(TcpRepr {
  5217. control: TcpControl::None,
  5218. seq_number: LOCAL_SEQ + 1,
  5219. ack_number: Some(REMOTE_SEQ + 1),
  5220. payload: &b"abcdef"[..],
  5221. ..RECV_TEMPL
  5222. }), exact);
  5223. recv!(s, time 1500, Ok(TcpRepr {
  5224. control: TcpControl::Psh,
  5225. seq_number: LOCAL_SEQ + 1 + 6,
  5226. ack_number: Some(REMOTE_SEQ + 1),
  5227. payload: &b"012345"[..],
  5228. ..RECV_TEMPL
  5229. }), exact);
  5230. recv_nothing!(s, time 1550);
  5231. }
  5232. #[test]
  5233. fn test_data_retransmit_bursts_half_ack() {
  5234. let mut s = socket_established();
  5235. s.remote_mss = 6;
  5236. s.send_slice(b"abcdef012345").unwrap();
  5237. recv!(s, time 0, Ok(TcpRepr {
  5238. control: TcpControl::None,
  5239. seq_number: LOCAL_SEQ + 1,
  5240. ack_number: Some(REMOTE_SEQ + 1),
  5241. payload: &b"abcdef"[..],
  5242. ..RECV_TEMPL
  5243. }), exact);
  5244. recv!(s, time 0, Ok(TcpRepr {
  5245. control: TcpControl::Psh,
  5246. seq_number: LOCAL_SEQ + 1 + 6,
  5247. ack_number: Some(REMOTE_SEQ + 1),
  5248. payload: &b"012345"[..],
  5249. ..RECV_TEMPL
  5250. }), exact);
  5251. // Acknowledge the first packet
  5252. send!(s, time 5, TcpRepr {
  5253. seq_number: REMOTE_SEQ + 1,
  5254. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5255. window_len: 6,
  5256. ..SEND_TEMPL
  5257. });
  5258. // The second packet should be re-sent.
  5259. recv!(s, time 1500, Ok(TcpRepr {
  5260. control: TcpControl::Psh,
  5261. seq_number: LOCAL_SEQ + 1 + 6,
  5262. ack_number: Some(REMOTE_SEQ + 1),
  5263. payload: &b"012345"[..],
  5264. ..RECV_TEMPL
  5265. }), exact);
  5266. recv_nothing!(s, time 1550);
  5267. }
  5268. #[test]
  5269. fn test_retransmit_timer_restart_on_partial_ack() {
  5270. let mut s = socket_established();
  5271. s.remote_mss = 6;
  5272. s.send_slice(b"abcdef012345").unwrap();
  5273. recv!(s, time 0, Ok(TcpRepr {
  5274. control: TcpControl::None,
  5275. seq_number: LOCAL_SEQ + 1,
  5276. ack_number: Some(REMOTE_SEQ + 1),
  5277. payload: &b"abcdef"[..],
  5278. ..RECV_TEMPL
  5279. }), exact);
  5280. recv!(s, time 0, Ok(TcpRepr {
  5281. control: TcpControl::Psh,
  5282. seq_number: LOCAL_SEQ + 1 + 6,
  5283. ack_number: Some(REMOTE_SEQ + 1),
  5284. payload: &b"012345"[..],
  5285. ..RECV_TEMPL
  5286. }), exact);
  5287. // Acknowledge the first packet
  5288. send!(s, time 600, TcpRepr {
  5289. seq_number: REMOTE_SEQ + 1,
  5290. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5291. window_len: 6,
  5292. ..SEND_TEMPL
  5293. });
  5294. // The ACK of the first packet should restart the retransmit timer and delay a retransmission.
  5295. recv_nothing!(s, time 2399);
  5296. // The second packet should be re-sent.
  5297. recv!(s, time 2400, Ok(TcpRepr {
  5298. control: TcpControl::Psh,
  5299. seq_number: LOCAL_SEQ + 1 + 6,
  5300. ack_number: Some(REMOTE_SEQ + 1),
  5301. payload: &b"012345"[..],
  5302. ..RECV_TEMPL
  5303. }), exact);
  5304. }
  5305. #[test]
  5306. fn test_data_retransmit_bursts_half_ack_close() {
  5307. let mut s = socket_established();
  5308. s.remote_mss = 6;
  5309. s.send_slice(b"abcdef012345").unwrap();
  5310. s.close();
  5311. recv!(s, time 0, Ok(TcpRepr {
  5312. control: TcpControl::None,
  5313. seq_number: LOCAL_SEQ + 1,
  5314. ack_number: Some(REMOTE_SEQ + 1),
  5315. payload: &b"abcdef"[..],
  5316. ..RECV_TEMPL
  5317. }), exact);
  5318. recv!(s, time 0, Ok(TcpRepr {
  5319. control: TcpControl::Fin,
  5320. seq_number: LOCAL_SEQ + 1 + 6,
  5321. ack_number: Some(REMOTE_SEQ + 1),
  5322. payload: &b"012345"[..],
  5323. ..RECV_TEMPL
  5324. }), exact);
  5325. // Acknowledge the first packet
  5326. send!(s, time 5, TcpRepr {
  5327. seq_number: REMOTE_SEQ + 1,
  5328. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5329. window_len: 6,
  5330. ..SEND_TEMPL
  5331. });
  5332. // The second packet should be re-sent.
  5333. recv!(s, time 1500, Ok(TcpRepr {
  5334. control: TcpControl::Fin,
  5335. seq_number: LOCAL_SEQ + 1 + 6,
  5336. ack_number: Some(REMOTE_SEQ + 1),
  5337. payload: &b"012345"[..],
  5338. ..RECV_TEMPL
  5339. }), exact);
  5340. recv_nothing!(s, time 1550);
  5341. }
  5342. #[test]
  5343. fn test_send_data_after_syn_ack_retransmit() {
  5344. let mut s = socket_syn_received();
  5345. recv!(s, time 50, Ok(TcpRepr {
  5346. control: TcpControl::Syn,
  5347. seq_number: LOCAL_SEQ,
  5348. ack_number: Some(REMOTE_SEQ + 1),
  5349. max_seg_size: Some(BASE_MSS),
  5350. ..RECV_TEMPL
  5351. }));
  5352. recv!(s, time 1050, Ok(TcpRepr { // retransmit
  5353. control: TcpControl::Syn,
  5354. seq_number: LOCAL_SEQ,
  5355. ack_number: Some(REMOTE_SEQ + 1),
  5356. max_seg_size: Some(BASE_MSS),
  5357. ..RECV_TEMPL
  5358. }));
  5359. send!(
  5360. s,
  5361. TcpRepr {
  5362. seq_number: REMOTE_SEQ + 1,
  5363. ack_number: Some(LOCAL_SEQ + 1),
  5364. ..SEND_TEMPL
  5365. }
  5366. );
  5367. assert_eq!(s.state(), State::Established);
  5368. s.send_slice(b"abcdef").unwrap();
  5369. recv!(
  5370. s,
  5371. [TcpRepr {
  5372. seq_number: LOCAL_SEQ + 1,
  5373. ack_number: Some(REMOTE_SEQ + 1),
  5374. payload: &b"abcdef"[..],
  5375. ..RECV_TEMPL
  5376. }]
  5377. )
  5378. }
  5379. #[test]
  5380. fn test_established_retransmit_for_dup_ack() {
  5381. let mut s = socket_established();
  5382. // Duplicate ACKs do not replace the retransmission timer
  5383. s.send_slice(b"abc").unwrap();
  5384. recv!(s, time 1000, Ok(TcpRepr {
  5385. seq_number: LOCAL_SEQ + 1,
  5386. ack_number: Some(REMOTE_SEQ + 1),
  5387. payload: &b"abc"[..],
  5388. ..RECV_TEMPL
  5389. }));
  5390. // Retransmit timer is on because all data was sent
  5391. assert_eq!(s.tx_buffer.len(), 3);
  5392. // ACK nothing new
  5393. send!(
  5394. s,
  5395. TcpRepr {
  5396. seq_number: REMOTE_SEQ + 1,
  5397. ack_number: Some(LOCAL_SEQ + 1),
  5398. ..SEND_TEMPL
  5399. }
  5400. );
  5401. // Retransmit
  5402. recv!(s, time 4000, Ok(TcpRepr {
  5403. seq_number: LOCAL_SEQ + 1,
  5404. ack_number: Some(REMOTE_SEQ + 1),
  5405. payload: &b"abc"[..],
  5406. ..RECV_TEMPL
  5407. }));
  5408. }
  5409. #[test]
  5410. fn test_established_retransmit_reset_after_ack() {
  5411. let mut s = socket_established();
  5412. s.remote_win_len = 6;
  5413. s.send_slice(b"abcdef").unwrap();
  5414. s.send_slice(b"123456").unwrap();
  5415. s.send_slice(b"ABCDEF").unwrap();
  5416. recv!(s, time 1000, Ok(TcpRepr {
  5417. seq_number: LOCAL_SEQ + 1,
  5418. ack_number: Some(REMOTE_SEQ + 1),
  5419. payload: &b"abcdef"[..],
  5420. ..RECV_TEMPL
  5421. }));
  5422. send!(s, time 1005, TcpRepr {
  5423. seq_number: REMOTE_SEQ + 1,
  5424. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5425. window_len: 6,
  5426. ..SEND_TEMPL
  5427. });
  5428. recv!(s, time 1010, Ok(TcpRepr {
  5429. seq_number: LOCAL_SEQ + 1 + 6,
  5430. ack_number: Some(REMOTE_SEQ + 1),
  5431. payload: &b"123456"[..],
  5432. ..RECV_TEMPL
  5433. }));
  5434. send!(s, time 1015, TcpRepr {
  5435. seq_number: REMOTE_SEQ + 1,
  5436. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  5437. window_len: 6,
  5438. ..SEND_TEMPL
  5439. });
  5440. recv!(s, time 1020, Ok(TcpRepr {
  5441. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  5442. ack_number: Some(REMOTE_SEQ + 1),
  5443. payload: &b"ABCDEF"[..],
  5444. ..RECV_TEMPL
  5445. }));
  5446. }
  5447. #[test]
  5448. fn test_established_queue_during_retransmission() {
  5449. let mut s = socket_established();
  5450. s.remote_mss = 6;
  5451. s.send_slice(b"abcdef123456ABCDEF").unwrap();
  5452. recv!(s, time 1000, Ok(TcpRepr {
  5453. seq_number: LOCAL_SEQ + 1,
  5454. ack_number: Some(REMOTE_SEQ + 1),
  5455. payload: &b"abcdef"[..],
  5456. ..RECV_TEMPL
  5457. })); // this one is dropped
  5458. recv!(s, time 1005, Ok(TcpRepr {
  5459. seq_number: LOCAL_SEQ + 1 + 6,
  5460. ack_number: Some(REMOTE_SEQ + 1),
  5461. payload: &b"123456"[..],
  5462. ..RECV_TEMPL
  5463. })); // this one is received
  5464. recv!(s, time 1010, Ok(TcpRepr {
  5465. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  5466. ack_number: Some(REMOTE_SEQ + 1),
  5467. payload: &b"ABCDEF"[..],
  5468. ..RECV_TEMPL
  5469. })); // also dropped
  5470. recv!(s, time 3000, Ok(TcpRepr {
  5471. seq_number: LOCAL_SEQ + 1,
  5472. ack_number: Some(REMOTE_SEQ + 1),
  5473. payload: &b"abcdef"[..],
  5474. ..RECV_TEMPL
  5475. })); // retransmission
  5476. send!(s, time 3005, TcpRepr {
  5477. seq_number: REMOTE_SEQ + 1,
  5478. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  5479. ..SEND_TEMPL
  5480. }); // acknowledgement of both segments
  5481. recv!(s, time 3010, Ok(TcpRepr {
  5482. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  5483. ack_number: Some(REMOTE_SEQ + 1),
  5484. payload: &b"ABCDEF"[..],
  5485. ..RECV_TEMPL
  5486. })); // retransmission of only unacknowledged data
  5487. }
  5488. #[test]
  5489. fn test_close_wait_retransmit_reset_after_ack() {
  5490. let mut s = socket_close_wait();
  5491. s.remote_win_len = 6;
  5492. s.send_slice(b"abcdef").unwrap();
  5493. s.send_slice(b"123456").unwrap();
  5494. s.send_slice(b"ABCDEF").unwrap();
  5495. recv!(s, time 1000, Ok(TcpRepr {
  5496. seq_number: LOCAL_SEQ + 1,
  5497. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5498. payload: &b"abcdef"[..],
  5499. ..RECV_TEMPL
  5500. }));
  5501. send!(s, time 1005, TcpRepr {
  5502. seq_number: REMOTE_SEQ + 1 + 1,
  5503. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5504. window_len: 6,
  5505. ..SEND_TEMPL
  5506. });
  5507. recv!(s, time 1010, Ok(TcpRepr {
  5508. seq_number: LOCAL_SEQ + 1 + 6,
  5509. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5510. payload: &b"123456"[..],
  5511. ..RECV_TEMPL
  5512. }));
  5513. send!(s, time 1015, TcpRepr {
  5514. seq_number: REMOTE_SEQ + 1 + 1,
  5515. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  5516. window_len: 6,
  5517. ..SEND_TEMPL
  5518. });
  5519. recv!(s, time 1020, Ok(TcpRepr {
  5520. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  5521. ack_number: Some(REMOTE_SEQ + 1 + 1),
  5522. payload: &b"ABCDEF"[..],
  5523. ..RECV_TEMPL
  5524. }));
  5525. }
  5526. #[test]
  5527. fn test_fin_wait_1_retransmit_reset_after_ack() {
  5528. let mut s = socket_established();
  5529. s.remote_win_len = 6;
  5530. s.send_slice(b"abcdef").unwrap();
  5531. s.send_slice(b"123456").unwrap();
  5532. s.send_slice(b"ABCDEF").unwrap();
  5533. s.close();
  5534. recv!(s, time 1000, Ok(TcpRepr {
  5535. seq_number: LOCAL_SEQ + 1,
  5536. ack_number: Some(REMOTE_SEQ + 1),
  5537. payload: &b"abcdef"[..],
  5538. ..RECV_TEMPL
  5539. }));
  5540. send!(s, time 1005, TcpRepr {
  5541. seq_number: REMOTE_SEQ + 1,
  5542. ack_number: Some(LOCAL_SEQ + 1 + 6),
  5543. window_len: 6,
  5544. ..SEND_TEMPL
  5545. });
  5546. recv!(s, time 1010, Ok(TcpRepr {
  5547. seq_number: LOCAL_SEQ + 1 + 6,
  5548. ack_number: Some(REMOTE_SEQ + 1),
  5549. payload: &b"123456"[..],
  5550. ..RECV_TEMPL
  5551. }));
  5552. send!(s, time 1015, TcpRepr {
  5553. seq_number: REMOTE_SEQ + 1,
  5554. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  5555. window_len: 6,
  5556. ..SEND_TEMPL
  5557. });
  5558. recv!(s, time 1020, Ok(TcpRepr {
  5559. control: TcpControl::Fin,
  5560. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  5561. ack_number: Some(REMOTE_SEQ + 1),
  5562. payload: &b"ABCDEF"[..],
  5563. ..RECV_TEMPL
  5564. }));
  5565. }
  5566. #[test]
  5567. fn test_fast_retransmit_after_triple_duplicate_ack() {
  5568. let mut s = socket_established();
  5569. s.remote_mss = 6;
  5570. // Normal ACK of previously received segment
  5571. send!(s, time 0, TcpRepr {
  5572. seq_number: REMOTE_SEQ + 1,
  5573. ack_number: Some(LOCAL_SEQ + 1),
  5574. ..SEND_TEMPL
  5575. });
  5576. // Send a long string of text divided into several packets
  5577. // because of previously received "window_len"
  5578. s.send_slice(b"xxxxxxyyyyyywwwwwwzzzzzz").unwrap();
  5579. // This packet is lost
  5580. recv!(s, time 1000, Ok(TcpRepr {
  5581. seq_number: LOCAL_SEQ + 1,
  5582. ack_number: Some(REMOTE_SEQ + 1),
  5583. payload: &b"xxxxxx"[..],
  5584. ..RECV_TEMPL
  5585. }));
  5586. recv!(s, time 1005, Ok(TcpRepr {
  5587. seq_number: LOCAL_SEQ + 1 + 6,
  5588. ack_number: Some(REMOTE_SEQ + 1),
  5589. payload: &b"yyyyyy"[..],
  5590. ..RECV_TEMPL
  5591. }));
  5592. recv!(s, time 1010, Ok(TcpRepr {
  5593. seq_number: LOCAL_SEQ + 1 + (6 * 2),
  5594. ack_number: Some(REMOTE_SEQ + 1),
  5595. payload: &b"wwwwww"[..],
  5596. ..RECV_TEMPL
  5597. }));
  5598. recv!(s, time 1015, Ok(TcpRepr {
  5599. seq_number: LOCAL_SEQ + 1 + (6 * 3),
  5600. ack_number: Some(REMOTE_SEQ + 1),
  5601. payload: &b"zzzzzz"[..],
  5602. ..RECV_TEMPL
  5603. }));
  5604. // First duplicate ACK
  5605. send!(s, time 1050, TcpRepr {
  5606. seq_number: REMOTE_SEQ + 1,
  5607. ack_number: Some(LOCAL_SEQ + 1),
  5608. ..SEND_TEMPL
  5609. });
  5610. // Second duplicate ACK
  5611. send!(s, time 1055, TcpRepr {
  5612. seq_number: REMOTE_SEQ + 1,
  5613. ack_number: Some(LOCAL_SEQ + 1),
  5614. ..SEND_TEMPL
  5615. });
  5616. // Third duplicate ACK
  5617. // Should trigger a fast retransmit of dropped packet
  5618. send!(s, time 1060, TcpRepr {
  5619. seq_number: REMOTE_SEQ + 1,
  5620. ack_number: Some(LOCAL_SEQ + 1),
  5621. ..SEND_TEMPL
  5622. });
  5623. // Fast retransmit packet
  5624. recv!(s, time 1100, Ok(TcpRepr {
  5625. seq_number: LOCAL_SEQ + 1,
  5626. ack_number: Some(REMOTE_SEQ + 1),
  5627. payload: &b"xxxxxx"[..],
  5628. ..RECV_TEMPL
  5629. }));
  5630. recv!(s, time 1105, Ok(TcpRepr {
  5631. seq_number: LOCAL_SEQ + 1 + 6,
  5632. ack_number: Some(REMOTE_SEQ + 1),
  5633. payload: &b"yyyyyy"[..],
  5634. ..RECV_TEMPL
  5635. }));
  5636. recv!(s, time 1110, Ok(TcpRepr {
  5637. seq_number: LOCAL_SEQ + 1 + (6 * 2),
  5638. ack_number: Some(REMOTE_SEQ + 1),
  5639. payload: &b"wwwwww"[..],
  5640. ..RECV_TEMPL
  5641. }));
  5642. recv!(s, time 1115, Ok(TcpRepr {
  5643. seq_number: LOCAL_SEQ + 1 + (6 * 3),
  5644. ack_number: Some(REMOTE_SEQ + 1),
  5645. payload: &b"zzzzzz"[..],
  5646. ..RECV_TEMPL
  5647. }));
  5648. // After all was send out, enter *normal* retransmission,
  5649. // don't stay in fast retransmission.
  5650. assert!(match s.timer {
  5651. Timer::Retransmit { expires_at, .. } => expires_at > Instant::from_millis(1115),
  5652. _ => false,
  5653. });
  5654. // ACK all received segments
  5655. send!(s, time 1120, TcpRepr {
  5656. seq_number: REMOTE_SEQ + 1,
  5657. ack_number: Some(LOCAL_SEQ + 1 + (6 * 4)),
  5658. ..SEND_TEMPL
  5659. });
  5660. }
  5661. #[test]
  5662. fn test_fast_retransmit_duplicate_detection_with_data() {
  5663. let mut s = socket_established();
  5664. s.send_slice(b"abc").unwrap(); // This is lost
  5665. recv!(s, time 1000, Ok(TcpRepr {
  5666. seq_number: LOCAL_SEQ + 1,
  5667. ack_number: Some(REMOTE_SEQ + 1),
  5668. payload: &b"abc"[..],
  5669. ..RECV_TEMPL
  5670. }));
  5671. // Normal ACK of previously received segment
  5672. send!(
  5673. s,
  5674. TcpRepr {
  5675. seq_number: REMOTE_SEQ + 1,
  5676. ack_number: Some(LOCAL_SEQ + 1),
  5677. ..SEND_TEMPL
  5678. }
  5679. );
  5680. // First duplicate
  5681. send!(
  5682. s,
  5683. TcpRepr {
  5684. seq_number: REMOTE_SEQ + 1,
  5685. ack_number: Some(LOCAL_SEQ + 1),
  5686. ..SEND_TEMPL
  5687. }
  5688. );
  5689. // Second duplicate
  5690. send!(
  5691. s,
  5692. TcpRepr {
  5693. seq_number: REMOTE_SEQ + 1,
  5694. ack_number: Some(LOCAL_SEQ + 1),
  5695. ..SEND_TEMPL
  5696. }
  5697. );
  5698. assert_eq!(s.local_rx_dup_acks, 2, "duplicate ACK counter is not set");
  5699. // This packet has content, hence should not be detected
  5700. // as a duplicate ACK and should reset the duplicate ACK count
  5701. send!(
  5702. s,
  5703. TcpRepr {
  5704. seq_number: REMOTE_SEQ + 1,
  5705. ack_number: Some(LOCAL_SEQ + 1),
  5706. payload: &b"xxxxxx"[..],
  5707. ..SEND_TEMPL
  5708. }
  5709. );
  5710. recv!(
  5711. s,
  5712. [TcpRepr {
  5713. seq_number: LOCAL_SEQ + 1 + 3,
  5714. ack_number: Some(REMOTE_SEQ + 1 + 6),
  5715. window_len: 58,
  5716. ..RECV_TEMPL
  5717. }]
  5718. );
  5719. assert_eq!(
  5720. s.local_rx_dup_acks, 0,
  5721. "duplicate ACK counter is not reset when receiving data"
  5722. );
  5723. }
  5724. #[test]
  5725. fn test_fast_retransmit_duplicate_detection_with_window_update() {
  5726. let mut s = socket_established();
  5727. s.send_slice(b"abc").unwrap(); // This is lost
  5728. recv!(s, time 1000, Ok(TcpRepr {
  5729. seq_number: LOCAL_SEQ + 1,
  5730. ack_number: Some(REMOTE_SEQ + 1),
  5731. payload: &b"abc"[..],
  5732. ..RECV_TEMPL
  5733. }));
  5734. // Normal ACK of previously received segment
  5735. send!(
  5736. s,
  5737. TcpRepr {
  5738. seq_number: REMOTE_SEQ + 1,
  5739. ack_number: Some(LOCAL_SEQ + 1),
  5740. ..SEND_TEMPL
  5741. }
  5742. );
  5743. // First duplicate
  5744. send!(
  5745. s,
  5746. TcpRepr {
  5747. seq_number: REMOTE_SEQ + 1,
  5748. ack_number: Some(LOCAL_SEQ + 1),
  5749. ..SEND_TEMPL
  5750. }
  5751. );
  5752. // Second duplicate
  5753. send!(
  5754. s,
  5755. TcpRepr {
  5756. seq_number: REMOTE_SEQ + 1,
  5757. ack_number: Some(LOCAL_SEQ + 1),
  5758. ..SEND_TEMPL
  5759. }
  5760. );
  5761. assert_eq!(s.local_rx_dup_acks, 2, "duplicate ACK counter is not set");
  5762. // This packet has a window update, hence should not be detected
  5763. // as a duplicate ACK and should reset the duplicate ACK count
  5764. send!(
  5765. s,
  5766. TcpRepr {
  5767. seq_number: REMOTE_SEQ + 1,
  5768. ack_number: Some(LOCAL_SEQ + 1),
  5769. window_len: 400,
  5770. ..SEND_TEMPL
  5771. }
  5772. );
  5773. assert_eq!(
  5774. s.local_rx_dup_acks, 0,
  5775. "duplicate ACK counter is not reset when receiving a window update"
  5776. );
  5777. }
  5778. #[test]
  5779. fn test_fast_retransmit_duplicate_detection() {
  5780. let mut s = socket_established();
  5781. s.remote_mss = 6;
  5782. // Normal ACK of previously received segment
  5783. send!(s, time 0, TcpRepr {
  5784. seq_number: REMOTE_SEQ + 1,
  5785. ack_number: Some(LOCAL_SEQ + 1),
  5786. ..SEND_TEMPL
  5787. });
  5788. // First duplicate, should not be counted as there is nothing to resend
  5789. send!(s, time 0, TcpRepr {
  5790. seq_number: REMOTE_SEQ + 1,
  5791. ack_number: Some(LOCAL_SEQ + 1),
  5792. ..SEND_TEMPL
  5793. });
  5794. assert_eq!(
  5795. s.local_rx_dup_acks, 0,
  5796. "duplicate ACK counter is set but wound not transmit data"
  5797. );
  5798. // Send a long string of text divided into several packets
  5799. // because of small remote_mss
  5800. s.send_slice(b"xxxxxxyyyyyywwwwwwzzzzzz").unwrap();
  5801. // This packet is reordered in network
  5802. recv!(s, time 1000, Ok(TcpRepr {
  5803. seq_number: LOCAL_SEQ + 1,
  5804. ack_number: Some(REMOTE_SEQ + 1),
  5805. payload: &b"xxxxxx"[..],
  5806. ..RECV_TEMPL
  5807. }));
  5808. recv!(s, time 1005, Ok(TcpRepr {
  5809. seq_number: LOCAL_SEQ + 1 + 6,
  5810. ack_number: Some(REMOTE_SEQ + 1),
  5811. payload: &b"yyyyyy"[..],
  5812. ..RECV_TEMPL
  5813. }));
  5814. recv!(s, time 1010, Ok(TcpRepr {
  5815. seq_number: LOCAL_SEQ + 1 + (6 * 2),
  5816. ack_number: Some(REMOTE_SEQ + 1),
  5817. payload: &b"wwwwww"[..],
  5818. ..RECV_TEMPL
  5819. }));
  5820. recv!(s, time 1015, Ok(TcpRepr {
  5821. seq_number: LOCAL_SEQ + 1 + (6 * 3),
  5822. ack_number: Some(REMOTE_SEQ + 1),
  5823. payload: &b"zzzzzz"[..],
  5824. ..RECV_TEMPL
  5825. }));
  5826. // First duplicate ACK
  5827. send!(s, time 1050, TcpRepr {
  5828. seq_number: REMOTE_SEQ + 1,
  5829. ack_number: Some(LOCAL_SEQ + 1),
  5830. ..SEND_TEMPL
  5831. });
  5832. // Second duplicate ACK
  5833. send!(s, time 1055, TcpRepr {
  5834. seq_number: REMOTE_SEQ + 1,
  5835. ack_number: Some(LOCAL_SEQ + 1),
  5836. ..SEND_TEMPL
  5837. });
  5838. // Reordered packet arrives which should reset duplicate ACK count
  5839. send!(s, time 1060, TcpRepr {
  5840. seq_number: REMOTE_SEQ + 1,
  5841. ack_number: Some(LOCAL_SEQ + 1 + (6 * 3)),
  5842. ..SEND_TEMPL
  5843. });
  5844. assert_eq!(
  5845. s.local_rx_dup_acks, 0,
  5846. "duplicate ACK counter is not reset when receiving ACK which updates send window"
  5847. );
  5848. // ACK all received segments
  5849. send!(s, time 1120, TcpRepr {
  5850. seq_number: REMOTE_SEQ + 1,
  5851. ack_number: Some(LOCAL_SEQ + 1 + (6 * 4)),
  5852. ..SEND_TEMPL
  5853. });
  5854. }
  5855. #[test]
  5856. fn test_fast_retransmit_dup_acks_counter() {
  5857. let mut s = socket_established();
  5858. s.send_slice(b"abc").unwrap(); // This is lost
  5859. recv!(s, time 0, Ok(TcpRepr {
  5860. seq_number: LOCAL_SEQ + 1,
  5861. ack_number: Some(REMOTE_SEQ + 1),
  5862. payload: &b"abc"[..],
  5863. ..RECV_TEMPL
  5864. }));
  5865. send!(s, time 0, TcpRepr {
  5866. seq_number: REMOTE_SEQ + 1,
  5867. ack_number: Some(LOCAL_SEQ + 1),
  5868. ..SEND_TEMPL
  5869. });
  5870. // A lot of retransmits happen here
  5871. s.local_rx_dup_acks = u8::MAX - 1;
  5872. // Send 3 more ACKs, which could overflow local_rx_dup_acks,
  5873. // but intended behaviour is that we saturate the bounds
  5874. // of local_rx_dup_acks
  5875. send!(s, time 0, TcpRepr {
  5876. seq_number: REMOTE_SEQ + 1,
  5877. ack_number: Some(LOCAL_SEQ + 1),
  5878. ..SEND_TEMPL
  5879. });
  5880. send!(s, time 0, TcpRepr {
  5881. seq_number: REMOTE_SEQ + 1,
  5882. ack_number: Some(LOCAL_SEQ + 1),
  5883. ..SEND_TEMPL
  5884. });
  5885. send!(s, time 0, TcpRepr {
  5886. seq_number: REMOTE_SEQ + 1,
  5887. ack_number: Some(LOCAL_SEQ + 1),
  5888. ..SEND_TEMPL
  5889. });
  5890. assert_eq!(
  5891. s.local_rx_dup_acks,
  5892. u8::MAX,
  5893. "duplicate ACK count should not overflow but saturate"
  5894. );
  5895. }
  5896. #[test]
  5897. fn test_fast_retransmit_zero_window() {
  5898. let mut s = socket_established();
  5899. send!(s, time 1000, TcpRepr {
  5900. seq_number: REMOTE_SEQ + 1,
  5901. ack_number: Some(LOCAL_SEQ + 1),
  5902. ..SEND_TEMPL
  5903. });
  5904. s.send_slice(b"abc").unwrap();
  5905. recv!(s, time 0, Ok(TcpRepr {
  5906. seq_number: LOCAL_SEQ + 1,
  5907. ack_number: Some(REMOTE_SEQ + 1),
  5908. payload: &b"abc"[..],
  5909. ..RECV_TEMPL
  5910. }));
  5911. // 3 dup acks
  5912. send!(s, time 1050, TcpRepr {
  5913. seq_number: REMOTE_SEQ + 1,
  5914. ack_number: Some(LOCAL_SEQ + 1),
  5915. ..SEND_TEMPL
  5916. });
  5917. send!(s, time 1050, TcpRepr {
  5918. seq_number: REMOTE_SEQ + 1,
  5919. ack_number: Some(LOCAL_SEQ + 1),
  5920. ..SEND_TEMPL
  5921. });
  5922. send!(s, time 1050, TcpRepr {
  5923. seq_number: REMOTE_SEQ + 1,
  5924. ack_number: Some(LOCAL_SEQ + 1),
  5925. window_len: 0, // boom
  5926. ..SEND_TEMPL
  5927. });
  5928. // even though we're in "fast retransmit", we shouldn't
  5929. // force-send anything because the remote's window is full.
  5930. recv_nothing!(s);
  5931. }
  5932. #[test]
  5933. fn test_retransmit_exponential_backoff() {
  5934. let mut s = socket_established();
  5935. s.send_slice(b"abcdef").unwrap();
  5936. recv!(s, time 0, Ok(TcpRepr {
  5937. seq_number: LOCAL_SEQ + 1,
  5938. ack_number: Some(REMOTE_SEQ + 1),
  5939. payload: &b"abcdef"[..],
  5940. ..RECV_TEMPL
  5941. }));
  5942. let expected_retransmission_instant = s.rtte.retransmission_timeout().total_millis() as i64;
  5943. recv_nothing!(s, time expected_retransmission_instant - 1);
  5944. recv!(s, time expected_retransmission_instant, Ok(TcpRepr {
  5945. seq_number: LOCAL_SEQ + 1,
  5946. ack_number: Some(REMOTE_SEQ + 1),
  5947. payload: &b"abcdef"[..],
  5948. ..RECV_TEMPL
  5949. }));
  5950. // "current time" is expected_retransmission_instant, and we want to wait 2 * retransmission timeout
  5951. let expected_retransmission_instant = 3 * expected_retransmission_instant;
  5952. recv_nothing!(s, time expected_retransmission_instant - 1);
  5953. recv!(s, time expected_retransmission_instant, Ok(TcpRepr {
  5954. seq_number: LOCAL_SEQ + 1,
  5955. ack_number: Some(REMOTE_SEQ + 1),
  5956. payload: &b"abcdef"[..],
  5957. ..RECV_TEMPL
  5958. }));
  5959. }
  5960. #[test]
  5961. fn test_data_retransmit_ack_more_than_expected() {
  5962. let mut s = socket_established();
  5963. s.remote_mss = 6;
  5964. s.send_slice(b"aaaaaabbbbbbcccccc").unwrap();
  5965. recv!(s, time 0, Ok(TcpRepr {
  5966. seq_number: LOCAL_SEQ + 1,
  5967. ack_number: Some(REMOTE_SEQ + 1),
  5968. payload: &b"aaaaaa"[..],
  5969. ..RECV_TEMPL
  5970. }));
  5971. recv!(s, time 0, Ok(TcpRepr {
  5972. seq_number: LOCAL_SEQ + 1 + 6,
  5973. ack_number: Some(REMOTE_SEQ + 1),
  5974. payload: &b"bbbbbb"[..],
  5975. ..RECV_TEMPL
  5976. }));
  5977. recv!(s, time 0, Ok(TcpRepr {
  5978. seq_number: LOCAL_SEQ + 1 + 12,
  5979. ack_number: Some(REMOTE_SEQ + 1),
  5980. payload: &b"cccccc"[..],
  5981. ..RECV_TEMPL
  5982. }));
  5983. recv_nothing!(s, time 0);
  5984. recv_nothing!(s, time 50);
  5985. // retransmit timer expires, we want to retransmit all 3 packets
  5986. // but we only manage to retransmit 2 (due to e.g. lack of device buffer space)
  5987. assert!(s.timer.is_retransmit());
  5988. recv!(s, time 1000, Ok(TcpRepr {
  5989. seq_number: LOCAL_SEQ + 1,
  5990. ack_number: Some(REMOTE_SEQ + 1),
  5991. payload: &b"aaaaaa"[..],
  5992. ..RECV_TEMPL
  5993. }));
  5994. recv!(s, time 1000, Ok(TcpRepr {
  5995. seq_number: LOCAL_SEQ + 1 + 6,
  5996. ack_number: Some(REMOTE_SEQ + 1),
  5997. payload: &b"bbbbbb"[..],
  5998. ..RECV_TEMPL
  5999. }));
  6000. // ack first packet.
  6001. send!(
  6002. s,
  6003. time 3000,
  6004. TcpRepr {
  6005. seq_number: REMOTE_SEQ + 1,
  6006. ack_number: Some(LOCAL_SEQ + 1 + 6),
  6007. ..SEND_TEMPL
  6008. }
  6009. );
  6010. // this should keep retransmit timer on, because there's
  6011. // still unacked data.
  6012. assert!(s.timer.is_retransmit());
  6013. // ack all three packets.
  6014. // This might confuse the TCP stack because after the retransmit
  6015. // it "thinks" the 3rd packet hasn't been transmitted yet, but it is getting acked.
  6016. send!(
  6017. s,
  6018. time 3000,
  6019. TcpRepr {
  6020. seq_number: REMOTE_SEQ + 1,
  6021. ack_number: Some(LOCAL_SEQ + 1 + 18),
  6022. ..SEND_TEMPL
  6023. }
  6024. );
  6025. // this should exit retransmit mode.
  6026. assert!(!s.timer.is_retransmit());
  6027. // and consider all data ACKed.
  6028. assert!(s.tx_buffer.is_empty());
  6029. recv_nothing!(s, time 5000);
  6030. }
  6031. #[test]
  6032. fn test_retransmit_fin() {
  6033. let mut s = socket_established();
  6034. s.close();
  6035. recv!(s, time 0, Ok(TcpRepr {
  6036. control: TcpControl::Fin,
  6037. seq_number: LOCAL_SEQ + 1,
  6038. ack_number: Some(REMOTE_SEQ + 1),
  6039. ..RECV_TEMPL
  6040. }));
  6041. recv_nothing!(s, time 999);
  6042. recv!(s, time 1000, Ok(TcpRepr {
  6043. control: TcpControl::Fin,
  6044. seq_number: LOCAL_SEQ + 1,
  6045. ack_number: Some(REMOTE_SEQ + 1),
  6046. ..RECV_TEMPL
  6047. }));
  6048. }
  6049. #[test]
  6050. fn test_retransmit_fin_wait() {
  6051. let mut s = socket_fin_wait_1();
  6052. // we send FIN
  6053. recv!(
  6054. s,
  6055. [TcpRepr {
  6056. control: TcpControl::Fin,
  6057. seq_number: LOCAL_SEQ + 1,
  6058. ack_number: Some(REMOTE_SEQ + 1),
  6059. ..RECV_TEMPL
  6060. }]
  6061. );
  6062. // remote also sends FIN, does NOT ack ours.
  6063. send!(
  6064. s,
  6065. TcpRepr {
  6066. control: TcpControl::Fin,
  6067. seq_number: REMOTE_SEQ + 1,
  6068. ack_number: Some(LOCAL_SEQ + 1),
  6069. ..SEND_TEMPL
  6070. }
  6071. );
  6072. // we ack it
  6073. recv!(
  6074. s,
  6075. [TcpRepr {
  6076. control: TcpControl::None,
  6077. seq_number: LOCAL_SEQ + 2,
  6078. ack_number: Some(REMOTE_SEQ + 2),
  6079. ..RECV_TEMPL
  6080. }]
  6081. );
  6082. // we haven't got an ACK for our FIN, we should retransmit.
  6083. recv_nothing!(s, time 999);
  6084. recv!(
  6085. s,
  6086. time 1000,
  6087. [TcpRepr {
  6088. control: TcpControl::Fin,
  6089. seq_number: LOCAL_SEQ + 1,
  6090. ack_number: Some(REMOTE_SEQ + 2),
  6091. ..RECV_TEMPL
  6092. }]
  6093. );
  6094. recv_nothing!(s, time 2999);
  6095. recv!(
  6096. s,
  6097. time 3000,
  6098. [TcpRepr {
  6099. control: TcpControl::Fin,
  6100. seq_number: LOCAL_SEQ + 1,
  6101. ack_number: Some(REMOTE_SEQ + 2),
  6102. ..RECV_TEMPL
  6103. }]
  6104. );
  6105. }
  6106. // =========================================================================================//
  6107. // Tests for window management.
  6108. // =========================================================================================//
  6109. #[test]
  6110. fn test_maximum_segment_size() {
  6111. let mut s = socket_listen();
  6112. s.tx_buffer = SocketBuffer::new(vec![0; 32767]);
  6113. send!(
  6114. s,
  6115. TcpRepr {
  6116. control: TcpControl::Syn,
  6117. seq_number: REMOTE_SEQ,
  6118. ack_number: None,
  6119. max_seg_size: Some(1000),
  6120. ..SEND_TEMPL
  6121. }
  6122. );
  6123. recv!(
  6124. s,
  6125. [TcpRepr {
  6126. control: TcpControl::Syn,
  6127. seq_number: LOCAL_SEQ,
  6128. ack_number: Some(REMOTE_SEQ + 1),
  6129. max_seg_size: Some(BASE_MSS),
  6130. ..RECV_TEMPL
  6131. }]
  6132. );
  6133. send!(
  6134. s,
  6135. TcpRepr {
  6136. seq_number: REMOTE_SEQ + 1,
  6137. ack_number: Some(LOCAL_SEQ + 1),
  6138. window_len: 32767,
  6139. ..SEND_TEMPL
  6140. }
  6141. );
  6142. s.send_slice(&[0; 1200][..]).unwrap();
  6143. recv!(
  6144. s,
  6145. Ok(TcpRepr {
  6146. seq_number: LOCAL_SEQ + 1,
  6147. ack_number: Some(REMOTE_SEQ + 1),
  6148. payload: &[0; 1000][..],
  6149. ..RECV_TEMPL
  6150. })
  6151. );
  6152. }
  6153. #[test]
  6154. fn test_close_wait_no_window_update() {
  6155. let mut s = socket_established();
  6156. send!(
  6157. s,
  6158. TcpRepr {
  6159. control: TcpControl::Fin,
  6160. seq_number: REMOTE_SEQ + 1,
  6161. ack_number: Some(LOCAL_SEQ + 1),
  6162. payload: &[1, 2, 3, 4],
  6163. ..SEND_TEMPL
  6164. }
  6165. );
  6166. assert_eq!(s.state, State::CloseWait);
  6167. // we ack the FIN, with the reduced window size.
  6168. recv!(
  6169. s,
  6170. Ok(TcpRepr {
  6171. seq_number: LOCAL_SEQ + 1,
  6172. ack_number: Some(REMOTE_SEQ + 6),
  6173. window_len: 60,
  6174. ..RECV_TEMPL
  6175. })
  6176. );
  6177. let rx_buf = &mut [0; 32];
  6178. assert_eq!(s.recv_slice(rx_buf), Ok(4));
  6179. // check that we do NOT send a window update even if it has changed.
  6180. recv_nothing!(s);
  6181. }
  6182. #[test]
  6183. fn test_time_wait_no_window_update() {
  6184. let mut s = socket_fin_wait_2();
  6185. send!(
  6186. s,
  6187. TcpRepr {
  6188. control: TcpControl::Fin,
  6189. seq_number: REMOTE_SEQ + 1,
  6190. ack_number: Some(LOCAL_SEQ + 2),
  6191. payload: &[1, 2, 3, 4],
  6192. ..SEND_TEMPL
  6193. }
  6194. );
  6195. assert_eq!(s.state, State::TimeWait);
  6196. // we ack the FIN, with the reduced window size.
  6197. recv!(
  6198. s,
  6199. Ok(TcpRepr {
  6200. seq_number: LOCAL_SEQ + 2,
  6201. ack_number: Some(REMOTE_SEQ + 6),
  6202. window_len: 60,
  6203. ..RECV_TEMPL
  6204. })
  6205. );
  6206. let rx_buf = &mut [0; 32];
  6207. assert_eq!(s.recv_slice(rx_buf), Ok(4));
  6208. // check that we do NOT send a window update even if it has changed.
  6209. recv_nothing!(s);
  6210. }
  6211. // =========================================================================================//
  6212. // Tests for flow control.
  6213. // =========================================================================================//
  6214. #[test]
  6215. fn test_psh_transmit() {
  6216. let mut s = socket_established();
  6217. s.remote_mss = 6;
  6218. s.send_slice(b"abcdef").unwrap();
  6219. s.send_slice(b"123456").unwrap();
  6220. recv!(s, time 0, Ok(TcpRepr {
  6221. control: TcpControl::None,
  6222. seq_number: LOCAL_SEQ + 1,
  6223. ack_number: Some(REMOTE_SEQ + 1),
  6224. payload: &b"abcdef"[..],
  6225. ..RECV_TEMPL
  6226. }), exact);
  6227. recv!(s, time 0, Ok(TcpRepr {
  6228. control: TcpControl::Psh,
  6229. seq_number: LOCAL_SEQ + 1 + 6,
  6230. ack_number: Some(REMOTE_SEQ + 1),
  6231. payload: &b"123456"[..],
  6232. ..RECV_TEMPL
  6233. }), exact);
  6234. }
  6235. #[test]
  6236. fn test_psh_receive() {
  6237. let mut s = socket_established();
  6238. send!(
  6239. s,
  6240. TcpRepr {
  6241. control: TcpControl::Psh,
  6242. seq_number: REMOTE_SEQ + 1,
  6243. ack_number: Some(LOCAL_SEQ + 1),
  6244. payload: &b"abcdef"[..],
  6245. ..SEND_TEMPL
  6246. }
  6247. );
  6248. recv!(
  6249. s,
  6250. [TcpRepr {
  6251. seq_number: LOCAL_SEQ + 1,
  6252. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6253. window_len: 58,
  6254. ..RECV_TEMPL
  6255. }]
  6256. );
  6257. }
  6258. #[test]
  6259. fn test_zero_window_ack() {
  6260. let mut s = socket_established();
  6261. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  6262. s.assembler = Assembler::new();
  6263. send!(
  6264. s,
  6265. TcpRepr {
  6266. seq_number: REMOTE_SEQ + 1,
  6267. ack_number: Some(LOCAL_SEQ + 1),
  6268. payload: &b"abcdef"[..],
  6269. ..SEND_TEMPL
  6270. }
  6271. );
  6272. recv!(
  6273. s,
  6274. [TcpRepr {
  6275. seq_number: LOCAL_SEQ + 1,
  6276. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6277. window_len: 0,
  6278. ..RECV_TEMPL
  6279. }]
  6280. );
  6281. send!(
  6282. s,
  6283. TcpRepr {
  6284. seq_number: REMOTE_SEQ + 1 + 6,
  6285. ack_number: Some(LOCAL_SEQ + 1),
  6286. payload: &b"123456"[..],
  6287. ..SEND_TEMPL
  6288. },
  6289. Some(TcpRepr {
  6290. seq_number: LOCAL_SEQ + 1,
  6291. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6292. window_len: 0,
  6293. ..RECV_TEMPL
  6294. })
  6295. );
  6296. }
  6297. #[test]
  6298. fn test_zero_window_fin() {
  6299. let mut s = socket_established();
  6300. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  6301. s.assembler = Assembler::new();
  6302. s.ack_delay = None;
  6303. send!(
  6304. s,
  6305. TcpRepr {
  6306. seq_number: REMOTE_SEQ + 1,
  6307. ack_number: Some(LOCAL_SEQ + 1),
  6308. payload: &b"abcdef"[..],
  6309. ..SEND_TEMPL
  6310. }
  6311. );
  6312. recv!(
  6313. s,
  6314. [TcpRepr {
  6315. seq_number: LOCAL_SEQ + 1,
  6316. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6317. window_len: 0,
  6318. ..RECV_TEMPL
  6319. }]
  6320. );
  6321. // Even though the sequence space for the FIN itself is outside the window,
  6322. // it is not data, so FIN must be accepted when window full.
  6323. send!(
  6324. s,
  6325. TcpRepr {
  6326. seq_number: REMOTE_SEQ + 1 + 6,
  6327. ack_number: Some(LOCAL_SEQ + 1),
  6328. payload: &[],
  6329. control: TcpControl::Fin,
  6330. ..SEND_TEMPL
  6331. }
  6332. );
  6333. assert_eq!(s.state, State::CloseWait);
  6334. recv!(
  6335. s,
  6336. [TcpRepr {
  6337. seq_number: LOCAL_SEQ + 1,
  6338. ack_number: Some(REMOTE_SEQ + 1 + 7),
  6339. window_len: 0,
  6340. ..RECV_TEMPL
  6341. }]
  6342. );
  6343. }
  6344. #[test]
  6345. fn test_zero_window_ack_on_window_growth() {
  6346. let mut s = socket_established();
  6347. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  6348. s.assembler = Assembler::new();
  6349. send!(
  6350. s,
  6351. TcpRepr {
  6352. seq_number: REMOTE_SEQ + 1,
  6353. ack_number: Some(LOCAL_SEQ + 1),
  6354. payload: &b"abcdef"[..],
  6355. ..SEND_TEMPL
  6356. }
  6357. );
  6358. recv!(
  6359. s,
  6360. [TcpRepr {
  6361. seq_number: LOCAL_SEQ + 1,
  6362. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6363. window_len: 0,
  6364. ..RECV_TEMPL
  6365. }]
  6366. );
  6367. recv_nothing!(s, time 0);
  6368. s.recv(|buffer| {
  6369. assert_eq!(&buffer[..3], b"abc");
  6370. (3, ())
  6371. })
  6372. .unwrap();
  6373. recv!(s, time 0, Ok(TcpRepr {
  6374. seq_number: LOCAL_SEQ + 1,
  6375. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6376. window_len: 3,
  6377. ..RECV_TEMPL
  6378. }));
  6379. recv_nothing!(s, time 0);
  6380. s.recv(|buffer| {
  6381. assert_eq!(buffer, b"def");
  6382. (buffer.len(), ())
  6383. })
  6384. .unwrap();
  6385. recv!(s, time 0, Ok(TcpRepr {
  6386. seq_number: LOCAL_SEQ + 1,
  6387. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6388. window_len: 6,
  6389. ..RECV_TEMPL
  6390. }));
  6391. }
  6392. #[test]
  6393. fn test_window_update_with_delay_ack() {
  6394. let mut s = socket_established_with_buffer_sizes(6, 6);
  6395. s.ack_delay = Some(Duration::from_millis(10));
  6396. send!(
  6397. s,
  6398. TcpRepr {
  6399. seq_number: REMOTE_SEQ + 1,
  6400. ack_number: Some(LOCAL_SEQ + 1),
  6401. payload: &b"abcdef"[..],
  6402. ..SEND_TEMPL
  6403. }
  6404. );
  6405. recv_nothing!(s, time 5);
  6406. s.recv(|buffer| {
  6407. assert_eq!(&buffer[..2], b"ab");
  6408. (2, ())
  6409. })
  6410. .unwrap();
  6411. recv!(
  6412. s,
  6413. time 5,
  6414. Ok(TcpRepr {
  6415. seq_number: LOCAL_SEQ + 1,
  6416. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6417. window_len: 2,
  6418. ..RECV_TEMPL
  6419. })
  6420. );
  6421. s.recv(|buffer| {
  6422. assert_eq!(&buffer[..1], b"c");
  6423. (1, ())
  6424. })
  6425. .unwrap();
  6426. recv_nothing!(s, time 5);
  6427. s.recv(|buffer| {
  6428. assert_eq!(&buffer[..1], b"d");
  6429. (1, ())
  6430. })
  6431. .unwrap();
  6432. recv!(
  6433. s,
  6434. time 5,
  6435. Ok(TcpRepr {
  6436. seq_number: LOCAL_SEQ + 1,
  6437. ack_number: Some(REMOTE_SEQ + 1 + 6),
  6438. window_len: 4,
  6439. ..RECV_TEMPL
  6440. })
  6441. );
  6442. }
  6443. #[test]
  6444. fn test_fill_peer_window() {
  6445. let mut s = socket_established();
  6446. s.remote_mss = 6;
  6447. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6448. recv!(
  6449. s,
  6450. [
  6451. TcpRepr {
  6452. seq_number: LOCAL_SEQ + 1,
  6453. ack_number: Some(REMOTE_SEQ + 1),
  6454. payload: &b"abcdef"[..],
  6455. ..RECV_TEMPL
  6456. },
  6457. TcpRepr {
  6458. seq_number: LOCAL_SEQ + 1 + 6,
  6459. ack_number: Some(REMOTE_SEQ + 1),
  6460. payload: &b"123456"[..],
  6461. ..RECV_TEMPL
  6462. },
  6463. TcpRepr {
  6464. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  6465. ack_number: Some(REMOTE_SEQ + 1),
  6466. payload: &b"!@#$%^"[..],
  6467. ..RECV_TEMPL
  6468. }
  6469. ]
  6470. );
  6471. }
  6472. #[test]
  6473. fn test_announce_window_after_read() {
  6474. let mut s = socket_established();
  6475. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  6476. s.assembler = Assembler::new();
  6477. send!(
  6478. s,
  6479. TcpRepr {
  6480. seq_number: REMOTE_SEQ + 1,
  6481. ack_number: Some(LOCAL_SEQ + 1),
  6482. payload: &b"abc"[..],
  6483. ..SEND_TEMPL
  6484. }
  6485. );
  6486. recv!(
  6487. s,
  6488. [TcpRepr {
  6489. seq_number: LOCAL_SEQ + 1,
  6490. ack_number: Some(REMOTE_SEQ + 1 + 3),
  6491. window_len: 3,
  6492. ..RECV_TEMPL
  6493. }]
  6494. );
  6495. // Test that `dispatch` updates `remote_last_win`
  6496. assert_eq!(s.remote_last_win, s.rx_buffer.window() as u16);
  6497. s.recv(|buffer| (buffer.len(), ())).unwrap();
  6498. assert!(s.window_to_update());
  6499. recv!(
  6500. s,
  6501. [TcpRepr {
  6502. seq_number: LOCAL_SEQ + 1,
  6503. ack_number: Some(REMOTE_SEQ + 1 + 3),
  6504. window_len: 6,
  6505. ..RECV_TEMPL
  6506. }]
  6507. );
  6508. assert_eq!(s.remote_last_win, s.rx_buffer.window() as u16);
  6509. // Provoke immediate ACK to test that `process` updates `remote_last_win`
  6510. send!(
  6511. s,
  6512. TcpRepr {
  6513. seq_number: REMOTE_SEQ + 1 + 6,
  6514. ack_number: Some(LOCAL_SEQ + 1),
  6515. payload: &b"def"[..],
  6516. ..SEND_TEMPL
  6517. },
  6518. Some(TcpRepr {
  6519. seq_number: LOCAL_SEQ + 1,
  6520. ack_number: Some(REMOTE_SEQ + 1 + 3),
  6521. window_len: 6,
  6522. ..RECV_TEMPL
  6523. })
  6524. );
  6525. send!(
  6526. s,
  6527. TcpRepr {
  6528. seq_number: REMOTE_SEQ + 1 + 3,
  6529. ack_number: Some(LOCAL_SEQ + 1),
  6530. payload: &b"abc"[..],
  6531. ..SEND_TEMPL
  6532. },
  6533. Some(TcpRepr {
  6534. seq_number: LOCAL_SEQ + 1,
  6535. ack_number: Some(REMOTE_SEQ + 1 + 9),
  6536. window_len: 0,
  6537. ..RECV_TEMPL
  6538. })
  6539. );
  6540. assert_eq!(s.remote_last_win, s.rx_buffer.window() as u16);
  6541. s.recv(|buffer| (buffer.len(), ())).unwrap();
  6542. assert!(s.window_to_update());
  6543. }
  6544. // =========================================================================================//
  6545. // Tests for zero-window probes.
  6546. // =========================================================================================//
  6547. #[test]
  6548. fn test_zero_window_probe_enter_on_win_update() {
  6549. let mut s = socket_established();
  6550. assert!(!s.timer.is_zero_window_probe());
  6551. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6552. assert!(!s.timer.is_zero_window_probe());
  6553. send!(
  6554. s,
  6555. TcpRepr {
  6556. seq_number: REMOTE_SEQ + 1,
  6557. ack_number: Some(LOCAL_SEQ + 1),
  6558. window_len: 0,
  6559. ..SEND_TEMPL
  6560. }
  6561. );
  6562. assert!(s.timer.is_zero_window_probe());
  6563. }
  6564. #[test]
  6565. fn test_zero_window_probe_enter_on_send() {
  6566. let mut s = socket_established();
  6567. send!(
  6568. s,
  6569. TcpRepr {
  6570. seq_number: REMOTE_SEQ + 1,
  6571. ack_number: Some(LOCAL_SEQ + 1),
  6572. window_len: 0,
  6573. ..SEND_TEMPL
  6574. }
  6575. );
  6576. assert!(!s.timer.is_zero_window_probe());
  6577. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6578. assert!(s.timer.is_zero_window_probe());
  6579. }
  6580. #[test]
  6581. fn test_zero_window_probe_exit() {
  6582. let mut s = socket_established();
  6583. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6584. assert!(!s.timer.is_zero_window_probe());
  6585. send!(
  6586. s,
  6587. TcpRepr {
  6588. seq_number: REMOTE_SEQ + 1,
  6589. ack_number: Some(LOCAL_SEQ + 1),
  6590. window_len: 0,
  6591. ..SEND_TEMPL
  6592. }
  6593. );
  6594. assert!(s.timer.is_zero_window_probe());
  6595. send!(
  6596. s,
  6597. TcpRepr {
  6598. seq_number: REMOTE_SEQ + 1,
  6599. ack_number: Some(LOCAL_SEQ + 1),
  6600. window_len: 6,
  6601. ..SEND_TEMPL
  6602. }
  6603. );
  6604. assert!(!s.timer.is_zero_window_probe());
  6605. }
  6606. #[test]
  6607. fn test_zero_window_probe_exit_ack() {
  6608. let mut s = socket_established();
  6609. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6610. send!(
  6611. s,
  6612. TcpRepr {
  6613. seq_number: REMOTE_SEQ + 1,
  6614. ack_number: Some(LOCAL_SEQ + 1),
  6615. window_len: 0,
  6616. ..SEND_TEMPL
  6617. }
  6618. );
  6619. recv!(
  6620. s,
  6621. time 1000,
  6622. [TcpRepr {
  6623. seq_number: LOCAL_SEQ + 1,
  6624. ack_number: Some(REMOTE_SEQ + 1),
  6625. payload: &b"a"[..],
  6626. ..RECV_TEMPL
  6627. }]
  6628. );
  6629. send!(
  6630. s,
  6631. time 1010,
  6632. TcpRepr {
  6633. seq_number: REMOTE_SEQ + 1,
  6634. ack_number: Some(LOCAL_SEQ + 2),
  6635. window_len: 6,
  6636. ..SEND_TEMPL
  6637. }
  6638. );
  6639. recv!(
  6640. s,
  6641. time 1010,
  6642. [TcpRepr {
  6643. seq_number: LOCAL_SEQ + 2,
  6644. ack_number: Some(REMOTE_SEQ + 1),
  6645. payload: &b"bcdef1"[..],
  6646. ..RECV_TEMPL
  6647. }]
  6648. );
  6649. }
  6650. #[test]
  6651. fn test_zero_window_probe_backoff_nack_reply() {
  6652. let mut s = socket_established();
  6653. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6654. send!(
  6655. s,
  6656. TcpRepr {
  6657. seq_number: REMOTE_SEQ + 1,
  6658. ack_number: Some(LOCAL_SEQ + 1),
  6659. window_len: 0,
  6660. ..SEND_TEMPL
  6661. }
  6662. );
  6663. recv_nothing!(s, time 999);
  6664. recv!(
  6665. s,
  6666. time 1000,
  6667. [TcpRepr {
  6668. seq_number: LOCAL_SEQ + 1,
  6669. ack_number: Some(REMOTE_SEQ + 1),
  6670. payload: &b"a"[..],
  6671. ..RECV_TEMPL
  6672. }]
  6673. );
  6674. send!(
  6675. s,
  6676. time 1100,
  6677. TcpRepr {
  6678. seq_number: REMOTE_SEQ + 1,
  6679. ack_number: Some(LOCAL_SEQ + 1),
  6680. window_len: 0,
  6681. ..SEND_TEMPL
  6682. }
  6683. );
  6684. recv_nothing!(s, time 2999);
  6685. recv!(
  6686. s,
  6687. time 3000,
  6688. [TcpRepr {
  6689. seq_number: LOCAL_SEQ + 1,
  6690. ack_number: Some(REMOTE_SEQ + 1),
  6691. payload: &b"a"[..],
  6692. ..RECV_TEMPL
  6693. }]
  6694. );
  6695. send!(
  6696. s,
  6697. time 3100,
  6698. TcpRepr {
  6699. seq_number: REMOTE_SEQ + 1,
  6700. ack_number: Some(LOCAL_SEQ + 1),
  6701. window_len: 0,
  6702. ..SEND_TEMPL
  6703. }
  6704. );
  6705. recv_nothing!(s, time 6999);
  6706. recv!(
  6707. s,
  6708. time 7000,
  6709. [TcpRepr {
  6710. seq_number: LOCAL_SEQ + 1,
  6711. ack_number: Some(REMOTE_SEQ + 1),
  6712. payload: &b"a"[..],
  6713. ..RECV_TEMPL
  6714. }]
  6715. );
  6716. }
  6717. #[test]
  6718. fn test_zero_window_probe_backoff_no_reply() {
  6719. let mut s = socket_established();
  6720. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6721. send!(
  6722. s,
  6723. TcpRepr {
  6724. seq_number: REMOTE_SEQ + 1,
  6725. ack_number: Some(LOCAL_SEQ + 1),
  6726. window_len: 0,
  6727. ..SEND_TEMPL
  6728. }
  6729. );
  6730. recv_nothing!(s, time 999);
  6731. recv!(
  6732. s,
  6733. time 1000,
  6734. [TcpRepr {
  6735. seq_number: LOCAL_SEQ + 1,
  6736. ack_number: Some(REMOTE_SEQ + 1),
  6737. payload: &b"a"[..],
  6738. ..RECV_TEMPL
  6739. }]
  6740. );
  6741. recv_nothing!(s, time 2999);
  6742. recv!(
  6743. s,
  6744. time 3000,
  6745. [TcpRepr {
  6746. seq_number: LOCAL_SEQ + 1,
  6747. ack_number: Some(REMOTE_SEQ + 1),
  6748. payload: &b"a"[..],
  6749. ..RECV_TEMPL
  6750. }]
  6751. );
  6752. }
  6753. #[test]
  6754. fn test_zero_window_probe_shift() {
  6755. let mut s = socket_established();
  6756. s.send_slice(b"abcdef123456!@#$%^").unwrap();
  6757. send!(
  6758. s,
  6759. TcpRepr {
  6760. seq_number: REMOTE_SEQ + 1,
  6761. ack_number: Some(LOCAL_SEQ + 1),
  6762. window_len: 0,
  6763. ..SEND_TEMPL
  6764. }
  6765. );
  6766. recv_nothing!(s, time 999);
  6767. recv!(
  6768. s,
  6769. time 1000,
  6770. [TcpRepr {
  6771. seq_number: LOCAL_SEQ + 1,
  6772. ack_number: Some(REMOTE_SEQ + 1),
  6773. payload: &b"a"[..],
  6774. ..RECV_TEMPL
  6775. }]
  6776. );
  6777. recv_nothing!(s, time 2999);
  6778. recv!(
  6779. s,
  6780. time 3000,
  6781. [TcpRepr {
  6782. seq_number: LOCAL_SEQ + 1,
  6783. ack_number: Some(REMOTE_SEQ + 1),
  6784. payload: &b"a"[..],
  6785. ..RECV_TEMPL
  6786. }]
  6787. );
  6788. // ack the ZWP byte, but still advertise zero window.
  6789. // this should restart the ZWP timer.
  6790. send!(
  6791. s,
  6792. time 3100,
  6793. TcpRepr {
  6794. seq_number: REMOTE_SEQ + 1,
  6795. ack_number: Some(LOCAL_SEQ + 2),
  6796. window_len: 0,
  6797. ..SEND_TEMPL
  6798. }
  6799. );
  6800. // ZWP should be sent at 3100+1000 = 4100
  6801. recv_nothing!(s, time 4099);
  6802. recv!(
  6803. s,
  6804. time 4100,
  6805. [TcpRepr {
  6806. seq_number: LOCAL_SEQ + 2,
  6807. ack_number: Some(REMOTE_SEQ + 1),
  6808. payload: &b"b"[..],
  6809. ..RECV_TEMPL
  6810. }]
  6811. );
  6812. }
  6813. // =========================================================================================//
  6814. // Tests for timeouts.
  6815. // =========================================================================================//
  6816. #[test]
  6817. fn test_listen_timeout() {
  6818. let mut s = socket_listen();
  6819. s.set_timeout(Some(Duration::from_millis(100)));
  6820. assert_eq!(s.socket.poll_at(&mut s.cx), PollAt::Ingress);
  6821. }
  6822. #[test]
  6823. fn test_connect_timeout() {
  6824. let mut s = socket();
  6825. s.local_seq_no = LOCAL_SEQ;
  6826. s.socket
  6827. .connect(&mut s.cx, REMOTE_END, LOCAL_END.port)
  6828. .unwrap();
  6829. s.set_timeout(Some(Duration::from_millis(100)));
  6830. recv!(s, time 150, Ok(TcpRepr {
  6831. control: TcpControl::Syn,
  6832. seq_number: LOCAL_SEQ,
  6833. ack_number: None,
  6834. max_seg_size: Some(BASE_MSS),
  6835. window_scale: Some(0),
  6836. sack_permitted: true,
  6837. ..RECV_TEMPL
  6838. }));
  6839. assert_eq!(s.state, State::SynSent);
  6840. assert_eq!(
  6841. s.socket.poll_at(&mut s.cx),
  6842. PollAt::Time(Instant::from_millis(250))
  6843. );
  6844. recv!(s, time 250, Ok(TcpRepr {
  6845. control: TcpControl::Rst,
  6846. seq_number: LOCAL_SEQ + 1,
  6847. ack_number: Some(TcpSeqNumber(0)),
  6848. window_scale: None,
  6849. ..RECV_TEMPL
  6850. }));
  6851. assert_eq!(s.state, State::Closed);
  6852. }
  6853. #[test]
  6854. fn test_established_timeout() {
  6855. let mut s = socket_established();
  6856. s.set_timeout(Some(Duration::from_millis(2000)));
  6857. recv_nothing!(s, time 250);
  6858. assert_eq!(
  6859. s.socket.poll_at(&mut s.cx),
  6860. PollAt::Time(Instant::from_millis(2250))
  6861. );
  6862. s.send_slice(b"abcdef").unwrap();
  6863. assert_eq!(s.socket.poll_at(&mut s.cx), PollAt::Now);
  6864. recv!(s, time 255, Ok(TcpRepr {
  6865. seq_number: LOCAL_SEQ + 1,
  6866. ack_number: Some(REMOTE_SEQ + 1),
  6867. payload: &b"abcdef"[..],
  6868. ..RECV_TEMPL
  6869. }));
  6870. assert_eq!(
  6871. s.socket.poll_at(&mut s.cx),
  6872. PollAt::Time(Instant::from_millis(1255))
  6873. );
  6874. recv!(s, time 1255, Ok(TcpRepr {
  6875. seq_number: LOCAL_SEQ + 1,
  6876. ack_number: Some(REMOTE_SEQ + 1),
  6877. payload: &b"abcdef"[..],
  6878. ..RECV_TEMPL
  6879. }));
  6880. assert_eq!(
  6881. s.socket.poll_at(&mut s.cx),
  6882. PollAt::Time(Instant::from_millis(2255))
  6883. );
  6884. recv!(s, time 2255, Ok(TcpRepr {
  6885. control: TcpControl::Rst,
  6886. seq_number: LOCAL_SEQ + 1 + 6,
  6887. ack_number: Some(REMOTE_SEQ + 1),
  6888. ..RECV_TEMPL
  6889. }));
  6890. assert_eq!(s.state, State::Closed);
  6891. }
  6892. #[test]
  6893. fn test_established_keep_alive_timeout() {
  6894. let mut s = socket_established();
  6895. s.set_keep_alive(Some(Duration::from_millis(50)));
  6896. s.set_timeout(Some(Duration::from_millis(100)));
  6897. recv!(s, time 100, Ok(TcpRepr {
  6898. seq_number: LOCAL_SEQ,
  6899. ack_number: Some(REMOTE_SEQ + 1),
  6900. payload: &[0],
  6901. ..RECV_TEMPL
  6902. }));
  6903. recv_nothing!(s, time 100);
  6904. assert_eq!(
  6905. s.socket.poll_at(&mut s.cx),
  6906. PollAt::Time(Instant::from_millis(150))
  6907. );
  6908. send!(s, time 105, TcpRepr {
  6909. seq_number: REMOTE_SEQ + 1,
  6910. ack_number: Some(LOCAL_SEQ + 1),
  6911. ..SEND_TEMPL
  6912. });
  6913. assert_eq!(
  6914. s.socket.poll_at(&mut s.cx),
  6915. PollAt::Time(Instant::from_millis(155))
  6916. );
  6917. recv!(s, time 155, Ok(TcpRepr {
  6918. seq_number: LOCAL_SEQ,
  6919. ack_number: Some(REMOTE_SEQ + 1),
  6920. payload: &[0],
  6921. ..RECV_TEMPL
  6922. }));
  6923. recv_nothing!(s, time 155);
  6924. assert_eq!(
  6925. s.socket.poll_at(&mut s.cx),
  6926. PollAt::Time(Instant::from_millis(205))
  6927. );
  6928. recv_nothing!(s, time 200);
  6929. recv!(s, time 205, Ok(TcpRepr {
  6930. control: TcpControl::Rst,
  6931. seq_number: LOCAL_SEQ + 1,
  6932. ack_number: Some(REMOTE_SEQ + 1),
  6933. ..RECV_TEMPL
  6934. }));
  6935. recv_nothing!(s, time 205);
  6936. assert_eq!(s.state, State::Closed);
  6937. }
  6938. #[test]
  6939. fn test_fin_wait_1_timeout() {
  6940. let mut s = socket_fin_wait_1();
  6941. s.set_timeout(Some(Duration::from_millis(1000)));
  6942. recv!(s, time 100, Ok(TcpRepr {
  6943. control: TcpControl::Fin,
  6944. seq_number: LOCAL_SEQ + 1,
  6945. ack_number: Some(REMOTE_SEQ + 1),
  6946. ..RECV_TEMPL
  6947. }));
  6948. recv!(s, time 1100, Ok(TcpRepr {
  6949. control: TcpControl::Rst,
  6950. seq_number: LOCAL_SEQ + 1 + 1,
  6951. ack_number: Some(REMOTE_SEQ + 1),
  6952. ..RECV_TEMPL
  6953. }));
  6954. assert_eq!(s.state, State::Closed);
  6955. }
  6956. #[test]
  6957. fn test_last_ack_timeout() {
  6958. let mut s = socket_last_ack();
  6959. s.set_timeout(Some(Duration::from_millis(1000)));
  6960. recv!(s, time 100, Ok(TcpRepr {
  6961. control: TcpControl::Fin,
  6962. seq_number: LOCAL_SEQ + 1,
  6963. ack_number: Some(REMOTE_SEQ + 1 + 1),
  6964. ..RECV_TEMPL
  6965. }));
  6966. recv!(s, time 1100, Ok(TcpRepr {
  6967. control: TcpControl::Rst,
  6968. seq_number: LOCAL_SEQ + 1 + 1,
  6969. ack_number: Some(REMOTE_SEQ + 1 + 1),
  6970. ..RECV_TEMPL
  6971. }));
  6972. assert_eq!(s.state, State::Closed);
  6973. }
  6974. #[test]
  6975. fn test_closed_timeout() {
  6976. let mut s = socket_established();
  6977. s.set_timeout(Some(Duration::from_millis(200)));
  6978. s.remote_last_ts = Some(Instant::from_millis(100));
  6979. s.abort();
  6980. assert_eq!(s.socket.poll_at(&mut s.cx), PollAt::Now);
  6981. recv!(s, time 100, Ok(TcpRepr {
  6982. control: TcpControl::Rst,
  6983. seq_number: LOCAL_SEQ + 1,
  6984. ack_number: Some(REMOTE_SEQ + 1),
  6985. ..RECV_TEMPL
  6986. }));
  6987. assert_eq!(s.socket.poll_at(&mut s.cx), PollAt::Ingress);
  6988. }
  6989. // =========================================================================================//
  6990. // Tests for keep-alive.
  6991. // =========================================================================================//
  6992. #[test]
  6993. fn test_responds_to_keep_alive() {
  6994. let mut s = socket_established();
  6995. send!(
  6996. s,
  6997. TcpRepr {
  6998. seq_number: REMOTE_SEQ,
  6999. ack_number: Some(LOCAL_SEQ + 1),
  7000. ..SEND_TEMPL
  7001. },
  7002. Some(TcpRepr {
  7003. seq_number: LOCAL_SEQ + 1,
  7004. ack_number: Some(REMOTE_SEQ + 1),
  7005. ..RECV_TEMPL
  7006. })
  7007. );
  7008. }
  7009. #[test]
  7010. fn test_sends_keep_alive() {
  7011. let mut s = socket_established();
  7012. s.set_keep_alive(Some(Duration::from_millis(100)));
  7013. // drain the forced keep-alive packet
  7014. assert_eq!(s.socket.poll_at(&mut s.cx), PollAt::Now);
  7015. recv!(s, time 0, Ok(TcpRepr {
  7016. seq_number: LOCAL_SEQ,
  7017. ack_number: Some(REMOTE_SEQ + 1),
  7018. payload: &[0],
  7019. ..RECV_TEMPL
  7020. }));
  7021. assert_eq!(
  7022. s.socket.poll_at(&mut s.cx),
  7023. PollAt::Time(Instant::from_millis(100))
  7024. );
  7025. recv_nothing!(s, time 95);
  7026. recv!(s, time 100, Ok(TcpRepr {
  7027. seq_number: LOCAL_SEQ,
  7028. ack_number: Some(REMOTE_SEQ + 1),
  7029. payload: &[0],
  7030. ..RECV_TEMPL
  7031. }));
  7032. assert_eq!(
  7033. s.socket.poll_at(&mut s.cx),
  7034. PollAt::Time(Instant::from_millis(200))
  7035. );
  7036. recv_nothing!(s, time 195);
  7037. recv!(s, time 200, Ok(TcpRepr {
  7038. seq_number: LOCAL_SEQ,
  7039. ack_number: Some(REMOTE_SEQ + 1),
  7040. payload: &[0],
  7041. ..RECV_TEMPL
  7042. }));
  7043. send!(s, time 250, TcpRepr {
  7044. seq_number: REMOTE_SEQ + 1,
  7045. ack_number: Some(LOCAL_SEQ + 1),
  7046. ..SEND_TEMPL
  7047. });
  7048. assert_eq!(
  7049. s.socket.poll_at(&mut s.cx),
  7050. PollAt::Time(Instant::from_millis(350))
  7051. );
  7052. recv_nothing!(s, time 345);
  7053. recv!(s, time 350, Ok(TcpRepr {
  7054. seq_number: LOCAL_SEQ,
  7055. ack_number: Some(REMOTE_SEQ + 1),
  7056. payload: &b"\x00"[..],
  7057. ..RECV_TEMPL
  7058. }));
  7059. }
  7060. // =========================================================================================//
  7061. // Tests for time-to-live configuration.
  7062. // =========================================================================================//
  7063. #[test]
  7064. fn test_set_hop_limit() {
  7065. let mut s = socket_syn_received();
  7066. s.set_hop_limit(Some(0x2a));
  7067. assert_eq!(
  7068. s.socket.dispatch(&mut s.cx, |_, (ip_repr, _)| {
  7069. assert_eq!(ip_repr.hop_limit(), 0x2a);
  7070. Ok::<_, ()>(())
  7071. }),
  7072. Ok(())
  7073. );
  7074. // assert that user-configurable settings are kept,
  7075. // see https://github.com/smoltcp-rs/smoltcp/issues/601.
  7076. s.reset();
  7077. assert_eq!(s.hop_limit(), Some(0x2a));
  7078. }
  7079. #[test]
  7080. #[should_panic(expected = "the time-to-live value of a packet must not be zero")]
  7081. fn test_set_hop_limit_zero() {
  7082. let mut s = socket_syn_received();
  7083. s.set_hop_limit(Some(0));
  7084. }
  7085. // =========================================================================================//
  7086. // Tests for reassembly.
  7087. // =========================================================================================//
  7088. #[test]
  7089. fn test_out_of_order() {
  7090. let mut s = socket_established();
  7091. send!(
  7092. s,
  7093. TcpRepr {
  7094. seq_number: REMOTE_SEQ + 1 + 3,
  7095. ack_number: Some(LOCAL_SEQ + 1),
  7096. payload: &b"def"[..],
  7097. ..SEND_TEMPL
  7098. },
  7099. Some(TcpRepr {
  7100. seq_number: LOCAL_SEQ + 1,
  7101. ack_number: Some(REMOTE_SEQ + 1),
  7102. ..RECV_TEMPL
  7103. })
  7104. );
  7105. s.recv(|buffer| {
  7106. assert_eq!(buffer, b"");
  7107. (buffer.len(), ())
  7108. })
  7109. .unwrap();
  7110. send!(
  7111. s,
  7112. TcpRepr {
  7113. seq_number: REMOTE_SEQ + 1,
  7114. ack_number: Some(LOCAL_SEQ + 1),
  7115. payload: &b"abcdef"[..],
  7116. ..SEND_TEMPL
  7117. },
  7118. Some(TcpRepr {
  7119. seq_number: LOCAL_SEQ + 1,
  7120. ack_number: Some(REMOTE_SEQ + 1 + 6),
  7121. window_len: 58,
  7122. ..RECV_TEMPL
  7123. })
  7124. );
  7125. s.recv(|buffer| {
  7126. assert_eq!(buffer, b"abcdef");
  7127. (buffer.len(), ())
  7128. })
  7129. .unwrap();
  7130. }
  7131. #[test]
  7132. fn test_buffer_wraparound_rx() {
  7133. let mut s = socket_established();
  7134. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  7135. s.assembler = Assembler::new();
  7136. send!(
  7137. s,
  7138. TcpRepr {
  7139. seq_number: REMOTE_SEQ + 1,
  7140. ack_number: Some(LOCAL_SEQ + 1),
  7141. payload: &b"abc"[..],
  7142. ..SEND_TEMPL
  7143. }
  7144. );
  7145. s.recv(|buffer| {
  7146. assert_eq!(buffer, b"abc");
  7147. (buffer.len(), ())
  7148. })
  7149. .unwrap();
  7150. send!(
  7151. s,
  7152. TcpRepr {
  7153. seq_number: REMOTE_SEQ + 1 + 3,
  7154. ack_number: Some(LOCAL_SEQ + 1),
  7155. payload: &b"defghi"[..],
  7156. ..SEND_TEMPL
  7157. }
  7158. );
  7159. let mut data = [0; 6];
  7160. assert_eq!(s.recv_slice(&mut data[..]), Ok(6));
  7161. assert_eq!(data, &b"defghi"[..]);
  7162. }
  7163. #[test]
  7164. fn test_buffer_wraparound_tx() {
  7165. let mut s = socket_established();
  7166. s.set_nagle_enabled(false);
  7167. s.tx_buffer = SocketBuffer::new(vec![b'.'; 9]);
  7168. assert_eq!(s.send_slice(b"xxxyyy"), Ok(6));
  7169. assert_eq!(s.tx_buffer.dequeue_many(3), &b"xxx"[..]);
  7170. assert_eq!(s.tx_buffer.len(), 3);
  7171. // "abcdef" not contiguous in tx buffer
  7172. assert_eq!(s.send_slice(b"abcdef"), Ok(6));
  7173. recv!(
  7174. s,
  7175. Ok(TcpRepr {
  7176. seq_number: LOCAL_SEQ + 1,
  7177. ack_number: Some(REMOTE_SEQ + 1),
  7178. payload: &b"yyyabc"[..],
  7179. ..RECV_TEMPL
  7180. })
  7181. );
  7182. recv!(
  7183. s,
  7184. Ok(TcpRepr {
  7185. seq_number: LOCAL_SEQ + 1 + 6,
  7186. ack_number: Some(REMOTE_SEQ + 1),
  7187. payload: &b"def"[..],
  7188. ..RECV_TEMPL
  7189. })
  7190. );
  7191. }
  7192. // =========================================================================================//
  7193. // Tests for graceful vs ungraceful rx close
  7194. // =========================================================================================//
  7195. #[test]
  7196. fn test_rx_close_fin() {
  7197. let mut s = socket_established();
  7198. send!(
  7199. s,
  7200. TcpRepr {
  7201. control: TcpControl::Fin,
  7202. seq_number: REMOTE_SEQ + 1,
  7203. ack_number: Some(LOCAL_SEQ + 1),
  7204. payload: &b"abc"[..],
  7205. ..SEND_TEMPL
  7206. }
  7207. );
  7208. s.recv(|data| {
  7209. assert_eq!(data, b"abc");
  7210. (3, ())
  7211. })
  7212. .unwrap();
  7213. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::Finished));
  7214. }
  7215. #[test]
  7216. fn test_rx_close_fin_in_fin_wait_1() {
  7217. let mut s = socket_fin_wait_1();
  7218. send!(
  7219. s,
  7220. TcpRepr {
  7221. control: TcpControl::Fin,
  7222. seq_number: REMOTE_SEQ + 1,
  7223. ack_number: Some(LOCAL_SEQ + 1),
  7224. payload: &b"abc"[..],
  7225. ..SEND_TEMPL
  7226. }
  7227. );
  7228. assert_eq!(s.state, State::Closing);
  7229. s.recv(|data| {
  7230. assert_eq!(data, b"abc");
  7231. (3, ())
  7232. })
  7233. .unwrap();
  7234. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::Finished));
  7235. }
  7236. #[test]
  7237. fn test_rx_close_fin_in_fin_wait_2() {
  7238. let mut s = socket_fin_wait_2();
  7239. send!(
  7240. s,
  7241. TcpRepr {
  7242. control: TcpControl::Fin,
  7243. seq_number: REMOTE_SEQ + 1,
  7244. ack_number: Some(LOCAL_SEQ + 1 + 1),
  7245. payload: &b"abc"[..],
  7246. ..SEND_TEMPL
  7247. }
  7248. );
  7249. assert_eq!(s.state, State::TimeWait);
  7250. s.recv(|data| {
  7251. assert_eq!(data, b"abc");
  7252. (3, ())
  7253. })
  7254. .unwrap();
  7255. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::Finished));
  7256. }
  7257. #[test]
  7258. fn test_rx_close_fin_with_hole() {
  7259. let mut s = socket_established();
  7260. send!(
  7261. s,
  7262. TcpRepr {
  7263. seq_number: REMOTE_SEQ + 1,
  7264. ack_number: Some(LOCAL_SEQ + 1),
  7265. payload: &b"abc"[..],
  7266. ..SEND_TEMPL
  7267. }
  7268. );
  7269. send!(
  7270. s,
  7271. TcpRepr {
  7272. control: TcpControl::Fin,
  7273. seq_number: REMOTE_SEQ + 1 + 6,
  7274. ack_number: Some(LOCAL_SEQ + 1),
  7275. payload: &b"ghi"[..],
  7276. ..SEND_TEMPL
  7277. },
  7278. Some(TcpRepr {
  7279. seq_number: LOCAL_SEQ + 1,
  7280. ack_number: Some(REMOTE_SEQ + 1 + 3),
  7281. window_len: 61,
  7282. ..RECV_TEMPL
  7283. })
  7284. );
  7285. s.recv(|data| {
  7286. assert_eq!(data, b"abc");
  7287. (3, ())
  7288. })
  7289. .unwrap();
  7290. s.recv(|data| {
  7291. assert_eq!(data, b"");
  7292. (0, ())
  7293. })
  7294. .unwrap();
  7295. send!(
  7296. s,
  7297. TcpRepr {
  7298. control: TcpControl::Rst,
  7299. seq_number: REMOTE_SEQ + 1 + 9,
  7300. ack_number: Some(LOCAL_SEQ + 1),
  7301. ..SEND_TEMPL
  7302. }
  7303. );
  7304. // Error must be `Illegal` even if we've received a FIN,
  7305. // because we are missing data.
  7306. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::InvalidState));
  7307. }
  7308. #[test]
  7309. fn test_rx_close_rst() {
  7310. let mut s = socket_established();
  7311. send!(
  7312. s,
  7313. TcpRepr {
  7314. seq_number: REMOTE_SEQ + 1,
  7315. ack_number: Some(LOCAL_SEQ + 1),
  7316. payload: &b"abc"[..],
  7317. ..SEND_TEMPL
  7318. }
  7319. );
  7320. send!(
  7321. s,
  7322. TcpRepr {
  7323. control: TcpControl::Rst,
  7324. seq_number: REMOTE_SEQ + 1 + 3,
  7325. ack_number: Some(LOCAL_SEQ + 1),
  7326. ..SEND_TEMPL
  7327. }
  7328. );
  7329. s.recv(|data| {
  7330. assert_eq!(data, b"abc");
  7331. (3, ())
  7332. })
  7333. .unwrap();
  7334. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::InvalidState));
  7335. }
  7336. #[test]
  7337. fn test_rx_close_rst_with_hole() {
  7338. let mut s = socket_established();
  7339. send!(
  7340. s,
  7341. TcpRepr {
  7342. seq_number: REMOTE_SEQ + 1,
  7343. ack_number: Some(LOCAL_SEQ + 1),
  7344. payload: &b"abc"[..],
  7345. ..SEND_TEMPL
  7346. }
  7347. );
  7348. send!(
  7349. s,
  7350. TcpRepr {
  7351. seq_number: REMOTE_SEQ + 1 + 6,
  7352. ack_number: Some(LOCAL_SEQ + 1),
  7353. payload: &b"ghi"[..],
  7354. ..SEND_TEMPL
  7355. },
  7356. Some(TcpRepr {
  7357. seq_number: LOCAL_SEQ + 1,
  7358. ack_number: Some(REMOTE_SEQ + 1 + 3),
  7359. window_len: 61,
  7360. ..RECV_TEMPL
  7361. })
  7362. );
  7363. send!(
  7364. s,
  7365. TcpRepr {
  7366. control: TcpControl::Rst,
  7367. seq_number: REMOTE_SEQ + 1 + 9,
  7368. ack_number: Some(LOCAL_SEQ + 1),
  7369. ..SEND_TEMPL
  7370. }
  7371. );
  7372. s.recv(|data| {
  7373. assert_eq!(data, b"abc");
  7374. (3, ())
  7375. })
  7376. .unwrap();
  7377. assert_eq!(s.recv(|_| (0, ())), Err(RecvError::InvalidState));
  7378. }
  7379. // =========================================================================================//
  7380. // Tests for delayed ACK
  7381. // =========================================================================================//
  7382. #[test]
  7383. fn test_delayed_ack() {
  7384. let mut s = socket_established();
  7385. s.set_ack_delay(Some(ACK_DELAY_DEFAULT));
  7386. send!(
  7387. s,
  7388. TcpRepr {
  7389. seq_number: REMOTE_SEQ + 1,
  7390. ack_number: Some(LOCAL_SEQ + 1),
  7391. payload: &b"abc"[..],
  7392. ..SEND_TEMPL
  7393. }
  7394. );
  7395. // No ACK is immediately sent.
  7396. recv_nothing!(s);
  7397. // After 10ms, it is sent.
  7398. recv!(s, time 11, Ok(TcpRepr {
  7399. seq_number: LOCAL_SEQ + 1,
  7400. ack_number: Some(REMOTE_SEQ + 1 + 3),
  7401. window_len: 61,
  7402. ..RECV_TEMPL
  7403. }));
  7404. }
  7405. #[test]
  7406. fn test_delayed_ack_win() {
  7407. let mut s = socket_established();
  7408. s.set_ack_delay(Some(ACK_DELAY_DEFAULT));
  7409. send!(
  7410. s,
  7411. TcpRepr {
  7412. seq_number: REMOTE_SEQ + 1,
  7413. ack_number: Some(LOCAL_SEQ + 1),
  7414. payload: &b"abc"[..],
  7415. ..SEND_TEMPL
  7416. }
  7417. );
  7418. // Reading the data off the buffer should cause a window update.
  7419. s.recv(|data| {
  7420. assert_eq!(data, b"abc");
  7421. (3, ())
  7422. })
  7423. .unwrap();
  7424. // However, no ACK or window update is immediately sent.
  7425. recv_nothing!(s);
  7426. // After 10ms, it is sent.
  7427. recv!(s, time 11, Ok(TcpRepr {
  7428. seq_number: LOCAL_SEQ + 1,
  7429. ack_number: Some(REMOTE_SEQ + 1 + 3),
  7430. ..RECV_TEMPL
  7431. }));
  7432. }
  7433. #[test]
  7434. fn test_delayed_ack_reply() {
  7435. let mut s = socket_established();
  7436. s.set_ack_delay(Some(ACK_DELAY_DEFAULT));
  7437. send!(
  7438. s,
  7439. TcpRepr {
  7440. seq_number: REMOTE_SEQ + 1,
  7441. ack_number: Some(LOCAL_SEQ + 1),
  7442. payload: &b"abc"[..],
  7443. ..SEND_TEMPL
  7444. }
  7445. );
  7446. s.recv(|data| {
  7447. assert_eq!(data, b"abc");
  7448. (3, ())
  7449. })
  7450. .unwrap();
  7451. s.send_slice(&b"xyz"[..]).unwrap();
  7452. // Writing data to the socket causes ACK to not be delayed,
  7453. // because it is immediately sent with the data.
  7454. recv!(
  7455. s,
  7456. Ok(TcpRepr {
  7457. seq_number: LOCAL_SEQ + 1,
  7458. ack_number: Some(REMOTE_SEQ + 1 + 3),
  7459. payload: &b"xyz"[..],
  7460. ..RECV_TEMPL
  7461. })
  7462. );
  7463. }
  7464. #[test]
  7465. fn test_delayed_ack_every_rmss() {
  7466. let mut s = socket_established_with_buffer_sizes(DEFAULT_MSS * 2, DEFAULT_MSS * 2);
  7467. s.set_ack_delay(Some(ACK_DELAY_DEFAULT));
  7468. send!(
  7469. s,
  7470. TcpRepr {
  7471. seq_number: REMOTE_SEQ + 1,
  7472. ack_number: Some(LOCAL_SEQ + 1),
  7473. payload: &[0; DEFAULT_MSS - 1],
  7474. ..SEND_TEMPL
  7475. }
  7476. );
  7477. // No ACK is immediately sent.
  7478. recv_nothing!(s);
  7479. send!(
  7480. s,
  7481. TcpRepr {
  7482. seq_number: REMOTE_SEQ + 1 + (DEFAULT_MSS - 1),
  7483. ack_number: Some(LOCAL_SEQ + 1),
  7484. payload: &b"a"[..],
  7485. ..SEND_TEMPL
  7486. }
  7487. );
  7488. // No ACK is immediately sent.
  7489. recv_nothing!(s);
  7490. send!(
  7491. s,
  7492. TcpRepr {
  7493. seq_number: REMOTE_SEQ + 1 + DEFAULT_MSS,
  7494. ack_number: Some(LOCAL_SEQ + 1),
  7495. payload: &b"a"[..],
  7496. ..SEND_TEMPL
  7497. }
  7498. );
  7499. // RMSS+1 bytes of data has been received, so ACK is sent without delay.
  7500. recv!(
  7501. s,
  7502. Ok(TcpRepr {
  7503. seq_number: LOCAL_SEQ + 1,
  7504. ack_number: Some(REMOTE_SEQ + 1 + (DEFAULT_MSS + 1)),
  7505. window_len: (DEFAULT_MSS - 1) as u16,
  7506. ..RECV_TEMPL
  7507. })
  7508. );
  7509. }
  7510. #[test]
  7511. fn test_delayed_ack_every_rmss_or_more() {
  7512. let mut s = socket_established_with_buffer_sizes(DEFAULT_MSS * 2, DEFAULT_MSS * 2);
  7513. s.set_ack_delay(Some(ACK_DELAY_DEFAULT));
  7514. send!(
  7515. s,
  7516. TcpRepr {
  7517. seq_number: REMOTE_SEQ + 1,
  7518. ack_number: Some(LOCAL_SEQ + 1),
  7519. payload: &[0; DEFAULT_MSS],
  7520. ..SEND_TEMPL
  7521. }
  7522. );
  7523. // No ACK is immediately sent.
  7524. recv_nothing!(s);
  7525. send!(
  7526. s,
  7527. TcpRepr {
  7528. seq_number: REMOTE_SEQ + 1 + DEFAULT_MSS,
  7529. ack_number: Some(LOCAL_SEQ + 1),
  7530. payload: &b"a"[..],
  7531. ..SEND_TEMPL
  7532. }
  7533. );
  7534. send!(
  7535. s,
  7536. TcpRepr {
  7537. seq_number: REMOTE_SEQ + 1 + (DEFAULT_MSS + 1),
  7538. ack_number: Some(LOCAL_SEQ + 1),
  7539. payload: &b"b"[..],
  7540. ..SEND_TEMPL
  7541. }
  7542. );
  7543. // RMSS+2 bytes of data has been received, so ACK is sent without delay.
  7544. recv!(
  7545. s,
  7546. Ok(TcpRepr {
  7547. seq_number: LOCAL_SEQ + 1,
  7548. ack_number: Some(REMOTE_SEQ + 1 + (DEFAULT_MSS + 2)),
  7549. window_len: (DEFAULT_MSS - 2) as u16,
  7550. ..RECV_TEMPL
  7551. })
  7552. );
  7553. }
  7554. // =========================================================================================//
  7555. // Tests for Nagle's Algorithm
  7556. // =========================================================================================//
  7557. #[test]
  7558. fn test_nagle() {
  7559. let mut s = socket_established();
  7560. s.remote_mss = 6;
  7561. s.send_slice(b"abcdef").unwrap();
  7562. recv!(
  7563. s,
  7564. [TcpRepr {
  7565. seq_number: LOCAL_SEQ + 1,
  7566. ack_number: Some(REMOTE_SEQ + 1),
  7567. payload: &b"abcdef"[..],
  7568. ..RECV_TEMPL
  7569. }]
  7570. );
  7571. // If there's data in flight, full segments get sent.
  7572. s.send_slice(b"foobar").unwrap();
  7573. recv!(
  7574. s,
  7575. [TcpRepr {
  7576. seq_number: LOCAL_SEQ + 1 + 6,
  7577. ack_number: Some(REMOTE_SEQ + 1),
  7578. payload: &b"foobar"[..],
  7579. ..RECV_TEMPL
  7580. }]
  7581. );
  7582. s.send_slice(b"aaabbbccc").unwrap();
  7583. // If there's data in flight, not-full segments don't get sent.
  7584. recv!(
  7585. s,
  7586. [TcpRepr {
  7587. seq_number: LOCAL_SEQ + 1 + 6 + 6,
  7588. ack_number: Some(REMOTE_SEQ + 1),
  7589. payload: &b"aaabbb"[..],
  7590. ..RECV_TEMPL
  7591. }]
  7592. );
  7593. // Data gets ACKd, so there's no longer data in flight
  7594. send!(
  7595. s,
  7596. TcpRepr {
  7597. seq_number: REMOTE_SEQ + 1,
  7598. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6 + 6),
  7599. ..SEND_TEMPL
  7600. }
  7601. );
  7602. // Now non-full segment gets sent.
  7603. recv!(
  7604. s,
  7605. [TcpRepr {
  7606. seq_number: LOCAL_SEQ + 1 + 6 + 6 + 6,
  7607. ack_number: Some(REMOTE_SEQ + 1),
  7608. payload: &b"ccc"[..],
  7609. ..RECV_TEMPL
  7610. }]
  7611. );
  7612. }
  7613. #[test]
  7614. fn test_final_packet_in_stream_doesnt_wait_for_nagle() {
  7615. let mut s = socket_established();
  7616. s.remote_mss = 6;
  7617. s.send_slice(b"abcdef0").unwrap();
  7618. s.socket.close();
  7619. recv!(s, time 0, Ok(TcpRepr {
  7620. control: TcpControl::None,
  7621. seq_number: LOCAL_SEQ + 1,
  7622. ack_number: Some(REMOTE_SEQ + 1),
  7623. payload: &b"abcdef"[..],
  7624. ..RECV_TEMPL
  7625. }), exact);
  7626. recv!(s, time 0, Ok(TcpRepr {
  7627. control: TcpControl::Fin,
  7628. seq_number: LOCAL_SEQ + 1 + 6,
  7629. ack_number: Some(REMOTE_SEQ + 1),
  7630. payload: &b"0"[..],
  7631. ..RECV_TEMPL
  7632. }), exact);
  7633. }
  7634. // =========================================================================================//
  7635. // Tests for packet filtering.
  7636. // =========================================================================================//
  7637. #[test]
  7638. fn test_doesnt_accept_wrong_port() {
  7639. let mut s = socket_established();
  7640. s.rx_buffer = SocketBuffer::new(vec![0; 6]);
  7641. s.assembler = Assembler::new();
  7642. let tcp_repr = TcpRepr {
  7643. seq_number: REMOTE_SEQ + 1,
  7644. ack_number: Some(LOCAL_SEQ + 1),
  7645. dst_port: LOCAL_PORT + 1,
  7646. ..SEND_TEMPL
  7647. };
  7648. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  7649. let tcp_repr = TcpRepr {
  7650. seq_number: REMOTE_SEQ + 1,
  7651. ack_number: Some(LOCAL_SEQ + 1),
  7652. src_port: REMOTE_PORT + 1,
  7653. ..SEND_TEMPL
  7654. };
  7655. assert!(!s.socket.accepts(&mut s.cx, &SEND_IP_TEMPL, &tcp_repr));
  7656. }
  7657. #[test]
  7658. fn test_doesnt_accept_wrong_ip() {
  7659. let mut s = socket_established();
  7660. let tcp_repr = TcpRepr {
  7661. seq_number: REMOTE_SEQ + 1,
  7662. ack_number: Some(LOCAL_SEQ + 1),
  7663. payload: &b"abcdef"[..],
  7664. ..SEND_TEMPL
  7665. };
  7666. let ip_repr = IpReprIpvX(IpvXRepr {
  7667. src_addr: REMOTE_ADDR,
  7668. dst_addr: LOCAL_ADDR,
  7669. next_header: IpProtocol::Tcp,
  7670. payload_len: tcp_repr.buffer_len(),
  7671. hop_limit: 64,
  7672. });
  7673. assert!(s.socket.accepts(&mut s.cx, &ip_repr, &tcp_repr));
  7674. let ip_repr_wrong_src = IpReprIpvX(IpvXRepr {
  7675. src_addr: OTHER_ADDR,
  7676. dst_addr: LOCAL_ADDR,
  7677. next_header: IpProtocol::Tcp,
  7678. payload_len: tcp_repr.buffer_len(),
  7679. hop_limit: 64,
  7680. });
  7681. assert!(!s.socket.accepts(&mut s.cx, &ip_repr_wrong_src, &tcp_repr));
  7682. let ip_repr_wrong_dst = IpReprIpvX(IpvXRepr {
  7683. src_addr: REMOTE_ADDR,
  7684. dst_addr: OTHER_ADDR,
  7685. next_header: IpProtocol::Tcp,
  7686. payload_len: tcp_repr.buffer_len(),
  7687. hop_limit: 64,
  7688. });
  7689. assert!(!s.socket.accepts(&mut s.cx, &ip_repr_wrong_dst, &tcp_repr));
  7690. }
  7691. // =========================================================================================//
  7692. // Timer tests
  7693. // =========================================================================================//
  7694. #[test]
  7695. fn test_timer_retransmit() {
  7696. const RTO: Duration = Duration::from_millis(100);
  7697. let mut r = Timer::new();
  7698. assert!(!r.should_retransmit(Instant::from_secs(1)));
  7699. r.set_for_retransmit(Instant::from_millis(1000), RTO);
  7700. assert!(!r.should_retransmit(Instant::from_millis(1000)));
  7701. assert!(!r.should_retransmit(Instant::from_millis(1050)));
  7702. assert!(r.should_retransmit(Instant::from_millis(1101)));
  7703. r.set_for_retransmit(Instant::from_millis(1101), RTO);
  7704. assert!(!r.should_retransmit(Instant::from_millis(1101)));
  7705. assert!(!r.should_retransmit(Instant::from_millis(1150)));
  7706. assert!(!r.should_retransmit(Instant::from_millis(1200)));
  7707. assert!(r.should_retransmit(Instant::from_millis(1301)));
  7708. r.set_for_idle(Instant::from_millis(1301), None);
  7709. assert!(!r.should_retransmit(Instant::from_millis(1350)));
  7710. }
  7711. #[test]
  7712. fn test_rtt_estimator() {
  7713. let mut r = RttEstimator::default();
  7714. let rtos = &[
  7715. 6000, 5000, 4252, 3692, 3272, 2956, 2720, 2540, 2408, 2308, 2232, 2176, 2132, 2100,
  7716. 2076, 2060, 2048, 2036, 2028, 2024, 2020, 2016, 2012, 2012,
  7717. ];
  7718. for &rto in rtos {
  7719. r.sample(2000);
  7720. assert_eq!(r.retransmission_timeout(), Duration::from_millis(rto));
  7721. }
  7722. }
  7723. #[test]
  7724. fn test_set_get_congestion_control() {
  7725. let mut s = socket_established();
  7726. #[cfg(feature = "socket-tcp-reno")]
  7727. {
  7728. s.set_congestion_control(CongestionControl::Reno);
  7729. assert_eq!(s.congestion_control(), CongestionControl::Reno);
  7730. }
  7731. #[cfg(feature = "socket-tcp-cubic")]
  7732. {
  7733. s.set_congestion_control(CongestionControl::Cubic);
  7734. assert_eq!(s.congestion_control(), CongestionControl::Cubic);
  7735. }
  7736. s.set_congestion_control(CongestionControl::None);
  7737. assert_eq!(s.congestion_control(), CongestionControl::None);
  7738. }
  7739. // =========================================================================================//
  7740. // Timestamp tests
  7741. // =========================================================================================//
  7742. #[test]
  7743. fn test_tsval_established_connection() {
  7744. let mut s = socket_established();
  7745. s.set_tsval_generator(Some(|| 1));
  7746. assert!(s.timestamp_enabled());
  7747. // First roundtrip after establishing.
  7748. s.send_slice(b"abcdef").unwrap();
  7749. recv!(
  7750. s,
  7751. [TcpRepr {
  7752. seq_number: LOCAL_SEQ + 1,
  7753. ack_number: Some(REMOTE_SEQ + 1),
  7754. payload: &b"abcdef"[..],
  7755. timestamp: Some(TcpTimestampRepr::new(1, 0)),
  7756. ..RECV_TEMPL
  7757. }]
  7758. );
  7759. assert_eq!(s.tx_buffer.len(), 6);
  7760. send!(
  7761. s,
  7762. TcpRepr {
  7763. seq_number: REMOTE_SEQ + 1,
  7764. ack_number: Some(LOCAL_SEQ + 1 + 6),
  7765. timestamp: Some(TcpTimestampRepr::new(500, 1)),
  7766. ..SEND_TEMPL
  7767. }
  7768. );
  7769. assert_eq!(s.tx_buffer.len(), 0);
  7770. // Second roundtrip.
  7771. s.send_slice(b"foobar").unwrap();
  7772. recv!(
  7773. s,
  7774. [TcpRepr {
  7775. seq_number: LOCAL_SEQ + 1 + 6,
  7776. ack_number: Some(REMOTE_SEQ + 1),
  7777. payload: &b"foobar"[..],
  7778. timestamp: Some(TcpTimestampRepr::new(1, 500)),
  7779. ..RECV_TEMPL
  7780. }]
  7781. );
  7782. send!(
  7783. s,
  7784. TcpRepr {
  7785. seq_number: REMOTE_SEQ + 1,
  7786. ack_number: Some(LOCAL_SEQ + 1 + 6 + 6),
  7787. ..SEND_TEMPL
  7788. }
  7789. );
  7790. assert_eq!(s.tx_buffer.len(), 0);
  7791. }
  7792. #[test]
  7793. fn test_tsval_disabled_in_remote_client() {
  7794. let mut s = socket_listen();
  7795. s.set_tsval_generator(Some(|| 1));
  7796. assert!(s.timestamp_enabled());
  7797. send!(
  7798. s,
  7799. TcpRepr {
  7800. control: TcpControl::Syn,
  7801. seq_number: REMOTE_SEQ,
  7802. ack_number: None,
  7803. ..SEND_TEMPL
  7804. }
  7805. );
  7806. assert_eq!(s.state(), State::SynReceived);
  7807. assert_eq!(s.tuple, Some(TUPLE));
  7808. assert!(!s.timestamp_enabled());
  7809. recv!(
  7810. s,
  7811. [TcpRepr {
  7812. control: TcpControl::Syn,
  7813. seq_number: LOCAL_SEQ,
  7814. ack_number: Some(REMOTE_SEQ + 1),
  7815. max_seg_size: Some(BASE_MSS),
  7816. ..RECV_TEMPL
  7817. }]
  7818. );
  7819. send!(
  7820. s,
  7821. TcpRepr {
  7822. seq_number: REMOTE_SEQ + 1,
  7823. ack_number: Some(LOCAL_SEQ + 1),
  7824. ..SEND_TEMPL
  7825. }
  7826. );
  7827. assert_eq!(s.state(), State::Established);
  7828. assert_eq!(s.local_seq_no, LOCAL_SEQ + 1);
  7829. assert_eq!(s.remote_seq_no, REMOTE_SEQ + 1);
  7830. }
  7831. #[test]
  7832. fn test_tsval_disabled_in_local_server() {
  7833. let mut s = socket_listen();
  7834. // s.set_timestamp(false); // commented to alert if the default state changes
  7835. assert!(!s.timestamp_enabled());
  7836. send!(
  7837. s,
  7838. TcpRepr {
  7839. control: TcpControl::Syn,
  7840. seq_number: REMOTE_SEQ,
  7841. ack_number: None,
  7842. timestamp: Some(TcpTimestampRepr::new(500, 0)),
  7843. ..SEND_TEMPL
  7844. }
  7845. );
  7846. assert_eq!(s.state(), State::SynReceived);
  7847. assert_eq!(s.tuple, Some(TUPLE));
  7848. assert!(!s.timestamp_enabled());
  7849. recv!(
  7850. s,
  7851. [TcpRepr {
  7852. control: TcpControl::Syn,
  7853. seq_number: LOCAL_SEQ,
  7854. ack_number: Some(REMOTE_SEQ + 1),
  7855. max_seg_size: Some(BASE_MSS),
  7856. ..RECV_TEMPL
  7857. }]
  7858. );
  7859. send!(
  7860. s,
  7861. TcpRepr {
  7862. seq_number: REMOTE_SEQ + 1,
  7863. ack_number: Some(LOCAL_SEQ + 1),
  7864. ..SEND_TEMPL
  7865. }
  7866. );
  7867. assert_eq!(s.state(), State::Established);
  7868. assert_eq!(s.local_seq_no, LOCAL_SEQ + 1);
  7869. assert_eq!(s.remote_seq_no, REMOTE_SEQ + 1);
  7870. }
  7871. #[test]
  7872. fn test_tsval_disabled_in_remote_server() {
  7873. let mut s = socket();
  7874. s.set_tsval_generator(Some(|| 1));
  7875. assert!(s.timestamp_enabled());
  7876. s.local_seq_no = LOCAL_SEQ;
  7877. s.socket
  7878. .connect(&mut s.cx, REMOTE_END, LOCAL_END.port)
  7879. .unwrap();
  7880. assert_eq!(s.tuple, Some(TUPLE));
  7881. recv!(
  7882. s,
  7883. [TcpRepr {
  7884. control: TcpControl::Syn,
  7885. seq_number: LOCAL_SEQ,
  7886. ack_number: None,
  7887. max_seg_size: Some(BASE_MSS),
  7888. window_scale: Some(0),
  7889. sack_permitted: true,
  7890. timestamp: Some(TcpTimestampRepr::new(1, 0)),
  7891. ..RECV_TEMPL
  7892. }]
  7893. );
  7894. send!(
  7895. s,
  7896. TcpRepr {
  7897. control: TcpControl::Syn,
  7898. seq_number: REMOTE_SEQ,
  7899. ack_number: Some(LOCAL_SEQ + 1),
  7900. max_seg_size: Some(BASE_MSS - 80),
  7901. window_scale: Some(0),
  7902. timestamp: None,
  7903. ..SEND_TEMPL
  7904. }
  7905. );
  7906. assert!(!s.timestamp_enabled());
  7907. s.send_slice(b"abcdef").unwrap();
  7908. recv!(
  7909. s,
  7910. [TcpRepr {
  7911. seq_number: LOCAL_SEQ + 1,
  7912. ack_number: Some(REMOTE_SEQ + 1),
  7913. payload: &b"abcdef"[..],
  7914. timestamp: None,
  7915. ..RECV_TEMPL
  7916. }]
  7917. );
  7918. }
  7919. #[test]
  7920. fn test_tsval_disabled_in_local_client() {
  7921. let mut s = socket();
  7922. // s.set_timestamp(false); // commented to alert if the default state changes
  7923. assert!(!s.timestamp_enabled());
  7924. s.local_seq_no = LOCAL_SEQ;
  7925. s.socket
  7926. .connect(&mut s.cx, REMOTE_END, LOCAL_END.port)
  7927. .unwrap();
  7928. assert_eq!(s.tuple, Some(TUPLE));
  7929. recv!(
  7930. s,
  7931. [TcpRepr {
  7932. control: TcpControl::Syn,
  7933. seq_number: LOCAL_SEQ,
  7934. ack_number: None,
  7935. max_seg_size: Some(BASE_MSS),
  7936. window_scale: Some(0),
  7937. sack_permitted: true,
  7938. ..RECV_TEMPL
  7939. }]
  7940. );
  7941. send!(
  7942. s,
  7943. TcpRepr {
  7944. control: TcpControl::Syn,
  7945. seq_number: REMOTE_SEQ,
  7946. ack_number: Some(LOCAL_SEQ + 1),
  7947. max_seg_size: Some(BASE_MSS - 80),
  7948. window_scale: Some(0),
  7949. timestamp: Some(TcpTimestampRepr::new(500, 0)),
  7950. ..SEND_TEMPL
  7951. }
  7952. );
  7953. assert!(!s.timestamp_enabled());
  7954. s.send_slice(b"abcdef").unwrap();
  7955. recv!(
  7956. s,
  7957. [TcpRepr {
  7958. seq_number: LOCAL_SEQ + 1,
  7959. ack_number: Some(REMOTE_SEQ + 1),
  7960. payload: &b"abcdef"[..],
  7961. timestamp: None,
  7962. ..RECV_TEMPL
  7963. }]
  7964. );
  7965. }
  7966. }